Hindmarsh’s ODE solver LSODE. More...

#include <lsode_integrator.h>

Inheritance diagram for MBSim::LSODEIntegrator:

Public Types
enum	Method { nonstiff =0 , stiff , unknown }

Public Member Functions
void	setMaximumStepSize (double dtMax_)

void	setMinimumStepSize (double dtMin_)

void	setAbsoluteTolerance (const fmatvec::Vec &aTol_)

void	setAbsoluteTolerance (double aTol_)

void	setRelativeTolerance (const fmatvec::Vec &rTol_)

void	setRelativeTolerance (double rTol_)

void	setInitialStepSize (double dt0_)

void	setStepLimit (int maxSteps_)

void	setMethod (Method method_)

void	integrate ()
	start the integration of the system set by setSystem. Each class implemeting this function should call debugInit first. More...

virtual void	initializeUsingXML (xercesc::DOMElement *element)
	initialize integrator More...

virtual void	integrate ()=0
	start the integration of the system set by setSystem. Each class implemeting this function should call debugInit first. More...

void	integrate (MBSim::DynamicSystemSolver &sys)
	Convinent function: call setSystem(&sys) and integrate()

Public Member Functions inherited from MBSim::ImplicitIntegrator
void	setReducedForm (bool reduced_)

void	setPartiallyAnalyticalJacobian (bool partiallyAnalyticalJacobian_)

Public Member Functions inherited from MBSim::RootFindingIntegrator
void	setRootFindingAccuracy (double dtRoot_)
	Define the root-finding accuracy.

void	setPlotOnRoot (bool b)
	Define wether to trigger a plot before and after each found root.

void	setToleranceForPositionConstraints (double gMax_)
	Set the maximum allowed position drift.

void	setToleranceForVelocityConstraints (double gdMax_)
	Set the maximum allowed velocity drift.

double	getToleranceForPositionConstraints ()
	Get the maximum allowed position drift.

double	getToleranceForVelocityConstraints ()
	Get the maximum allowed velocity drift.

virtual void	initializeUsingXML (xercesc::DOMElement *element)
	initialize integrator More...

Public Member Functions inherited from MBSim::Integrator
	Integrator ()
	constructor

	~Integrator () override=default
	destructor

void	setStartTime (double tStart_)

void	setEndTime (double tEnd_)

void	setPlotStepSize (double dtPlot_)

double	getStartTime () const

double	getEndTime () const

double	getPlotStepSize () const

void	execute () override
	start solving the dynamic system set by setSystem. More...

virtual void	integrate ()=0
	start the integration of the system set by setSystem. Each class implemeting this function should call debugInit first. More...

void	integrate (MBSim::DynamicSystemSolver &sys)
	Convinent function: call setSystem(&sys) and integrate()

void	debugInit ()

virtual void	preIntegrate ()

virtual void	subIntegrate (double tStop)

virtual void	postIntegrate ()

void	initializeUsingXML (xercesc::DOMElement *element) override
	initialize integrator More...

Public Member Functions inherited from MBSim::Solver
	Solver ()
	constructor

	~Solver () override=default
	destructor

void	throwError (const std::string &msg) const

virtual void	execute ()=0
	start solving the dynamic system set by setSystem. More...

virtual void	postprocessing ()

virtual void	initializeUsingXML (xercesc::DOMElement *element)

void	setInitialState (const fmatvec::Vec &z0_)

const fmatvec::Vec &	getInitialState () const

void	setSystem (DynamicSystemSolver *s)

MBSim::DynamicSystemSolver *	getSystem ()

const MBXMLUtils::DOMEvalException &	getDOMEvalError () const

Private Member Functions
double	delta (int i, double z) const override

void	init () override

Static Private Member Functions
static void	fzdot (int neq, double t, double z_, double zd_)

static void	jac (int neq, double t, double z_, int ml, int mu, double J_, int *nrowp)

Private Attributes
double	dtMax {0}

double	dtMin {0}

fmatvec::Vec	aTol

fmatvec::Vec	rTol

double	dt0 {0}

int	maxSteps {std::numeric_limits<int>::max()}

Method	method {nonstiff}

fmatvec::Vec	rWork

int	lewt

double	r0

std::exception_ptr	exception

Additional Inherited Members
Protected Member Functions inherited from MBSim::ImplicitIntegrator
virtual double	delta (int i, double z) const

