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

Inheritance diagram for localEulerDdtScheme< Type >:

Collaboration diagram for localEulerDdtScheme< Type >:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual tmp< scalarField >	meshPhi (const GeometricField< Type, fvPatchField, volMesh > &, const label patchi)

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

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

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

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

template<>
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. 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 &)
	Disallow default bitwise copy construction. More...

virtual	~ddtScheme ()
	Destructor. More...

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

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

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

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

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

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

Additional Inherited Members
Static Public Member Functions inherited from localEulerDdt
static bool	enabled (const fvMesh &mesh)
	Return true if LTS is enabled. More...

static const volScalarField &	localRDeltaT (const fvMesh &mesh)
	Return the reciprocal of the local time-step. More...

static const surfaceScalarField &	localRDeltaTf (const fvMesh &mesh)
	Return the reciprocal of the local face time-step. More...

static tmp< volScalarField >	localRSubDeltaT (const fvMesh &mesh, const label nAlphaSubCycles)
	Calculate and return the reciprocal of the local sub-cycling. More...

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

Static Public Attributes inherited from localEulerDdt
static word	rDeltaTName
	Name of the reciprocal local time-step field. More...

static word	rDeltaTfName
	Name of the reciprocal local face time-step field. More...

static word	rSubDeltaTName
	Name of the reciprocal local sub-cycling time-step field. More...

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

Protected Attributes inherited from ddtScheme< Type >
const fvMesh &	mesh_

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 112 of file localEulerDdtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

typedef ddtScheme<Type>::fluxFieldType fluxFieldType

Definition at line 212 of file localEulerDdtScheme.H.

Constructor & Destructor Documentation

◆ localEulerDdtScheme() [1/3]

localEulerDdtScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 135 of file localEulerDdtScheme.H.

◆ localEulerDdtScheme() [2/3]

localEulerDdtScheme	(	const fvMesh &	mesh,
		Istream &	is
	)

inline

Construct from mesh and Istream.

Definition at line 141 of file localEulerDdtScheme.H.

References alpha(), psi, and rho.

Here is the call graph for this function:

◆ localEulerDdtScheme() [3/3]

localEulerDdtScheme ( const localEulerDdtScheme< Type > & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "localEuler" )

Runtime type information.

◆ fvcDdt() [1/6]

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

virtual

Implements ddtScheme< Type >.

Definition at line 59 of file localEulerDdtScheme.C.

References dimensioned< Type >::dimensions(), Foam::dimTime, mesh, dimensioned< Type >::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::Zero.

Referenced by localEulerDdtScheme< Type >::fvcDdt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvcDdt() [2/6]

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

virtual

Implements ddtScheme< Type >.

Definition at line 86 of file localEulerDdtScheme.C.

References localEulerDdtScheme< Type >::fvcDdt(), IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

◆ fvcDdt() [3/6]

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

virtual

Implements ddtScheme< Type >.

Definition at line 108 of file localEulerDdtScheme.C.

References localEulerDdtScheme< Type >::fvcDdt(), dimensioned< Type >::name(), IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

◆ fvcDdt() [4/6]

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

virtual

Implements ddtScheme< Type >.

Definition at line 131 of file localEulerDdtScheme.C.

References localEulerDdtScheme< Type >::fvcDdt(), IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

◆ fvcDdt() [5/6]

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 154 of file localEulerDdtScheme.C.

References localEulerDdtScheme< Type >::fvcDdt(), IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

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 from ddtScheme< Type >.

Definition at line 182 of file localEulerDdtScheme.C.

References localEulerDdtScheme< Type >::fvmDdt(), IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

◆ fvmDdt() [1/4]

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

virtual

Implements ddtScheme< Type >.

Definition at line 201 of file localEulerDdtScheme.C.

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

Referenced by localEulerDdtScheme< Type >::fvcDdt(), and localEulerDdtScheme< Type >::fvmDdt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvmDdt() [2/4]

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

