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

Inheritance diagram for cellLimitedGrad< Type >:

Collaboration diagram for cellLimitedGrad< Type >:

Public Member Functions
	TypeName ("cellLimited")
	RunTime type information. More...

	cellLimitedGrad (const fvMesh &mesh, Istream &schemeData)
	Construct from mesh and schemeData. More...

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

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

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 &vsf, const word &name) const

Public Member Functions inherited from gradScheme< Type >
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))

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

virtual	~gradScheme ()
	Destructor. More...

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

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

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

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

Static Public Member Functions
static void	limitFace (Type &limiter, const Type &maxDelta, const Type &minDelta, const Type &extrapolate)

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

Private Member Functions
	cellLimitedGrad (const cellLimitedGrad &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
tmp< fv::gradScheme< Type > >	basicGradScheme_

const scalar	k_
	Limiter coefficient. More...

Detailed Description

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

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 minumum 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() [1/2]

cellLimitedGrad ( const cellLimitedGrad< Type > & )

private

Disallow default bitwise copy construct.

◆ cellLimitedGrad() [2/2]

cellLimitedGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

inline

Construct from mesh and schemeData.

Definition at line 89 of file cellLimitedGrad.H.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and cellLimitedGrad< Type >::k_.

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

void operator= ( const cellLimitedGrad< Type > & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "cellLimited" )

RunTime type information.

◆ limitFace() [1/2]

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

inlinestatic

Definition at line 155 of file cellLimitedGrad.H.

References Foam::MULES::limiter().

Here is the call graph for this function:

◆ calcGrad() [1/4]

virtual tmp< GeometricField <typename outerProduct<vector, Type>::type, fvPatchField, 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 >.

◆ limitFace() [2/2]

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

inline

Definition at line 135 of file cellLimitedGrad.H.

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

Here is the call graph for this function:

◆ calcGrad() [2/4]

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

◆ calcGrad() [3/4]

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

◆ calcGrad() [4/4]

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

Definition at line 197 of file cellLimitedGrads.C.

References GeometricField::boundaryField(), Foam::cmptMultiply(), correctBoundaryConditions(), fvPatchField::coupled(), Foam::endl(), forAll, g, Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::Info, GeometricField::internalField(), Foam::MULES::limiter(), Foam::max(), mesh, Foam::min(), Foam::name(), patchi, fvPatchField::patchNeighbourField(), x, and y.

Here is the call graph for this function:

Field Documentation

◆ basicGradScheme_

tmp<fv::gradScheme<Type> > basicGradScheme_

private

Definition at line 65 of file cellLimitedGrad.H.

◆ k_

const scalar k_

private

Limiter coefficient.

Definition at line 68 of file cellLimitedGrad.H.

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

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ cellLimitedGrad() [1/2]

◆ cellLimitedGrad() [2/2]

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ limitFace() [1/2]

◆ calcGrad() [1/4]

◆ limitFace() [2/2]

◆ calcGrad() [2/4]

◆ calcGrad() [3/4]

◆ calcGrad() [4/4]

Field Documentation

◆ basicGradScheme_

◆ k_

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