Reaktoro  A unified framework for modeling chemically reactive systems
Reaktoro::ODESolver Class Reference

## Detailed Description

A wrapper class for CVODE, a library for solving ordinary differential equations.

ODEProblem, ODEOptions

#include <ODE.hpp>

## Public Member Functions

ODESolver ()
Construct a default ODESolver instance.

ODESolver (const ODESolver &other)
Construct a copy of an ODESolver instance.

virtual ~ODESolver ()
Destroy this ODESolver instance.

auto operator= (ODESolver other) -> ODESolver &
Assign a ODESolver instance to this instance.

auto setOptions (const ODEOptions &options) -> void
Set the options for the ODE solver. More...

auto setProblem (const ODEProblem &problem) -> void
Set the ODE problem. More...

auto initialize (double tstart, const Vector &y) -> void
Initializes the ODE solver. More...

auto integrate (double &t, Vector &y) -> void
Integrate the ODE performing a single step. More...

auto integrate (double &t, Vector &y, double tfinal) -> void
Integrate the ODE performing a single step not going over a given time. More...

auto solve (double &t, double dt, Vector &y) -> void
Solve the ODE equations from a given start time to a final one. More...

## Member Function Documentation

 auto Reaktoro::ODESolver::setOptions ( const ODEOptions & options ) -> void

Set the options for the ODE solver.

ODEOptions
 auto Reaktoro::ODESolver::setProblem ( const ODEProblem & problem ) -> void

Set the ODE problem.

ODEProblem
 auto Reaktoro::ODESolver::initialize ( double tstart, const Vector & y ) -> void

Initializes the ODE solver.

This method should be invoked whenever the user intends to make a call to ODESolver::integrate.

Parameters
 tstart The start time of the integration. y The initial values of the variables
 auto Reaktoro::ODESolver::integrate ( double & t, Vector & y ) -> void

Integrate the ODE performing a single step.

Parameters
 [in,out] t The current time of the integration as input, the new current time as output [in,out] y The current variables as input, the new current variables as output
 auto Reaktoro::ODESolver::integrate ( double & t, Vector & y, double tfinal ) -> void

Integrate the ODE performing a single step not going over a given time.

Parameters
 [in,out] t The current time of the integration as input, the new current time as output [in,out] y The current variables as input, the new current variables as output tfinal The final time that the integration must satisfy
 auto Reaktoro::ODESolver::solve ( double & t, double dt, Vector & y ) -> void

Solve the ODE equations from a given start time to a final one.

Parameters
 [in,out] t The current time of the integration as input, the new current time as output dt The value of the time step [in,out] y The current variables as input, the new current variables as output

The documentation for this class was generated from the following files:
• Reaktoro/Math/ODE.hpp
• Reaktoro/Math/ODE.cpp