convectionScheme< Type > Class Template Reference

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

#include <faConvectionScheme.H>

Inheritance diagram for convectionScheme< Type >:

Collaboration diagram for convectionScheme< Type >:

Public Member Functions
	declareRunTimeSelectionTable (tmp, convectionScheme, Istream,(const faMesh &mesh, const edgeScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
	convectionScheme (const convectionScheme &)=delete
	No copy construct.
void	operator= (const convectionScheme &)=delete
	No copy assignment.
	convectionScheme (const faMesh &mesh, const edgeScalarField &faceFlux)
	Construct from mesh, flux and Istream.
virtual	~convectionScheme ()
	Destructor.
const faMesh &	mesh () const noexcept
	Return mesh reference.
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.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

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.

Detailed Description

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

Abstract base class for finite area calculus convection schemes.

Source files

• faConvectionScheme.H
• faConvectionScheme.C

Definition at line 60 of file faConvectionScheme.H.

Constructor & Destructor Documentation

convectionScheme() [1/2]

template<class Type>

convectionScheme ( const convectionScheme< Type > & )

delete

No copy construct.

References convectionScheme().

Referenced by convectionScheme(), declareRunTimeSelectionTable(), gaussConvectionScheme< Type >::gaussConvectionScheme(), gaussConvectionScheme< Type >::gaussConvectionScheme(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

convectionScheme() [2/2]

template<class Type>

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

inline

Construct from mesh, flux and Istream.

Definition at line 108 of file faConvectionScheme.H.

References mesh().

Here is the call graph for this function:

~convectionScheme()

template<class Type>

~convectionScheme ( )

virtual

Destructor.

Definition at line 74 of file faConvectionScheme.C.

Member Function Documentation

declareRunTimeSelectionTable()

template<class Type>

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

References convectionScheme(), and mesh().

Here is the call graph for this function:

operator=()

template<class Type>

void operator= ( const convectionScheme< Type > & )

delete

No copy assignment.

References convectionScheme().

Here is the call graph for this function:

New()

template<class Type>

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 29 of file faConvectionScheme.C.

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

Referenced by Foam::fac::div(), Foam::fam::div(), Foam::fam::div(), gaussConvectionScheme< Type >::gaussConvectionScheme(), Foam::fac::ndiv(), and Foam::fam::ndiv().

Here is the call graph for this function:

Here is the caller graph for this function:

mesh()

template<class Type>

const faMesh & mesh ( ) const

inlinenoexcept

Return mesh reference.

Definition at line 142 of file faConvectionScheme.H.

References Foam::noexcept.

Referenced by convectionScheme(), declareRunTimeSelectionTable(), gaussConvectionScheme< Type >::gaussConvectionScheme(), gaussConvectionScheme< Type >::gaussConvectionScheme(), and New().

Here is the caller graph for this function:

flux()

template<class Type>

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

pure virtual

Implemented in gaussConvectionScheme< Type >.

famDiv()

template<class Type>

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

pure virtual

Implemented in gaussConvectionScheme< Type >.

facDiv()

template<class Type>

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:

• src/finiteArea/finiteArea/convectionSchemes/faConvectionScheme/faConvectionScheme.H
• src/finiteArea/finiteArea/convectionSchemes/faConvectionScheme/faConvectionScheme.C