Local time-step first-order Euler implicit/explicit ddt. More...

#include <localEulerDdtScheme.H>

Inheritance diagram for localEulerDdtScheme< Type >:

[legend]

Collaboration diagram for localEulerDdtScheme< Type >:

[legend]

Public Types
typedef ddtScheme< Type >::fluxFieldType	fluxFieldType
Public Types inherited from ddtScheme< Type >
typedef GeometricField< typename flux< Type >::type, fvsPatchField, surfaceMesh >	fluxFieldType

Public Member Functions
	TypeName ("localEuler")
	Runtime type information.
	localEulerDdtScheme (const fvMesh &mesh)
	Construct from mesh.
	localEulerDdtScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream.
const fvMesh &	mesh () const
	Return mesh reference.
tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const dimensioned< Type > &)
tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const GeometricField< Type, fvPatchField, volMesh > &)
tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< GeometricField< Type, fvPatchField, volMesh > >	fvcDdt (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &psi)
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	fvcDdt (const GeometricField< Type, fvsPatchField, surfaceMesh > &)
tmp< fvMatrix< Type > >	fvmDdt (const GeometricField< Type, fvPatchField, volMesh > &)
tmp< fvMatrix< Type > >	fvmDdt (const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< fvMatrix< Type > >	fvmDdt (const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< fvMatrix< Type > >	fvmDdt (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &psi)
tmp< fluxFieldType >	fvcDdtUfCorr (const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)
tmp< fluxFieldType >	fvcDdtPhiCorr (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)
tmp< fluxFieldType >	fvcDdtUfCorr (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)
tmp< fluxFieldType >	fvcDdtPhiCorr (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)
tmp< surfaceScalarField >	meshPhi (const GeometricField< Type, fvPatchField, volMesh > &)
tmp< surfaceScalarField >	fvcDdtUfCorr (const GeometricField< scalar, fvPatchField, volMesh > &U, const GeometricField< scalar, fvsPatchField, surfaceMesh > &Uf)
tmp< surfaceScalarField >	fvcDdtPhiCorr (const volScalarField &U, const surfaceScalarField &phi)
tmp< surfaceScalarField >	fvcDdtUfCorr (const volScalarField &rho, const volScalarField &U, const surfaceScalarField &Uf)
tmp< surfaceScalarField >	fvcDdtPhiCorr (const volScalarField &rho, const volScalarField &U, const surfaceScalarField &phi)
tmp< surfaceScalarField >	fvcDdtUfCorr (const volScalarField &U, const surfaceScalarField &Uf)
tmp< surfaceScalarField >	fvcDdtPhiCorr (const volScalarField &U, const surfaceScalarField &phi)
tmp< surfaceScalarField >	fvcDdtUfCorr (const volScalarField &rho, const volScalarField &U, const surfaceScalarField &Uf)
tmp< surfaceScalarField >	fvcDdtPhiCorr (const volScalarField &rho, const volScalarField &U, const surfaceScalarField &phi)
Public Member Functions inherited from localEulerDdt
	localEulerDdt ()
Public Member Functions inherited from ddtScheme< Type >
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (tmp, ddtScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	ddtScheme (const fvMesh &mesh)
	Construct from mesh.
	ddtScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream.
virtual	~ddtScheme ()=default
	Destructor.
const fvMesh &	mesh () const
	Return mesh reference.
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)
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.
Public Member Functions inherited from ddtSchemeBase
	ddtSchemeBase ()
	ddtSchemeBase ()

Additional Inherited Members
Static Public Member Functions inherited from localEulerDdt
static bool	enabled (const fvMesh &mesh)
	Return true if LTS is enabled.
static const volScalarField &	localRDeltaT (const fvMesh &mesh)
	Return the reciprocal of the local time-step.
static const surfaceScalarField &	localRDeltaTf (const fvMesh &mesh)
	Return the reciprocal of the local face time-step.
static tmp< volScalarField >	localRSubDeltaT (const fvMesh &mesh, const label nAlphaSubCycles)
	Calculate and return the reciprocal of the local sub-cycling.
Static Public Member Functions inherited from ddtScheme< Type >
static tmp< ddtScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new ddtScheme created on freestore.
Static Public Attributes inherited from localEulerDdt
static word	rDeltaTName
	Name of the reciprocal local time-step field.
static word	rDeltaTfName
	Name of the reciprocal local face time-step field.
static word	rSubDeltaTName
	Name of the reciprocal local sub-cycling time-step field.
Static Public Attributes inherited from ddtSchemeBase
static bool	experimentalDdtCorr
	Flag to use experimental ddtCorr from org version Default is off for backwards compatibility.
Protected Member Functions inherited from ddtScheme< Type >
	ddtScheme (const ddtScheme &)=delete
	No copy construct.
void	operator= (const ddtScheme &)=delete
	No copy assignment.
Protected Attributes inherited from ddtScheme< Type >
const fvMesh &	mesh_
scalar	ddtPhiCoeff_
	Input for fvcDdtPhiCoeff.

Detailed Description

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

Local time-step first-order Euler implicit/explicit ddt.

The reciprocal of the local time-step field is looked-up from the database.

This scheme should only be used for steady-state computations using transient codes where local time-stepping is preferably to under-relaxation for transport consistency reasons.

See also: Foam::fv::CoEulerDdtScheme

Source files

Definition at line 130 of file localEulerDdtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

template<class Type>

typedef ddtScheme<Type>::fluxFieldType fluxFieldType

Definition at line 253 of file localEulerDdtScheme.H.

Constructor & Destructor Documentation

◆ localEulerDdtScheme() [1/2]

template<class Type>

localEulerDdtScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 171 of file localEulerDdtScheme.H.

References ddtScheme< Type >::ddtScheme(), and mesh().

Here is the call graph for this function:

◆ localEulerDdtScheme() [2/2]

template<class Type>

localEulerDdtScheme	(	const fvMesh &	mesh,
		Istream &	is )

inline

Construct from mesh and Istream.

Definition at line 179 of file localEulerDdtScheme.H.

References ddtScheme< Type >::ddtScheme(), and mesh().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "localEuler" )

Runtime type information.

◆ mesh()

template<class Type>

const fvMesh & mesh ( ) const

inline

Return mesh reference.

Definition at line 190 of file localEulerDdtScheme.H.

References ddtScheme< Type >::mesh().

Referenced by fvcDdt(), fvcDdt(), fvcDdt(), fvcDdt(), fvcDdt(), fvcDdt(), fvcDdtPhiCorr(), fvcDdtPhiCorr(), fvcDdtUfCorr(), fvcDdtUfCorr(), localEulerDdtScheme(), and localEulerDdtScheme().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvcDdt() [1/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 53 of file localEulerDdtScheme.C.

References fvPatchFieldBase::calculatedType(), dimensioned< Type >::dimensions(), Foam::dimTime, mesh(), mesh, dimensioned< Type >::name(), Foam::New(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ fvcDdt() [2/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 77 of file localEulerDdtScheme.C.

References mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), and timeName.

Here is the call graph for this function:

◆ fvcDdt() [3/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 104 of file localEulerDdtScheme.C.

References mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), rho, and timeName.

Here is the call graph for this function:

◆ fvcDdt() [4/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 132 of file localEulerDdtScheme.C.

References mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), rho, and timeName.

Here is the call graph for this function:

◆ fvcDdt() [5/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 160 of file localEulerDdtScheme.C.

References alpha, mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), rho, and timeName.

Here is the call graph for this function:

◆ fvcDdt() [6/6]

template<class Type>

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

virtual

Reimplemented from ddtScheme< Type >.

Definition at line 193 of file localEulerDdtScheme.C.

References mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), and timeName.

Here is the call graph for this function:

◆ fvmDdt() [1/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 220 of file localEulerDdtScheme.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), and tmp< T >::ref().

Here is the call graph for this function:

◆ fvmDdt() [2/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 247 of file localEulerDdtScheme.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ fvmDdt() [3/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 276 of file localEulerDdtScheme.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ fvmDdt() [4/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 306 of file localEulerDdtScheme.C.

References alpha, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [1/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 339 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), ddtScheme< Type >::fvcDdtPhiCoeff(), Foam::fvc::interpolate(), mesh(), mesh, timeName, U, and Uf.

Here is the call graph for this function:

◆ fvcDdtPhiCorr() [1/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 372 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), ddtScheme< Type >::fvcDdtPhiCoeff(), Foam::fvc::interpolate(), mesh(), mesh, phi, timeName, and U.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [2/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 404 of file localEulerDdtScheme.C.

References Foam::abort(), Foam::dimDensity, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, ddtScheme< Type >::fvcDdtPhiCoeff(), Foam::fvc::interpolate(), mesh(), mesh, GeometricField< Type, PatchField, GeoMesh >::null(), rho, timeName, U, and Uf.

Here is the call graph for this function:

◆ fvcDdtPhiCorr() [2/6]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 489 of file localEulerDdtScheme.C.

References Foam::abort(), Foam::dimArea, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, ddtScheme< Type >::fvcDdtPhiCoeff(), Foam::fvc::interpolate(), mesh(), mesh, GeometricField< Type, PatchField, GeoMesh >::null(), phi, rho, timeName, and U.

Here is the call graph for this function:

◆ meshPhi()

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 579 of file localEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVolume, mesh, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, tmp< T >::ref(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [3/6]

tmp< surfaceScalarField > fvcDdtUfCorr	(	const GeometricField< scalar, fvPatchField, volMesh > &	U,
		const GeometricField< scalar, fvsPatchField, surfaceMesh > &	Uf )

References U, and Uf.

◆ fvcDdtPhiCorr() [3/6]

tmp< surfaceScalarField > fvcDdtPhiCorr	(	const volScalarField &	U,
		const surfaceScalarField &	phi )

References phi, and U.

◆ fvcDdtUfCorr() [4/6]

tmp< surfaceScalarField > fvcDdtUfCorr	(	const volScalarField &	rho,
		const volScalarField &	U,
		const surfaceScalarField &	Uf )

References rho, U, and Uf.

◆ fvcDdtPhiCorr() [4/6]

tmp< surfaceScalarField > fvcDdtPhiCorr	(	const volScalarField &	rho,
		const volScalarField &	U,
		const surfaceScalarField &	phi )

References phi, rho, and U.

◆ fvcDdtUfCorr() [5/6]

tmp< surfaceScalarField > fvcDdtUfCorr	(	const volScalarField &	U,
		const surfaceScalarField &	Uf )

Definition at line 26 of file localEulerDdtSchemes.C.

◆ fvcDdtPhiCorr() [5/6]

tmp< surfaceScalarField > fvcDdtPhiCorr	(	const volScalarField &	U,
		const surfaceScalarField &	phi )

Definition at line 26 of file localEulerDdtSchemes.C.

◆ fvcDdtUfCorr() [6/6]

tmp< surfaceScalarField > fvcDdtUfCorr	(	const volScalarField &	rho,
		const volScalarField &	U,
		const surfaceScalarField &	Uf )

Definition at line 26 of file localEulerDdtSchemes.C.

◆ fvcDdtPhiCorr() [6/6]

tmp< surfaceScalarField > fvcDdtPhiCorr	(	const volScalarField &	rho,
		const volScalarField &	U,
		const surfaceScalarField &	phi )

Definition at line 26 of file localEulerDdtSchemes.C.

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

src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H
src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.C

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ fluxFieldType

Constructor & Destructor Documentation

◆ localEulerDdtScheme() [1/2]

◆ localEulerDdtScheme() [2/2]

Member Function Documentation

◆ TypeName()

◆ 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]

◆ fvcDdtUfCorr() [1/6]

◆ fvcDdtPhiCorr() [1/6]

◆ fvcDdtUfCorr() [2/6]

◆ fvcDdtPhiCorr() [2/6]

◆ meshPhi()

◆ fvcDdtUfCorr() [3/6]

◆ fvcDdtPhiCorr() [3/6]

◆ fvcDdtUfCorr() [4/6]

◆ fvcDdtPhiCorr() [4/6]

◆ fvcDdtUfCorr() [5/6]

◆ fvcDdtPhiCorr() [5/6]

◆ fvcDdtUfCorr() [6/6]

◆ fvcDdtPhiCorr() [6/6]