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 VolField< Type > &) 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< SurfaceField< Type > >	correction (const VolField< Type > &) const
	Return the explicit correction to the limitedSnGrad. More...

void	operator= (const limitedSnGrad &)=delete
	Disallow default bitwise assignment. 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...

	snGradScheme (const snGradScheme &)=delete
	Disallow default bitwise copy construction. More...

virtual	~snGradScheme ()
	Destructor. More...

const fvMesh &	mesh () const
	Return mesh reference. More...

virtual tmp< SurfaceField< Type > >	snGrad (const VolField< Type > &) const
	Return the snGrad of the given cell field. More...

tmp< SurfaceField< Type > >	snGrad (const tmp< VolField< Type >> &) const
	Return the snGrad of the given tmp cell field. More...

void	operator= (const snGradScheme &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...

bool	unique () const
	Return true if the reference count is 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...

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. 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< SurfaceField< Type > >	snGrad (const VolField< Type > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")
	Return the snGrad of the given cell field with the given deltaCoeffs. More...

static tmp< SurfaceField< Type > >	sndGrad (const VolField< Type > &, const word &snGradName="sndGrad")
	Return the sndGrad of the given cell field. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. 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 )

Construct from mesh.

Definition at line 43 of file limitedSnGrad.C.

◆ limitedSnGrad() [2/2]

limitedSnGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

Construct from mesh and data stream.

Definition at line 52 of file limitedSnGrad.C.

References Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.

Here is the call graph for this function:

◆ ~limitedSnGrad()

~limitedSnGrad

virtual

Destructor.

Definition at line 72 of file limitedSnGrad.C.

Member Function Documentation

◆ TypeName()

TypeName ( "limited" )

Runtime type information.

◆ deltaCoeffs()

tmp< surfaceScalarField > deltaCoeffs ( const VolField< Type > & vf ) const

virtual

Return the interpolation weighting factors for the given field.

Implements snGradScheme< Type >.

Definition at line 79 of file limitedSnGrad.C.

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from snGradScheme< Type >.

Definition at line 137 of file limitedSnGrad.H.

◆ correction()

tmp< SurfaceField< Type > > correction ( const VolField< Type > & vf ) const

virtual

Return the explicit correction to the limitedSnGrad.

for the given field

Reimplemented from snGradScheme< Type >.

Definition at line 90 of file limitedSnGrad.C.

References Foam::average(), Foam::correction(), DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::dimless, Foam::endl(), InfoInFunction, Foam::MULES::limiter(), Foam::mag(), Foam::max(), and Foam::min().

Here is the call graph for this function:

◆ operator=()

void operator= ( const limitedSnGrad< Type > & )

delete

Disallow default bitwise assignment.

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

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

◆ TypeName()

◆ deltaCoeffs()

◆ corrected()

◆ correction()

◆ operator=()

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