Courant number limited first-order Euler implicit/explicit ddt. More...

#include <CoEulerDdtScheme.H>

Inheritance diagram for CoEulerDdtScheme< Type >:

Collaboration diagram for CoEulerDdtScheme< 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 ("CoEuler")
	Runtime type information.
	CoEulerDdtScheme (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< 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 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.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	fvcDdt (const GeometricField< Type, fvsPatchField, surfaceMesh > &)
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 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 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::CoEulerDdtScheme< Type >

Courant number limited first-order Euler implicit/explicit ddt.

The time-step is adjusted locally so that the local Courant number does not exceed the specified value.

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

Source files

Definition at line 62 of file CoEulerDdtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

template<class Type>

typedef ddtScheme<Type>::fluxFieldType fluxFieldType

Definition at line 194 of file CoEulerDdtScheme.H.

Constructor & Destructor Documentation

◆ CoEulerDdtScheme()

template<class Type>

CoEulerDdtScheme	(	const fvMesh &	mesh,
		Istream &	is )

inline

Construct from mesh and Istream.

Definition at line 122 of file CoEulerDdtScheme.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "CoEuler" )

Runtime type information.

◆ mesh()

template<class Type>

const fvMesh & mesh ( ) const

inline

Return mesh reference.

Definition at line 136 of file CoEulerDdtScheme.H.

References ddtScheme< Type >::mesh().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvcDdt() [1/5]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 145 of file CoEulerDdtScheme.C.

References fvPatchFieldBase::calculatedType(), dimensioned< Type >::dimensions(), Foam::dimTime, mesh(), mesh, dimensioned< Type >::name(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), timeName, dimensioned< Type >::value(), and Foam::Zero.

Here is the call graph for this function:

◆ fvcDdt() [2/5]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 200 of file CoEulerDdtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DimensionedField< Type, GeoMesh >::dimensions(), mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), and timeName.

Here is the call graph for this function:

◆ fvcDdt() [3/5]

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 258 of file CoEulerDdtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DimensionedField< Type, GeoMesh >::dimensions(), mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), rho, and timeName.

Here is the call graph for this function:

◆ fvcDdt() [4/5]

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 317 of file CoEulerDdtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DimensionedField< Type, GeoMesh >::dimensions(), mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), rho, and timeName.

Here is the call graph for this function:

◆ fvcDdt() [5/5]

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 379 of file CoEulerDdtScheme.C.

References alpha, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DimensionedField< Type, GeoMesh >::dimensions(), mesh(), mesh, IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), rho, 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 455 of file CoEulerDdtScheme.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 490 of file CoEulerDdtScheme.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 527 of file CoEulerDdtScheme.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 566 of file CoEulerDdtScheme.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/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 609 of file CoEulerDdtScheme.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/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 642 of file CoEulerDdtScheme.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/4]

template<class Type>

tmp< typename CoEulerDdtScheme< 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 674 of file CoEulerDdtScheme.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/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 759 of file CoEulerDdtScheme.C.

References Foam::abort(), Foam::dimArea, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, ddtScheme< Type >::fvcDdtPhiCoeff(), 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 849 of file CoEulerDdtScheme.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/4]

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

References U, and Uf.

◆ fvcDdtPhiCorr() [3/4]

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

References phi, and U.

◆ fvcDdtUfCorr() [4/4]

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

References rho, U, and Uf.

◆ fvcDdtPhiCorr() [4/4]

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

References phi, rho, and U.

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

src/finiteVolume/finiteVolume/ddtSchemes/CoEulerDdtScheme/CoEulerDdtScheme.H
src/finiteVolume/finiteVolume/ddtSchemes/CoEulerDdtScheme/CoEulerDdtScheme.C

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ fluxFieldType

Constructor & Destructor Documentation

◆ CoEulerDdtScheme()

Member Function Documentation

◆ TypeName()

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

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