localEulerDdtScheme< Type > Class Template Reference

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 SurfaceField< typename flux< Type >::typefluxFieldType
 

Public Member Functions

 TypeName ("localEuler")
 Runtime type information. More...
 
 localEulerDdtScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
 localEulerDdtScheme (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 localEulerDdtScheme (const localEulerDdtScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual tmp< VolField< Type > > fvcDdt (const dimensioned< Type > &)
 
virtual tmp< VolField< Type > > fvcDdt (const VolField< Type > &)
 
virtual tmp< VolField< Type > > fvcDdt (const dimensionedScalar &, const VolField< Type > &)
 
virtual tmp< VolField< Type > > fvcDdt (const volScalarField &, const VolField< Type > &)
 
virtual tmp< VolField< Type > > fvcDdt (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &psi)
 
virtual tmp< SurfaceField< Type > > fvcDdt (const SurfaceField< Type > &)
 
virtual tmp< fvMatrix< Type > > fvmDdt (const VolField< Type > &)
 
virtual tmp< fvMatrix< Type > > fvmDdt (const dimensionedScalar &, const VolField< Type > &)
 
virtual tmp< fvMatrix< Type > > fvmDdt (const volScalarField &, const VolField< Type > &)
 
virtual tmp< fvMatrix< Type > > fvmDdt (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &psi)
 
virtual tmp< fluxFieldTypefvcDdtUfCorr (const VolField< Type > &U, const SurfaceField< Type > &Uf)
 
virtual tmp< fluxFieldTypefvcDdtPhiCorr (const VolField< Type > &U, const fluxFieldType &phi)
 
virtual tmp< fluxFieldTypefvcDdtUfCorr (const volScalarField &rho, const VolField< Type > &U, const SurfaceField< Type > &rhoUf)
 
virtual tmp< fluxFieldTypefvcDdtPhiCorr (const volScalarField &rho, const VolField< Type > &U, const fluxFieldType &phi)
 
virtual tmp< fluxFieldTypefvcDdtUfCorr (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &U, const SurfaceField< Type > &Uf)
 
virtual tmp< fluxFieldTypefvcDdtPhiCorr (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &U, const fluxFieldType &phi)
 
virtual tmp< surfaceScalarFieldmeshPhi (const VolField< Type > &)
 
virtual tmp< scalarFieldmeshPhi (const VolField< Type > &, const label patchi)
 
void operator= (const localEulerDdtScheme &)=delete
 Disallow default bitwise assignment. More...
 
tmp< surfaceScalarFieldfvcDdtUfCorr (const VolField< scalar > &U, const SurfaceField< scalar > &Uf)
 
tmp< surfaceScalarFieldfvcDdtPhiCorr (const volScalarField &U, const surfaceScalarField &phi)
 
tmp< surfaceScalarFieldfvcDdtUfCorr (const volScalarField &rho, const volScalarField &U, const surfaceScalarField &Uf)
 
tmp< surfaceScalarFieldfvcDdtPhiCorr (const volScalarField &rho, const volScalarField &U, const surfaceScalarField &phi)
 
tmp< surfaceScalarFieldfvcDdtUfCorr (const volScalarField &alpha, const volScalarField &rho, const volScalarField &U, const surfaceScalarField &Uf)
 
tmp< surfaceScalarFieldfvcDdtPhiCorr (const volScalarField &alpha, const volScalarField &rho, const volScalarField &U, const surfaceScalarField &phi)
 
tmp< surfaceScalarFieldfvcDdtUfCorr (const volScalarField &alpha, const volScalarField &rho, const volScalarField &U, const surfaceScalarField &Uf)
 
tmp< surfaceScalarFieldfvcDdtPhiCorr (const volScalarField &alpha, 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 wordtype () 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...
 
 ddtScheme (const ddtScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~ddtScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual tmp< surfaceScalarFieldfvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr)
 
virtual tmp< surfaceScalarFieldfvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr, const volScalarField &rho)
 
virtual tmp< surfaceScalarFieldfvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi)
 
virtual tmp< surfaceScalarFieldfvcDdtPhiCoeff (const VolField< Type > &U, const fluxFieldType &phi, const volScalarField &rho)
 
void operator= (const ddtScheme &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from localEulerDdt
static bool enabled (const fvMesh &mesh)
 Return true if LTS is enabled. More...
 
static const volScalarFieldlocalRDeltaT (const fvMesh &mesh)
 Return the reciprocal of the local time-step. More...
 
static const surfaceScalarFieldlocalRDeltaTf (const fvMesh &mesh)
 Return the reciprocal of the local face time-step. More...
 
static tmp< volScalarFieldlocalRSubDeltaT (const fvMesh &mesh, const label nAlphaSubCycles)
 Calculate and return the reciprocal of the local sub-cycling. More...
 
- 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...
 
- Static Public Attributes inherited from localEulerDdt
static word rDeltaTName
 Name of the reciprocal local time-step field. More...
 
static word rDeltaTfName
 Name of the reciprocal local face time-step field. More...
 
static word rSubDeltaTName
 Name of the reciprocal local sub-cycling time-step field. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from ddtScheme< Type >
const fvMeshmesh_
 

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

Member Typedef Documentation

◆ fluxFieldType

Definition at line 212 of file localEulerDdtScheme.H.

Constructor & Destructor Documentation

◆ localEulerDdtScheme() [1/3]

localEulerDdtScheme ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 135 of file localEulerDdtScheme.H.

◆ localEulerDdtScheme() [2/3]

localEulerDdtScheme ( const fvMesh mesh,
Istream is 
)
inline

Construct from mesh and Istream.

Definition at line 141 of file localEulerDdtScheme.H.

◆ localEulerDdtScheme() [3/3]

localEulerDdtScheme ( const localEulerDdtScheme< Type > &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "localEuler"  )

Runtime type information.

◆ fvcDdt() [1/6]

tmp< VolField< Type > > fvcDdt ( const dimensioned< Type > &  dt)
virtual

◆ fvcDdt() [2/6]

tmp< VolField< Type > > fvcDdt ( const VolField< Type > &  vf)
virtual

Implements ddtScheme< Type >.

Definition at line 85 of file localEulerDdtScheme.C.

References IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and OldTimeField< FieldType >::oldTime().

Here is the call graph for this function:

◆ fvcDdt() [3/6]

tmp< VolField< Type > > fvcDdt ( const dimensionedScalar rho,
const VolField< Type > &  vf 
)
virtual

Implements ddtScheme< Type >.

Definition at line 107 of file localEulerDdtScheme.C.

References IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), OldTimeField< FieldType >::oldTime(), and rho.

Here is the call graph for this function:

◆ fvcDdt() [4/6]

tmp< VolField< Type > > fvcDdt ( const volScalarField rho,
const VolField< Type > &  vf 
)
virtual

Implements ddtScheme< Type >.

Definition at line 130 of file localEulerDdtScheme.C.

References IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), OldTimeField< FieldType >::oldTime(), and rho.

