Public Member Functions | List of all members
Rosenbrock34 Class Reference

L-stable embedded Rosenbrock ODE solver of order (3)4. More...

Inheritance diagram for Rosenbrock34:
Inheritance graph
[legend]
Collaboration diagram for Rosenbrock34:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("Rosenbrock34")
 Runtime type information. More...
 
 Rosenbrock34 (const ODESystem &ode, const dictionary &dict)
 Construct from ODESystem. More...
 
virtual ~Rosenbrock34 ()
 Destructor. More...
 
virtual bool resize ()
 Resize the ODE solver. More...
 
virtual scalar solve (const scalar x0, const scalarField &y0, const scalarField &dydx0, const scalar dx, scalarField &y) const
 Solve a single step dx and return the error. More...
 
virtual void solve (scalar &x, scalarField &y, scalar &dxTry) 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...
 
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, stepState &step) const
 Solve the ODE system as far as possible up to dxTry. More...
 
virtual void solve (const scalar xStart, const scalar xEnd, scalarField &y, scalar &dxEst) const
 Solve the ODE system from xStart to xEnd, update the state. More...
 
- Public Member Functions inherited from adaptiveSolver
 adaptiveSolver (const ODESystem &ode, const dictionary &dict)
 Construct from ODESystem. More...
 
virtual ~adaptiveSolver ()
 Destructor. More...
 
bool resize (const label n)
 Resize the ODE solver. More...
 
void solve (const ODESystem &ode, scalar &x, scalarField &y, scalar &dxTry) const
 Solve the ODE system and the update the state. 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 normalizeError (const scalarField &y0, const scalarField &y, const scalarField &err) const
 Return the nomalized scalar error. More...
 
 ODESolver (const ODESolver &)
 Disallow default bitwise copy construct. More...
 
void operator= (const ODESolver &)
 Disallow default bitwise assignment. 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

L-stable embedded Rosenbrock ODE solver of order (3)4.

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

The default constants are from:

    Shampine, L. F. (1982).
    Implementation of Rosenbrock Methods.
    ACM Transactions on Mathematical Software, vol. 8, pp. 93–113.

with which the scheme is more accurate than with the L-Stable coefficients for small step-size but less stable for large step-size.

The L-Stable scheme constants are provided commented-out in Rosenbrock34.C

Source files

Definition at line 67 of file Rosenbrock34.H.

Constructor & Destructor Documentation

◆ Rosenbrock34()

Rosenbrock34 ( const ODESystem ode,
const dictionary dict 
)

Construct from ODESystem.

Definition at line 108 of file Rosenbrock34.C.

◆ ~Rosenbrock34()

virtual ~Rosenbrock34 ( )
inlinevirtual

Destructor.

Definition at line 109 of file Rosenbrock34.H.

References Rosenbrock34::resize(), Rosenbrock34::solve(), ODESolver::solve(), x, y, and Foam::y0().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "Rosenbrock34"  )

Runtime type information.

◆ resize()

bool resize ( )
virtual

Resize the ODE solver.

Implements ODESolver.

Definition at line 127 of file Rosenbrock34.C.

References ODESolver::n_, adaptiveSolver::resize(), ODESolver::resize(), ODESolver::resizeField(), ODESolver::resizeMatrix(), and Rosenbrock34::solve().

Referenced by Rosenbrock34::~Rosenbrock34().

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

◆ solve() [1/2]

Foam::scalar solve ( const scalar  x0,
const scalarField y0,
const scalarField dydx0,
const scalar  dx,
scalarField y 
) const
virtual

Solve a single step dx and return the error.

Implements adaptiveSolver.

Definition at line 154 of file Rosenbrock34.C.

References ODESystem::derivatives(), forAll, ODESystem::jacobian(), Foam::LUBacksubstitute(), Foam::LUDecompose(), ODESolver::n_, ODESolver::normalizeError(), and ODESolver::odes_.

Referenced by Rosenbrock34::resize(), and Rosenbrock34::~Rosenbrock34().

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

◆ solve() [2/2]

void solve ( scalar &  x,
scalarField y,
scalar &  dxTry 
) const
virtual

Solve the ODE system and the update the state.

Reimplemented from ODESolver.

Definition at line 235 of file Rosenbrock34.C.

References ODESolver::odes_, and adaptiveSolver::solve().

Here is the call graph for this function:

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