A simple criterion based on Kinetic energy calculation. More...

Inheritance diagram for kineticEnergy:

Collaboration diagram for kineticEnergy:

Public Member Functions
std::string	getName () override
	get stopping criterion name

	kineticEnergy (mml::KineticEnergy c, MonitoringManager monitoringManager, MultipleCriterion *parent=nullptr)
	constructor

	~kineticEnergy () override=default
	destructor

Public Member Functions inherited from Criterion
bool	checkCriterion () override
	return true if the criterion is reach

	Criterion (mml::Criteria c, MonitoringManager monitoringManager, MultipleCriterion *parent=nullptr)
	constructor

StoppingCriterion *	getChild (const unsigned int i) override
	get the child repered by index, return null if no child

std::string	getMethodString ()
	get Method Name

int	getNumberOfChildren () override
	get number of childre; return -1 for non multiple criteria

std::string	scopeToString ()
	get Method scope as string

	~Criterion () override
	destructor

Public Member Functions inherited from StoppingCriterion
MultipleCriterion *	getParent ()
	get parent multiple criteria

	StoppingCriterion (MonitoringManager monitoringManager, MultipleCriterion parent=nullptr)
	constructor

virtual	~StoppingCriterion ()=default
	destructor

Additional Inherited Members
Protected Member Functions inherited from Criterion
void	write ()
	write values in the mmlOut file

Protected Attributes inherited from Criterion
double	factor
	factor to multiplate for conversion to SI

mml::Criteria *	mappedObject
	the xsdcxx object representing criterion, used for serialization

Method *	meth
	the computationnal method used to check if criterion is true

std::string	unit
	unit

std::vector< double >	values
	vector that stores current data of the stopping criteria

Protected Attributes inherited from StoppingCriterion
MonitoringManager *	monitoringManager
	monitoring manager

MultipleCriterion *	parent
	parent stopping Criterion

Detailed Description

A simple criterion based on Kinetic energy calculation.

Constructor & Destructor Documentation

kineticEnergy::kineticEnergy	(	mml::KineticEnergy *	c,
		MonitoringManager *	monitoringManager,
		MultipleCriterion *	parent = `nullptr`
	)

constructor

Parameters

c	the xsdcxx generated KineticEnergy criterion

kineticEnergy::~kineticEnergy ( )

overridedefault

destructor

std::string kineticEnergy::getName ( )

overridevirtual

get stopping criterion name

Implements Criterion.

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