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

Private Member Functions
	gaussGrad (const gaussGrad &)
	Disallow default bitwise copy construct. More...
void	operator= (const gaussGrad &)
	Disallow default bitwise assignment. More...

Private Attributes
tmp< surfaceInterpolationScheme< Type > >	tinterpScheme_

Detailed Description

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

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

Source files

• gaussGrad.H
• gaussGrad.C

Definition at line 57 of file gaussGrad.H.

Constructor & Destructor Documentation

gaussGrad() [1/3]

gaussGrad ( const gaussGrad< Type > &  )

private

Disallow default bitwise copy construct.

gaussGrad() [2/3]

gaussGrad ( const fvMesh &  mesh )

inline

Construct from mesh.

Definition at line 84 of file gaussGrad.H.

gaussGrad() [3/3]

gaussGrad ( const fvMesh &  mesh, Istream &  is  )

inline

Construct from mesh and Istream.

Definition at line 91 of file gaussGrad.H.

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

Here is the call graph for this function:

Member Function Documentation

operator=()

void operator= ( const gaussGrad< Type > &  )

private

Disallow default bitwise assignment.

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

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 145 of file gaussGrad.C.

References GeometricField::boundaryField(), forAll, n, and patchi.

Here is the call graph for this function:

Field Documentation

tinterpScheme_

tmp<surfaceInterpolationScheme<Type> > tinterpScheme_

private

Definition at line 63 of file gaussGrad.H.

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

---

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

• src/finiteVolume/finiteVolume/gradSchemes/gaussGrad/gaussGrad.H
• src/finiteVolume/finiteVolume/gradSchemes/gaussGrad/gaussGrad.C