orthogonalSnGrad< Type > Class Template Reference

Simple central-difference snGrad scheme using the cell-centre to cell-centre delta-coefficients. More...

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

Public Member Functions

 TypeName ("orthogonal")
 Runtime type information. More...
 
 orthogonalSnGrad (const fvMesh &mesh)
 Construct from mesh. More...
 
 orthogonalSnGrad (const fvMesh &mesh, Istream &)
 Construct from mesh and data stream. More...
 
virtual ~orthogonalSnGrad ()
 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 orthogonalSnGrad. More...
 
void operator= (const orthogonalSnGrad &)=delete
 Disallow default bitwise assignment. 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...
 
 snGradScheme (const snGradScheme &)
 Disallow default bitwise copy construction. 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...
 
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...
 

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...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 

Detailed Description

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

Simple central-difference snGrad scheme using the cell-centre to cell-centre delta-coefficients.

Source files

Definition at line 55 of file orthogonalSnGrad.H.

Constructor & Destructor Documentation

◆ orthogonalSnGrad() [1/2]

orthogonalSnGrad ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 69 of file orthogonalSnGrad.H.

◆ orthogonalSnGrad() [2/2]

orthogonalSnGrad ( const fvMesh mesh,
Istream  
)
inline

Construct from mesh and data stream.

Definition at line 76 of file orthogonalSnGrad.H.

References orthogonalSnGrad< Type >::deltaCoeffs(), and orthogonalSnGrad< Type >::~orthogonalSnGrad().

Here is the call graph for this function:

◆ ~orthogonalSnGrad()

~orthogonalSnGrad ( )
virtual

Destructor.

Definition at line 46 of file orthogonalSnGrad.C.

References orthogonalSnGrad< Type >::correction().

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

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "orthogonal"  )

Runtime type information.

◆ deltaCoeffs()

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 90 of file orthogonalSnGrad.H.

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

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

Here is the call graph for this function:
Here is the caller 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 98 of file orthogonalSnGrad.H.

References orthogonalSnGrad< Type >::correction(), and orthogonalSnGrad< Type >::operator=().

Here is the call graph for this function:

◆ correction()

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

Return the explicit correction to the orthogonalSnGrad.

for the given field

Reimplemented from snGradScheme< Type >.

Definition at line 55 of file orthogonalSnGrad.C.

References NotImplemented.

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

Here is the caller graph for this function:

◆ operator=()

void operator= ( const orthogonalSnGrad< Type > &  )
delete

Disallow default bitwise assignment.

Referenced by orthogonalSnGrad< Type >::corrected().

Here is the caller graph for this function:

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