cellLimitedGrad< Type, Limiter > Class Template Reference

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

Inheritance diagram for cellLimitedGrad< Type, Limiter >:
[legend]
Collaboration diagram for cellLimitedGrad< Type, Limiter >:
[legend]

Public Member Functions

 TypeName ("cellLimited")
 RunTime type information. More...
 
 cellLimitedGrad (const fvMesh &mesh, Istream &schemeData)
 Construct from mesh and schemeData. More...
 
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. More...
 
- Public Member Functions inherited from gradScheme< Type >
virtual const wordtype () 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 ()=default
 Destructor. More...
 
const fvMeshmesh () const
 Return const reference to mesh. More...
 
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > calcGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &name) const =0
 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 word &name) const
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad (const GeometricField< Type, fvPatchField, volMesh > &) const
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad (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 gradScheme< Type >
static tmp< gradScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore. More...
 

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 63 of file cellLimitedGrad.H.

Constructor & Destructor Documentation

◆ cellLimitedGrad()

cellLimitedGrad ( const fvMesh mesh,
Istream schemeData 
)
inline

Construct from mesh and schemeData.

Definition at line 106 of file cellLimitedGrad.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cellLimited"  )

RunTime type information.

◆ limitFaceCmpt()

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

Definition at line 158 of file cellLimitedGrad.H.

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

Here is the call graph for this function:

◆ limitFace()

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

Definition at line 186 of file cellLimitedGrad.H.

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

Here is the call graph for this function:

◆ calcGrad()

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 74 of file cellLimitedGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatchField< Type >::coupled(), Foam::endl(), forAll, g, Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::Info, Foam::limiter(), max(), mesh, DimensionedField< Type, GeoMesh >::mesh(), Foam::min(), IOobject::name(), Foam::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: