Computer Assited Medical Intervention Tool Kit  version 5.0
KineticEnergy.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 
27 #ifndef STOPPINGCRITERION_STOPPINGCRITERIA_CRITERIA_KINETICENGERGY_H
28 #define STOPPINGCRITERION_STOPPINGCRITERIA_CRITERIA_KINETICENGERGY_H
29 
30 #include <MonitorIn.hxx>
31 
32 // Stopping criteria includes
33 #include "Criterion.h"
41 class kineticEnergy: public Criterion {
42 public:
47  kineticEnergy(mml::KineticEnergy* c, MonitoringManager* monitoringManager, MultipleCriterion* parent = nullptr);
49  ~kineticEnergy() override = default;
50 
52  std::string getName() override;
53 
54 private:
56  void calculate() override;
57 };
58 
59 #endif // STOPPINGCRITERION_STOPPINGCRITERIA_CRITERIA_KINETICENGERGY_H
Criterion
Class which represents a simple criterion A criterion can be checked using checkCriterion method to k...
Definition: Criterion.h:47
kineticEnergy::calculate
void calculate() override
calculate stopping criteria data and store it into values vector
Definition: KineticEnergy.cpp:32
kineticEnergy
A simple criterion based on Kinetic energy calculation.
Definition: KineticEnergy.h:41
kineticEnergy::kineticEnergy
kineticEnergy(mml::KineticEnergy *c, MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
constructor
Definition: KineticEnergy.cpp:29
MonitoringManager
Manager of the benchmark tests. Do simulation loop and tests.
Definition: MonitoringManager.h:50
KineticEnergy.h
StoppingCriterion::parent
MultipleCriterion * parent
parent stopping Criterion
Definition: StoppingCriterion.h:76
Criterion.h
kineticEnergy::~kineticEnergy
~kineticEnergy() override=default
destructor
MultipleCriterion
class which represents a multiple criterion a multiple criterion is either an OrMUltipleCriterion or ...
Definition: MultipleCriterion.h:45
StoppingCriterion::monitoringManager
MonitoringManager * monitoringManager
monitoring manager
Definition: StoppingCriterion.h:74
kineticEnergy::getName
std::string getName() override
get stopping criterion name
Definition: KineticEnergy.cpp:35