orthogonalSnGrad< Type > Class Template Reference

Surface gradient scheme with no non-orthogonal correction. More...

Inheritance diagram for orthogonalSnGrad< Type >:
[legend]
Collaboration diagram for orthogonalSnGrad< Type >:
[legend]

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 ()=default
 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 noexcept
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction (const GeometricField< Type, fvPatchField, volMesh > &) 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...
 
virtual ~snGradScheme ()=default
 Destructor. More...
 
const fvMeshmesh () const
 Return const reference to mesh. More...
 
virtual tmp< surfaceScalarFielddeltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const =0
 Return the interpolation weighting factors for the given field. More...
 
virtual bool corrected () const noexcept
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction (const GeometricField< Type, fvPatchField, volMesh > &) const
 
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const GeometricField< Type, fvPatchField, volMesh > &) const
 
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 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")
 
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::orthogonalSnGrad< Type >

Surface gradient scheme with no non-orthogonal correction.

Usage
Minimal example by using system/fvSchemes:
snGradSchemes
{
    snGrad(<term>)       orthogonal;
}
Note
  • Interpolation weighting factors (i.e. delta coefficients) are based on the deltaCoeffs function rather than the nonOrthDeltaCoeffs function, which is used by the uncorrected scheme.
Source files

Definition at line 74 of file orthogonalSnGrad.H.

Constructor & Destructor Documentation

◆ orthogonalSnGrad() [1/2]

orthogonalSnGrad ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 93 of file orthogonalSnGrad.H.

◆ orthogonalSnGrad() [2/2]

orthogonalSnGrad ( const fvMesh mesh,
Istream  
)
inline

Construct from mesh and data stream.

Definition at line 99 of file orthogonalSnGrad.H.

◆ ~orthogonalSnGrad()

virtual ~orthogonalSnGrad ( )
virtualdefault

Destructor.

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

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

Here is the call graph for this function:

◆ corrected()

virtual bool corrected ( ) const
inlinevirtualnoexcept

Return true if this scheme uses an explicit correction.

Reimplemented from snGradScheme< Type >.

Definition at line 121 of file orthogonalSnGrad.H.

◆ 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 47 of file orthogonalSnGrad.C.

References NotImplemented.


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