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

Abstract base class for gradient schemes. More...

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

Public Member Functions

virtual const word & type () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 gradScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
virtual ~gradScheme ()=default
 Destructor. More...
 
const fvMesh & mesh () const
 Return const reference to mesh. More...
 
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > calcGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &name) const =0
 Calculate and return the grad of the given field. More...
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad (const GeometricField< Type, fvPatchField, volMesh > &, const word &name) const
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad (const GeometricField< Type, fvPatchField, volMesh > &) const
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, 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 fvMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore. More...
 

Detailed Description

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

Abstract base class for gradient schemes.

Source files

Definition at line 63 of file gradScheme.H.

Constructor & Destructor Documentation

◆ gradScheme()

gradScheme ( const fvMesh &  mesh)
inline

Construct from mesh.

Definition at line 103 of file gradScheme.H.

◆ ~gradScheme()

virtual ~gradScheme ( )
virtualdefault

Destructor.

Member Function Documentation

◆ type()

virtual const word & type ( ) const
pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

Foam::tmp< Foam::fv::gradScheme< Type > > New ( const fvMesh &  mesh,
Istream &  schemeData 
)
static

Return a pointer to a new gradScheme created on freestore.

Definition at line 36 of file gradScheme.C.

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

Here is the call graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const
inline

Return const reference to mesh.

Definition at line 126 of file gradScheme.H.

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

Here is the caller graph for this function:

◆ calcGrad()

virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > calcGrad ( const GeometricField< Type, fvPatchField, volMesh > &  ,
const word &  name 
) const
pure virtual

Calculate and return the grad of the given field.

Used by grad either to recalculate the cached gradient when it is out of date with respect to the field or when it is not cached.

Implemented in fourthGrad< Type >, gaussGrad< Type >, iterativeGaussGrad< Type >, leastSquaresGrad< Type >, LeastSquaresGrad< Type, Stencil >, cellLimitedGrad< Type, Limiter >, cellMDLimitedGrad< Type >, faceLimitedGrad< Type >, and faceMDLimitedGrad< Type >.

◆ grad() [1/3]

Foam::tmp< Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > > grad ( const GeometricField< Type, fvPatchField, volMesh > &  vsf,
const word &  name 
) const

Calculate and return the grad of the given field which may have been cached

Definition at line 87 of file gradScheme.C.

References mesh, and Foam::name().

Referenced by fourthGrad< Type >::calcGrad(), and faceLimitedGrad< Type >::calcGrad().

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

◆ grad() [2/3]

Foam::tmp< Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > > grad ( const GeometricField< Type, fvPatchField, volMesh > &  vsf) const

Calculate and return the grad of the given field with the default name which may have been cached

Definition at line 150 of file gradScheme.C.

References IOobject::name().

Here is the call graph for this function:

◆ grad() [3/3]

Foam::tmp< Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > > grad ( const tmp< GeometricField< Type, fvPatchField, volMesh > > &  tvsf) const

Calculate and return the grad of the given field with the default name which may have been cached

Definition at line 169 of file gradScheme.C.

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