FreeFOAM The Cross-Platform CFD Toolkit
snGradScheme< Type > Class Template Reference

Abstract base class for snGrad schemes. More...

#include <finiteVolume/snGradScheme.H>


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.

+ 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 ()
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.
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.

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.

Constructor & Destructor Documentation

snGradScheme ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 98 of file snGradScheme.H.

~snGradScheme ( )
virtual

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, and mesh.

Referenced by quadraticFitSnGrad< Type >::correction().

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad ( const GeometricField< Type, fvPatchField, volMesh > &  vf,
const tmp< surfaceScalarField > &  tdeltaCoeffs,
const word snGradName = "snGrad" 
)
static
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 >, quadraticFitSnGrad< Type >, correctedSnGrad< Type >, and uncorrectedSnGrad< Type >.

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented in limitedSnGrad< Type >, quadraticFitSnGrad< Type >, correctedSnGrad< Type >, and uncorrectedSnGrad< Type >.

Definition at line 144 of file snGradScheme.H.

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 >, quadraticFitSnGrad< Type >, correctedSnGrad< Type >, and uncorrectedSnGrad< Type >.

Definition at line 152 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 159 of file snGradScheme.C.

References Foam::correction(), and Foam::fvc::snGrad().

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

References Foam::fvc::snGrad().


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