Abstract base class for convection schemes. More...

#include <convectionScheme.H>

Inheritance diagram for convectionScheme< Type >:

[legend]

Collaboration diagram for convectionScheme< Type >:

Public Member Functions
virtual const word &	type () const =0
	Runtime type information.
	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.
	convectionScheme (const fvMesh &mesh, const surfaceScalarField &)
	Construct from mesh, flux and Istream.
virtual	~convectionScheme ()
	Destructor.
const fvMesh &	mesh () const
	Return mesh reference.
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.
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 fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return a pointer to a new convectionScheme created on freestore.
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.

Detailed Description

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

Abstract base class for convection schemes.

Source files

Definition at line 65 of file convectionScheme.H.

Constructor & Destructor Documentation

◆ convectionScheme() [1/2]

template<class Type>

convectionScheme ( const convectionScheme< Type > & cs )

Copy construct.

Definition at line 44 of file convectionScheme.C.

References convectionScheme(), and refCount::refCount().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convectionScheme() [2/2]

template<class Type>

convectionScheme	(	const fvMesh &	mesh,
		const surfaceScalarField &	)

inline

Construct from mesh, flux and Istream.

Definition at line 123 of file convectionScheme.H.

References mesh().

Here is the call graph for this function:

◆ ~convectionScheme()

template<class Type>

~convectionScheme ( )

virtual

Destructor.

Definition at line 145 of file convectionScheme.C.

Member Function Documentation

◆ type()

template<class Type>

virtual const word & type ( ) const

pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

template<class Type>

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

References convectionScheme(), and mesh().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/2]

template<class Type>

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

References convectionScheme(), fields, and mesh().

Here is the call graph for this function:

◆ New() [1/2]

template<class Type>

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

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

Referenced by boundedConvectionScheme< Type >::boundedConvectionScheme(), Foam::fvc::div(), Foam::fvm::div(), Foam::fvc::flux(), fusedGaussConvectionScheme< Type >::fusedGaussConvectionScheme(), gaussConvectionScheme< Type >::gaussConvectionScheme(), and multivariateGaussConvectionScheme< Type >::multivariateGaussConvectionScheme().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

template<class Type>

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

References Foam::endl(), IOstream::eof(), FatalIOErrorInFunction, fields, InfoInFunction, and mesh().

Here is the call graph for this function:

◆ mesh()

template<class Type>

const fvMesh & mesh ( ) const

inline

Return mesh reference.

Definition at line 172 of file convectionScheme.H.

Referenced by boundedConvectionScheme< Type >::boundedConvectionScheme(), convectionScheme(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), fusedGaussConvectionScheme< Type >::fusedGaussConvectionScheme(), fusedGaussConvectionScheme< Type >::fusedGaussConvectionScheme(), fusedGaussConvectionScheme< Type >::fvcDiv(), gaussConvectionScheme< Type >::gaussConvectionScheme(), gaussConvectionScheme< Type >::gaussConvectionScheme(), multivariateGaussConvectionScheme< Type >::multivariateGaussConvectionScheme(), New(), and New().

Here is the caller graph for this function:

◆ interpolate()

template<class Type>

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

pure virtual

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

◆ flux()

template<class Type>

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

pure virtual

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

◆ fvmDiv()

template<class Type>

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

pure virtual

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

◆ fvcDiv()

template<class Type>

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

pure virtual

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

References convectionScheme().

Here is the call graph for this function:

◆ operator=()

template<class Type>

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

Definition at line 152 of file convectionScheme.C.

References convectionScheme().

Here is the call 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

Detailed Description

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=()