This criteria function class applies the infinity norm locally for arbitrary combinations of sub-vectors of the complete vector. It has different tolerances for the different sub-vectors and a list of "result"-lists for each step and each "result" of a sub-vector. More...

#include <criteria_functions.h>

Inheritance diagram for MBSim::LocalCriteriaFunction:

[legend]

Public Member Functions
	LocalCriteriaFunction (std::map< fmatvec::RangeV, double > tolerances_)
	Constructor.

	~LocalCriteriaFunction () override
	Destructor.

int	operator() (const fmatvec::Vec &vector) override
	computes the criteria More...

bool	isBetter (const fmatvec::Vec &vector, const fmatvec::Vec &fVal=fmatvec::Vec(0, fmatvec::NONINIT)) override
	compares the result of given vector with the last result and returns if it got better (for damping) More...

void	clear () override
	deletes the list of criteria results More...

virtual void	setTolerances (const std::map< fmatvec::RangeV, double > &tolerances_)

Public Member Functions inherited from MBSim::CriteriaFunction
	CriteriaFunction ()
	Constructor.

	~CriteriaFunction () override
	Destructor.

void	setFunction (Function< fmatvec::Vec(fmatvec::Vec)> *function_)

int	operator() (const fmatvec::Vec &vector) override=0
	computes the criteria More...

virtual void	clear ()=0
	deletes the list of criteria results More...

virtual bool	isBetter (const fmatvec::Vec &vector, const fmatvec::Vec &fVal=fmatvec::Vec(0, fmatvec::NONINIT))=0
	compares the result of given vector with the last result and returns if it got better (for damping) More...

Public Member Functions inherited from MBSim::Function< int(fmatvec::Vec)>
	Function ()

void	initializeUsingXML (xercesc::DOMElement *element) override

Public Member Functions inherited from MBSim::FunctionBase
	FunctionBase ()

virtual Element *	getDependency () const

Public Member Functions inherited from MBSim::Element
	Element (const std::string &name)
	constructor

	~Element () override=default
	destructor

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

virtual void	setDynamicSystemSolver (DynamicSystemSolver *sys)
	sets the used dynamics system solver to the element More...

virtual void	plot ()
	plots time dependent data More...

virtual void	plotAtSpecialEvent ()
	plots time dependent data at special events More...

const std::string &	getName () const

void	setName (const std::string &str)

void	setPath (const std::string &str)

DynamicSystemSolver *	getDynamicSystemSolver ()

virtual void	init (InitStage stage, const InitConfigSet &config=InitConfigSet())
	plots time series header More...

virtual void	createPlotGroup ()
	creates the plotGroup for H5-output More...

H5::GroupBase *	getPlotGroup ()

virtual H5::GroupBase *	getFramesPlotGroup ()

virtual H5::GroupBase *	getContoursPlotGroup ()

virtual H5::GroupBase *	getGroupsPlotGroup ()

virtual H5::GroupBase *	getObjectsPlotGroup ()

virtual H5::GroupBase *	getLinksPlotGroup ()

virtual H5::GroupBase *	getConstraintsPlotGroup ()

virtual H5::GroupBase *	getObserversPlotGroup ()

bool	getPlotFeature (const PlotFeatureEnum &pf)

virtual void	setPlotFeature (const PlotFeatureEnum &pf, bool value)
	Set a plot feature. More...

void	setPlotFeatureForChildren (const PlotFeatureEnum &pf, bool value)
	Set a plot feature for the children of this object. More...

void	setPlotFeatureRecursive (const PlotFeatureEnum &pf, bool value)
	Set a plot feature for this object and the children of this object. More...

template<class T >
void	setPlotAttribute (const std::string &name, const T &value)
	Set a plot attribute: static data attached as key/value pairs to the plot datasets/groups.

void	setPlotAttribute (const std::string &name)

virtual void	initializeUsingXML (xercesc::DOMElement *element)

template<class T >
T *	getByPath (const std::string &path, bool initialCaller=true) const
	Get the object of type T represented by the path path. Do not set any argurment other than path!

std::string	getPath (const Element *relTo=nullptr, std::string sep="/") const
	Return the path of this object. If relativeTo is not NULL return a relative path to relativeTo. Do not set any argurment other than relTo and sep!

virtual Element *	getChildByContainerAndName (const std::string &container, const std::string &name) const
	Get the Element named name in the container named container. More...

virtual std::shared_ptr< OpenMBV::Group >	getOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getFramesOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getContoursOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getGroupsOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getObjectsOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getLinksOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getConstraintsOpenMBVGrp ()

