Abstract base class for ddt schemes. More...

Inheritance diagram for ddtScheme< Type >:

[legend]

Collaboration diagram for ddtScheme< Type >:

Public Types
typedef SurfaceField< typename flux< Type >::type >	fluxFieldType

Public Member Functions
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, ddtScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))

	ddtScheme (const fvMesh &mesh)
	Construct from mesh. More...

	ddtScheme (const fvMesh &mesh, Istream &)
	Construct from mesh and Istream. More...

	ddtScheme (const ddtScheme &)=delete
	Disallow default bitwise copy construction. More...

virtual	~ddtScheme ()
	Destructor. More...

const fvMesh &	mesh () const
	Return mesh reference. More...

virtual tmp< VolField< Type > >	fvcDdt (const dimensioned< Type > &)=0

virtual tmp< VolField< Type > >	fvcDdt (const VolField< Type > &)=0

virtual tmp< VolField< Type > >	fvcDdt (const dimensionedScalar &, const VolField< Type > &)=0

virtual tmp< VolField< Type > >	fvcDdt (const volScalarField &, const VolField< Type > &)=0

virtual tmp< VolField< Type > >	fvcDdt (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &)=0

virtual tmp< SurfaceField< Type > >	fvcDdt (const SurfaceField< Type > &)

virtual tmp< fvMatrix< Type > >	fvmDdt (const VolField< Type > &)=0

virtual tmp< fvMatrix< Type > >	fvmDdt (const dimensionedScalar &, const VolField< Type > &)=0

virtual tmp< fvMatrix< Type > >	fvmDdt (const volScalarField &, const VolField< Type > &)=0

virtual tmp< fvMatrix< Type > >	fvmDdt (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &vf)=0

virtual tmp< surfaceScalarField >	fvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr)

virtual tmp< surfaceScalarField >	fvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr, const volScalarField &rho)

virtual tmp< surfaceScalarField >	fvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi)

virtual tmp< surfaceScalarField >	fvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi, const volScalarField &rho)

virtual tmp< fluxFieldType >	fvcDdtUfCorr (const VolField< Type > &U, const SurfaceField< Type > &Uf)=0

virtual tmp< fluxFieldType >	fvcDdtPhiCorr (const VolField< Type > &U, const fluxFieldType &phi)=0

virtual tmp< fluxFieldType >	fvcDdtUfCorr (const volScalarField &rho, const VolField< Type > &U, const SurfaceField< Type > &rhoUf)=0

virtual tmp< fluxFieldType >	fvcDdtPhiCorr (const volScalarField &rho, const VolField< Type > &U, const fluxFieldType &phi)=0

virtual tmp< fluxFieldType >	fvcDdtUfCorr (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &U, const SurfaceField< Type > &Uf)=0

virtual tmp< fluxFieldType >	fvcDdtPhiCorr (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &U, const fluxFieldType &phi)=0

virtual tmp< surfaceScalarField >	meshPhi (const VolField< Type > &)=0

virtual tmp< scalarField >	meshPhi (const VolField< Type > &, const label patchi)=0

void	operator= (const ddtScheme &)=delete
	Disallow default bitwise assignment. More...

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

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Static Public Member Functions
static tmp< ddtScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new ddtScheme created on freestore. More...

Protected Attributes
const fvMesh &	mesh_

Additional Inherited Members
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Detailed Description

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

Abstract base class for ddt schemes.

Source files

Definition at line 65 of file ddtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

typedef SurfaceField<typename flux<Type>::type> fluxFieldType

Definition at line 193 of file ddtScheme.H.

Constructor & Destructor Documentation

◆ ddtScheme() [1/3]

ddtScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 98 of file ddtScheme.H.

◆ ddtScheme() [2/3]

ddtScheme	(	const fvMesh &	mesh,
		Istream &
	)

inline

Construct from mesh and Istream.

Definition at line 104 of file ddtScheme.H.

◆ ddtScheme() [3/3]

ddtScheme ( const ddtScheme< Type > & )

delete

Disallow default bitwise copy construction.

◆ ~ddtScheme()

~ddtScheme

virtual

Destructor.

Definition at line 89 of file ddtScheme.C.

Member Function Documentation

◆ type()

virtual const word& type ( ) const

pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	tmp	,
		ddtScheme< Type >	,
		Istream	,
		(const fvMesh &mesh, Istream &schemeData)	,
		(mesh, schemeData)
	)

◆ New()

tmp< ddtScheme< Type > > New	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

static

Return a pointer to a new ddtScheme created on freestore.

Definition at line 44 of file ddtScheme.C.

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

Referenced by Foam::fvc::ddt(), Foam::fvm::ddt(), and Foam::fvc::ddtCorr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 130 of file ddtScheme.H.

References ddtScheme< Type >::mesh_.

Referenced by backwardDdtScheme< Type >::mesh(), boundedDdtScheme< Type >::mesh(), CoEulerDdtScheme< Type >::mesh(), CrankNicolsonDdtScheme< Type >::mesh(), SLTSDdtScheme< Type >::mesh(), and steadyStateDdtScheme< Type >::mesh().

Here is the caller graph for this function:

◆ fvcDdt() [1/6]

virtual tmp<VolField<Type> > fvcDdt ( const dimensioned< Type > & )

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdt() [2/6]

virtual tmp<VolField<Type> > fvcDdt ( const VolField< Type > & )

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdt() [3/6]

