Loading...
Searching...
No Matches
ddtScheme< Type > Class Template Referenceabstract
Numerics » Finite volume numerical schemes » Time schemes

Abstract base class for ddt schemes. More...

#include <ddtScheme.H>

Inheritance diagram for ddtScheme< Type >:
Inheritance graph
[legend]
Collaboration diagram for ddtScheme< Type >:
Collaboration graph
[legend]

Public Types

typedef GeometricField< typename flux< Type >::type, fvsPatchField, surfaceMesh > fluxFieldType

Public Member Functions

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, fvPatchField, volMesh > > fvcDdt (const dimensioned< Type > &)=0
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt (const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt (const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt (const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > fvcDdt (const GeometricField< Type, fvsPatchField, surfaceMesh > &)
virtual tmp< fvMatrix< Type > > fvmDdt (const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< fvMatrix< Type > > fvmDdt (const dimensionedScalar &, const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< fvMatrix< Type > > fvmDdt (const volScalarField &, const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual tmp< fvMatrix< Type > > fvmDdt (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &vf)=0
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)
virtual tmp< fluxFieldType > fvcDdtUfCorr (const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)=0
virtual tmp< fluxFieldType > fvcDdtPhiCorr (const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)=0
virtual tmp< fluxFieldType > fvcDdtUfCorr (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)=0
virtual tmp< fluxFieldType > fvcDdtPhiCorr (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)=0
virtual tmp< surfaceScalarField > meshPhi (const GeometricField< Type, fvPatchField, volMesh > &)=0
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 ()

Static Public Member Functions

static tmp< ddtScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return a pointer to a new ddtScheme created on freestore.

Protected Member Functions

 ddtScheme (const ddtScheme &)=delete
 No copy construct.
void operator= (const ddtScheme &)=delete
 No copy assignment.

Protected Attributes

const fvMesh & mesh_
scalar ddtPhiCoeff_
 Input for fvcDdtPhiCoeff.

Additional Inherited Members

Static Public Attributes inherited from ddtSchemeBase
static bool experimentalDdtCorr
 Flag to use experimental ddtCorr from org version Default is off for backwards compatibility.

Detailed Description

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

Abstract base class for ddt schemes.

Source files

Definition at line 81 of file ddtScheme.H.

Member Typedef Documentation

◆ fluxFieldType

template<class Type>
typedef GeometricField< typename flux<Type>::type, fvsPatchField, surfaceMesh > fluxFieldType

Definition at line 247 of file ddtScheme.H.

Constructor & Destructor Documentation

◆ ddtScheme() [1/3]

template<class Type>
ddtScheme ( const ddtScheme< Type > & )
protecteddelete

No copy construct.

Referenced by backwardDdtScheme< Type >::backwardDdtScheme(), backwardDdtScheme< Type >::backwardDdtScheme(), boundedDdtScheme< Type >::boundedDdtScheme(), CoEulerDdtScheme< Type >::CoEulerDdtScheme(), CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), EulerDdtScheme< Type >::EulerDdtScheme(), EulerDdtScheme< Type >::EulerDdtScheme(), localEulerDdtScheme< Type >::localEulerDdtScheme(), localEulerDdtScheme< Type >::localEulerDdtScheme(), SLTSDdtScheme< Type >::SLTSDdtScheme(), steadyStateDdtScheme< Type >::steadyStateDdtScheme(), and steadyStateDdtScheme< Type >::steadyStateDdtScheme().

Here is the caller graph for this function:

◆ ddtScheme() [2/3]

template<class Type>
ddtScheme ( const fvMesh & mesh)
inline

Construct from mesh.

Definition at line 140 of file ddtScheme.H.

◆ ddtScheme() [3/3]

template<class Type>
ddtScheme ( const fvMesh & mesh,
Istream & is )
inline

Construct from mesh and Istream.

Definition at line 149 of file ddtScheme.H.

◆ ~ddtScheme()

template<class Type>
virtual ~ddtScheme ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

template<class Type>
void operator= ( const ddtScheme< Type > & )
protecteddelete

No copy assignment.

◆ type()

template<class Type>
virtual const word & type ( ) const
pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class Type>
declareRunTimeSelectionTable ( tmp ,
ddtScheme< Type > ,
Istream ,
(const fvMesh &mesh, Istream &schemeData) ,
(mesh, schemeData)  )

◆ New()

template<class Type>
tmp< ddtScheme< Type > > New ( const fvMesh & mesh,
Istream & schemeData )
static

Return a pointer to a new ddtScheme created on freestore.

Definition at line 42 of file ddtScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, InfoInFunction, and mesh().

Referenced by boundedDdtScheme< Type >::boundedDdtScheme(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvm::ddt(), Foam::fvm::ddt(), Foam::fvm::ddt(), Foam::fvm::ddt(), Foam::fvc::ddtCorr(), Foam::fvc::ddtCorr(), Foam::fvc::ddtCorr(), Foam::fvc::ddtCorr(), Foam::fvc::meshPhi(), Foam::fvc::meshPhi(), and Foam::fvc::meshPhi().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mesh()

template<class Type>
const fvMesh & mesh ( ) const
inline

Return mesh reference.

Definition at line 179 of file ddtScheme.H.

Referenced by fvcDdtPhiCoeff(), fvcDdtPhiCoeffExperimental(), backwardDdtScheme< Type >::mesh(), boundedDdtScheme< Type >::mesh(), CoEulerDdtScheme< Type >::mesh(), CrankNicolsonDdtScheme< Type >::mesh(), EulerDdtScheme< Type >::mesh(), localEulerDdtScheme< Type >::mesh(), SLTSDdtScheme< Type >::mesh(), steadyStateDdtScheme< Type >::mesh(), and New().

Here is the caller graph for this function:

◆ fvcDdt() [1/6]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdt() [2/6]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdt() [3/6]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdt() [4/6]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdt() [5/6]

template<class Type>
tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt ( const volScalarField & alpha,
const volScalarField & rho,
const GeometricField< Type, fvPatchField, volMesh > & vf )
pure virtual

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

Definition at line 84 of file ddtScheme.C.

References alpha, NotImplemented, and rho.

◆ fvcDdt() [6/6]

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

Reimplemented in EulerDdtScheme< Type >, and localEulerDdtScheme< Type >.

Definition at line 110 of file ddtScheme.C.

References NotImplemented.

◆ fvmDdt() [1/4]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvmDdt() [2/4]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvmDdt() [3/4]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvmDdt() [4/4]

template<class Type>
tmp< fvMatrix< Type > > fvmDdt ( const volScalarField & alpha,
const volScalarField & rho,
const GeometricField< Type, fvPatchField, volMesh > & vf )
pure virtual

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

Definition at line 97 of file ddtScheme.C.

References alpha, NotImplemented, and rho.

◆ fvcDdtPhiCoeff() [1/4]

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

Definition at line 121 of file ddtScheme.C.

References boundary, GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), ddtPhiCoeff_, Foam::dimless, Foam::endl(), forAll, Foam::gAverage(), Foam::gMinMax(), InfoInFunction, Foam::isA(), limits, Foam::mag(), mesh(), Foam::min(), phi, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), and U.

Referenced by fvcDdtPhiCoeff(), fvcDdtPhiCoeff(), fvcDdtPhiCoeff(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtUfCorr(), backwardDdtScheme< Type >::fvcDdtUfCorr(), CoEulerDdtScheme< Type >::fvcDdtUfCorr(), CoEulerDdtScheme< Type >::fvcDdtUfCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr(), EulerDdtScheme< Type >::fvcDdtUfCorr(), EulerDdtScheme< Type >::fvcDdtUfCorr(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), SLTSDdtScheme< Type >::fvcDdtUfCorr(), and SLTSDdtScheme< Type >::fvcDdtUfCorr().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fvcDdtPhiCoeffExperimental()

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

Definition at line 195 of file ddtScheme.C.

References boundary, GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), ddtPhiCoeff_, Foam::dimless, Foam::endl(), forAll, Foam::gAverage(), Foam::gMinMax(), InfoInFunction, Foam::isA(), limits, Foam::mag(), mesh(), mesh, Foam::min(), phi, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), DimensionedField< Type, GeoMesh >::setOriented(), and U.

Referenced by fvcDdtPhiCoeff(), fvcDdtPhiCoeff(), and fvcDdtPhiCoeff().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fvcDdtPhiCoeff() [2/4]

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

Definition at line 276 of file ddtScheme.C.

References ddtSchemeBase::experimentalDdtCorr, fvcDdtPhiCoeff(), fvcDdtPhiCoeffExperimental(), Foam::fvc::interpolate(), phi, rho, and U.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [3/4]

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

Definition at line 302 of file ddtScheme.C.

References Foam::fvc::dotInterpolate(), ddtSchemeBase::experimentalDdtCorr, fvcDdtPhiCoeff(), fvcDdtPhiCoeffExperimental(), mesh, phi, and U.

Here is the call graph for this function:

◆ fvcDdtPhiCoeff() [4/4]

template<class Type>
tmp< surfaceScalarField > fvcDdtPhiCoeff ( const GeometricField< Type, fvPatchField, volMesh > & rhoU,
const fluxFieldType & phi,
const volScalarField & rho )

Definition at line 332 of file ddtScheme.C.

References Foam::fvc::dotInterpolate(), ddtSchemeBase::experimentalDdtCorr, fvcDdtPhiCoeff(), fvcDdtPhiCoeffExperimental(), Foam::fvc::interpolate(), mesh, phi, and rho.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [1/2]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdtPhiCorr() [1/2]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdtUfCorr() [2/2]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ fvcDdtPhiCorr() [2/2]

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

◆ meshPhi()

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

Implemented in backwardDdtScheme< Type >, boundedDdtScheme< Type >, CoEulerDdtScheme< Type >, CrankNicolsonDdtScheme< Type >, EulerDdtScheme< Type >, localEulerDdtScheme< Type >, SLTSDdtScheme< Type >, and steadyStateDdtScheme< Type >.

Member Data Documentation

◆ mesh_

template<class Type>
const fvMesh& mesh_
protected

Definition at line 91 of file ddtScheme.H.

◆ ddtPhiCoeff_

template<class Type>
scalar ddtPhiCoeff_
protected

Input for fvcDdtPhiCoeff.

If set to -1 (default) the code will calculate the coefficient If > 0 the coupling coeff is set to this value

Definition at line 99 of file ddtScheme.H.

Referenced by fvcDdtPhiCoeff(), and fvcDdtPhiCoeffExperimental().

The documentation for this class was generated from the following files:
  • src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.H
  • src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.C