MBSim

Project Page
Public Member Functions | Protected Attributes
MBSim::ExtraDynamic Class Reference

base class for dynamic systems of the form $\dot{x}=f\left(x,u\right)$ and $y=g\left(x,u\right)$ More...

#include <extra_dynamic.h>

Inheritance diagram for MBSim::ExtraDynamic:
MBSim::Element

List of all members.

Public Member Functions

 ExtraDynamic (const std::string &name)
 constructor
virtual void updatedx (double t, double dt)=0
 update order one parameter increment
virtual void updatexd (double t)=0
 update differentiated order one parameter
virtual void calcxSize ()
virtual const fmatvec::Vec & getx () const
virtual fmatvec::Vec & getx ()
virtual void setxInd (int xInd_)
virtual int getxSize () const
virtual void updatexRef (const fmatvec::Vec &ref)
virtual void updatexdRef (const fmatvec::Vec &ref)
virtual void init (InitStage stage)
 plots time series header
virtual void initz ()
virtual std::string getType () const
virtual void closePlot ()
 closes plot file
virtual void plot (double t, double dt=1)
 plots time dependent data
virtual void updateg (double t)=0
void setInitialState (const fmatvec::Vec &x0_)
virtual Element * getByPathSearch (std::string path)
 a general element search by path
virtual void initializeUsingXML (TiXmlElement *element)
- Public Member Functions inherited from MBSim::Element
 Element (const std::string &name)
 constructor
virtual ~Element ()
 destructor
virtual void initDataInterfaceBase (DynamicSystemSolver *parentds)
 TODO.
virtual void setDynamicSystemSolver (DynamicSystemSolver *sys)
virtual void plotAtSpecialEvent (double t, double dt=1)
 plots time dependent data at special events
const std::string & getName () const
const std::string getShortName () const
void setName (const std::string &str)
DynamicSystemSolver * getDynamicSystemSolver ()
virtual void createPlotGroup ()
 creates the plotGroup for H5-output
H5::Group * getPlotGroup ()
virtual void setPlotFeature (PlotFeature pf, PlotFeatureStatus value)
 Set a plot feature.
void setPlotFeatureForChildren (PlotFeature pf, PlotFeatureStatus value)
 Set a plot feature for the children of this object.
void setPlotFeatureRecursive (PlotFeature pf, PlotFeatureStatus value)
 Set a plot feature for this object and the children of this object.
PlotFeatureStatus getPlotFeature (PlotFeature pf)
PlotFeatureStatus getPlotFeatureForChildren (PlotFeature pf)
template<class T >
T * getByPath (std::string path)
 a general element access
virtual Element * getParent ()
virtual const Element * getParent () const
virtual void setParent (Element *parent_)
std::string getPath (char pathDelim='.')

Protected Attributes

fmatvec::Vec x
 order one parameter, differentiated order one parameter, initial order one parameters
fmatvec::Vec xd
fmatvec::Vec x0
int xSize
 size of order one parameter vector
int xInd
 index of order one parameters
fmatvec::Vec y
 system output $y=g\left(x\right)$
- Protected Attributes inherited from MBSim::Element
Element * parent
std::string name
 name of element
DynamicSystemSolver * ds
 dynamic system
H5::VectorSerie< double > * plotVectorSerie
 time series
std::vector< double > plotVector
 one entry of time series
std::vector< std::string > plotColumns
 columns of time series
H5::Group * plotGroup
 associated plot group

Additional Inherited Members

- Static Public Member Functions inherited from MBSim::Element
static double getDouble (TiXmlElement *e)
static int getInt (TiXmlElement *e)
static bool getBool (TiXmlElement *e)
static fmatvec::Vec getVec (TiXmlElement *e, int rows=0)
static fmatvec::Mat getMat (TiXmlElement *e, int rows=0, int cols=0)
static fmatvec::SqrMat getSqrMat (TiXmlElement *e, int size=0)
static fmatvec::SymMat getSymMat (TiXmlElement *e, int size=0)
- Protected Member Functions inherited from MBSim::Element
void updatePlotFeatures ()

Detailed Description

base class for dynamic systems of the form $\dot{x}=f\left(x,u\right)$ and $y=g\left(x,u\right)$

Author:
Mathias Bachmayer
Date:
2009-04-06 interface extracted (Thorsten Schindler)
2009-07-28 splitted interfaces (Thorsten Schindler)

Constructor & Destructor Documentation

MBSim::ExtraDynamic::ExtraDynamic ( const std::string &  name)

constructor

Parameters:
nameof extra dynamic system

Member Function Documentation

virtual std::string MBSim::ExtraDynamic::getType ( ) const
inlinevirtual
Returns:
std::string representation

Reimplemented from MBSim::Element.

virtual void MBSim::ExtraDynamic::init ( InitStage  stage)
virtual

plots time series header

Parameters:
invocingparent class

Reimplemented from MBSim::Element.

virtual void MBSim::ExtraDynamic::plot ( double  t,
double  dt = 1 
)
virtual

plots time dependent data

Parameters:
simulationtime
simulationtime step size for derivative calculation

Reimplemented from MBSim::Element.

virtual void MBSim::ExtraDynamic::updatedx ( double  t,
double  dt 
)
pure virtual

update order one parameter increment

Parameters:
simulationtime
simulationstep size
virtual void MBSim::ExtraDynamic::updatexd ( double  t)
pure virtual

update differentiated order one parameter

Parameters:
simulationtime

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