seulex Class Reference

An extrapolation-algorithm, based on the linearly implicit Euler method with step size control and order selection. More...

Inheritance diagram for seulex:
Collaboration diagram for seulex:

Public Member Functions

 TypeName ("seulex")
 Runtime type information. More...
 
 seulex (const ODESystem &ode, const dictionary &dict)
 Construct from ODESystem. More...
 
virtual ~seulex ()
 Destructor. More...
 
virtual bool resize ()
 Resize the ODE solver. More...
 
virtual void solve (scalar &x, scalarField &y, const label li, stepState &step) const
 Solve the ODE system and the update the state. More...
 
- Public Member Functions inherited from ODESolver
 TypeName ("ODESolver")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, ODESolver, dictionary,(const ODESystem &ode, const dictionary &dict),(ode, dict))
 
 ODESolver (const ODESystem &ode, const dictionary &dict)
 Construct for given ODESystem. More...
 
 ODESolver (const ODESystem &ode, const scalarField &absTol, const scalarField &relTol)
 Construct for given ODESystem specifying tolerances. More...
 
 ODESolver (const ODESolver &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~ODESolver ()
 Destructor. More...
 
label nEqns () const
 Return the number of equations to solve. More...
 
scalarFieldabsTol ()
 Return access to the absolute tolerance field. More...
 
scalarFieldrelTol ()
 Return access to the relative tolerance field. More...
 
template<class Type >
void resizeField (UList< Type > &f) const
 
void resizeMatrix (scalarSquareMatrix &m) const
 
virtual void solve (scalar &x, scalarField &y, const label li, scalar &dxTry) const
 Solve the ODE system from the current state xStart, y. More...
 
virtual void solve (const scalar xStart, const scalar xEnd, scalarField &y, const label li, scalar &dxEst) const
 Solve the ODE system from the current state xStart, y. More...
 
void operator= (const ODESolver &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ODESolver
static autoPtr< ODESolverNew (const ODESystem &ode, const dictionary &dict)
 Select null constructed. More...
 
template<class Type >
static void resizeField (UList< Type > &f, const label n)
 
- Protected Member Functions inherited from ODESolver
scalar normaliseError (const scalarField &y0, const scalarField &y, const scalarField &err) const
 Return the normalised scalar error. More...
 
- Protected Attributes inherited from ODESolver
const ODESystemodes_
 Reference to ODESystem. More...
 
const label maxN_
 Maximum size of the ODESystem. More...
 
label n_
 Size of the ODESystem (adjustable) More...
 
scalarField absTol_
 Absolute convergence tolerance per step. More...
 
scalarField relTol_
 Relative convergence tolerance per step. More...
 
label maxSteps_
 The maximum number of sub-steps allowed for the integration step. More...
 

Detailed Description

An extrapolation-algorithm, based on the linearly implicit Euler method with step size control and order selection.

Reference:

    Hairer, E., Nørsett, S. P., & Wanner, G. (1996).
    Solving Ordinary Differential Equations II:
    Stiff and Differential-Algebraic Problems, second edition",
    Springer-Verlag, Berlin.
Source files

Definition at line 59 of file seulex.H.

Constructor & Destructor Documentation

◆ seulex()

seulex ( const ODESystem ode,
const dictionary dict 
)

Construct from ODESystem.

Definition at line 50 of file seulex.C.

References k.

◆ ~seulex()

virtual ~seulex ( )
inlinevirtual

Destructor.

Definition at line 139 of file seulex.H.

Member Function Documentation

◆ TypeName()

TypeName ( "seulex"  )

Runtime type information.

◆ resize()

bool resize ( )
virtual

Resize the ODE solver.

Implements ODESolver.

Definition at line 221 of file seulex.C.

References ODESolver::resize().

Here is the call graph for this function:

◆ solve()

void solve ( scalar &  x,
scalarField y,
const label  li,
stepState step 
) const
virtual

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