snGradScheme< Type > Class Template Reference

Abstract base class for snGrad schemes. More...

Inheritance diagram for snGradScheme< Type >:
Collaboration diagram for snGradScheme< Type >:

List of all members.

Public Member Functions

virtual const wordtype () const =0
 Runtime type information.
 declareRunTimeSelectionTable (tmp, snGradScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 snGradScheme (const fvMesh &mesh)
 Construct from mesh.
virtual ~snGradScheme ()
 Destructor.
const fvMeshmesh () const
 Return mesh reference.
virtual tmp< surfaceScalarFielddeltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const =0
 Return the interpolation weighting factors for the given field.
virtual bool corrected () const
 Return true if this scheme uses an explicit correction.
virtual tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
correction (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the explicit correction to the snGrad.
virtual tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
snGrad (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the snGrad of the given cell field.
tmp< GeometricField< Type,
fvsPatchField, surfaceMesh > > 
snGrad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 Return the snGrad of the given tmp cell field.

Static Public Member Functions

static tmp< snGradScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme.
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.
static tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
sndGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &snGradName="sndGrad")
 Return the sndGrad of the given cell field.

Detailed Description

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

Abstract base class for snGrad schemes.

Source files

Definition at line 61 of file snGradScheme.H.


Constructor & Destructor Documentation

snGradScheme ( const fvMesh mesh) [inline]

Construct from mesh.

Definition at line 98 of file snGradScheme.H.

~snGradScheme ( ) [virtual]

Destructor.

Definition at line 96 of file snGradScheme.C.


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.

Here is the call 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]

Return the snGrad of the given cell field with the given deltaCoeffs.

Definition at line 105 of file snGradScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, IOobject::instance(), DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), fvMesh::neighbour(), IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::owner(), and patchi.

Referenced by Foam::fvc::snGrad().

Here is the call graph for this function:

Here is the caller graph for this function:

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 157 of file snGradScheme.C.

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

Here is the call 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 correctedSnGrad< Type >, faceCorrectedSnGrad< Type >, limitedSnGrad< Type >, orthogonalSnGrad< Type >, and uncorrectedSnGrad< Type >.

virtual bool corrected ( ) const [inline, virtual]

Return true if this scheme uses an explicit correction.

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

Definition at line 151 of file snGradScheme.H.

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction ( const GeometricField< Type, fvPatchField, volMesh > &  ) const [inline, virtual]

Return the explicit correction to the snGrad.

for the given field

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

Definition at line 159 of file snGradScheme.H.

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 171 of file snGradScheme.C.

References Foam::correction(), and Foam::fvc::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 194 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:
  • src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H
  • src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.C