FreeFOAM The Cross-Platform CFD Toolkit
gradScheme< Type > Class Template Reference

Abstract base class for gradient schemes. More...

#include <finiteVolume/gradScheme.H>


Detailed Description

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

Abstract base class for gradient schemes.

Source files

Definition at line 61 of file gradScheme.H.

+ Inheritance diagram for gradScheme< Type >:
+ Collaboration diagram for gradScheme< Type >:

List of all members.

Public Member Functions

virtual const wordtype () const =0
 Runtime type information.
 declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 gradScheme (const fvMesh &mesh)
 Construct from mesh.
virtual ~gradScheme ()
const fvMeshmesh () const
 Return mesh reference.
virtual tmp< GeometricField
< typename outerProduct
< vector, Type >::type,
fvPatchField, volMesh > > 
grad (const GeometricField< Type, fvPatchField, volMesh > &) const =0
 Calculate and return the grad of the given field.
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.

Static Public Member Functions

static tmp< gradScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore.

Constructor & Destructor Documentation

gradScheme ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 100 of file gradScheme.H.

~gradScheme ( )
virtual

Definition at line 94 of file gradScheme.C.


Member Function Documentation

virtual const word& type ( ) const
pure virtual

Runtime type information.

declareRunTimeSelectionTable ( tmp  ,
gradScheme< Type >  ,
Istream  ,
(const fvMesh &mesh, Istream &schemeData)  ,
(mesh, schemeData)   
)
tmp< gradScheme< Type > > New ( const fvMesh mesh,
Istream schemeData 
)
static

Return a pointer to a new gradScheme created on freestore.

Definition at line 46 of file gradScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and mesh.

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

const fvMesh& mesh ( ) const
inline

Return mesh reference.

Definition at line 124 of file gradScheme.H.

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


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