correctedSnGrad< Type > Class Template Reference

Simple central-difference snGrad scheme with non-orthogonal correction. More...

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

Public Member Functions

 TypeName ("corrected")
 Runtime type information. More...
 
 correctedSnGrad (const fvMesh &mesh)
 Construct from mesh. More...
 
 correctedSnGrad (const fvMesh &mesh, Istream &)
 Construct from mesh and data stream. More...
 
virtual ~correctedSnGrad ()
 Destructor. More...
 
virtual tmp< surfaceScalarFielddeltaCoeffs (const VolField< Type > &) 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...
 
tmp< SurfaceField< Type > > fullGradCorrection (const VolField< Type > &) const
 Return the explicit correction to the correctedSnGrad. More...
 
virtual tmp< SurfaceField< Type > > correction (const VolField< Type > &) const
 Return the explicit correction to the correctedSnGrad. More...
 
tmp< surfaceScalarFieldcorrection (const volScalarField &vsf) const
 
tmp< surfaceVectorFieldcorrection (const volVectorField &vvf) const
 
Foam::tmp< Foam::surfaceVectorFieldcorrection (const volVectorField &vvf) const
 
- 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...
 
 snGradScheme (const snGradScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~snGradScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual tmp< SurfaceField< Type > > snGrad (const VolField< Type > &) const
 Return the snGrad of the given cell field. More...
 
tmp< SurfaceField< Type > > snGrad (const tmp< VolField< Type >> &) const
 Return the snGrad of the given tmp cell field. More...
 
void operator= (const snGradScheme &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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< SurfaceField< Type > > snGrad (const VolField< Type > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")
 Return the snGrad of the given cell field with the given deltaCoeffs. More...
 
static tmp< SurfaceField< Type > > sndGrad (const VolField< Type > &, const word &snGradName="sndGrad")
 Return the sndGrad of the given cell field. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 

Detailed Description

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

Simple central-difference snGrad scheme with non-orthogonal correction.

Source files

Definition at line 54 of file correctedSnGrad.H.

Constructor & Destructor Documentation

◆ correctedSnGrad() [1/2]

correctedSnGrad ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 73 of file correctedSnGrad.H.

◆ correctedSnGrad() [2/2]

correctedSnGrad ( const fvMesh mesh,
Istream  
)
inline

Construct from mesh and data stream.

Definition at line 80 of file correctedSnGrad.H.

◆ ~correctedSnGrad()

~correctedSnGrad
virtual

Destructor.

Definition at line 36 of file correctedSnGrad.C.

Member Function Documentation

◆ TypeName()

TypeName ( "corrected"  )

Runtime type information.

◆ deltaCoeffs()

virtual tmp<surfaceScalarField> deltaCoeffs ( const VolField< Type > &  ) const
inlinevirtual

Return the interpolation weighting factors for the given field.

Implements snGradScheme< Type >.

Definition at line 93 of file correctedSnGrad.H.

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

Here is the call graph for this function:

◆ corrected()

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from snGradScheme< Type >.

Definition at line 102 of file correctedSnGrad.H.

◆ fullGradCorrection()

Foam::tmp< Foam::SurfaceField< Type > > fullGradCorrection ( const VolField< Type > &  vf) const

Return the explicit correction to the correctedSnGrad.

for the given field using the gradient of the field

Definition at line 44 of file correctedSnGrad.C.

References Foam::fvc::dotInterpolate(), Foam::fvc::grad(), fvSchemes::grad(), IOobject::name(), Foam::compressible::New(), surfaceInterpolation::nonOrthCorrectionVectors(), tmp< T >::ref(), and fvMesh::schemes().

Here is the call graph for this function:

◆ correction() [1/4]

Foam::tmp< Foam::SurfaceField< Type > > correction ( const VolField< Type > &  vf) const
virtual

Return the explicit correction to the correctedSnGrad.

for the given field using the gradients of the field components

Reimplemented from snGradScheme< Type >.

Definition at line 70 of file correctedSnGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::component(), DimensionedField< Type, GeoMesh >::dimensions(), IOobject::name(), surfaceInterpolation::nonOrthDeltaCoeffs(), tmp< T >::ref(), and GeometricField< Type, PatchField, GeoMesh >::replace().

Here is the call graph for this function:

◆ correction() [2/4]

tmp< surfaceScalarField > correction ( const volScalarField vsf) const

◆ correction() [3/4]

tmp< surfaceVectorField > correction ( const volVectorField vvf) const

◆ correction() [4/4]

Foam::tmp< Foam::surfaceVectorField > correction ( const volVectorField vvf) const

Definition at line 46 of file correctedSnGrads.C.


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