RungeKutta4IvpOdeSolver Class Reference

#include <RungeKutta4IvpOdeSolver.hpp>

Inherits AbstractOneStepIvpOdeSolver.

Collaboration diagram for RungeKutta4IvpOdeSolver:

[legend]

List of all members.

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)
Private Attributes
std::vector< double >	k1
std::vector< double >	k2
std::vector< double >	k3
std::vector< double >	k4
std::vector< double >	yki
Friends
class	boost::serialization::access

---

Detailed Description

A concrete one step ODE solver class that employs the Runge Kutta 4th order solver (RK4).

Definition at line 41 of file RungeKutta4IvpOdeSolver.hpp.

---

Member Function Documentation

void RungeKutta4IvpOdeSolver::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.

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 RungeKutta4IvpOdeSolver.cpp.

References AbstractOdeSystem::EvaluateYDerivatives(), AbstractUntemplatedParameterisedSystem::GetNumberOfStateVariables(), k1, k2, k3, k4, and yki.

template<class Archive >

void RungeKutta4IvpOdeSolver::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.

Definition at line 54 of file RungeKutta4IvpOdeSolver.hpp.

---

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractOneStepIvpOdeSolver.

Definition at line 46 of file RungeKutta4IvpOdeSolver.hpp.

---

Member Data Documentation

std::vector<double> RungeKutta4IvpOdeSolver::k1 [private]

Working memory: expression k1 in the RK4 method.

Definition at line 79 of file RungeKutta4IvpOdeSolver.hpp.

Referenced by CalculateNextYValue().

std::vector<double> RungeKutta4IvpOdeSolver::k2 [private]

Working memory: expression k2 in the RK4 method.

Definition at line 80 of file RungeKutta4IvpOdeSolver.hpp.

Referenced by CalculateNextYValue().

std::vector<double> RungeKutta4IvpOdeSolver::k3 [private]

Working memory: expression k3 in the RK4 method.

Definition at line 81 of file RungeKutta4IvpOdeSolver.hpp.

Referenced by CalculateNextYValue().

std::vector<double> RungeKutta4IvpOdeSolver::k4 [private]

Working memory: expression k4 in the RK4 method.

Definition at line 82 of file RungeKutta4IvpOdeSolver.hpp.

Referenced by CalculateNextYValue().

std::vector<double> RungeKutta4IvpOdeSolver::yki [private]

Working memory: expression yki in the RK4 method.

Definition at line 83 of file RungeKutta4IvpOdeSolver.hpp.

Referenced by CalculateNextYValue().

---

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

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