analytical Class Reference

Analytical integration scheme. More...

Inheritance diagram for analytical:
[legend]
Collaboration diagram for analytical:
[legend]

Public Member Functions

 TypeName ("analytical")
 Runtime type information. More...
 
 analytical ()
 Construct. More...
 
virtual autoPtr< integrationSchemeclone () const
 Construct and return clone. More...
 
virtual ~analytical ()
 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. 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 autoPtr< integrationSchemeclone () const =0
 Construct and return clone. 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...
 
virtual scalar dtEff (const scalar dt, const scalar Beta) const =0
 Return the integration effective time step. More...
 
virtual scalar sumDtEff (const scalar dt, const scalar Beta) const =0
 Return the integral of the effective time step. 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

Analytical integration scheme.

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

Definition at line 53 of file analytical.H.

Constructor & Destructor Documentation

◆ analytical()

Construct.

Definition at line 44 of file analytical.C.

Referenced by analytical::clone().

Here is the caller graph for this function:

◆ ~analytical()

~analytical ( )
virtual

Destructor.

Definition at line 50 of file analytical.C.

Member Function Documentation

◆ TypeName()

TypeName ( "analytical"  )

Runtime type information.

◆ clone()

virtual autoPtr< integrationScheme > clone ( ) const
inlinevirtual

Construct and return clone.

Implements integrationScheme.

Definition at line 69 of file analytical.H.

References analytical::analytical().

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 56 of file analytical.C.

References Foam::exp(), and Foam::mag().

Here is the call graph for this function:

◆ sumDtEff()

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

Return the integral of the effective time step.

Implements integrationScheme.

Definition at line 69 of file analytical.C.

References Foam::exp(), Foam::mag(), and Foam::sqr().

Here is the call graph for this function:

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