Abstract base class for convection schemes. More...

#include <finiteVolume/convectionScheme.H>

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.

Inheritance diagram for convectionScheme< Type >:

Collaboration diagram for convectionScheme< Type >:

List of all members.

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 ()
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 &, 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.
int	count () const
	Return the reference count.
bool	okToDelete () const
	Return true if the reference count is zero.
void	resetRefCount ()
	Reset the reference count to zero.
void	operator++ ()
	Increment the reference count.
void	operator++ (int)
	Increment the reference count.
void	operator-- ()
	Decrement the reference count.
void	operator-- (int)
	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.

Constructor & Destructor Documentation

convectionScheme ( const convectionScheme< Type > & cs )

Copy construct.

Definition at line 47 of file convectionScheme.C.

convectionScheme	(	const fvMesh &	mesh,
		const surfaceScalarField &
	)

inline

Construct from mesh, flux and Istream.

Definition at line 118 of file convectionScheme.H.

~convectionScheme ( )

virtual

Definition at line 169 of file convectionScheme.C.

Member Function Documentation

virtual const word& type ( ) const

pure virtual

Runtime type information.

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

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

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, FatalIOErrorIn, Foam::Info, and mesh.

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

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, fields, Foam::Info, and mesh.

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 158 of file convectionScheme.H.

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

pure virtual

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

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

pure virtual

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

Referenced by Foam::fvc::flux().

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

pure virtual

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

Referenced by Foam::fvm::div().

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

pure virtual

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

Referenced by Foam::fvc::div().

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

Definition at line 176 of file convectionScheme.C.

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

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

Detailed Description

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

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

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