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

Abstract base class for snGrad schemes. More...

Inheritance diagram for snGradScheme< Type >:
Inheritance graph
[legend]
Collaboration diagram for snGradScheme< Type >:
Collaboration graph
[legend]

Public Member Functions

virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, snGradScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 snGradScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
virtual ~snGradScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual tmp< surfaceScalarFielddeltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const =0
 Return the interpolation weighting factors for the given field. More...
 
virtual bool corrected () const
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the explicit correction to the snGrad. More...
 
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the snGrad of the given cell field. More...
 
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 Return the snGrad of the given tmp cell 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< snGradScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")
 Return the snGrad of the given cell field with the given deltaCoeffs. More...
 
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > sndGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &snGradName="sndGrad")
 Return the sndGrad of the given cell field. More...
 

Detailed Description

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

Abstract base class for snGrad schemes.

Source files

Definition at line 60 of file snGradScheme.H.

Constructor & Destructor Documentation

snGradScheme ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 97 of file snGradScheme.H.

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

Here is the call graph for this function:

~snGradScheme ( )
virtual

Destructor.

Definition at line 96 of file snGradScheme.C.

References snGradScheme< Type >::snGrad().

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

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  ,
snGradScheme< Type >  ,
Mesh  ,
(const fvMesh &mesh, Istream &schemeData)  ,
(mesh, schemeData)   
)
tmp< snGradScheme< Type > > New ( const fvMesh mesh,
Istream schemeData 
)
static

Return new tmp interpolation scheme.

Definition at line 46 of file snGradScheme.C.

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

Referenced by laplacianScheme< Type, GType >::laplacianScheme(), Foam::fvc::snGrad(), and snGradScheme< Type >::snGradScheme().

Here is the call graph for this function:

Here is the caller graph for this function:

const fvMesh& mesh ( ) const
inline
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad ( const GeometricField< Type, fvPatchField, volMesh > &  vf,
const tmp< surfaceScalarField > &  tdeltaCoeffs,
const word snGradName = "snGrad" 
)
static
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > sndGrad ( const GeometricField< Type, fvPatchField, volMesh > &  vf,
const word snGradName = "sndGrad" 
)
static

Return the sndGrad of the given cell field.

Definition at line 167 of file snGradScheme.C.

References DimensionedField< Type, GeoMesh >::mesh(), Foam::fvc::snGrad(), and snGradScheme< Type >::snGrad().

Referenced by snGradScheme< Type >::mesh(), and snGradScheme< Type >::snGrad().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual tmp<surfaceScalarField> deltaCoeffs ( const GeometricField< Type, fvPatchField, volMesh > &  ) const
pure virtual

Return the interpolation weighting factors for the given field.

Implemented in limitedSnGrad< Type >, CentredFitSnGradScheme< Type, Polynomial, Stencil >, correctedSnGrad< Type >, faceCorrectedSnGrad< Type >, orthogonalSnGrad< Type >, and uncorrectedSnGrad< Type >.

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

Here is the caller graph for this function:

virtual bool corrected ( ) const
inlinevirtual
virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction ( const GeometricField< Type, fvPatchField, volMesh > &  ) const
inlinevirtual

Return the explicit correction to the snGrad.

for the given field

Reimplemented in limitedSnGrad< Type >, correctedSnGrad< Type >, faceCorrectedSnGrad< Type >, CentredFitSnGradScheme< Type, Polynomial, Stencil >, orthogonalSnGrad< Type >, and uncorrectedSnGrad< Type >.

Definition at line 158 of file snGradScheme.H.

References snGradScheme< Type >::snGrad().

Here is the call graph for this function:

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad ( const GeometricField< Type, fvPatchField, volMesh > &  vf) const
virtual

Return the snGrad of the given cell field.

Return the face-snGrad of the given cell field.

with explicit correction

Definition at line 181 of file snGradScheme.C.

References Foam::correction(), Foam::fvc::snGrad(), and snGradScheme< Type >::snGrad().

Here is the call graph for this function:

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad ( const tmp< GeometricField< Type, fvPatchField, volMesh > > &  tvf) const

Return the snGrad of the given tmp cell field.

Return the face-snGrad of the given cell field.

with explicit correction

Definition at line 204 of file snGradScheme.C.

References tmp< T >::clear(), and Foam::fvc::snGrad().

Here is the call graph for this function:


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