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 >:
Inheritance graph
[legend]
Collaboration diagram for gradScheme< Type >:
Collaboration graph
[legend]

Public Member Functions

virtual const wordtype () 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 ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. 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
 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
 Calculate and return the grad of the given field. More...
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 Calculate and return the grad of the given field. More...
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 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 60 of file gradScheme.H.

Constructor & Destructor Documentation

gradScheme ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 99 of file gradScheme.H.

References gradScheme< Type >::New(), and gradScheme< Type >::~gradScheme().

Here is the call graph for this function:

~gradScheme ( )
virtual

Destructor.

Definition at line 85 of file gradScheme.C.

References Foam::fvc::grad(), gradScheme< Type >::grad(), mesh, Foam::name(), IOobject::name(), and tmp< T >::ptr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

virtual const word& type ( ) const
pure virtual

Runtime type information.

declareRunTimeSelectionTable ( tmp  ,
gradScheme< Type >  ,
Istream  ,
(const fvMesh &mesh, Istream &schemeData)  ,
(mesh, schemeData)   
)
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 34 of file gradScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, mesh, and Foam::nl.

Referenced by Foam::fvc::grad(), and gradScheme< Type >::gradScheme().

Here is the call graph for this function:

Here is the caller graph for this function:

const fvMesh& mesh ( ) const
inline

Return mesh reference.

Definition at line 122 of file gradScheme.H.

References gradScheme< Type >::calcGrad(), gradScheme< Type >::grad(), and Foam::name().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 LeastSquaresGrad< Type, Stencil >, gaussGrad< Type >, faceLimitedGrad< Type >, faceMDLimitedGrad< Type >, cellLimitedGrad< Type >, cellMDLimitedGrad< Type >, leastSquaresGrad< Type >, and fourthGrad< Type >.

Referenced by gradScheme< Type >::mesh().

Here is the caller graph for this function:

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

Calculate and return the grad of the given field.

which may have been cached

Referenced by faceLimitedGrad< Type >::calcGrad(), gradScheme< Type >::mesh(), and gradScheme< Type >::~gradScheme().

Here is the caller graph for this function:

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

Calculate and return the grad of the given field.

with the default name which may have been cached

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

Calculate and return the grad of the given field.

with the default name which may have been cached


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