virtual std::shared_ptr< OpenMBV::Group >	getObserversOpenMBVGrp ()

virtual Element *	getParent ()

virtual const Element *	getParent () const

virtual void	setParent (Element *parent_)

std::vector< Element * >	getDependencies () const
	checks dependency on other elements. More...

void	addDependency (Element *ele)

int	computeLevel ()
	computes the length of the pathes in the graph that represents the dependencies between all elements. More...

virtual void	updatePositions (Frame *frame)

virtual void	updateVelocities (Frame *frame)

virtual void	updateAccelerations (Frame *frame)

virtual void	updateJacobians (Frame *frame, int j=0)

virtual void	updateGyroscopicAccelerations (Frame *frame)

virtual void	resetUpToDate ()

const double &	getTime () const

double	getStepSize () const

const MBXMLUtils::DOMEvalException &	getDOMEvalError () const

Protected Member Functions
virtual std::vector< double >	computeResults (const fmatvec::Vec &x, const fmatvec::Vec &fVal=fmatvec::Vec(0, fmatvec::NONINIT))=0

Protected Member Functions inherited from MBSim::Element
void	updatePlotFeatures ()

void	addToPlot (const std::string &name)

void	addToPlot (const std::string &name, int size)

void	addToPlot (const std::string &name, const std::vector< std::string > &iname)

template<class AT >
void	plot (const AT &x)

template<class Type , class AT >
void	plot (const fmatvec::Vector< Type, AT > &x)

Protected Attributes
std::map< fmatvec::RangeV, double >	tolerances

std::vector< std::vector< double > >	criteriaResults
	saves the results of the criteria for each index set and each operator step

Protected Attributes inherited from MBSim::CriteriaFunction
Function< fmatvec::Vec(fmatvec::Vec)> *	function {nullptr}
	function that computes the values

Protected Attributes inherited from MBSim::Element
Element *	parent { nullptr }

std::string	name
	name of element

std::string	path
	The path of this object. Is set during the init stage reorganizeHierarchy. Before this the path is calculated dynamically using getPath() after this stage getPath just returns this value.

MBXMLUtils::DOMEvalException	domEvalError
	Special XML helper variable.

DynamicSystemSolver *	ds { nullptr }
	dynamic system

H5::VectorSerie< double > *	plotVectorSerie { nullptr }
	time series

std::vector< double >	plotVector
	one entry of time series

std::vector< std::string >	plotColumns
	columns of time series

H5::GroupBase *	plotGroup { nullptr }
	associated plot group

std::vector< Element * >	dependency
	vector containing all dependencies.

PlotFeatureMap	plotFeature
	plot feature

PlotFeatureMap	plotFeatureForChildren

std::map< std::string, std::variant< std::monostate, int, double, std::string, std::vector< int >, std::vector< double >, std::vector< std::vector< double > > > >	plotAttribute

Additional Inherited Members
Public Types inherited from MBSim::Element
enum	InitStage { resolveStringRef =0 , preInit , plotting , unknownStage , LASTINITSTAGE }
	The stages of the initialization. More...

Detailed Description

This criteria function class applies the infinity norm locally for arbitrary combinations of sub-vectors of the complete vector. It has different tolerances for the different sub-vectors and a list of "result"-lists for each step and each "result" of a sub-vector.

Member Function Documentation

◆ clear()

void MBSim::LocalCriteriaFunction::clear ( )

overridevirtual

deletes the list of criteria results

Implements MBSim::CriteriaFunction.

◆ isBetter()

bool MBSim::LocalCriteriaFunction::isBetter	(	const fmatvec::Vec &	vector,
		const fmatvec::Vec &	fVal = `fmatvec::Vec(0, fmatvec::NONINIT)`
	)

overridevirtual

compares the result of given vector with the last result and returns if it got better (for damping)

Implements MBSim::CriteriaFunction.

◆ operator()()

int MBSim::LocalCriteriaFunction::operator() ( const fmatvec::Vec & vector )

overridevirtual

computes the criteria

The criteria has to fulfill at least:

result = 0: the criteria is fulfilled and should stop
result = 1: the algorithm should go on
result = 2: the algorithm has slow convergence and should stop
result = -1: the algorithm diverges and should stop

Implements MBSim::CriteriaFunction.

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

/mbsim-env/mbsim/kernel/mbsim/numerics/functions/criteria_functions.h
/mbsim-env/mbsim/kernel/mbsim/numerics/functions/criteria_functions.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear()

◆ isBetter()

◆ operator()()