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")

	localEulerDdtScheme (const fvMesh &mesh)

	localEulerDdtScheme (const fvMesh &mesh, Istream &is)

const fvMesh &	mesh () const

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)

Public Member Functions inherited from localEulerDdt
	localEulerDdt ()

Public Member Functions inherited from ddtScheme< Type >
virtual const word &	type () const =0

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

	ddtScheme (const fvMesh &mesh)

	ddtScheme (const fvMesh &mesh, Istream &is)

virtual	~ddtScheme ()=default

const fvMesh &	mesh () const

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

int	count () const noexcept

bool	unique () const noexcept

void	operator++ () noexcept

void	operator++ (int) noexcept

void	operator-- () noexcept

void	operator-- (int) noexcept

Public Member Functions inherited from ddtSchemeBase
	ddtSchemeBase ()

	ddtSchemeBase ()

Additional Inherited Members
Static Public Member Functions inherited from localEulerDdt
static bool	enabled (const fvMesh &mesh)

static const volScalarField &	localRDeltaT (const fvMesh &mesh)

static const surfaceScalarField &	localRDeltaTf (const fvMesh &mesh)

static tmp< volScalarField >	localRSubDeltaT (const fvMesh &mesh, const label nAlphaSubCycles)

Static Public Member Functions inherited from ddtScheme< Type >
static tmp< ddtScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)

Static Public Attributes inherited from localEulerDdt
static word	rDeltaTName

static word	rDeltaTfName

static word	rSubDeltaTName

Static Public Attributes inherited from ddtSchemeBase
static bool	experimentalDdtCorr

Protected Member Functions inherited from ddtScheme< Type >
	ddtScheme (const ddtScheme &)=delete

void	operator= (const ddtScheme &)=delete

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

scalar	ddtPhiCoeff_

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

Member Typedef Documentation

◆ fluxFieldType

typedef ddtScheme<Type>::fluxFieldType fluxFieldType

Definition at line 220 of file localEulerDdtScheme.H.

Constructor & Destructor Documentation

◆ localEulerDdtScheme() [1/2]

localEulerDdtScheme ( const fvMesh & mesh )

inline

Definition at line 142 of file localEulerDdtScheme.H.

◆ localEulerDdtScheme() [2/2]

localEulerDdtScheme	(	const fvMesh &	mesh,
		Istream &	is
	)

inline

Definition at line 148 of file localEulerDdtScheme.H.

Member Function Documentation

◆ TypeName()

TypeName ( "localEuler" )

◆ mesh()

const fvMesh& mesh ( ) const

inline

Definition at line 157 of file localEulerDdtScheme.H.

References ddtScheme< Type >::mesh().

Here is the call graph for this function:

◆ fvcDdt() [1/6]

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

virtual

Implements ddtScheme< Type >.

Definition at line 54 of file localEulerDdtScheme.C.

References dimensioned::dimensions(), Foam::dimTime, mesh, dimensioned::name(), Foam::New(), timeName, and Foam::Zero.

Here is the call 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 78 of file localEulerDdtScheme.C.

References mesh, GeometricField::oldTime(), and timeName.

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

References mesh, GeometricField::oldTime(), rho, and timeName.

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

References mesh, GeometricField::oldTime(), rho, and timeName.

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

References Foam::constant::atomic::alpha, mesh, dimensioned::name(), GeometricField::oldTime(), rho, and timeName.

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

References mesh, GeometricField::oldTime(), and timeName.

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

References Foam::dimTime, Foam::dimVol, mesh, GeometricField::oldTime(), tmp::ref(), and fvMatrix::source().

Here is the call 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 248 of file localEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVol, mesh, GeometricField::oldTime(), tmp::ref(), rho, and fvMatrix::source().

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

References Foam::dimTime, Foam::dimVol, mesh, GeometricField::oldTime(), tmp::ref(), rho, and fvMatrix::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 307 of file localEulerDdtScheme.C.

References Foam::constant::atomic::alpha, dimensioned::dimensions(), Foam::dimTime, Foam::dimVol, mesh, GeometricField::oldTime(), tmp::ref(), rho, and fvMatrix::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 340 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), Foam::fvc::interpolate(), mesh, timeName, U, and Uf.

Here is the call 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 373 of file localEulerDdtScheme.C.

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

Here is the call 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 405 of file localEulerDdtScheme.C.

References Foam::abort(), Foam::dimDensity, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, Foam::fvc::interpolate(), mesh, rho, timeName, U, and Uf.

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

References Foam::abort(), Foam::dimArea, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, Foam::fvc::interpolate(), mesh, phi, rho, timeName, and U.

Here is the call graph for this function:

◆ meshPhi()

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

virtual

Implements ddtScheme< Type >.

Definition at line 580 of file localEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVolume, mesh, IOobject::NO_READ, IOobject::NO_WRITE, tmp::ref(), timeName, and Foam::Zero.

Here is the call graph for this function:

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

◆ fvcDdtPhiCorr() [1/4]

◆ fvcDdtUfCorr() [2/4]

◆ fvcDdtPhiCorr() [2/4]

◆ meshPhi()

◆ fvcDdtUfCorr() [3/4]

◆ fvcDdtPhiCorr() [3/4]

◆ fvcDdtUfCorr() [4/4]

◆ fvcDdtPhiCorr() [4/4]

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