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

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

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

Public Member Functions

 TypeName ("relaxed")
 
 relaxedSnGrad (const fvMesh &mesh)
 
 relaxedSnGrad (const fvMesh &mesh, Istream &schemeData)
 
virtual ~relaxedSnGrad ()=default
 
virtual tmp< surfaceScalarFielddeltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const
 
virtual bool corrected () const noexcept
 
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
 
 declareRunTimeSelectionTable (tmp, snGradScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 snGradScheme (const fvMesh &mesh)
 
virtual ~snGradScheme ()=default
 
const fvMeshmesh () 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
 
int count () const noexcept
 
bool unique () const noexcept
 
void operator++ () noexcept
 
void operator++ (int) noexcept
 
void operator-- () noexcept
 
void operator-- (int) noexcept
 

Additional Inherited Members

- Static Public Member Functions inherited from snGradScheme< Type >
static tmp< snGradScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 
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")
 

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]

relaxedSnGrad ( const fvMesh mesh)
inline

Definition at line 102 of file relaxedSnGrad.H.

◆ relaxedSnGrad() [2/2]

relaxedSnGrad ( const fvMesh mesh,
Istream schemeData 
)
inline

Definition at line 109 of file relaxedSnGrad.H.

◆ ~relaxedSnGrad()

virtual ~relaxedSnGrad ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "relaxed"  )

◆ deltaCoeffs()

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

Implements snGradScheme< Type >.

Definition at line 124 of file relaxedSnGrad.H.

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

Here is the call graph for this function:

◆ corrected()

virtual bool corrected ( ) const
inlinevirtualnoexcept

Reimplemented from snGradScheme< Type >.

Definition at line 132 of file relaxedSnGrad.H.

◆ correction()

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

Reimplemented from snGradScheme< Type >.

Definition at line 31 of file relaxedSnGrad.C.

References objectRegistry::foundObject(), objectRegistry::lookupObjectRef(), tmp::ref(), and relax().

Here is the call graph for this function:

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