EulerIvpOdeSolver Class Reference

#include <EulerIvpOdeSolver.hpp>

Inherits AbstractOneStepIvpOdeSolver.

Inherited by MockEulerIvpOdeSolver.

Collaboration diagram for EulerIvpOdeSolver:

[legend]

List of all members.

Public Member Functions
	EulerIvpOdeSolver ()
virtual	~EulerIvpOdeSolver ()
Protected Member Functions
void	CalculateNextYValue (AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rNextYValues)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access

---

Detailed Description

A concrete one step ODE solver class that employs the forward Euler method. This numerical method is explicit.

Definition at line 42 of file EulerIvpOdeSolver.hpp.

---

Constructor & Destructor Documentation

EulerIvpOdeSolver::EulerIvpOdeSolver

(

)

[inline]

Constructor.

Definition at line 87 of file EulerIvpOdeSolver.hpp.

virtual EulerIvpOdeSolver::~EulerIvpOdeSolver

(

)

[inline, virtual]

Destructor.

Definition at line 93 of file EulerIvpOdeSolver.hpp.

---

Member Function Documentation

void EulerIvpOdeSolver::CalculateNextYValue	(	AbstractOdeSystem *	pAbstractOdeSystem,
		double	timeStep,
		double	time,
		std::vector< double > &	rCurrentYValues,
		std::vector< double > &	rNextYValues
	)			[protected, virtual]

Calculate the solution to the ODE system at the next timestep.

A usage example: EulerIvpOdeSolver mySolver; OdeSolution solution = mySolver.Solve(pMyOdeSystem, yInit, StartTime, EndTime, TimeStep, SamplingTime);

Parameters:

	pAbstractOdeSystem	the ODE system to solve
	timeStep	dt
	time	the current time
	rCurrentYValues	the current (initial) state
	rNextYValues	the state at the next timestep

Implements AbstractOneStepIvpOdeSolver.

Definition at line 31 of file EulerIvpOdeSolver.cpp.

References AbstractOdeSystem::EvaluateYDerivatives(), and AbstractUntemplatedParameterisedSystem::GetNumberOfStateVariables().

template<class Archive >

void EulerIvpOdeSolver::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Archive the abstract IVP Solver, never used directly - boost uses this.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractOneStepIvpOdeSolver.

Reimplemented in MockEulerIvpOdeSolver.

Definition at line 55 of file EulerIvpOdeSolver.hpp.

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractOneStepIvpOdeSolver.

Reimplemented in MockEulerIvpOdeSolver.

Definition at line 47 of file EulerIvpOdeSolver.hpp.

---

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

• ode/src/solver/EulerIvpOdeSolver.hpp
• ode/src/solver/EulerIvpOdeSolver.cpp