ddtScheme< Type > Class Template Reference

Abstract base class for ddt schemes. More...

Inheritance diagram for ddtScheme< Type >:

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 &is)
	Construct from mesh and Istream. More...
virtual	~ddtScheme ()=default
	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< GeometricField< Type, fvsPatchField, surfaceMesh > >	fvcDdt (const GeometricField< Type, fvsPatchField, surfaceMesh > &)
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 >	fvcDdtPhiCoeffExperimental (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr)
tmp< surfaceScalarField >	fvcDdtPhiCoeff (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr, const volScalarField &rho)
tmp< surfaceScalarField >	fvcDdtPhiCoeff (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)
tmp< surfaceScalarField >	fvcDdtPhiCoeff (const GeometricField< Type, fvPatchField, volMesh > &rhoU, const fluxFieldType &phi, const volScalarField &rho)
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
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...
int	count () const noexcept
	Return the current reference count. More...
bool	unique () const noexcept
	Return true if the reference count is zero. More...
void	operator++ () noexcept
	Increment the reference count. More...
void	operator++ (int) noexcept
	Increment the reference count. More...
void	operator-- () noexcept
	Decrement the reference count. More...
void	operator-- (int) noexcept
	Decrement the reference count. More...
Public Member Functions inherited from ddtSchemeBase
	ddtSchemeBase ()
	ddtSchemeBase ()

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 &)=delete
	No copy construct. More...
void	operator= (const ddtScheme &)=delete
	No copy assignment. More...

Protected Attributes
const fvMesh &	mesh_
scalar	ddtPhiCoeff_
	Input for fvcDdtPhiCoeff. More...

Additional Inherited Members
Static Public Attributes inherited from ddtSchemeBase
static bool	experimentalDdtCorr
	Flag to use experimental ddtCorr from org version Default is off for backwards compatibility. More...

Detailed Description

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

Abstract base class for ddt schemes.

Source files

• ddtScheme.H
• ddtScheme.C

Definition at line 81 of file ddtScheme.H.

Member Typedef Documentation

fluxFieldType

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

Definition at line 247 of file ddtScheme.H.

Constructor & Destructor Documentation

ddtScheme() [1/3]

ddtScheme ( const ddtScheme< Type > &  )

protecteddelete

No copy construct.

ddtScheme() [2/3]

ddtScheme ( const fvMesh &  mesh )

inline

Construct from mesh.

Definition at line 140 of file ddtScheme.H.

ddtScheme() [3/3]

ddtScheme ( const fvMesh &  mesh, Istream &  is  )

inline

Construct from mesh and Istream.

Definition at line 149 of file ddtScheme.H.

~ddtScheme()

virtual ~ddtScheme ( )

virtualdefault

Destructor.

Member Function Documentation

operator=()

void operator= ( const ddtScheme< Type > &  )

protecteddelete

No copy 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 43 of file ddtScheme.C.

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

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 179 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/6]

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

pure virtual

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

fvcDdt() [2/6]

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

pure virtual

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

fvcDdt() [3/6]

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

pure virtual

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

fvcDdt() [4/6]

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

pure virtual

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

fvcDdt() [5/6]

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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, EulerDdtScheme< Type >, and steadyStateDdtScheme< Type >.

Definition at line 85 of file ddtScheme.C.

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

Here is the call graph for this function:

fvcDdt() [6/6]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > fvcDdt ( const GeometricField< Type, fvsPatchField, surfaceMesh > &  sf )

virtual

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

Definition at line 121 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 GeometricField< Type, fvPatchField, volMesh > &  )

pure virtual

Implemented in CrankNicolsonDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, EulerDdtScheme< Type >, and steadyStateDdtScheme< Type >.

Definition at line 102 of file ddtScheme.C.

References Foam::constant::atomic::alpha, dimensioned< Type >::dimensions(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, Foam::New(), NotImplemented, and rho.

Here is the call graph for this function:

fvcDdtPhiCoeff() [1/4]

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

Definition at line 137 of file ddtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::ensightOutput::debug, Foam::dimless, Foam::endl(), forAll, Foam::gAverage(), Foam::gMax(), Foam::gMin(), InfoInFunction, Foam::mag(), mesh, Foam::min(), phi, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), and U.

Here is the call graph for this function:

fvcDdtPhiCoeffExperimental()

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

Definition at line 211 of file ddtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::ensightOutput::debug, Foam::dimless, Foam::endl(), forAll, Foam::gAverage(), Foam::gMax(), Foam::gMin(), InfoInFunction, Foam::mag(), mesh, Foam::min(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), DimensionedField< Type, GeoMesh >::setOriented(), and U.

Here is the call graph for this function:

fvcDdtPhiCoeff() [2/4]

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

Definition at line 292 of file ddtScheme.C.

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

Here is the call graph for this function:

fvcDdtPhiCoeff() [3/4]

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

Definition at line 318 of file ddtScheme.C.

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

Here is the call graph for this function:

fvcDdtPhiCoeff() [4/4]

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

Definition at line 348 of file ddtScheme.C.

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

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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< 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 >, backwardDdtScheme< Type >, CoEulerDdtScheme< Type >, boundedDdtScheme< Type >, EulerDdtScheme< Type >, and steadyStateDdtScheme< Type >.

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Definition at line 91 of file ddtScheme.H.

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

ddtPhiCoeff_

scalar ddtPhiCoeff_

protected

Input for fvcDdtPhiCoeff.

If set to -1 (default) the code will calculate the coefficient If > 0 the coupling coeff is set to this value

Definition at line 99 of file ddtScheme.H.

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

---

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