Simulator Class Reference

A simulator engine is used to compute the displacements of all atoms of the model. More...

#include <Simulator.h>

Public Member Functions
virtual void	createPml (const char *inputFile, const char *pmlFile)=0
	Create a pml file from a simulator specific imput file.
virtual void	end ()=0
	end simultor
virtual void	getForce (int index, double force[3])=0
	get current force for one atom
virtual void	getPosition (int index, double position[3])=0
	get current position for one atom
virtual void	init ()=0
	initialize the simulator
	Simulator (MonitoringManager *monitoringManager)
	default constructor build a simulation from context provided by monitoringManager
	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
void	updatePositions ()
	update all current positions and store last positions
virtual	~Simulator ()=default
	destructor

Protected Attributes
MonitoringManager *	monitoringManager
	monitoring manager

Detailed Description

A simulator engine is used to compute the displacements of all atoms of the model.

Constructor & Destructor Documentation

Simulator() [1/2]

Simulator::Simulator

(

MonitoringManager *

monitoringManager

)

default constructor build a simulation from context provided by monitoringManager

Parameters

monitoringManager

manager provinding context of simulation

References monitoringManager.

Referenced by InteractiveSimulator::InteractiveSimulator(), InteractiveSimulator::InteractiveSimulator(), NonInteractiveSimulator::NonInteractiveSimulator(), and NonInteractiveSimulator::NonInteractiveSimulator().

Simulator() [2/2]

Simulator::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

Parameters

monitoringManager	manager provinding context of simulation
file	path to simulator specific file

References monitoringManager.

~Simulator()

virtual Simulator::~Simulator ( )

virtualdefault

destructor

Member Function Documentation

createPml()

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

pure virtual

Create a pml file from a simulator specific imput file.

Implemented in AnsysSimulator, ArtisynthSimulator, InteractiveSimulator, NonInteractiveSimulator, and SofaSimulator.

end()

virtual void Simulator::end ( )

pure virtual

end simultor

Implemented in AnsysSimulator, ArtisynthSimulator, InteractiveSimulator, NonInteractiveSimulator, and SofaSimulator.

References updatePositions().

getForce()

virtual void Simulator::getForce ( int index, double force[3] )

pure virtual

get current force for one atom

Implemented in AnsysSimulator, ArtisynthSimulator, and SofaSimulator.

Referenced by MonitorForce::calculate().

getPosition()

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

pure virtual

get current position for one atom

Implemented in AnsysSimulator, ArtisynthSimulator, InteractiveSimulator, NonInteractiveSimulator, and SofaSimulator.

Referenced by updatePositions().

init()

virtual void Simulator::init ( )

pure virtual

initialize the simulator

Implemented in AnsysSimulator, ArtisynthSimulator, InteractiveSimulator, NonInteractiveSimulator, and SofaSimulator.

updatePositions()

void Simulator::updatePositions

(

)

update all current positions and store last positions

References getPosition(), and monitoringManager.

Referenced by end().

Member Data Documentation

monitoringManager

MonitoringManager* Simulator::monitoringManager

protected

monitoring manager

Referenced by AnsysSimulator::AnsysSimulator(), AnsysSimulator::AnsysSimulator(), ArtisynthSimulator::ArtisynthSimulator(), ArtisynthSimulator::ArtisynthSimulator(), AnsysSimulator::getPosition(), ArtisynthSimulator::getPosition(), SofaSimulator::init(), InteractiveSimulator::InteractiveSimulator(), InteractiveSimulator::InteractiveSimulator(), NonInteractiveSimulator::NonInteractiveSimulator(), NonInteractiveSimulator::NonInteractiveSimulator(), Simulator(), Simulator(), SofaSimulator::SofaSimulator(), SofaSimulator::SofaSimulator(), and updatePositions().

---

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

• Simulator.h
• Simulator.cpp