Here is the call graph for this function:

◆ fvcDdt() [5/6]

tmp< VolField< Type > > fvcDdt ( const volScalarField alpha,
const volScalarField rho,
const VolField< Type > &  psi 
)
virtual

Implements ddtScheme< Type >.

Definition at line 153 of file localEulerDdtScheme.C.

References alpha(), IOobject::name(), GeometricField< Type, PatchField, GeoMesh >::New(), OldTimeField< FieldType >::oldTime(), and rho.

Here is the call graph for this function:

◆ fvcDdt() [6/6]

tmp< SurfaceField< Type > > fvcDdt ( const SurfaceField< Type > &  sf)
virtual

Reimplemented from ddtScheme< Type >.

Definition at line 181 of file localEulerDdtScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::New(), and sf().

Here is the call graph for this function:

◆ fvmDdt() [1/4]

tmp< fvMatrix< Type > > fvmDdt ( const VolField< Type > &  vf)
virtual

◆ fvmDdt() [2/4]

tmp< fvMatrix< Type > > fvmDdt ( const dimensionedScalar rho,
const VolField< Type > &  vf 
)
virtual

◆ fvmDdt() [3/4]

tmp< fvMatrix< Type > > fvmDdt ( const volScalarField rho,
const VolField< Type > &  vf 
)
virtual

◆ fvmDdt() [4/4]

tmp< fvMatrix< Type > > fvmDdt ( const volScalarField alpha,
const volScalarField rho,
const VolField< Type > &  psi 
)
virtual

◆ fvcDdtUfCorr() [1/7]

tmp< typename localEulerDdtScheme< Type >::fluxFieldType > fvcDdtUfCorr ( const VolField< Type > &  U,
const SurfaceField< Type > &  Uf 
)
virtual

Implements ddtScheme< Type >.

Definition at line 369 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), Foam::fvc::interpolate(), IOobject::name(), Foam::name(), OldTimeField< FieldType >::oldTime(), and U.

Here is the call graph for this function:

◆ fvcDdtPhiCorr() [1/7]

tmp< typename localEulerDdtScheme< Type >::fluxFieldType > fvcDdtPhiCorr ( const VolField< Type > &  U,
const fluxFieldType phi 
)
virtual

Implements ddtScheme< Type >.

Definition at line 402 of file localEulerDdtScheme.C.

References Foam::fvc::dotInterpolate(), Foam::fvc::interpolate(), IOobject::name(), Foam::name(), OldTimeField< FieldType >::oldTime(), and U.

Here is the call graph for this function:

◆ fvcDdtUfCorr() [2/7]

tmp< typename localEulerDdtScheme< Type >::fluxFieldType > fvcDdtUfCorr ( const volScalarField rho,
const VolField< Type > &  U,
const SurfaceField< Type > &  rhoUf 
)
virtual

◆ fvcDdtPhiCorr() [2/7]

◆ fvcDdtUfCorr() [3/7]

tmp< typename localEulerDdtScheme< Type >::fluxFieldType > fvcDdtUfCorr ( const volScalarField alpha,
const volScalarField rho,
const VolField< Type > &  U,
const SurfaceField< Type > &  Uf 
)
virtual

◆ fvcDdtPhiCorr() [3/7]

◆ meshPhi() [1/2]

tmp< surfaceScalarField > meshPhi ( const VolField< Type > &  )
virtual

Implements ddtScheme< Type >.

Definition at line 692 of file localEulerDdtScheme.C.

References Foam::dimTime, Foam::dimVolume, and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ meshPhi() [2/2]

tmp< scalarField > meshPhi ( const VolField< Type > &  ,
const label  patchi 
)
virtual

Implements ddtScheme< Type >.

Definition at line 707 of file localEulerDdtScheme.C.

References boundary(), and patchi.

Here is the call graph for this function:

◆ operator=()

void operator= ( const localEulerDdtScheme< Type > &  )
delete

Disallow default bitwise assignment.

◆ fvcDdtUfCorr() [4/7]

tmp< surfaceScalarField > fvcDdtUfCorr ( const VolField< scalar > &  U,
const SurfaceField< scalar > &  Uf 
)

◆ fvcDdtPhiCorr() [4/7]

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

◆ fvcDdtUfCorr() [5/7]

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

◆ fvcDdtPhiCorr() [5/7]

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

◆ fvcDdtUfCorr() [6/7]

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

◆ fvcDdtPhiCorr() [6/7]

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

◆ fvcDdtUfCorr() [7/7]

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

◆ fvcDdtPhiCorr() [7/7]

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

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