Computer Assisted Medical Intervention Tool Kit  version 5.2
NonInteractiveSimulator Class Referenceabstract

An interactive simulator is a simulator that we cannot control step by step (ex: Ansys) Entire simulation is performed and then post-processed. More...

#include <NonInteractiveSimulator.h>

+ Inheritance diagram for NonInteractiveSimulator:
+ Collaboration diagram for NonInteractiveSimulator:

Public Member Functions

void createPml (const char *inputFile, const char *pmlFile) override=0
 Create a pml file from an imput file. More...
 
virtual bool doCalc ()=0
 make entire simulation ans store results of all step More...
 
void end () override=0
 end simultor More...
 
virtual int getMaxStep ()=0
 get the number of steps after simulation More...
 
void getPosition (int index, double position[3]) override=0
 get current position for one atom (use parameters) More...
 
virtual double getTime (int step)=0
 get the time of simulation of a given step More...
 
void init () override=0
 initialize simulator More...
 
 NonInteractiveSimulator (MonitoringManager *monitoringManager)
 constructor More...
 
 NonInteractiveSimulator (MonitoringManager *monitoringManager, const char *file)
 constructor More...
 
 ~NonInteractiveSimulator () override=default
 destructor More...
 
- Public Member Functions inherited from Simulator
virtual void getForce (int index, double force[3])=0
 get current force for one atom More...
 
 Simulator (MonitoringManager *monitoringManager)
 default constructor build a simulation from context provided by monitoringManager More...
 
 Simulator (MonitoringManager *monitoringManager, const char *file)
 constructor with simulator file build a simulation from context provided by monitoringManager and physical model provided by a simulator specific input file More...
 
void updatePositions ()
 update all current positions and store last positions More...
 
virtual ~Simulator ()=default
 destructor More...
 

Additional Inherited Members

- Protected Attributes inherited from Simulator
MonitoringManagermonitoringManager
 monitoring manager More...
 

Detailed Description

An interactive simulator is a simulator that we cannot control step by step (ex: Ansys) Entire simulation is performed and then post-processed.

Constructor & Destructor Documentation

◆ NonInteractiveSimulator() [1/2]

NonInteractiveSimulator::NonInteractiveSimulator ( MonitoringManager monitoringManager)

constructor

◆ NonInteractiveSimulator() [2/2]

NonInteractiveSimulator::NonInteractiveSimulator ( MonitoringManager monitoringManager,
const char *  file 
)

constructor

◆ ~NonInteractiveSimulator()

NonInteractiveSimulator::~NonInteractiveSimulator ( )
overridedefault

destructor

Member Function Documentation

◆ createPml()

void NonInteractiveSimulator::createPml ( const char *  inputFile,
const char *  pmlFile 
)
overridepure virtual

Create a pml file from an imput file.

Implements Simulator.

Implemented in ArtisynthSimulator, and AnsysSimulator.

◆ doCalc()

virtual bool NonInteractiveSimulator::doCalc ( )
pure virtual

make entire simulation ans store results of all step

Returns
true if calculation succeded

Implemented in ArtisynthSimulator, and AnsysSimulator.

Referenced by NonInteractiveMonitoringManager::doCalc().

+ Here is the caller graph for this function:

◆ end()

void NonInteractiveSimulator::end ( )
overridepure virtual

end simultor

Implements Simulator.

Implemented in ArtisynthSimulator, and AnsysSimulator.

Referenced by NonInteractiveMonitoringManager::end().

+ Here is the caller graph for this function:

◆ getMaxStep()

virtual int NonInteractiveSimulator::getMaxStep ( )
pure virtual

get the number of steps after simulation

Implemented in ArtisynthSimulator, and AnsysSimulator.

Referenced by NonInteractiveMonitoringManager::init().

+ Here is the caller graph for this function:

◆ getPosition()

void NonInteractiveSimulator::getPosition ( int  index,
double  position[3] 
)
overridepure virtual

get current position for one atom (use parameters)

Implements Simulator.

Implemented in ArtisynthSimulator, and AnsysSimulator.

◆ getTime()

virtual double NonInteractiveSimulator::getTime ( int  step)
pure virtual

get the time of simulation of a given step

Implemented in ArtisynthSimulator, and AnsysSimulator.

Referenced by NonInteractiveMonitoringManager::doMove().

+ Here is the caller graph for this function:

◆ init()

void NonInteractiveSimulator::init ( )
overridepure virtual

initialize simulator

Implements Simulator.

Implemented in ArtisynthSimulator, and AnsysSimulator.

Referenced by NonInteractiveMonitoringManager::init().

+ Here is the caller graph for this function:

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