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

#include <cellLimitedGrad.H>

Inheritance diagram for cellLimitedGrad< Type, Limiter >:

[legend]

Collaboration diagram for cellLimitedGrad< Type, Limiter >:

[legend]

Public Member Functions
	TypeName ("cellLimited")
	RunTime type information.
	cellLimitedGrad (const fvMesh &mesh, Istream &schemeData)
	Construct from mesh and schemeData.
void	limitFaceCmpt (scalar &limiter, const scalar maxDelta, const scalar minDelta, const scalar extrapolate) const
void	limitFace (Type &limiter, const Type &maxDelta, const Type &minDelta, const Type &extrapolate) const
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.
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.
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.
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 Limiter>
class Foam::fv::cellLimitedGrad< Type, Limiter >

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

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

Source files

Definition at line 59 of file cellLimitedGrad.H.

Constructor & Destructor Documentation

◆ cellLimitedGrad()

template<class Type, class Limiter>

cellLimitedGrad	(	const fvMesh &	mesh,
		Istream &	schemeData )

inline

Construct from mesh and schemeData.

Definition at line 112 of file cellLimitedGrad.H.

Member Function Documentation

◆ TypeName()

template<class Type, class Limiter>

TypeName ( "cellLimited" )

RunTime type information.

◆ limitFaceCmpt()

template<class Type, class Limiter>

void limitFaceCmpt	(	scalar &	limiter,
		const scalar	maxDelta,
		const scalar	minDelta,
		const scalar	extrapolate ) const

inline

Definition at line 177 of file cellLimitedGrad.H.

References Foam::limiter(), and Foam::min().

Referenced by limitFace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ limitFace()

template<class Type, class Limiter>

void limitFace	(	Type &	limiter,
		const Type &	maxDelta,
		const Type &	minDelta,
		const Type &	extrapolate ) const

inline

Definition at line 205 of file cellLimitedGrad.H.

References Foam::component(), Foam::limiter(), limitFaceCmpt(), and Foam::setComponent().

Referenced by calcGrad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcGrad() [1/2]

template<class Type, class Limiter>

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

virtual

Return the gradient of the given field to the gradScheme::grad.

for optional caching

Implements gradScheme< Type >.

Definition at line 221 of file cellLimitedGrad.C.

References calcGrad(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimLength, fvPatchFieldBase::extrapolatedCalculatedType(), IOobject::instance(), DimensionedField< Type, GeoMesh >::mesh(), gradScheme< Type >::mesh(), Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and tmp< T >::ref().

Referenced by calcGrad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcGrad() [2/2]

template<class Type, class Limiter>

void calcGrad	(	GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > &	res,
		const GeometricField< Type, fvPatchField, volMesh > &	vsf ) const

virtual

Calculate the grad of the given field into supplied field.

Reimplemented from gradScheme< Type >.

Definition at line 58 of file cellLimitedGrad.C.

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

Here is the call graph for this function:

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

src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellLimitedGrad/cellLimitedGrad.H
src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellLimitedGrad/cellLimitedGrad.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cellLimitedGrad()

Member Function Documentation

◆ TypeName()

◆ limitFaceCmpt()

◆ limitFace()

◆ calcGrad() [1/2]

◆ calcGrad() [2/2]