AbstractOdeSystemWithAnalyticJacobian Class Reference

#include <AbstractOdeSystemWithAnalyticJacobian.hpp>

Inheritance diagram for AbstractOdeSystemWithAnalyticJacobian:

[legend]

Collaboration diagram for AbstractOdeSystemWithAnalyticJacobian:

[legend]

List of all members.

Public Member Functions
	AbstractOdeSystemWithAnalyticJacobian (unsigned numberOfStateVariables=0)
virtual void	AnalyticJacobian (const std::vector< double > &rSolutionGuess, double **jacobian, double time, double timeStep)=0

---

Detailed Description

Abstract analytic Jacobian class.

Represents an ODE system with an analytic Jacobian available, which can be computed using the method AnalyticJacobian.

Definition at line 42 of file AbstractOdeSystemWithAnalyticJacobian.hpp.

---

Constructor & Destructor Documentation

AbstractOdeSystemWithAnalyticJacobian::AbstractOdeSystemWithAnalyticJacobian

(

unsigned

numberOfStateVariables = 0

)

[inline]

Constructor.

Parameters:

numberOfStateVariables

the number of state variables in the ODE system (defaults to 0)

Definition at line 51 of file AbstractOdeSystemWithAnalyticJacobian.hpp.

References AbstractOdeSystem::mUseAnalyticJacobian.

---

Member Function Documentation

virtual void AbstractOdeSystemWithAnalyticJacobian::AnalyticJacobian	(	const std::vector< double > &	rSolutionGuess,
		double **	jacobian,
		double	time,
		double	timeStep
	)			[pure virtual]

Compute the analytic Jacobian matrix of the ODE system.

Parameters:

	rSolutionGuess	the current guess at the solution for this time step
	jacobian	will be filled in with the Jacobian matrix entries
	time	the current simulation time
	timeStep	the time step in use by the integrator at present

Implemented in TysonNovak2001OdeSystem.

Referenced by BackwardEulerIvpOdeSolver::ComputeJacobian().

---

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

• ode/src/common/AbstractOdeSystemWithAnalyticJacobian.hpp