Abstract base class for ddt schemes. More...

Inheritance diagram for ddtScheme< Type >:

[legend]

Collaboration diagram for ddtScheme< Type >:

Public Types
typedef GeometricField< typename flux< Type >::type, fvsPatchField, surfaceMesh >	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...

virtual	~ddtScheme ()
	Destructor. More...

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

virtual tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const dimensioned< Type > &)=0

virtual tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const GeometricField< Type, fvPatchField, volMesh > &)=0

virtual tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)=0

virtual tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)=0

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

virtual tmp< fvMatrix< Type > >	fvmDdt (const GeometricField< Type, fvPatchField, volMesh > &)=0

virtual tmp< fvMatrix< Type > >	fvmDdt (const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)=0

virtual tmp< fvMatrix< Type > >	fvmDdt (const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)=0

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

tmp< surfaceScalarField >	fvcDdtPhiCoeff (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr)

tmp< surfaceScalarField >	fvcDdtPhiCoeff (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)

virtual tmp< fluxFieldType >	fvcDdtUfCorr (const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)=0

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

virtual tmp< fluxFieldType >	fvcDdtUfCorr (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)=0

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

virtual tmp< surfaceScalarField >	meshPhi (const GeometricField< Type, fvPatchField, volMesh > &)=0

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< ddtScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new ddtScheme created on freestore. More...

Protected Member Functions
	ddtScheme (const ddtScheme &)
	Disallow copy construct. More...

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

Protected Attributes
const fvMesh &	mesh_

Detailed Description

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

Abstract base class for ddt schemes.

Source files

Definition at line 64 of file ddtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

typedef GeometricField< typename flux<Type>::type, fvsPatchField, surfaceMesh > fluxFieldType

Definition at line 198 of file ddtScheme.H.

Constructor & Destructor Documentation

◆ ddtScheme() [1/3]

ddtScheme ( const ddtScheme< Type > & )

protected

Disallow copy construct.

◆ ddtScheme() [2/3]

ddtScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 106 of file ddtScheme.H.

◆ ddtScheme() [3/3]

ddtScheme	(	const fvMesh &	mesh,
		Istream &
	)

inline

Construct from mesh and Istream.

Definition at line 112 of file ddtScheme.H.

◆ ~ddtScheme()

~ddtScheme

virtual

Destructor.

Definition at line 92 of file ddtScheme.C.

Member Function Documentation

◆ operator=()

void operator= ( const ddtScheme< Type > & )

protected

Disallow default bitwise assignment.

◆ 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 46 of file ddtScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, mesh, 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 135 of file ddtScheme.H.

References ddtScheme< Type >::mesh_.

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

Here is the caller graph for this function:

◆ fvcDdt() [1/5]

virtual tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt ( const dimensioned< Type > & )

pure virtual

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

◆ fvcDdt() [2/5]

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

pure virtual

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

◆ fvcDdt() [3/5]

virtual tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt	(	const dimensionedScalar &	,
		const GeometricField< Type, fvPatchField, volMesh > &
	)

pure virtual

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

◆ fvcDdt() [4/5]

virtual tmp<GeometricField<Type, fvPatchField, volMesh> > fvcDdt	(	const volScalarField &	,
		const GeometricField< Type, fvPatchField, volMesh > &
	)

pure virtual

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

◆ fvcDdt() [5/5]

tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const GeometricField< Type, fvPatchField, volMesh > &	vf
	)

pure virtual

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

Definition at line 100 of file ddtScheme.C.

References NotImplemented, and GeometricField::null().

Here is the call graph for this function:

◆ fvmDdt() [1/4]

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

pure virtual

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

◆ fvmDdt() [2/4]

virtual tmp<fvMatrix<Type> > fvmDdt	(	const dimensionedScalar &	,
		const GeometricField< Type, fvPatchField, volMesh > &
	)

pure virtual

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

◆ fvmDdt() [3/4]

virtual tmp<fvMatrix<Type> > fvmDdt	(	const volScalarField &	,
		const GeometricField< Type, fvPatchField, volMesh > &
	)

pure virtual

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

◆ fvmDdt() [4/4]

tmp< fvMatrix< Type > > fvmDdt	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const GeometricField< Type, fvPatchField, volMesh > &	vf
	)

pure virtual

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

Definition at line 117 of file ddtScheme.C.

References Foam::constant::atomic::alpha, dimensioned::dimensions(), Foam::dimTime, Foam::dimVol, NotImplemented, and rho.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [1/2]

tmp< surfaceScalarField > fvcDdtPhiCoeff	(	const GeometricField< Type, fvPatchField, volMesh > &	U,
		const fluxFieldType &	phi,
		const fluxFieldType &	phiCorr
	)

Definition at line 139 of file ddtScheme.C.

References boundary(), GeometricField::boundaryField(), Foam::endl(), forAll, Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::Info, GeometricField::internalField(), Foam::mag(), mesh, Foam::min(), patchi, phi, and U.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [2/2]

tmp< surfaceScalarField > fvcDdtPhiCoeff	(	const GeometricField< Type, fvPatchField, volMesh > &	U,
		const fluxFieldType &	phi
	)

Definition at line 182 of file ddtScheme.C.

References Foam::fvc::interpolate(), mesh, phi, and U.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [1/2]

virtual tmp<fluxFieldType> fvcDdtUfCorr	(	const GeometricField< Type, fvPatchField, volMesh > &	U,
		const GeometricField< Type, fvsPatchField, surfaceMesh > &	Uf
	)

pure virtual

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

◆ fvcDdtPhiCorr() [1/2]

virtual tmp<fluxFieldType> fvcDdtPhiCorr	(	const GeometricField< Type, fvPatchField, volMesh > &	U,
		const fluxFieldType &	phi
	)

pure virtual

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

◆ fvcDdtUfCorr() [2/2]

virtual tmp<fluxFieldType> fvcDdtUfCorr	(	const volScalarField &	rho,
		const GeometricField< Type, fvPatchField, volMesh > &	U,
		const GeometricField< Type, fvsPatchField, surfaceMesh > &	Uf
	)

pure virtual

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

◆ fvcDdtPhiCorr() [2/2]

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

pure virtual

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

◆ meshPhi()

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

pure virtual

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

Field Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 73 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 Member Functions

Protected Attributes

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

◆ operator=()

◆ type()

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ fvcDdt() [1/5]

◆ fvcDdt() [2/5]

◆ fvcDdt() [3/5]

◆ fvcDdt() [4/5]

◆ fvcDdt() [5/5]

◆ fvmDdt() [1/4]

◆ fvmDdt() [2/4]

◆ fvmDdt() [3/4]

◆ fvmDdt() [4/4]

◆ fvcDdtPhiCoeff() [1/2]

◆ fvcDdtPhiCoeff() [2/2]

◆ fvcDdtUfCorr() [1/2]

◆ fvcDdtPhiCorr() [1/2]

◆ fvcDdtUfCorr() [2/2]

◆ fvcDdtPhiCorr() [2/2]

◆ meshPhi()

Field Documentation

◆ mesh_

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