ArtisynthSimulator Class Reference

Simulator class to use Artisynth as simulation engine. More...

#include <ArtiSynthSimulator.h>

Public Member Functions
	ArtisynthSimulator (MonitoringManager *monitoringManager)
	constructor More...
	ArtisynthSimulator (MonitoringManager *monitoringManager, const char *file)
	constructor More...
virtual void	createPml (const char *inputFile, const char *pmlFile)
	Create a pml file from an imput file. More...
bool	doCalc ()
	make entire simulation ans store results of all step More...
void	end ()
	end simultor More...
void	getForce (int index, double force[3])
	get current force for one atom More...
int	getMaxStep ()
	get the number of steps after simulation More...
void	getPosition (int index, double position[3])
	get current position for one atom (use parameters) More...
double	getTime (int step)
	get the time of simulation of a given step More...
void	init ()
	initialize simulator More...
	~ArtisynthSimulator ()
	destructor More...
Public Member Functions inherited from NonInteractiveSimulator
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	createPml (const char *inputFile, const char *pmlFile)=0
	Create a pml file from a simulator specific imput file. More...
virtual void	end ()=0
	end simultor More...
virtual void	getForce (int index, double force[3])=0
	get current force for one atom More...
virtual void	getPosition (int index, double position[3])=0
	get current position for one atom More...
virtual void	init ()=0
	initialize the simulator 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...

Private Member Functions
void	runArtisynth ()
	start Artisynth calculations More...

Private Attributes
std::string	artisynthPath
	Artisynth binary. More...
std::string	workingDir
	Artisynth working dir. More...

Additional Inherited Members
Protected Attributes inherited from Simulator
MonitoringManager *	monitoringManager
	monitoring manager More...

Detailed Description

Simulator class to use Artisynth as simulation engine.

Constructor & Destructor Documentation

ArtisynthSimulator() [1/2]

ArtisynthSimulator::ArtisynthSimulator

(

MonitoringManager *

monitoringManager

)

constructor

ArtisynthSimulator() [2/2]

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

constructor

~ArtisynthSimulator()

ArtisynthSimulator::~ArtisynthSimulator

(

)

destructor

Member Function Documentation

createPml()

void ArtisynthSimulator::createPml ( const char *  inputFile, const char *  pmlFile  )

virtual

Create a pml file from an imput file.

Implements NonInteractiveSimulator.

doCalc()

bool ArtisynthSimulator::doCalc ( )

virtual

make entire simulation ans store results of all step

Returns

true if calculation succeded

Implements NonInteractiveSimulator.

References runArtisynth().

end()

void ArtisynthSimulator::end ( )

virtual

end simultor

Implements NonInteractiveSimulator.

getForce()

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

virtual

get current force for one atom

Implements Simulator.

getMaxStep()

int ArtisynthSimulator::getMaxStep ( )

virtual

get the number of steps after simulation

Implements NonInteractiveSimulator.

References workingDir.

getPosition()

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

virtual

get current position for one atom (use parameters)

Implements NonInteractiveSimulator.

References MonitoringManager::getCurrentStep(), Simulator::monitoringManager, and workingDir.

getTime()

double ArtisynthSimulator::getTime ( int  step )

virtual

get the time of simulation of a given step

Implements NonInteractiveSimulator.

References workingDir.

init()

void ArtisynthSimulator::init ( )

virtual

initialize simulator

Implements NonInteractiveSimulator.

References workingDir.

runArtisynth()

void ArtisynthSimulator::runArtisynth ( )

private

start Artisynth calculations

References artisynthPath, PhysicalModel::exportAnsysMesh(), MonitoringManager::getPml(), Simulator::monitoringManager, and workingDir.

Referenced by doCalc().

Member Data Documentation

artisynthPath

std::string ArtisynthSimulator::artisynthPath

private

Artisynth binary.

Referenced by runArtisynth().

workingDir

std::string ArtisynthSimulator::workingDir

private

Artisynth working dir.

Referenced by getMaxStep(), getPosition(), getTime(), init(), and runArtisynth().

---

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

• ArtiSynthSimulator.h
• ArtiSynthSimulator.cpp