faceLimitedGrad< Type > Class Template Reference

faceLimitedGrad gradient scheme applied to a runTime selected base gradient scheme. More...

#include <faceLimitedGrad.H>

Inheritance diagram for faceLimitedGrad< Type >:

Collaboration diagram for faceLimitedGrad< Type >:

Public Member Functions
	TypeName ("faceLimited")
	RunTime type information.
	faceLimitedGrad (const fvMesh &mesh, Istream &schemeData)
	Construct from mesh and schemeData.
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	calcGrad (const GeometricField< Type, fvPatchField, volMesh > &vsf, const word &name) const
	Return the gradient of the given field to the gradScheme::grad for optional caching.
tmp< volVectorField >	calcGrad (const volScalarField &vsf, const word &name) const
tmp< volTensorField >	calcGrad (const volVectorField &vsf, const word &name) const
Foam::tmp< Foam::volTensorField >	calcGrad (const volVectorField &vvf, const word &name) const
Public Member Functions inherited from gradScheme< Type >
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const fvMesh &mesh)
	Construct from mesh.
virtual	~gradScheme ()=default
	Destructor.
const fvMesh &	mesh () const
	Return const reference to mesh.
virtual void	calcGrad (GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > &res, const GeometricField< Type, fvPatchField, volMesh > &) const
	Calculate the grad of the given field into supplied field.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (const GeometricField< Type, fvPatchField, volMesh > &, const word &name) const
	Calculate and return the grad of the given field which may have been cached.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (const GeometricField< Type, fvPatchField, volMesh > &) const
	Calculate and return the grad of the given field with the default name which may have been cached.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Calculate and return the grad of the given field with the default name which may have been cached.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Static Public Member Functions inherited from gradScheme< Type >
static tmp< gradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new gradScheme created on freestore.

Detailed Description

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

faceLimitedGrad gradient scheme applied to a runTime selected base gradient scheme.

The scalar limiter based on limiting the extrapolated face values between the face-neighbour cell values and is applied to all components of the gradient.

Source files

• faceLimitedGrad.H
• faceLimitedGrad.C

Definition at line 61 of file faceLimitedGrad.H.

Constructor & Destructor Documentation

faceLimitedGrad()

template<class Type>

faceLimitedGrad ( const fvMesh & mesh, Istream & schemeData )

inline

Construct from mesh and schemeData.

Definition at line 113 of file faceLimitedGrad.H.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, gradScheme< Type >::mesh(), and gradScheme< Type >::New().

Here is the call graph for this function:

Member Function Documentation

TypeName()

template<class Type>

TypeName

(

"faceLimited"

)

RunTime type information.

calcGrad() [1/4]

template<class Type>

virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > calcGrad ( const GeometricField< Type, fvPatchField, volMesh > & vsf, const word & name ) const

inlinevirtual

Return the gradient of the given field to the gradScheme::grad for optional caching.

Implements gradScheme< Type >.

Definition at line 139 of file faceLimitedGrad.H.

References gradScheme< Type >::grad(), and Foam::name().

Here is the call graph for this function:

calcGrad() [2/4]

tmp< volVectorField > calcGrad	(	const volScalarField &	vsf,
		const word &	name ) const

References Foam::name().

Here is the call graph for this function:

calcGrad() [3/4]

tmp< volTensorField > calcGrad	(	const volVectorField &	vsf,
		const word &	name ) const

References Foam::name().

Here is the call graph for this function:

calcGrad() [4/4]

Foam::tmp< Foam::volTensorField > calcGrad	(	const volVectorField &	vvf,
		const word &	name ) const

Definition at line 177 of file faceLimitedGrads.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), gaussGrad< Type >::correctBoundaryConditions(), fvPatchFieldBase::coupled(), Foam::endl(), fvPatchFieldBase::fixesValue(), forAll, g, Foam::gAverage(), Foam::gMinMax(), Foam::Info, Foam::limiter(), limits, Foam::magSqr(), Foam::max(), DimensionedField< Type, GeoMesh >::mesh(), gradScheme< Type >::mesh(), Foam::min(), IOobject::name(), Foam::name(), fvPatchField< Type >::patchNeighbourField(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), and UList< T >::size().

Here is the call graph for this function:

---

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

• src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceLimitedGrad/faceLimitedGrad.H