Second-oder Crank-Nicolson implicit ddt using the current and previous time-step fields as well as the previous time-step ddt. More...

#include <CrankNicolsonDdtScheme.H>

Inheritance diagram for CrankNicolsonDdtScheme< Type >:

[legend]

Collaboration diagram for CrankNicolsonDdtScheme< 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 ("CrankNicolson")
	Runtime type information.
	CrankNicolsonDdtScheme (const fvMesh &mesh)
	Construct from mesh.
	CrankNicolsonDdtScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream.
const fvMesh &	mesh () const
	Return mesh reference.
scalar	ocCoeff () const
	Return the current off-centreing coefficient.
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 > &)
template<class GeoField>
CrankNicolsonDdtScheme< Type >::template DDt0Field< GeoField > &	ddt0_ (const word &name, const dimensionSet &dims)
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::CrankNicolsonDdtScheme< Type >

Second-oder Crank-Nicolson implicit ddt using the current and previous time-step fields as well as the previous time-step ddt.

The Crank-Nicolson scheme is often unstable for complex flows in complex geometries and it is necessary to "off-centre" the scheme to stabilize it while retaining greater temporal accuracy than the first-order Euler-implicit scheme. Off-centering is specified via the mandatory coefficient ocCoeff in the range [0,1] following the scheme name e.g.

ddtSchemes
{
    default         CrankNicolson 0.9;
}

or with an optional "ramp" function to transition from the Euler scheme to Crank-Nicolson over a initial period to avoid start-up problems, e.g.

ddtSchemes
{
    default         CrankNicolson
    ocCoeff
    {
        type        scale;
        scale       linearRamp;
        duration    0.01;
        value       0.9;
    };
}

With a coefficient of 1 the scheme is fully centred and second-order, with a coefficient of 0 the scheme is equivalent to Euler-implicit. A coefficient of 0.9 has been found to be suitable for a range of cases for which higher-order accuracy in time is needed and provides similar accuracy and stability to the backward scheme. However, the backward scheme has been found to be more robust and provides formal second-order accuracy in time.

The advantage of the Crank-Nicolson scheme over backward is that only the new and old-time values are needed, the additional terms relating to the fluxes and sources are evaluated at the mid-point of the time-step which provides the opportunity to limit the fluxes in such a way as to ensure boundedness while maintaining greater accuracy in time compared to the Euler-implicit scheme. This approach is now used with MULES in the interFoam family of solvers. Boundedness cannot be guaranteed with the backward scheme.

Note

The Crank-Nicolson coefficient for the implicit part of the RHS is related to the off-centering coefficient by

    cnCoeff = 1.0/(1.0 + ocCoeff);

See also: Foam::Euler Foam::backward

Source files

Definition at line 112 of file CrankNicolsonDdtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

template<class Type>

typedef ddtScheme<Type>::fluxFieldType fluxFieldType

Definition at line 334 of file CrankNicolsonDdtScheme.H.

Constructor & Destructor Documentation

◆ CrankNicolsonDdtScheme() [1/2]

template<class Type>

CrankNicolsonDdtScheme ( const fvMesh & mesh )

Construct from mesh.

Definition at line 269 of file CrankNicolsonDdtScheme.C.

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

Here is the call graph for this function:

◆ CrankNicolsonDdtScheme() [2/2]

template<class Type>

CrankNicolsonDdtScheme	(	const fvMesh &	mesh,
		Istream &	is )

Construct from mesh and Istream.

Definition at line 284 of file CrankNicolsonDdtScheme.C.

References ddtScheme< Type >::ddtScheme(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::isNumber(), mesh(), token::number(), ocCoeff(), and Istream::putBack().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "CrankNicolson" )

Runtime type information.

References mesh().

Here is the call graph for this function:

◆ mesh()

template<class Type>

const fvMesh & mesh ( ) const

inline

Return mesh reference.

Definition at line 268 of file CrankNicolsonDdtScheme.H.

References ddtScheme< Type >::mesh().

