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

Inheritance diagram for relaxedSnGrad< Type >:

Collaboration diagram for relaxedSnGrad< Type >:

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

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

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

virtual	~relaxedSnGrad ()=default
	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 noexcept
	Return true if this scheme uses an explicit correction. More...

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
	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 ()=default
	Destructor. More...

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

virtual tmp< surfaceScalarField >	deltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const =0
	Return the interpolation weighting factors for the given field. More...

virtual bool	corrected () const noexcept
	Return true if this scheme uses an explicit correction. More...

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &) 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
	Default construct, initializing count to 0. More...

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

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

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. 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< 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")
	Return the sndGrad of the given cell field. More...

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 81 of file relaxedSnGrad.H.

Constructor & Destructor Documentation

◆ relaxedSnGrad() [1/2]

relaxedSnGrad ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 106 of file relaxedSnGrad.H.

◆ relaxedSnGrad() [2/2]

relaxedSnGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

inline

Construct from mesh and data stream.

Definition at line 113 of file relaxedSnGrad.H.

◆ ~relaxedSnGrad()

virtual ~relaxedSnGrad ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "relaxed" )

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

Return true if this scheme uses an explicit correction.

Reimplemented from snGradScheme< Type >.

Definition at line 136 of file relaxedSnGrad.H.

◆ correction()

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