Surface gradient scheme with limited explicit non-orthogonal correction. More...

Inheritance diagram for limitedSnGrad< Type >:

Collaboration diagram for limitedSnGrad< Type >:

Public Member Functions
	TypeName ("limited")

	limitedSnGrad (const fvMesh &mesh)

	limitedSnGrad (const fvMesh &mesh, Istream &schemeData)

virtual	~limitedSnGrad ()=default

virtual tmp< surfaceScalarField >	deltaCoeffs (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 word &	type () const =0

	declareRunTimeSelectionTable (tmp, snGradScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))

	snGradScheme (const fvMesh &mesh)

virtual	~snGradScheme ()=default

const fvMesh &	mesh () 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::limitedSnGrad< Type >

Surface gradient scheme with limited explicit non-orthogonal correction.

The limiter is controlled by a coefficient with a value between 0 and 1 which when 0 switches the correction off and the scheme behaves as uncorrected snGrad, when set to 1 the full correction of the selected scheme is used and the scheme behaves as corrected snGrad, and when set to 0.5 the limiter is calculated such that the non-orthogonal component does not exceed the orthogonal component.

Usage

Minimal example by using system/fvSchemes:

snGradSchemes
{
    snGrad(<term>)       limited <corrected scheme> <coefficient>;

    // Backward compatibility
    snGrad(<term>)       limited <coefficient>;
}

Source files

Definition at line 75 of file limitedSnGrad.H.