convectionScheme< Type > Class Template Referenceabstract

Abstract base class for convection schemes. More...

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

Public Member Functions

virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, convectionScheme, Istream,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
 
 declareRunTimeSelectionTable (tmp, convectionScheme, Multivariate,(const fvMesh &mesh, const typename multivariateSurfaceInterpolationScheme< Type >::fieldTable &fields, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, fields, faceFlux, schemeData))
 
 convectionScheme (const convectionScheme &)
 Copy construct. More...
 
 convectionScheme (const fvMesh &mesh, const surfaceScalarField &)
 Construct from mesh, flux and Istream. More...
 
virtual ~convectionScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual tmp< SurfaceField< Type > > interpolate (const surfaceScalarField &, const VolField< Type > &) const =0
 
virtual tmp< SurfaceField< Type > > flux (const surfaceScalarField &, const VolField< Type > &) const =0
 
virtual tmp< fvMatrix< Type > > fvmDiv (const surfaceScalarField &, const VolField< Type > &) const =0
 
virtual tmp< VolField< Type > > fvcDiv (const surfaceScalarField &, const VolField< Type > &) const =0
 
void operator= (const convectionScheme< Type > &)
 
- 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Static Public Member Functions

static tmp< convectionScheme< Type > > New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return a pointer to a new convectionScheme created on freestore. More...
 
static tmp< convectionScheme< Type > > New (const fvMesh &mesh, const typename multivariateSurfaceInterpolationScheme< Type >::fieldTable &fields, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return a pointer to a new multivariate convectionScheme. More...
 

Additional Inherited Members

- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 

Detailed Description

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

Abstract base class for convection schemes.

Source files

Definition at line 64 of file convectionScheme.H.

Constructor & Destructor Documentation

◆ convectionScheme() [1/2]

convectionScheme ( const convectionScheme< Type > &  cs)

Copy construct.

Definition at line 47 of file convectionScheme.C.

◆ convectionScheme() [2/2]

convectionScheme ( const fvMesh mesh,
const surfaceScalarField  
)
inline

Construct from mesh, flux and Istream.

Definition at line 116 of file convectionScheme.H.

◆ ~convectionScheme()

~convectionScheme
virtual

Destructor.

Definition at line 149 of file convectionScheme.C.

Member Function Documentation

◆ type()

virtual const word& type ( ) const
pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( tmp  ,
convectionScheme< Type >  ,
Istream  ,
(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)  ,
(mesh, faceFlux, schemeData)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( tmp  ,
convectionScheme< Type >  ,
Multivariate  ,
(const fvMesh &mesh, const typename multivariateSurfaceInterpolationScheme< Type >::fieldTable &fields, const surfaceScalarField &faceFlux, Istream &schemeData)  ,
(mesh, fields, faceFlux, schemeData)   
)

◆ New() [1/2]

tmp< convectionScheme< Type > > New ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream schemeData 
)
static

Return a pointer to a new convectionScheme created on freestore.

Definition at line 57 of file convectionScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, and Foam::nl.

Referenced by Foam::fvc::div(), Foam::fvm::div(), and Foam::fvc::flux().

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

◆ New() [2/2]

tmp< convectionScheme< Type > > New ( const fvMesh mesh,
const typename multivariateSurfaceInterpolationScheme< Type >::fieldTable &  fields,
const surfaceScalarField faceFlux,
Istream schemeData 
)
static

Return a pointer to a new multivariate convectionScheme.

created on freestore

Definition at line 101 of file convectionScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, fields, InfoInFunction, and Foam::nl.

Here is the call graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const
inline

Return mesh reference.

Definition at line 156 of file convectionScheme.H.

◆ interpolate()

virtual tmp<SurfaceField<Type> > interpolate ( const surfaceScalarField ,
const VolField< Type > &   
) const
pure virtual

◆ flux()

virtual tmp<SurfaceField<Type> > flux ( const surfaceScalarField ,
const VolField< Type > &   
) const
pure virtual

◆ fvmDiv()

virtual tmp<fvMatrix<Type> > fvmDiv ( const surfaceScalarField ,
const VolField< Type > &   
) const
pure virtual

◆ fvcDiv()

virtual tmp<VolField<Type> > fvcDiv ( const surfaceScalarField ,
const VolField< Type > &   
) const
pure virtual

◆ operator=()

void operator= ( const convectionScheme< Type > &  cs)

Definition at line 156 of file convectionScheme.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

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