Gradient.H

Go to the documentation of this file.

// Gradient class: utility for computing grad(phi) for difference stencils
// written by F. Miniati

#ifndef _GRADIENT_H
#define _GRADIENT_H

#include "ProblemDomain.H"
#include "FArrayBox.H"
#include "FluxBox.H"
#include "Box.H"

enum StencilType {TwoPts, FourPts, TenPts};

class Gradient
{
public:
  Gradient(){;};

  virtual ~Gradient(){;};

  // computes cell centered gradient
  virtual void gradient(FArrayBox&           a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box) = 0;

  // computes cell centered gradient
  virtual void gradient(FluxBox&             a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box) = 0;
};

class TwoPtsGradient : public Gradient
{
public:
  TwoPtsGradient() : Gradient() {;};

  virtual ~TwoPtsGradient(){;};

  virtual void gradient(FArrayBox&           a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box);

  virtual void gradient(FluxBox&             a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box);
};

class FourPtsGradient : public Gradient
{
public:
  FourPtsGradient() : Gradient() {;};

  virtual ~FourPtsGradient(){;};

  virtual void gradient(FArrayBox&           a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box);

  virtual void gradient(FluxBox&             a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box);
};

class TenPtsGradient : public Gradient
{
public:
  TenPtsGradient() : Gradient() {;};

  virtual ~TenPtsGradient(){;};

  virtual void gradient(FArrayBox&           a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box);

  virtual void gradient(FluxBox&             a_grad,
                        const FArrayBox&     a_phi,
                        const ProblemDomain& a_domain,
                        const Real&          a_dx,
                        const Box&           a_box);
};

#endif

---