Run-time selected snGrad scheme with limited non-orthogonal correction. More...

Inheritance diagram for limitedSnGrad< Type >:

Collaboration diagram for limitedSnGrad< Type >:

Public Member Functions
	TypeName ("limited")
	Runtime type information. More...

	limitedSnGrad (const fvMesh &mesh)
	Construct from mesh. More...

	limitedSnGrad (const fvMesh &mesh, Istream &schemeData)
	Construct from mesh and data stream. More...

virtual	~limitedSnGrad ()
	Destructor. More...

virtual tmp< surfaceScalarField >	deltaCoeffs (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 limitedSnGrad. More...

Public Member Functions inherited from snGradScheme< Type >
virtual const word &	type () 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 ()
	Destructor. More...

const fvMesh &	mesh () 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...

Public Member Functions inherited from refCount
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

bool	okToDelete () const
	Return true if the reference count is zero. More...

void	resetRefCount ()
	Reset the reference count to 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...

Private Member Functions
void	operator= (const limitedSnGrad &)
	Disallow default bitwise assignment. More...

tmp< snGradScheme< Type > >	lookupCorrectedScheme (Istream &schemeData)
	Lookup function for the corrected to support backward compatibility. More...

Private Attributes
tmp< snGradScheme< Type > >	correctedScheme_

scalar	limitCoeff_

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...

Detailed Description

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

Run-time selected snGrad scheme with limited 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 uncorrectedSnGrad, when set to 1 the full correction of the selected scheme is used and when set to 0.5 the limiter is calculated such that the non-orthogonal contribution does not exceed the orthogonal part.

Format: limited <corrected scheme> <coefficient>;

or

limited <coefficient>; // Backward compatibility

Source files

Definition at line 67 of file limitedSnGrad.H.

Constructor & Destructor Documentation

◆ limitedSnGrad() [1/2]

limitedSnGrad ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 121 of file limitedSnGrad.H.

◆ limitedSnGrad() [2/2]

limitedSnGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

inline

Construct from mesh and data stream.

Definition at line 130 of file limitedSnGrad.H.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and limitedSnGrad< Type >::limitCoeff_.

Here is the call graph for this function:

◆ ~limitedSnGrad()

~limitedSnGrad

virtual

Destructor.

Definition at line 45 of file limitedSnGrad.C.

Member Function Documentation

◆ operator=()

void operator= ( const limitedSnGrad< Type > & )

private

Disallow default bitwise assignment.

◆ lookupCorrectedScheme()

tmp<snGradScheme<Type> > lookupCorrectedScheme ( Istream & schemeData )

inlineprivate

Lookup function for the corrected to support backward compatibility.

of dictionary specification

Definition at line 85 of file limitedSnGrad.H.

◆ TypeName()

TypeName ( "limited" )

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 155 of file limitedSnGrad.H.

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

Here is the call 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 163 of file limitedSnGrad.H.

◆ correction()

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

virtual

Return the explicit correction to the limitedSnGrad.

for the given field

Reimplemented from snGradScheme< Type >.

Definition at line 54 of file limitedSnGrad.C.

References Foam::average(), Foam::correction(), Foam::dimless, Foam::endl(), Foam::Info, Foam::MULES::limiter(), Foam::mag(), Foam::max(), and Foam::min().

Here is the call graph for this function:

Field Documentation

◆ correctedScheme_

tmp<snGradScheme<Type> > correctedScheme_

private

Definition at line 73 of file limitedSnGrad.H.

◆ limitCoeff_

scalar limitCoeff_

private

Definition at line 75 of file limitedSnGrad.H.

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

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

src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H
src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ limitedSnGrad() [1/2]

◆ limitedSnGrad() [2/2]

◆ ~limitedSnGrad()

Member Function Documentation

◆ operator=()

◆ lookupCorrectedScheme()

◆ TypeName()

◆ deltaCoeffs()

◆ corrected()

◆ correction()

Field Documentation

◆ correctedScheme_

◆ limitCoeff_

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