Public Member Functions | List of all members

4/5th Order Dormand-Prince Runge-Kutta ODE solver. More...

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

Public Member Functions

 TypeName ("RKDP45")
 
 RKDP45 (const ODESystem &ode, const dictionary &dict)
 
virtual ~RKDP45 ()=default
 
virtual bool resize ()
 
virtual scalar solve (const scalar x0, const scalarField &y0, const scalarField &dydx0, const scalar dx, scalarField &y) const
 
virtual void solve (scalar &x, scalarField &y, scalar &dxTry) const
 
virtual void solve (scalar &x, scalarField &y, scalar &dxTry) const
 
virtual void solve (scalar &x, scalarField &y, stepState &step) const
 
virtual void solve (const scalar xStart, const scalar xEnd, scalarField &y, scalar &dxEst) const
 
- Public Member Functions inherited from ODESolver
 TypeName ("ODESolver")
 
 declareRunTimeSelectionTable (autoPtr, ODESolver, dictionary,(const ODESystem &ode, const dictionary &dict),(ode, dict))
 
 ODESolver (const ODESystem &ode, const dictionary &dict)
 
 ODESolver (const ODESystem &ode, const scalarField &absTol, const scalarField &relTol)
 
virtual ~ODESolver ()=default
 
label nEqns () const
 
scalarFieldabsTol ()
 
scalarFieldrelTol ()
 
template<class Type >
void resizeField (UList< Type > &f) const
 
void resizeMatrix (scalarSquareMatrix &m) const
 
virtual void solve (scalar &x, scalarField &y, stepState &step) const
 
virtual void solve (const scalar xStart, const scalar xEnd, scalarField &y, scalar &dxEst) const
 
- Public Member Functions inherited from adaptiveSolver
 adaptiveSolver (const ODESystem &ode, const dictionary &dict)
 
virtual ~adaptiveSolver ()=default
 
bool resize (const label n)
 
void solve (const ODESystem &ode, scalar &x, scalarField &y, scalar &dxTry) const
 

Additional Inherited Members

- Static Public Member Functions inherited from ODESolver
static autoPtr< ODESolverNew (const ODESystem &ode, const dictionary &dict)
 
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
 
 ODESolver (const ODESolver &)=delete
 
void operator= (const ODESolver &)=delete
 
- Protected Attributes inherited from ODESolver
const ODESystemodes_
 
const label maxN_
 
label n_
 
scalarField absTol_
 
scalarField relTol_
 
label maxSteps_
 

Detailed Description

4/5th Order Dormand-Prince Runge-Kutta ODE solver.

References:

    Dormand, J. R., & Prince, P. J. (1980).
    A family of embedded Runge-Kutta formulae.
    Journal of computational and applied mathematics, 6(1), 19-26.

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

Definition at line 67 of file RKDP45.H.

Constructor & Destructor Documentation

◆ RKDP45()

RKDP45 ( const ODESystem ode,
const dictionary dict 
)

Definition at line 75 of file RKDP45.C.

◆ ~RKDP45()

virtual ~RKDP45 ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "RKDP45"  )

◆ resize()

bool resize ( )
virtual

Implements ODESolver.

Definition at line 91 of file RKDP45.C.

References adaptiveSolver::resize(), and ODESolver::resize().

Here is the call graph for this function:

◆ solve() [1/5]

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

Implements adaptiveSolver.

Definition at line 113 of file RKDP45.C.

References Foam::constant::physicoChemical::c2, forAll, y, and Foam::y0().

Here is the call graph for this function:

◆ solve() [2/5]

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

Reimplemented from ODESolver.

Definition at line 181 of file RKDP45.C.

References adaptiveSolver::solve(), x, and y.

Here is the call graph for this function:

◆ solve() [3/5]

void solve

Definition at line 110 of file ODESolver.C.

◆ solve() [4/5]

void solve

Definition at line 123 of file ODESolver.C.

◆ solve() [5/5]

void solve

Definition at line 136 of file ODESolver.C.


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