Public Member Functions | Static Public Member Functions | List of all members
gradScheme< Type > Class Template Referenceabstract

Abstract base class for finite area calculus gradient schemes. More...

Inheritance diagram for gradScheme< Type >:
[legend]
Collaboration diagram for gradScheme< Type >:
[legend]

Public Member Functions

 declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 gradScheme (const faMesh &mesh)
 Construct from mesh. More...
 
virtual ~gradScheme ()
 Destructor. More...
 
const faMesh & mesh () const
 Return mesh reference. More...
 
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const GeometricField< Type, faPatchField, areaMesh > &) const =0
 Calculate and return the grad of the given field. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Construct null initializing count to 0. More...
 
int count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 Decrement the reference count. More...
 

Static Public Member Functions

static tmp< gradScheme< Type > > New (const faMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore. More...
 

Detailed Description

template<class Type>
class Foam::fa::gradScheme< Type >

Abstract base class for finite area calculus gradient schemes.

Source files

Definition at line 63 of file faGradScheme.H.

Constructor & Destructor Documentation

◆ gradScheme()

gradScheme ( const faMesh &  mesh)
inline

Construct from mesh.

Definition at line 98 of file faGradScheme.H.

◆ ~gradScheme()

~gradScheme ( )
virtual

Destructor.

Definition at line 89 of file faGradScheme.C.

Member Function Documentation

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( tmp  ,
gradScheme< Type >  ,
Istream  ,
(const faMesh &mesh, Istream &schemeData)  ,
(mesh, schemeData)   
)

◆ New()

tmp< gradScheme< Type > > New ( const faMesh &  mesh,
Istream &  schemeData 
)
static

Return a pointer to a new gradScheme created on freestore.

Definition at line 46 of file faGradScheme.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, InfoInFunction, mesh, and Foam::nl.

Referenced by Foam::fac::grad(), and Foam::fac::ngrad().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mesh()

const faMesh& mesh ( ) const
inline

Return mesh reference.

Definition at line 121 of file faGradScheme.H.

Referenced by gaussGrad< Type >::gaussGrad().

Here is the caller graph for this function:

◆ grad()

virtual tmp< GeometricField <typename outerProduct<vector, Type>::type, faPatchField, areaMesh> > grad ( const GeometricField< Type, faPatchField, areaMesh > &  ) const
pure virtual

Calculate and return the grad of the given field.

Implemented in gaussGrad< Type >, faceLimitedGrad< Type >, edgeLimitedGrad< Type >, and leastSquaresFaGrad< Type >.

The documentation for this class was generated from the following files: