mbsim 4.0.0 MBSim Kernel

Public Member Functions | Protected Attributes | List of all members
MBSim::Integrator Class Referenceabstract

integrator-interface for dynamic systems More...

`#include <integrator.h>`

Inheritance diagram for MBSim::Integrator:
[legend]

## Public Member Functions

| Integrator ()
| constructor
| ~Integrator () override=default
| destructor
void | setStartTime (double tStart_)
void | setEndTime (double tEnd_)
void | setPlotStepSize (double dtPlot_)
void | setInitialState (const fmatvec::Vec &z0_)
double | getStartTime () const
double | getEndTime () const
double | getPlotStepSize () const
const fmatvec::Vec & | getInitialState () const override
void | execute () override
| start solving the dynamic system set by setSystem.
virtual void | integrate ()=0
| start the integration of the system set by setSystem. Each class implemeting this function should call debugInit first.
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 | postprocessing ()
void | setSystem (DynamicSystemSolver *s)
MBSim::DynamicSystemSolver * | getSystem ()
const MBXMLUtils::DOMEvalException & | getDOMEvalError () const

## Protected Attributes

double | tStart {0.}
| start, end, plot time
double | tEnd {1.}
double | dtPlot {1e-4}
fmatvec::Vec | z0
| initial state
std::string | name
| name of integrator
Protected Attributes inherited from MBSim::Solver
MBSim::DynamicSystemSolver * | system
| dynamic system
MBXMLUtils::DOMEvalException | domEvalError
| Special XML helper variable.

## Detailed Description

integrator-interface for dynamic systems

Author
  Martin Foerg

Date
  2009-07-13 some comments (Thorsten Schindler)

## Member Function Documentation

## ◆ debugInit()

void MBSim::Integrator::debugInit | ( |  | ) |

Each class implementing the Integrator::integrate function should call this function first. This function does currently only some minor modification of the integrator data (like end time) dependent on environment variables. This is used mainly for debugging purposes like automatic valgrind runs with a very small tEnd time.

## ◆ initializeUsingXML()

void MBSim::Integrator::initializeUsingXML | ( | xercesc::DOMElement * | element | ) |

override virtual

initialize integrator

Parameters

  XML | description

Reimplemented from MBSim::Solver.

Reimplemented in MBSim::TimeSteppingSSCIntegrator, MBSim::QuasiStaticIntegrator, MBSim::RADAU5Integrator, MBSim::RADAUIntegrator, MBSim::RODASIntegrator, MBSim::SEULEXIntegrator, MBSim::PHEM56Integrator, MBSim::LSODIIntegrator, MBSim::LSODEIntegrator, MBSim::ODEXIntegrator, MBSim::LSODAIntegrator, MBSim::RootFindingIntegrator, MBSim::RKSuiteIntegrator, MBSim::ThetaTimeSteppingIntegrator, MBSim::ThetaTimeSteppingSSCIntegrator, and MBSim::TimeSteppingIntegrator.

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

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