virtual tmp<VolField<Type> > fvcDdt	(	const dimensionedScalar &	,
		const VolField< Type > &
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdt() [4/6]

virtual tmp<VolField<Type> > fvcDdt	(	const volScalarField &	,
		const VolField< Type > &
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdt() [5/6]

tmp< VolField< Type > > fvcDdt	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const VolField< Type > &	vf
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

Definition at line 96 of file ddtScheme.C.

References NotImplemented, and GeometricField< Type, PatchField, GeoMesh >::null().

Here is the call graph for this function:

◆ fvcDdt() [6/6]

tmp< SurfaceField< Type > > fvcDdt ( const SurfaceField< Type > & sf )

virtual

Reimplemented in localEulerDdtScheme< Type >, and EulerDdtScheme< Type >.

Definition at line 135 of file ddtScheme.C.

References NotImplemented, and GeometricField< Type, PatchField, GeoMesh >::null().

Here is the call graph for this function:

◆ fvmDdt() [1/4]

virtual tmp<fvMatrix<Type> > fvmDdt ( const VolField< Type > & )

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvmDdt() [2/4]

virtual tmp<fvMatrix<Type> > fvmDdt	(	const dimensionedScalar &	,
		const VolField< Type > &
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvmDdt() [3/4]

virtual tmp<fvMatrix<Type> > fvmDdt	(	const volScalarField &	,
		const VolField< Type > &
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvmDdt() [4/4]

tmp< fvMatrix< Type > > fvmDdt	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const VolField< Type > &	vf
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

Definition at line 113 of file ddtScheme.C.

References alpha(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVolume, NotImplemented, and rho.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [1/4]

tmp< surfaceScalarField > fvcDdtPhiCoeff	(	const VolField< Type > &	U,
		const fluxFieldType &	phi,
		const fluxFieldType &	phiCorr
	)

virtual

Definition at line 151 of file ddtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::endl(), forAll, Foam::gAverage(), Foam::gMax(), Foam::gMin(), InfoInFunction, Foam::mag(), Foam::min(), patchi, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), Foam::SMALL, and U.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [2/4]

tmp< surfaceScalarField > fvcDdtPhiCoeff	(	const VolField< Type > &	U,
		const fluxFieldType &	phi,
		const fluxFieldType &	phiCorr,
		const volScalarField &	rho
	)

virtual

Definition at line 205 of file ddtScheme.C.

References U.

◆ fvcDdtPhiCoeff() [3/4]

tmp< surfaceScalarField > fvcDdtPhiCoeff	(	const VolField< Type > &	U,
		const fluxFieldType &	phi
	)

virtual

Definition at line 218 of file ddtScheme.C.

References Foam::fvc::dotInterpolate(), and U.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [4/4]

tmp< surfaceScalarField > fvcDdtPhiCoeff	(	const VolField< Type > &	U,
		const fluxFieldType &	phi,
		const volScalarField &	rho
	)

virtual

Definition at line 229 of file ddtScheme.C.

References Foam::fvc::dotInterpolate(), and U.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [1/3]

virtual tmp<fluxFieldType> fvcDdtUfCorr	(	const VolField< Type > &	U,
		const SurfaceField< Type > &	Uf
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdtPhiCorr() [1/3]

virtual tmp<fluxFieldType> fvcDdtPhiCorr	(	const VolField< Type > &	U,
		const fluxFieldType &	phi
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdtUfCorr() [2/3]

virtual tmp<fluxFieldType> fvcDdtUfCorr	(	const volScalarField &	rho,
		const VolField< Type > &	U,
		const SurfaceField< Type > &	rhoUf
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdtPhiCorr() [2/3]

virtual tmp<fluxFieldType> fvcDdtPhiCorr	(	const volScalarField &	rho,
		const VolField< Type > &	U,
		const fluxFieldType &	phi
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdtUfCorr() [3/3]

virtual tmp<fluxFieldType> fvcDdtUfCorr	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const VolField< Type > &	U,
		const SurfaceField< Type > &	Uf
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ fvcDdtPhiCorr() [3/3]

virtual tmp<fluxFieldType> fvcDdtPhiCorr	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const VolField< Type > &	U,
		const fluxFieldType &	phi
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ meshPhi() [1/2]

virtual tmp<surfaceScalarField> meshPhi ( const VolField< Type > & )

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ meshPhi() [2/2]

virtual tmp<scalarField> meshPhi	(	const VolField< Type > &	,
		const label	patchi
	)

pure virtual

Implemented in steadyStateDdtScheme< Type >, SLTSDdtScheme< Type >, localEulerDdtScheme< Type >, EulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, and backwardDdtScheme< Type >.

◆ operator=()

void operator= ( const ddtScheme< Type > & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 74 of file ddtScheme.H.

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

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

src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.H
src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ fluxFieldType

Constructor & Destructor Documentation

◆ ddtScheme() [1/3]

◆ ddtScheme() [2/3]

◆ ddtScheme() [3/3]

◆ ~ddtScheme()

Member Function Documentation

◆ type()

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ fvcDdt() [1/6]

◆ fvcDdt() [2/6]

◆ fvcDdt() [3/6]

◆ fvcDdt() [4/6]

◆ fvcDdt() [5/6]

◆ fvcDdt() [6/6]

◆ fvmDdt() [1/4]

◆ fvmDdt() [2/4]

◆ fvmDdt() [3/4]

◆ fvmDdt() [4/4]

◆ fvcDdtPhiCoeff() [1/4]

◆ fvcDdtPhiCoeff() [2/4]

◆ fvcDdtPhiCoeff() [3/4]

◆ fvcDdtPhiCoeff() [4/4]

◆ fvcDdtUfCorr() [1/3]

◆ fvcDdtPhiCorr() [1/3]

◆ fvcDdtUfCorr() [2/3]

◆ fvcDdtPhiCorr() [2/3]

◆ fvcDdtUfCorr() [3/3]

◆ fvcDdtPhiCorr() [3/3]

◆ meshPhi() [1/2]

◆ meshPhi() [2/2]

◆ operator=()

Member Data Documentation

◆ mesh_

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