gaussGrad< Type > Class Template Reference

Basic second-order gradient scheme using face-interpolation and Gauss' theorem. More...

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

Public Member Functions

 TypeName ("Gauss")
 Runtime type information. More...
 
 gaussGrad (const fvMesh &mesh)
 Construct from mesh. More...
 
 gaussGrad (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. 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 for optional caching. 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...
 
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. 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 with the default name which may have been cached. 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 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...
 

Static Public Member Functions

static tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > gradf (const GeometricField< Type, fvsPatchField, surfaceMesh > &, const word &name)
 Return the gradient of the given field calculated using Gauss' theorem on the given surface field. More...
 
static void correctBoundaryConditions (const GeometricField< Type, fvPatchField, volMesh > &, GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > &)
 Correct the boundary values of the gradient using the patchField snGrad functions. More...
 
- 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 Foam::fv::gaussGrad< Type >

Basic second-order gradient scheme using face-interpolation and Gauss' theorem.

Source files

Definition at line 59 of file gaussGrad.H.

Constructor & Destructor Documentation

◆ gaussGrad() [1/2]

gaussGrad ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 97 of file gaussGrad.H.

◆ gaussGrad() [2/2]

gaussGrad ( const fvMesh mesh,
Istream is 
)
inline

Construct from mesh and Istream.

Definition at line 106 of file gaussGrad.H.

References IOstream::eof(), gradScheme< Type >::mesh(), and surfaceInterpolationScheme< Type >::New().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "Gauss"  )

Runtime type information.

◆ gradf()

static tmp< GeometricField <typename outerProduct<vector, Type>::type, fvPatchField, volMesh> > gradf ( const GeometricField< Type, fvsPatchField, surfaceMesh > &  ,
const word name 
)
static

Return the gradient of the given field calculated using Gauss' theorem on the given surface field.

Referenced by Foam::fvc::grad().

Here is the caller graph for this function:

◆ calcGrad()

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

Reimplemented in iterativeGaussGrad< Type >.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( const GeometricField< Type, fvPatchField, volMesh > &  vsf,
GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > &  gGrad 
)
static

Correct the boundary values of the gradient using the patchField snGrad functions.

Definition at line 138 of file gaussGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, DimensionedField< Type, GeoMesh >::mesh(), and n.

Here is the call graph for this function:

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