faceLimitedGrad< Type > Class Template Reference

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

Inheritance diagram for faceLimitedGrad< Type >:
Collaboration diagram for faceLimitedGrad< Type >:

Public Member Functions

 TypeName ("faceLimited")
 RunTime type information. More...
 
 faceLimitedGrad (const fvMesh &mesh, Istream &schemeData)
 Construct from mesh and schemeData. More...
 
 faceLimitedGrad (const faceLimitedGrad &)=delete
 Disallow default bitwise copy construction. 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 operator= (const faceLimitedGrad &)=delete
 Disallow default bitwise assignment. More...
 
template<>
tmp< volVectorFieldcalcGrad (const volScalarField &vsf, const word &name) const
 
template<>
tmp< volTensorFieldcalcGrad (const volVectorField &vsf, const word &name) const
 
template<>
Foam::tmp< Foam::volTensorFieldcalcGrad (const volVectorField &vvf, const word &name) const
 
- 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 ()
 Destructor. More...
 
const fvMeshmesh () 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
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is 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...
 

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...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initializing count to 0. More...
 

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

Definition at line 59 of file faceLimitedGrad.H.

Constructor & Destructor Documentation

◆ faceLimitedGrad() [1/2]

faceLimitedGrad ( const fvMesh mesh,
Istream schemeData 
)
inline

Construct from mesh and schemeData.

Definition at line 91 of file faceLimitedGrad.H.

References faceLimitedGrad< Type >::calcGrad(), Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.

Here is the call graph for this function:

◆ faceLimitedGrad() [2/2]

faceLimitedGrad ( const faceLimitedGrad< Type > &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "faceLimited"  )

RunTime type information.

◆ calcGrad() [1/4]

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 121 of file faceLimitedGrad.H.

References gradScheme< Type >::grad(), Foam::min(), Foam::name(), and faceLimitedGrad< Type >::operator=().

Referenced by faceLimitedGrad< Type >::faceLimitedGrad(), and makeFvGradScheme().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const faceLimitedGrad< Type > &  )
delete

Disallow default bitwise assignment.

Referenced by faceLimitedGrad< Type >::calcGrad().

Here is the caller 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]


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