Public Member Functions | List of all members
RKCK45 Class Reference

4/5th Order Cash-Karp Runge-Kutta ODE solver. More...

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

Public Member Functions

 TypeName ("RKCK45")
 Runtime type information. More...
 
 RKCK45 (const ODESystem &ode, const dictionary &dict)
 Construct from ODESystem. More...
 
virtual ~RKCK45 ()
 Destructor. More...
 
virtual bool resize ()
 Resize the ODE solver. More...
 
virtual scalar solve (const scalar x0, const scalarField &y0, const label li, 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, const label li, 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...
 
 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...
 
scalarField & absTol ()
 Return access to the absolute tolerance field. More...
 
scalarField & relTol ()
 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, stepState &step) 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...
 
- 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, const label li, 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< ODESolver > New (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 ODESystem & odes_
 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

4/5th Order Cash-Karp Runge-Kutta ODE solver.

References: 

    Cash, J. R., & Karp, A. H. (1990).
    A variable order Runge-Kutta method for initial value problems
    with rapidly varying right-hand sides.
    ACM Transactions on Mathematical Software (TOMS), 16(3), 201-222.

    Hairer, E., Nørsett, S. P., & Wanner, G. (1993).
    Solving Ordinary Differential Equations I: Nonstiff Problems,
    second edition.
    Springer-Verlag, Berlin.
Source files

Definition at line 62 of file RKCK45.H.

Constructor & Destructor Documentation

◆ RKCK45()

RKCK45 ( const ODESystem &  ode,
const dictionary &  dict 
)

Construct from ODESystem.

Definition at line 74 of file RKCK45.C.

◆ ~RKCK45()

virtual ~RKCK45 ( )
inlinevirtual

Destructor.

Definition at line 102 of file RKCK45.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "RKCK45"  )

Runtime type information.

◆ resize()

bool resize ( )
virtual

Resize the ODE solver.

Implements ODESolver.

Definition at line 90 of file RKCK45.C.

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

Referenced by RKCK45::~RKCK45().

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 label  li,
const scalarField &  dydx0,
const scalar  dx,
scalarField &  y 
) const
virtual

Solve a single step dx and return the error.

Implements adaptiveSolver.

Definition at line 114 of file RKCK45.C.

References ODESystem::derivatives(), forAll, ODESolver::normaliseError(), and ODESolver::odes_.

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

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,
const label  li,
scalar &  dxTry 
) const
virtual

Solve the ODE system and the update the state.

Reimplemented from ODESolver.

Definition at line 179 of file RKCK45.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: