edgeLimitedGrad< Type > Class Template Reference

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

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

Public Member Functions

 TypeName ("edgeLimited")
 RunTime type information. More...
 
 edgeLimitedGrad (const faMesh &mesh, Istream &schemeData)
 Construct from mesh and schemeData. More...
 
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > calcGrad (const GeometricField< Type, faPatchField, areaMesh > &vsf, const word &name) const
 Return the gradient of the given field to the gradScheme::grad for optional caching. More...
 
- Public Member Functions inherited from gradScheme< Type >
 declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 gradScheme (const faMesh &mesh)
 Construct from mesh. More...
 
virtual ~gradScheme ()=default
 Destructor. More...
 
const faMeshmesh () const
 Return mesh reference. More...
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const GeometricField< Type, faPatchField, areaMesh > &, const word &name) const
 Calculate and return the grad of the given field which may have been cached. More...
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const GeometricField< Type, faPatchField, areaMesh > &) const
 Calculate and return the grad of the given field with the default name which may have been cached. More...
 
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const tmp< GeometricField< Type, faPatchField, areaMesh >> &) const
 Calculate and return the grad of the given field with the default name which may have been cached. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int use_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 faMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore. More...
 

Detailed Description

template<class Type>
class Foam::fa::edgeLimitedGrad< Type >

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

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

Source files

Definition at line 58 of file edgeLimitedFaGrad.H.

Constructor & Destructor Documentation

◆ edgeLimitedGrad()

edgeLimitedGrad ( const faMesh mesh,
Istream schemeData 
)
inline

Construct from mesh and schemeData.

Definition at line 107 of file edgeLimitedFaGrad.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "edgeLimited"  )

RunTime type information.

◆ calcGrad()

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

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

Implements gradScheme< Type >.

Referenced by makeFaGradScheme().

Here is the caller graph for this function:

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