Referenced by CrankNicolsonDdtScheme(), CrankNicolsonDdtScheme(), fvcDdt(), fvcDdt(), fvcDdt(), fvcDdt(), fvcDdt(), fvcDdtPhiCorr(), fvcDdtPhiCorr(), fvcDdtUfCorr(), fvcDdtUfCorr(), ocCoeff(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ocCoeff()

template<class Type>

scalar ocCoeff ( ) const

inline

Return the current off-centreing coefficient.

Definition at line 276 of file CrankNicolsonDdtScheme.H.

References mesh().

Referenced by CrankNicolsonDdtScheme().

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 330 of file CrankNicolsonDdtScheme.C.

References dimensioned< Type >::dimensions(), Foam::dimTime, mesh(), mesh, dimensioned< Type >::name(), tmp< T >::ref(), and timeName.

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 393 of file CrankNicolsonDdtScheme.C.

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

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 493 of file CrankNicolsonDdtScheme.C.

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

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

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

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 709 of file CrankNicolsonDdtScheme.C.

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

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 852 of file CrankNicolsonDdtScheme.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, Foam::fv::ff(), mesh, IOobject::name(), 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 941 of file CrankNicolsonDdtScheme.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, Foam::fv::ff(), mesh, IOobject::name(), 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 1029 of file CrankNicolsonDdtScheme.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, Foam::fv::ff(), mesh, IOobject::name(), 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 1125 of file CrankNicolsonDdtScheme.C.

References alpha, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVol, Foam::fv::ff(), mesh, IOobject::name(), 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 CrankNicolsonDdtScheme< Type >::fluxFieldType > fvcDdtUfCorr	(	const GeometricField< Type, fvPatchField, volMesh > &	U,
		const GeometricField< Type, fvsPatchField, surfaceMesh > &	Uf )

virtual

Implements ddtScheme< Type >.

Definition at line 1242 of file CrankNicolsonDdtScheme.C.

References 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 CrankNicolsonDdtScheme< Type >::fluxFieldType > fvcDdtPhiCorr	(	const GeometricField< Type, fvPatchField, volMesh > &	U,
		const fluxFieldType &	phi )

virtual

Implements ddtScheme< Type >.

Definition at line 1303 of file CrankNicolsonDdtScheme.C.

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

Here is the call graph for this function:

◆ fvcDdtUfCorr() [2/4]

template<class Type>

tmp< typename CrankNicolsonDdtScheme< 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 1366 of file CrankNicolsonDdtScheme.C.

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

Here is the call graph for this function:

◆ fvcDdtPhiCorr() [2/4]

template<class Type>

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

virtual

Implements ddtScheme< Type >.

Definition at line 1523 of file CrankNicolsonDdtScheme.C.

References Foam::abort(), Foam::dimArea, Foam::dimVelocity, Foam::fvc::dotInterpolate(), Foam::FatalError, FatalErrorInFunction, ddtScheme< Type >::fvcDdtPhiCoeff(), mesh(), mesh, GeometricField< Type, PatchField, GeoMesh >::null(), oldTime(), 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 > & vf )

virtual

Implements ddtScheme< Type >.

Definition at line 1668 of file CrankNicolsonDdtScheme.C.

References Foam::dimVolume, mesh, name, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, phi, and timeName.

◆ ddt0_()

template<class Type>

template<class GeoField>

CrankNicolsonDdtScheme< Type >::template DDt0Field< GeoField > & ddt0_	(	const word &	name,
		const dimensionSet &	dims )

Definition at line 95 of file CrankNicolsonDdtScheme.C.

References IOobjectOption::AUTO_WRITE, Foam::dimTime, mesh, IOobjectOption::MUST_READ, Foam::name(), IOobjectOption::NO_READ, IOobjectOption::REGISTER, runTime, regIOobject::store(), and timeName.

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/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H
src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.C

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ fluxFieldType

Constructor & Destructor Documentation

◆ CrankNicolsonDdtScheme() [1/2]

◆ CrankNicolsonDdtScheme() [2/2]

Member Function Documentation

◆ TypeName()

◆ mesh()

◆ ocCoeff()

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

◆ ddt0_()

◆ fvcDdtUfCorr() [3/4]

◆ fvcDdtPhiCorr() [3/4]

◆ fvcDdtUfCorr() [4/4]

◆ fvcDdtPhiCorr() [4/4]