Euler Class Reference

Euler-implicit integration scheme. More...

Inheritance diagram for Euler:
Collaboration diagram for Euler:

Public Member Functions

 TypeName ("Euler")
 Runtime type information. More...
 
 Euler ()
 Construct. More...
 
virtual autoPtr< integrationSchemeclone () const
 Construct and return clone. More...
 
virtual ~Euler ()
 Destructor. More...
 
virtual scalar dtEff (const scalar dt, const scalar Beta) const
 Return the integration effective time step. More...
 
virtual scalar sumDtEff (const scalar dt, const scalar Beta) const
 Return the integral of the effective time step (using an Euler. More...
 
- Public Member Functions inherited from integrationScheme
 TypeName ("integrationScheme")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, integrationScheme, word,(),())
 Declare runtime constructor selection table. More...
 
 integrationScheme ()
 Construct. More...
 
virtual ~integrationScheme ()
 Destructor. More...
 
template<class Type >
Type delta (const Type &phi, const scalar dt, const Type &Alpha, const scalar Beta) const
 Perform the integration. More...
 
template<class Type >
Type partialDelta (const Type &phi, const scalar dt, const Type &Alpha, const scalar Beta, const Type &alphai, const scalar betai) const
 Perform a part of the integration. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from integrationScheme
static autoPtr< integrationSchemeNew (const word &phiName, const dictionary &dict)
 Select an integration scheme. More...
 
template<class Type >
static Type explicitDelta (const Type &phi, const scalar dtEff, const Type &Alpha, const scalar Beta)
 Perform the integration explicitly. More...
 

Detailed Description

Euler-implicit integration scheme.

\[ \Delta \phi = (A - B \phi^n) \frac{\Delta t}{1 + B \Delta t} \]

Definition at line 51 of file Euler.H.

Constructor & Destructor Documentation

◆ Euler()

Euler ( )

Construct.

Definition at line 42 of file Euler.C.

Referenced by Euler::clone().

Here is the caller graph for this function:

◆ ~Euler()

~Euler ( )
virtual

Destructor.

Definition at line 48 of file Euler.C.

References Euler::dtEff().

Referenced by Euler::clone().

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

Member Function Documentation

◆ TypeName()

TypeName ( "Euler"  )

Runtime type information.

◆ clone()

virtual autoPtr<integrationScheme> clone ( ) const
inlinevirtual

Construct and return clone.

Implements integrationScheme.

Definition at line 67 of file Euler.H.

References Euler::dtEff(), Euler::Euler(), Euler::sumDtEff(), and Euler::~Euler().

Here is the call graph for this function:

◆ dtEff()

Foam::scalar dtEff ( const scalar  dt,
const scalar  Beta 
) const
virtual

Return the integration effective time step.

Implements integrationScheme.

Definition at line 55 of file Euler.C.

References Euler::sumDtEff().

Referenced by Euler::clone(), and Euler::~Euler().

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

◆ sumDtEff()

Foam::scalar sumDtEff ( const scalar  dt,
const scalar  Beta 
) const
virtual

Return the integral of the effective time step (using an Euler.

integration method)

Implements integrationScheme.

Definition at line 65 of file Euler.C.

References Foam::sqr().

Referenced by Euler::clone(), and Euler::dtEff().

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

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