Public Member Functions | Static Public Member Functions | List of all members
convectionScheme< Type > Class Template Referenceabstract

Abstract base class for finite area calculus convection schemes. More...

Inheritance diagram for convectionScheme< Type >:
Inheritance graph
[legend]
Collaboration diagram for convectionScheme< Type >:
Collaboration graph
[legend]

Public Member Functions

 declareRunTimeSelectionTable (tmp, convectionScheme, Istream,(const faMesh &mesh, const edgeScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
 
 convectionScheme (const faMesh &mesh, const edgeScalarField &faceFlux)
 Construct from mesh, flux and Istream. More...
 
virtual ~convectionScheme ()
 Destructor. More...
 
const faMesh & mesh () const
 Return mesh reference. More...
 
virtual tmp< GeometricField< Type, faePatchField, edgeMesh > > flux (const edgeScalarField &, const GeometricField< Type, faPatchField, areaMesh > &) const =0
 
virtual tmp< faMatrix< Type > > famDiv (const edgeScalarField &, const GeometricField< Type, faPatchField, areaMesh > &) const =0
 
virtual tmp< GeometricField< Type, faPatchField, areaMesh > > facDiv (const edgeScalarField &, const GeometricField< Type, faPatchField, areaMesh > &) const =0
 
- 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< convectionScheme< Type > > New (const faMesh &mesh, const edgeScalarField &faceFlux, Istream &schemeData)
 Return a pointer to a new convectionScheme created on freestore. More...
 

Detailed Description

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

Abstract base class for finite area calculus convection schemes.

Source files

Definition at line 61 of file faConvectionScheme.H.

Constructor & Destructor Documentation

◆ convectionScheme()

convectionScheme ( const faMesh &  mesh,
const edgeScalarField &  faceFlux 
)
inline

Construct from mesh, flux and Istream.

Definition at line 107 of file faConvectionScheme.H.

◆ ~convectionScheme()

~convectionScheme ( )
virtual

Destructor.

Definition at line 74 of file faConvectionScheme.C.

Member Function Documentation

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( tmp  ,
convectionScheme< Type >  ,
Istream  ,
(const faMesh &mesh, const edgeScalarField &faceFlux, Istream &schemeData)  ,
(mesh, faceFlux, schemeData)   
)

◆ New()

Foam::tmp< Foam::fa::convectionScheme< Type > > New ( const faMesh &  mesh,
const edgeScalarField &  faceFlux,
Istream &  schemeData 
)
static

Return a pointer to a new convectionScheme created on freestore.

Definition at line 30 of file faConvectionScheme.C.

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

Referenced by Foam::fam::div(), and Foam::fam::ndiv().

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

◆ mesh()

const faMesh& mesh ( ) const
inline

Return mesh reference.

Definition at line 140 of file faConvectionScheme.H.

◆ flux()

virtual tmp<GeometricField<Type, faePatchField, edgeMesh> > flux ( const edgeScalarField &  ,
const GeometricField< Type, faPatchField, areaMesh > &   
) const
pure virtual

Implemented in gaussConvectionScheme< Type >.

◆ famDiv()

virtual tmp<faMatrix<Type> > famDiv ( const edgeScalarField &  ,
const GeometricField< Type, faPatchField, areaMesh > &   
) const
pure virtual

Implemented in gaussConvectionScheme< Type >.

◆ facDiv()

virtual tmp<GeometricField<Type, faPatchField, areaMesh> > facDiv ( const edgeScalarField &  ,
const GeometricField< Type, faPatchField, areaMesh > &   
) const
pure virtual

Implemented in gaussConvectionScheme< Type >.

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