AbstractIvpOdeSolver Class Reference
#include <AbstractIvpOdeSolver.hpp>
Public Member Functions | |
| virtual OdeSolution | Solve (AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep, double timeSampling)=0 |
| virtual void | Solve (AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep)=0 |
| virtual void | SolveAndUpdateStateVariable (AbstractOdeSystem *pAbstractOdeSystem, double startTime, double endTime, double timeStep) |
| bool | StoppingEventOccurred () |
| double | GetStoppingTime () |
Protected Attributes | |
| bool | mStoppingEventOccurred |
| double | mStoppingTime |
Detailed Description
Abstract IvpOdeSolver class. Sets up variables and functions for a numerical solution technique for an initial value ODE problem.Definition at line 42 of file AbstractIvpOdeSolver.hpp.
Member Function Documentation
| virtual OdeSolution AbstractIvpOdeSolver::Solve | ( | AbstractOdeSystem * | pAbstractOdeSystem, | |
| std::vector< double > & | rYValues, | |||
| double | startTime, | |||
| double | endTime, | |||
| double | timeStep, | |||
| double | timeSampling | |||
| ) | [pure virtual] |
Solves a system of ODEs using a specified one-step ODE solver
- Parameters:
-
pAbstractOdeSystem points to the concrete ODE system to be solved startTime the time at which the initial conditions are specified endTime the time to which the system should be solved and the solution returned timeStep the time interval to be used by the solver initialConditions a standard vector specifying the intial condition of each solution variable in the system.
- Returns:
- OdeSolution is an object containing an integer of the number of equations, a stdAbstractOdeSystem::vector of times and a std::vector of std::vectors where each of those vectors contains the solution for one variable of the ODE system at those times.
Implemented in AbstractOneStepIvpOdeSolver, and RungeKuttaFehlbergIvpOdeSolver.
Referenced by AbstractCardiacCell::Compute().
| bool AbstractIvpOdeSolver::StoppingEventOccurred | ( | ) | [inline] |
Determine whether the solver quit due to the ODE's stopping event triggering
Definition at line 106 of file AbstractIvpOdeSolver.hpp.
References mStoppingEventOccurred.
Referenced by AbstractWntOdeBasedCellCycleModel::GetOdeStopTime(), WntCellCycleModel::SolveOdeToTime(), and IngeWntSwatCellCycleModel::SolveOdeToTime().
Member Data Documentation
bool AbstractIvpOdeSolver::mStoppingEventOccurred [protected] |
boolean indicating whether the solver quit due to the ODEs stopping event occuring
Definition at line 49 of file AbstractIvpOdeSolver.hpp.
Referenced by RungeKuttaFehlbergIvpOdeSolver::InternalSolve(), AbstractOneStepIvpOdeSolver::InternalSolve(), RungeKuttaFehlbergIvpOdeSolver::Solve(), AbstractOneStepIvpOdeSolver::Solve(), and StoppingEventOccurred().
double AbstractIvpOdeSolver::mStoppingTime [protected] |
if a stopping event occurred the time is stored here
Definition at line 52 of file AbstractIvpOdeSolver.hpp.
Referenced by RungeKuttaFehlbergIvpOdeSolver::InternalSolve(), AbstractOneStepIvpOdeSolver::InternalSolve(), and AbstractOneStepIvpOdeSolver::Solve().
The documentation for this class was generated from the following file:
- /tmp/release_1/ode/src/solver/AbstractIvpOdeSolver.hpp
