Loading...
Searching...
No Matches
relaxedSnGrad< Type > Class Template Reference
Numerics » Finite volume numerical schemes » Surface normal gradient schemes

Surface gradient scheme with under-/over-relaxed full or limited explicit non-orthogonal correction. More...

#include <relaxedSnGrad.H>

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

Public Member Functions

 TypeName ("relaxed")
 Runtime type information.
 relaxedSnGrad (const fvMesh &mesh)
 Construct from mesh.
 relaxedSnGrad (const fvMesh &mesh, Istream &schemeData)
 Construct from mesh and data stream.
virtual ~relaxedSnGrad ()=default
 Destructor.
virtual tmp< surfaceScalarField > deltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors for the given field.
virtual bool corrected () const noexcept
 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 relaxedSnGrad for the given field using the gradients of the field components.
Public Member Functions inherited from snGradScheme< Type >
virtual const word & type () 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 ()=default
 Destructor.
const fvMesh & mesh () const
 Return const reference to mesh.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the snGrad of the given cell field with explicit correction.
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 Return the snGrad of the given tmp cell field with explicit correction.
Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0.
int use_count () const noexcept
 Return the current reference count.
bool unique () const noexcept
 Return true if the reference count is zero.
void operator++ () noexcept
 Increment the reference count.
void operator++ (int) noexcept
 Increment the reference count.
void operator-- () noexcept
 Decrement the reference count.
void operator-- (int) noexcept
 Decrement the reference count.

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.
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 by using the given deltaCoeffs.
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > sndGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &snGradName="sndGrad")
 Return the sndGrad of the given cell field.

Detailed Description

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

Surface gradient scheme with under-/over-relaxed full or limited explicit non-orthogonal correction.

Usage
Minimal example by using system/fvSchemes: 
snGradSchemes
{
    snGrad(<term>)       relaxed;
}

and by using system/fvSolution: 

relaxationFactors
{
    fields
    {
        snGrad(<term>)   <relaxation factor>;
    }
}
Source files

Definition at line 77 of file relaxedSnGrad.H.

Constructor & Destructor Documentation

◆ relaxedSnGrad() [1/2]

template<class Type>
relaxedSnGrad ( const fvMesh & mesh)
inline

Construct from mesh.

Definition at line 110 of file relaxedSnGrad.H.

References snGradScheme< Type >::mesh().

Here is the call graph for this function:

◆ relaxedSnGrad() [2/2]

template<class Type>
relaxedSnGrad ( const fvMesh & mesh,
Istream & schemeData )
inline

Construct from mesh and data stream.

Definition at line 119 of file relaxedSnGrad.H.

References snGradScheme< Type >::mesh().

Here is the call graph for this function:

◆ ~relaxedSnGrad()

template<class Type>
virtual ~relaxedSnGrad ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

template<class Type>
TypeName ( "relaxed" )

Runtime type information.

◆ deltaCoeffs()

template<class Type>
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 137 of file relaxedSnGrad.H.

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

Here is the call graph for this function:

◆ corrected()

template<class Type>
virtual bool corrected ( ) const
inlinevirtualnoexcept

Return true if this scheme uses an explicit correction.

Reimplemented from snGradScheme< Type >.

Definition at line 148 of file relaxedSnGrad.H.

References Foam::noexcept.

◆ correction()

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

Return the explicit correction to the relaxedSnGrad for the given field using the gradients of the field components.

Reimplemented from snGradScheme< Type >.

Definition at line 30 of file relaxedSnGrad.C.

References IOobject::db(), objectRegistry::foundObject(), objectRegistry::lookupObjectRef(), DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), tmp< T >::New(), and relax().

Here is the call graph for this function:
The documentation for this class was generated from the following files: