Public Member Functions | List of all members
limitedSnGrad< Type > Class Template Reference

Run-time selected snGrad scheme with limited non-orthogonal correction. More...

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

Public Member Functions

 TypeName ("limited")
 Runtime type information. More...
 
 limitedSnGrad (const fvMesh &mesh)
 Construct from mesh. More...
 
 limitedSnGrad (const fvMesh &mesh, Istream &schemeData)
 Construct from mesh and data stream. More...
 
virtual ~limitedSnGrad ()
 Destructor. More...
 
virtual tmp< surfaceScalarFielddeltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const
 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 limitedSnGrad. More...
 
- Public Member Functions inherited from snGradScheme< Type >
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< 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from snGradScheme< Type >
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::limitedSnGrad< Type >

Run-time selected snGrad scheme with limited non-orthogonal correction.

The limiter is controlled by a coefficient with a value between 0 and 1 which when 0 switches the correction off and the scheme behaves as uncorrectedSnGrad, when set to 1 the full correction of the selected scheme is used and when set to 0.5 the limiter is calculated such that the non-orthogonal contribution does not exceed the orthogonal part.

Format: limited <corrected scheme>=""> <coefficient>;

or

limited <coefficient>; // Backward compatibility

Source files

Definition at line 67 of file limitedSnGrad.H.

Constructor & Destructor Documentation

limitedSnGrad ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 121 of file limitedSnGrad.H.

limitedSnGrad ( const fvMesh mesh,
Istream schemeData 
)
inline

Construct from mesh and data stream.

Definition at line 130 of file limitedSnGrad.H.

References limitedSnGrad< Type >::deltaCoeffs(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, and limitedSnGrad< Type >::~limitedSnGrad().

Here is the call graph for this function:

~limitedSnGrad ( )
virtual

Destructor.

Definition at line 45 of file limitedSnGrad.C.

References limitedSnGrad< Type >::correction().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "limited"  )

Runtime type information.

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

Return the interpolation weighting factors for the given field.

Implements snGradScheme< Type >.

Definition at line 156 of file limitedSnGrad.H.

References snGradScheme< Type >::mesh(), and surfaceInterpolation::nonOrthDeltaCoeffs().

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

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from snGradScheme< Type >.

Definition at line 164 of file limitedSnGrad.H.

References limitedSnGrad< Type >::correction().

Here is the call graph for this function:

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

Return the explicit correction to the limitedSnGrad.

for the given field

Reimplemented from snGradScheme< Type >.

Definition at line 54 of file limitedSnGrad.C.

References Foam::average(), Foam::correction(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimless, Foam::endl(), Foam::Info, GeometricField< Type, PatchField, GeoMesh >::internalField(), Foam::MULES::limiter(), Foam::mag(), Foam::max(), and Foam::min().

Referenced by limitedSnGrad< Type >::corrected(), and limitedSnGrad< Type >::~limitedSnGrad().

Here is the call graph for this function:

Here is the caller graph for this function:


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