Abstract base class for convection schemes. More...

Inheritance diagram for convectionScheme< Type >:

[legend]

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
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...

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...

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.

References convectionScheme< Type >::New().

Here is the call graph for this function:

◆ convectionScheme() [2/2]

convectionScheme	(	const fvMesh &	mesh,
		const surfaceScalarField &
	)

inline

Construct from mesh, flux and Istream.

Definition at line 117 of file convectionScheme.H.

References convectionScheme< Type >::New(), and convectionScheme< Type >::~convectionScheme().

Here is the call graph for this function:

◆ ~convectionScheme()

~convectionScheme ( )

virtual

Destructor.

Definition at line 149 of file convectionScheme.C.

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

Here is the caller graph for this function:

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 58 of file convectionScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, convectionScheme< Type >::mesh(), and Foam::nl.

Referenced by convectionScheme< Type >::convectionScheme(), Foam::fvm::div(), Foam::fvc::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 102 of file convectionScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, fields, InfoInFunction, convectionScheme< Type >::mesh(), 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.

References convectionScheme< Type >::flux(), convectionScheme< Type >::fvcDiv(), convectionScheme< Type >::fvmDiv(), convectionScheme< Type >::interpolate(), and convectionScheme< Type >::operator=().

Referenced by convectionScheme< Type >::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate()

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

pure virtual

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

Referenced by convectionScheme< Type >::mesh().

Here is the caller graph for this function:

◆ flux()

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

pure virtual

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

Referenced by convectionScheme< Type >::mesh().

Here is the caller graph for this function:

◆ fvmDiv()

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

pure virtual

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

Referenced by convectionScheme< Type >::mesh().

Here is the caller graph for this function:

◆ fvcDiv()

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

pure virtual

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

Referenced by convectionScheme< Type >::mesh().

Here is the caller graph for this function:

◆ operator=()

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

Definition at line 156 of file convectionScheme.C.

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

Referenced by convectionScheme< Type >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ convectionScheme() [1/2]

◆ convectionScheme() [2/2]

◆ ~convectionScheme()

Member Function Documentation

◆ type()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ mesh()

◆ interpolate()

◆ flux()

◆ fvmDiv()

◆ fvcDiv()

◆ operator=()

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