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

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

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

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

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

virtual	~ddtScheme ()
	Destructor. More...

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

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

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

Public Member Functions inherited from refCount
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

bool	okToDelete () const
	Return true if the reference count is zero. More...

void	resetRefCount ()
	Reset the reference count to 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...

Private Member Functions
	CoEulerDdtScheme (const CoEulerDdtScheme &)
	Disallow default bitwise copy construct. More...

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

tmp< volScalarField >	CorDeltaT () const
	Return the reciprocal of the Courant-number limited time-step. More...

tmp< surfaceScalarField >	CofrDeltaT () const
	Return the reciprocal of the face-Courant-number limited time-step. More...

Private Attributes
word	phiName_
	Name of the flux field used to calculate the local time-step. More...

word	rhoName_
	Name of the density field used to obtain the volumetric flux. More...

scalar	maxCo_
	Maximum local Courant number. More...

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

Protected Member Functions inherited from ddtScheme< Type >
	ddtScheme (const ddtScheme &)
	Disallow copy construct. More...

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

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

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 61 of file CoEulerDdtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

typedef ddtScheme<Type>::fluxFieldType fluxFieldType

Definition at line 172 of file CoEulerDdtScheme.H.

Constructor & Destructor Documentation

◆ CoEulerDdtScheme() [1/2]

CoEulerDdtScheme ( const CoEulerDdtScheme< Type > & )

private

Disallow default bitwise copy construct.

◆ CoEulerDdtScheme() [2/2]

CoEulerDdtScheme	(	const fvMesh &	mesh,
		Istream &	is
	)

inline

Construct from mesh and Istream.

Definition at line 102 of file CoEulerDdtScheme.H.

Member Function Documentation

◆ operator=()

void operator= ( const CoEulerDdtScheme< Type > & )

private

Disallow default bitwise assignment.

◆ CorDeltaT()

tmp< volScalarField > CorDeltaT

private

Return the reciprocal of the Courant-number limited time-step.

Definition at line 44 of file CoEulerDdtScheme.C.

References GeometricField::boundaryField(), GeometricField::correctBoundaryConditions(), forAll, Foam::max(), mesh, p, fvsPatchField::patch(), and patchi.

Here is the call graph for this function:

◆ CofrDeltaT()

tmp< surfaceScalarField > CofrDeltaT

private

Return the reciprocal of the face-Courant-number limited time-step.

Definition at line 108 of file CoEulerDdtScheme.C.

References Foam::abort(), surfaceInterpolation::deltaCoeffs(), Foam::FatalError, FatalErrorInFunction, Foam::fvc::interpolate(), Foam::mag(), Foam::max(), mesh, phi, and rho.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "CoEuler" )

Runtime type information.

◆ mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 114 of file CoEulerDdtScheme.H.

References ddtScheme< Type >::mesh().

Here is the call graph for this function:

◆ fvcDdt() [1/5]

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

virtual

Implements ddtScheme< Type >.

Definition at line 156 of file CoEulerDdtScheme.C.

References dimensioned::dimensions(), Foam::dimTime, GeometricField::internalField(), mesh, dimensioned::name(), timeName, and dimensioned::value().

Here is the call graph for this function:

◆ fvcDdt() [2/5]

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

virtual

Implements ddtScheme< Type >.

Definition at line 216 of file CoEulerDdtScheme.C.

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

Here is the call graph for this function:

◆ fvcDdt() [3/5]

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

virtual

Implements ddtScheme< Type >.

Definition at line 267 of file CoEulerDdtScheme.C.

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

Here is the call graph for this function:

◆ fvcDdt() [4/5]

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

virtual

Implements ddtScheme< Type >.

Definition at line 319 of file CoEulerDdtScheme.C.

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

Here is the call graph for this function:

◆ fvcDdt() [5/5]

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

References Foam::constant::atomic::alpha, GeometricField::boundaryField(), dimensioned::dimensions(), GeometricField::internalField(), mesh, dimensioned::name(), GeometricField::oldTime(), rho, 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 443 of file CoEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVol, internalField(), mesh, GeometricField::oldTime(), 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 478 of file CoEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVol, internalField(), mesh, GeometricField::oldTime(), 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 515 of file CoEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVol, internalField(), mesh, GeometricField::oldTime(), 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 554 of file CoEulerDdtScheme.C.

References Foam::constant::atomic::alpha, dimensioned::dimensions(), Foam::dimTime, Foam::dimVol, internalField(), mesh, GeometricField::oldTime(), rho, and fvMatrix::source().

Here is the call graph for this function:

◆ fvcDdtUfCorr() [1/4]

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

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

Here is the call graph for this function:

◆ fvcDdtPhiCorr() [1/4]

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

virtual

Implements ddtScheme< Type >.

Definition at line 633 of file CoEulerDdtScheme.C.

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

Here is the call graph for this function:

◆ fvcDdtUfCorr() [2/4]

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

References Foam::abort(), Foam::dimDensity, Foam::dimVelocity, 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 CoEulerDdtScheme< Type >::fluxFieldType > fvcDdtPhiCorr	(	const volScalarField &	rho,
		const GeometricField< Type, fvPatchField, volMesh > &	U,
		const fluxFieldType &	phi
	)

virtual

Implements ddtScheme< Type >.

Definition at line 732 of file CoEulerDdtScheme.C.

References Foam::abort(), Foam::dimArea, Foam::dimVelocity, 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 793 of file CoEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVolume, mesh, IOobject::NO_READ, IOobject::NO_WRITE, and timeName.

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

Field Documentation

◆ phiName_

word phiName_

private

Name of the flux field used to calculate the local time-step.

Definition at line 68 of file CoEulerDdtScheme.H.

◆ rhoName_

word rhoName_

private

Name of the density field used to obtain the volumetric flux.

from the mass flux if required

Definition at line 72 of file CoEulerDdtScheme.H.

◆ maxCo_

scalar maxCo_

private

Maximum local Courant number.

Definition at line 75 of file CoEulerDdtScheme.H.

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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ fluxFieldType

Constructor & Destructor Documentation

◆ CoEulerDdtScheme() [1/2]

◆ CoEulerDdtScheme() [2/2]

Member Function Documentation

◆ operator=()

◆ CorDeltaT()

◆ CofrDeltaT()

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

Field Documentation

◆ phiName_

◆ rhoName_

◆ maxCo_

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