convectionScheme< Type > Class Template Reference

Abstract base class for convection schemes. More...

Inheritance diagram for convectionScheme< Type >:

Collaboration diagram for convectionScheme< Type >:

Public Member Functions
virtual const word &	type () 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 fvMesh &	mesh () const
	Return mesh reference. More...
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const surfaceScalarField &, const GeometricField< Type, fvPatchField, volMesh > &) const =0
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	flux (const surfaceScalarField &, const GeometricField< Type, fvPatchField, volMesh > &) const =0
virtual tmp< fvMatrix< Type > >	fvmDiv (const surfaceScalarField &, const GeometricField< Type, fvPatchField, volMesh > &) const =0
virtual tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDiv (const surfaceScalarField &, const GeometricField< Type, fvPatchField, volMesh > &) const =0
void	operator= (const convectionScheme< Type > &)
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 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...

Detailed Description

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

Abstract base class for convection schemes.

Source files

• convectionScheme.H
• convectionScheme.C

Definition at line 65 of file convectionScheme.H.

Constructor & Destructor Documentation

convectionScheme() [1/2]

convectionScheme

(

const convectionScheme< Type > &

cs

)

Copy construct.

Definition at line 44 of file convectionScheme.C.

convectionScheme() [2/2]

convectionScheme ( const fvMesh &  mesh, const surfaceScalarField &    )

inline

Construct from mesh, flux and Istream.

Definition at line 124 of file convectionScheme.H.

~convectionScheme()

~convectionScheme ( )

virtual

Destructor.

Definition at line 145 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 55 of file convectionScheme.C.

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

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.

mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 172 of file convectionScheme.H.

interpolate()

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate ( const surfaceScalarField &  , const GeometricField< Type, fvPatchField, volMesh > &    ) const

pure virtual

Implemented in gaussConvectionScheme< Type >, boundedConvectionScheme< Type >, and multivariateGaussConvectionScheme< Type >.

flux()

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux ( const surfaceScalarField &  , const GeometricField< Type, fvPatchField, volMesh > &    ) const

pure virtual

Implemented in gaussConvectionScheme< Type >, boundedConvectionScheme< Type >, and multivariateGaussConvectionScheme< Type >.

fvmDiv()

virtual tmp<fvMatrix<Type> > fvmDiv ( const surfaceScalarField &  , const GeometricField< Type, fvPatchField, volMesh > &    ) const

pure virtual

Implemented in gaussConvectionScheme< Type >, boundedConvectionScheme< Type >, and multivariateGaussConvectionScheme< Type >.

fvcDiv()

virtual tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDiv ( const surfaceScalarField &  , const GeometricField< Type, fvPatchField, volMesh > &    ) const

pure virtual

Implemented in gaussConvectionScheme< Type >, boundedConvectionScheme< Type >, and multivariateGaussConvectionScheme< Type >.

operator=()

void operator=

(

const convectionScheme< Type > &

cs

)

Definition at line 152 of file convectionScheme.C.

---

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

• src/finiteVolume/finiteVolume/convectionSchemes/convectionScheme/convectionScheme.H
• src/finiteVolume/finiteVolume/convectionSchemes/convectionScheme/convectionScheme.C