ddtScheme< Type > Class Template Referenceabstract

Abstract base class for Lagrangian ddt schemes. More...

Inheritance diagram for ddtScheme< Type >:
Collaboration diagram for ddtScheme< Type >:

Public Member Functions

 TypeName ("ddtScheme")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, ddtScheme, Istream,(const LagrangianMesh &mesh, Istream &is),(mesh, is))
 Declare run-time constructor selection tables. More...
 
 ddtScheme (const LagrangianMesh &mesh)
 Construct from a mesh. More...
 
 ddtScheme (const LagrangianMesh &mesh, Istream &)
 Construct from a mesh and a stream. More...
 
 ddtScheme (const ddtScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~ddtScheme ()
 Destructor. More...
 
const LagrangianMeshmesh () const
 Return mesh reference. More...
 
virtual bool LagrangianmInitDdt (const dimensionSet &mDims, const LagrangianSubSubField< Type > &psi, const bool instantaneousDdt)=0
 Initialise time-derivative information. More...
 
virtual tmp< LagrangianEqn< Type > > LagrangianmNoDdt (const LagrangianSubScalarField &deltaT, const dimensionSet &mDims, const LagrangianSubSubField< Type > &psi)=0
 Return the no-time-derivative matrix. More...
 
virtual tmp< LagrangianEqn< Type > > LagrangianmDdt (const LagrangianSubScalarField &deltaT, LagrangianSubSubField< Type > &psi)=0
 Return the time-derivative matrix. More...
 
virtual tmp< LagrangianEqn< Type > > LagrangianmDdt (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &m, LagrangianSubSubField< Type > &psi)=0
 Return the time-derivative matrix. More...
 
virtual tmp< LagrangianSubField< Type > > LagrangiancDdt (const LagrangianSubSubField< Type > &psi)=0
 Return the instantaneous time-derivative. More...
 
virtual tmp< LagrangianSubField< Type > > LagrangiancDdt (const LagrangianSubScalarSubField &m, const LagrangianSubSubField< Type > &psi)=0
 Return the instantaneous time-derivative. More...
 
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...
 

Static Public Member Functions

static tmp< ddtScheme< Type > > New (const LagrangianMesh &mesh, Istream &is)
 Return a pointer to a new ddtScheme. More...
 
static tmp< LagrangianEqn< Type > > Lagrangianmddt (const LagrangianSubScalarField &deltaT, const LagrangianSubSubField< Type > &psi)
 Return the time-derivative matrix. More...
 
static tmp< LagrangianEqn< Type > > Lagrangianmddt (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &m, const LagrangianSubSubField< Type > &psi)
 Return the time-derivative matrix. More...
 
static tmp< LagrangianEqn< Type > > Lagrangianmddt0 (const LagrangianSubScalarField &deltaT, const LagrangianSubSubField< Type > &psi)
 Return the explicit/forward time-derivative matrix. More...
 
static tmp< LagrangianEqn< Type > > Lagrangianmddt0 (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &m, const LagrangianSubSubField< Type > &psi)
 Return the explicit/forward time-derivative matrix. More...
 

Protected Attributes

const LagrangianMeshmesh_
 Reference to the mesh. More...
 

Additional Inherited Members

- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 

Detailed Description

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

Abstract base class for Lagrangian ddt schemes.

Source files

Definition at line 62 of file LagrangianDdtScheme.H.

Constructor & Destructor Documentation

◆ ddtScheme() [1/3]

ddtScheme ( const LagrangianMesh mesh)
inline

Construct from a mesh.

Definition at line 94 of file LagrangianDdtScheme.H.

◆ ddtScheme() [2/3]

ddtScheme ( const LagrangianMesh mesh,
Istream  
)
inline

Construct from a mesh and a stream.

Definition at line 100 of file LagrangianDdtScheme.H.

◆ ddtScheme() [3/3]

ddtScheme ( const ddtScheme< Type > &  )
delete

Disallow default bitwise copy construction.

◆ ~ddtScheme()

~ddtScheme
virtual

Destructor.

Definition at line 69 of file LagrangianDdtScheme.C.

Member Function Documentation

◆ TypeName()

TypeName ( "ddtScheme< Type >"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( tmp  ,
ddtScheme< Type >  ,
Istream  ,
(const LagrangianMesh &mesh, Istream &is)  ,
(mesh, is)   
)

Declare run-time constructor selection tables.

◆ New()

Foam::tmp< Foam::Lagrangian::ddtScheme< Type > > New ( const LagrangianMesh mesh,
Istream is 
)
static

Return a pointer to a new ddtScheme.

Definition at line 33 of file LagrangianDdtScheme.C.

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

Here is the call graph for this function:

◆ mesh()

const LagrangianMesh& mesh ( ) const
inline

Return mesh reference.

Definition at line 126 of file LagrangianDdtScheme.H.

References ddtScheme< Type >::mesh_.

◆ LagrangianmInitDdt()

virtual bool LagrangianmInitDdt ( const dimensionSet mDims,
const LagrangianSubSubField< Type > &  psi,
const bool  instantaneousDdt 
)
pure virtual

Initialise time-derivative information.

Implemented in Euler< Type >, and CrankNicolson< Type >.

◆ LagrangianmNoDdt()

virtual tmp<LagrangianEqn<Type> > LagrangianmNoDdt ( const LagrangianSubScalarField deltaT,
const dimensionSet mDims,
const LagrangianSubSubField< Type > &  psi 
)
pure virtual

Return the no-time-derivative matrix.

Implemented in Euler< Type >, and CrankNicolson< Type >.

◆ LagrangianmDdt() [1/2]

virtual tmp<LagrangianEqn<Type> > LagrangianmDdt ( const LagrangianSubScalarField deltaT,
LagrangianSubSubField< Type > &  psi 
)
pure virtual

Return the time-derivative matrix.

Implemented in Euler< Type >, and CrankNicolson< Type >.

◆ LagrangianmDdt() [2/2]

virtual tmp<LagrangianEqn<Type> > LagrangianmDdt ( const LagrangianSubScalarField deltaT,
const LagrangianSubScalarSubField m,
LagrangianSubSubField< Type > &  psi 
)
pure virtual

Return the time-derivative matrix.

Implemented in Euler< Type >, and CrankNicolson< Type >.

◆ LagrangiancDdt() [1/2]

virtual tmp<LagrangianSubField<Type> > LagrangiancDdt ( const LagrangianSubSubField< Type > &  psi)
pure virtual

Return the instantaneous time-derivative.

Implemented in Euler< Type >, and CrankNicolson< Type >.

◆ LagrangiancDdt() [2/2]

virtual tmp<LagrangianSubField<Type> > LagrangiancDdt ( const LagrangianSubScalarSubField m,
const LagrangianSubSubField< Type > &  psi 
)
pure virtual

Return the instantaneous time-derivative.

Implemented in Euler< Type >, and CrankNicolson< Type >.

◆ Lagrangianmddt() [1/2]

Foam::tmp< Foam::LagrangianEqn< Type > > Lagrangianmddt ( const LagrangianSubScalarField deltaT,
const LagrangianSubSubField< Type > &  psi 
)
static

Return the time-derivative matrix.

Definition at line 77 of file LagrangianDdtScheme.C.

References psi, and tmp< T >::ref().

Here is the call graph for this function:

◆ Lagrangianmddt() [2/2]

Foam::tmp< Foam::LagrangianEqn< Type > > Lagrangianmddt ( const LagrangianSubScalarField deltaT,
const LagrangianSubScalarSubField m,
const LagrangianSubSubField< Type > &  psi 
)
static

Return the time-derivative matrix.

Definition at line 94 of file LagrangianDdtScheme.C.

References OldTimeField< FieldType >::oldTime(), psi, and tmp< T >::ref().

Here is the call graph for this function:

◆ Lagrangianmddt0() [1/2]

Foam::tmp< Foam::LagrangianEqn< Type > > Lagrangianmddt0 ( const LagrangianSubScalarField deltaT,
const LagrangianSubSubField< Type > &  psi 
)
static

Return the explicit/forward time-derivative matrix.

Definition at line 112 of file LagrangianDdtScheme.C.

References psi, and tmp< T >::ref().

Here is the call graph for this function:

◆ Lagrangianmddt0() [2/2]

Foam::tmp< Foam::LagrangianEqn< Type > > Lagrangianmddt0 ( const LagrangianSubScalarField deltaT,
const LagrangianSubScalarSubField m,
const LagrangianSubSubField< Type > &  psi 
)
static

Return the explicit/forward time-derivative matrix.

Definition at line 128 of file LagrangianDdtScheme.C.

References OldTimeField< FieldType >::oldTime(), psi, and tmp< T >::ref().

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.

Member Data Documentation

◆ mesh_

const LagrangianMesh& mesh_
protected

Reference to the mesh.

Definition at line 71 of file LagrangianDdtScheme.H.

Referenced by ddtScheme< Type >::mesh().


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