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
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

bool	okToDelete () const
	Return true if the reference count is zero. More...

void	resetRefCount ()
	Reset the reference count to 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...

Private Attributes
const fvMesh &	mesh_

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.

◆ convectionScheme() [2/2]

convectionScheme	(	const fvMesh &	mesh,
		const surfaceScalarField &
	)

inline

Construct from mesh, flux and Istream.

Definition at line 117 of file convectionScheme.H.

◆ ~convectionScheme()

~convectionScheme

virtual

Destructor.

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

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

Referenced by blendingFactor::calc(), 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 105 of file convectionScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, fields, Foam::Info, 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 >::mesh_.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ mesh_

const fvMesh& mesh_

private

Definition at line 70 of file convectionScheme.H.

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

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

Private Attributes

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

Field Documentation

◆ mesh_

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