void	par_ud_xd_par_q (fmatvec::Mat &J)

void	par_zd_par_q (fmatvec::Mat &J)

void	par_ud_xd_par_u_x (fmatvec::Mat &J, bool updla)

void	par_zd_par_z (fmatvec::Mat &J, bool updla)

virtual void	calcSize ()

virtual void	init ()

Protected Member Functions inherited from MBSim::RootFindingIntegrator
bool	signChangedWRTsvLast (const fmatvec::Vec &svStepEnd) const

Protected Attributes inherited from MBSim::ImplicitIntegrator
bool	reduced {false}

bool	partiallyAnalyticalJacobian {false}

int	neq

int	qMove

fmatvec::Vec	zd0

fmatvec::RangeV	Rq

fmatvec::RangeV	Ru

fmatvec::RangeV	Rx

fmatvec::RangeV	Rz

fmatvec::RangeV	RuMove

fmatvec::RangeV	RxMove

Protected Attributes inherited from MBSim::RootFindingIntegrator
double	dtRoot {1e-10}

bool	plotOnRoot {false}

double	gMax {-1}

double	gdMax {-1}

fmatvec::Vec	svLast

bool	shift {false}

Protected Attributes inherited from MBSim::Integrator
double	tStart {0.}
	start, end, plot time

double	tEnd {1.}

double	dtPlot {1e-4}

std::string	name
	name of integrator

Protected Attributes inherited from MBSim::Solver
fmatvec::Vec	z0
	initial state

MBSim::DynamicSystemSolver *	system
	dynamic system

MBXMLUtils::DOMEvalException	domEvalError
	Special XML helper variable.

Detailed Description

Hindmarsh’s ODE solver LSODE.

Livermore Solver for Ordinary Differential Equations. LSODE solves the initial-value problem for stiff or nonstiff systems of first-order ODE's. This integrator uses ODEPACK (http://www.netlib.org/odepack).

Member Function Documentation

◆ delta()

double MBSim::LSODEIntegrator::delta	(	int	i,
		double	z
	)		const

overrideprivatevirtual

Reimplemented from MBSim::ImplicitIntegrator.

◆ init()

void MBSim::LSODEIntegrator::init ( )

overrideprivatevirtual

Reimplemented from MBSim::ImplicitIntegrator.

◆ initializeUsingXML()

void MBSim::LSODEIntegrator::initializeUsingXML ( xercesc::DOMElement * element )

virtual

initialize integrator

Parameters

XML	description

Reimplemented from MBSim::RootFindingIntegrator.

◆ integrate() [1/2]

void MBSim::LSODEIntegrator::integrate ( )

virtual

start the integration of the system set by setSystem. Each class implemeting this function should call debugInit first.

Implements MBSim::Integrator.

◆ integrate() [2/2]

virtual void MBSim::Integrator::integrate ( )

virtual

start the integration of the system set by setSystem. Each class implemeting this function should call debugInit first.

Implements MBSim::Integrator.

Member Data Documentation

◆ aTol

fmatvec::Vec MBSim::LSODEIntegrator::aTol

private

Absolute Toleranz

◆ dt0

double MBSim::LSODEIntegrator::dt0 {0}

private

step size for the first step

◆ dtMax

double MBSim::LSODEIntegrator::dtMax {0}

private

maximal step size

◆ dtMin

double MBSim::LSODEIntegrator::dtMin {0}

private

minimal step size

◆ maxSteps

int MBSim::LSODEIntegrator::maxSteps {std::numeric_limits<int>::max()}

private

maximum number of steps allowed during one call to the solver.

◆ method

Method MBSim::LSODEIntegrator::method {nonstiff}

private

use stiff (BDF) or nonstiff (Adams) method

◆ rTol

fmatvec::Vec MBSim::LSODEIntegrator::rTol

private

Relative Toleranz

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

/mbsim-env/mbsim/kernel/mbsim/integrators/lsode_integrator.h
/mbsim-env/mbsim/kernel/mbsim/integrators/lsode_integrator.cc

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ delta()

◆ init()

◆ initializeUsingXML()

◆ integrate() [1/2]

◆ integrate() [2/2]

Member Data Documentation

◆ aTol

◆ dt0

◆ dtMax

◆ dtMin

◆ maxSteps

◆ method

◆ rTol