virtual

Implements ddtScheme< Type >.

Definition at line 228 of file localEulerDdtScheme.C.

References lduMatrix::diag(), dimensioned< Type >::dimensions(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, localEulerDdtScheme< Type >::fvmDdt(), mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), tmp< T >::ref(), fvMatrix< Type >::source(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ fvmDdt() [3/4]

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

virtual

Implements ddtScheme< Type >.

Definition at line 257 of file localEulerDdtScheme.C.

References lduMatrix::diag(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, localEulerDdtScheme< Type >::fvmDdt(), mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), and fvMatrix< Type >::source().

Here is the call graph for this function:

◆ fvmDdt() [4/4]

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

virtual

Implements ddtScheme< Type >.

Definition at line 287 of file localEulerDdtScheme.C.

References lduMatrix::diag(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, localEulerDdtScheme< Type >::fvcDdtUfCorr(), mesh, GeometricField< Type, PatchField, GeoMesh >::oldTime(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), and fvMatrix< Type >::source().

Here is the call graph for this function:

◆ fvcDdtUfCorr() [1/4]

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 370 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), Foam::fvc::interpolate(), mesh, IOobject::name(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Referenced by localEulerDdtScheme< Type >::fvcDdtPhiCorr(), and localEulerDdtScheme< Type >::fvmDdt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvcDdtPhiCorr() [1/4]

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

virtual

Implements ddtScheme< Type >.

Definition at line 403 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), Foam::fvc::interpolate(), mesh, IOobject::name(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Referenced by localEulerDdtScheme< Type >::fvcDdtUfCorr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvcDdtUfCorr() [2/4]

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 435 of file localEulerDdtScheme.C.

References Foam::abort(), Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, localEulerDdtScheme< Type >::fvcDdtPhiCorr(), Foam::fvc::interpolate(), mesh, IOobject::name(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

◆ fvcDdtPhiCorr() [2/4]

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 520 of file localEulerDdtScheme.C.

References Foam::abort(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimFlux, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, Foam::fvc::interpolate(), mesh, localEulerDdtScheme< Type >::meshPhi(), IOobject::name(), and GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

◆ meshPhi() [1/2]

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

virtual

Implements ddtScheme< Type >.

Definition at line 610 of file localEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVolume, mesh, and GeometricField< scalar, fvsPatchField, surfaceMesh >::New().

Referenced by localEulerDdtScheme< Type >::fvcDdtPhiCorr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ meshPhi() [2/2]

tmp< scalarField > meshPhi	(	const GeometricField< Type, fvPatchField, volMesh > &	,
		const label	patchi
	)

virtual

Implements ddtScheme< Type >.

Definition at line 625 of file localEulerDdtScheme.C.

References boundary(), and mesh.

Here is the call graph for this function:

◆ operator=()

void operator= ( const localEulerDdtScheme< Type > & )

delete

Disallow default bitwise assignment.

◆ fvcDdtUfCorr() [3/4]

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

◆ fvcDdtPhiCorr() [3/4]

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

◆ fvcDdtUfCorr() [4/4]

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

◆ fvcDdtPhiCorr() [4/4]

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

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

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

Member Typedef Documentation

◆ fluxFieldType

Constructor & Destructor Documentation

◆ localEulerDdtScheme() [1/3]

◆ localEulerDdtScheme() [2/3]

◆ localEulerDdtScheme() [3/3]

Member Function Documentation

◆ TypeName()

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

◆ fvcDdtPhiCorr() [1/4]

◆ fvcDdtUfCorr() [2/4]

◆ fvcDdtPhiCorr() [2/4]

◆ meshPhi() [1/2]

◆ meshPhi() [2/2]

◆ operator=()

◆ fvcDdtUfCorr() [3/4]

◆ fvcDdtPhiCorr() [3/4]

◆ fvcDdtUfCorr() [4/4]

◆ fvcDdtPhiCorr() [4/4]

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