Concrete implementation of an Opal simulation wrapper. More...

#include <OpalSimulation.h>

Inheritance diagram for OpalSimulation:

Collaboration diagram for OpalSimulation:

Public Member Functions
	OpalSimulation (Expressions::Named_t objectives, Expressions::Named_t constraints, Param_t params, std::string name, MPI_Comm comm, CmdArguments_t args, std::map< std::string, std::string > uvars)

virtual	~OpalSimulation ()

void	run ()

std::map< std::string, std::vector< double > >	getData (const std::vector< std::string > &statVariables)

void	collectResults ()
	Parse SDDS stat file and build up requested variable dictionary. More...

void	cleanUp ()

void	cleanUp (const std::vector< std::string > &keep)
	remove temporary files except to the ones in 'keep' More...

reqVarContainer_t	getResults ()
	returns container containing all requested variables with results More...

void	setFilename (int id)
	set job id (SAMPLE command) More...

Public Member Functions inherited from Simulation
	Simulation (CmdArguments_t args)

	~Simulation ()

CmdArguments_t	getArgs ()

virtual void	run ()=0

virtual void	collectResults ()=0

virtual reqVarContainer_t	getResults ()=0

Private Member Functions
void	invalidBunch ()
	mark a solution as invalid More...

bool	hasResultsAvailable ()
	check if we already have simulated the current set of design vars More...

void	createSymlink_m (const std::string &path)
	create symbolic links More...

void	copyH5_m ()
	copy H5 file More...

void	setupSimulation ()
	create directories, input files, fieldmaps... More...

void	setupFSStructure ()
	create directories, input files, symlinks... More...

void	getVariableDictionary (variableDictionary_t &dictionary, const std::string &filename, const Expressions::Expr_t *const expression)
	get variables for expression evaluation from SDDS file. Can throw SDDSParserException More...

void	redirectOutToFile ()
	redirect stdout and stderr to file More...

void	restoreOut ()
	restore stdout and stderr to default More...

Private Attributes
std::string	simulationName_
	identification of the simulation (corresponding to output filename) More...

std::string	simulationDirName_
	full path of simulation directory (where simulation will be run) More...

std::string	simTmpDir_
	temporary directory for simulation data (environment var SIMTMPDIR) More...

std::string	pwd_
	holds current directory (for restoring) More...

std::streambuf *	strm_buffer_
	stream buffer to redirect output More...

std::streambuf *	strm_err_
	stream buffer to redirect stderr More...

std::map< std::string, std::string >	userVariables_
	variable dictionary holding requested optimizer values More...

reqVarContainer_t	requestedVars_
	holds solutions returned to the optimizer More...

Expressions::Named_t	objectives_

Expressions::Named_t	constraints_

std::set< std::string >	dvarNames_

MPI_Comm	comm_

boost::scoped_ptr< GenerateOpalSimulation >	gs_
	object to generate simulation input files More...

int	id_m
	job id (SAMPLE command) More...

Detailed Description

Concrete implementation of an Opal simulation wrapper.

See also: http://amas.web.psi.ch

In order to work properly the user must ensure that the environment variables

SIMTMPDIR (temporary directory for simulation input data) and
TEMPLATES (directory containing tmpl file)

are specified correctly.

Definition at line 30 of file OpalSimulation.h.

Constructor & Destructor Documentation

◆ OpalSimulation()

OpalSimulation::OpalSimulation	(	Expressions::Named_t	objectives,
		Expressions::Named_t	constraints,
		Param_t	params,
		std::string	name,
		MPI_Comm	comm,
		CmdArguments_t	args,
		std::map< std::string, std::string >	uvars
	)

Setup OPAL run.

Parameters

[in]	objectives	of the optimization problem
[in]	constraints	of the optimization problem
[in]	params
[in]	name	of the simulation
[in]	comm	MPI communicator used for running the simulation
[in]	args	command line arguments passed to the framework
[in]	uvars	defined in the input file (e.g. REAL a = 1.0)

Definition at line 40 of file OpalSimulation.cpp.

References dvarNames_, endl(), Hypervolume::fs, NativeHashGenerator::generate(), gs_, name, simTmpDir_, simulationDirName_, simulationName_, and userVariables_.

Here is the call graph for this function:

◆ ~OpalSimulation()

OpalSimulation::~OpalSimulation ( )

virtual

Definition at line 137 of file OpalSimulation.cpp.

References requestedVars_, and userVariables_.

Member Function Documentation

◆ cleanUp() [1/2]

void OpalSimulation::cleanUp ( )

remove temporary simulation files (if Boost filesystem library is not available, this call do nothing).

Definition at line 625 of file OpalSimulation.cpp.

References comm_, endl(), Hypervolume::fs, and simulationDirName_.

Referenced by collectResults().

Here is the call graph for this function:

◆ cleanUp() [2/2]

void OpalSimulation::cleanUp ( const std::vector< std::string > & keep )

remove temporary files except to the ones in 'keep'

Definition at line 641 of file OpalSimulation.cpp.

References comm_, endl(), Expressions::find(), Hypervolume::fs, simulationDirName_, and Util::toUpper().

Here is the call graph for this function:

◆ collectResults()

void OpalSimulation::collectResults ( )

virtual

Parse SDDS stat file and build up requested variable dictionary.

Implements Simulation.

Definition at line 467 of file OpalSimulation.cpp.

References cleanUp(), constraints_, Physics::e, endl(), Expression::evaluate(), EVALUATE, Expression::getRegFuncs(), getVariableDictionary(), invalidBunch(), objectives_, pwd_, requestedVars_, simulationDirName_, simulationName_, and Expression::toString().

Here is the call graph for this function:

◆ copyH5_m()

void OpalSimulation::copyH5_m ( )

private

copy H5 file

Definition at line 175 of file OpalSimulation.cpp.

References endl(), Hypervolume::fs, Simulation::getArgs(), simulationDirName_, and simulationName_.

Referenced by setupFSStructure().

Here is the call graph for this function:

◆ createSymlink_m()

void OpalSimulation::createSymlink_m ( const std::string & path )

private

create symbolic links

Definition at line 157 of file OpalSimulation.cpp.

References Physics::e, endl(), Hypervolume::fs, and simulationDirName_.

Referenced by setupFSStructure().

Here is the call graph for this function:

◆ getData()

std::map< std::string, std::vector< double > > OpalSimulation::getData ( const std::vector< std::string > & statVariables )

Definition at line 442 of file OpalSimulation.cpp.

References Physics::e, endl(), SDDS::SDDSParser::getBoostVariantValue(), SDDS::SDDSParser::getColumnData(), SDDS::SDDSParser::getColumnType(), SDDS::SDDSParser::run(), simulationDirName_, and simulationName_.

Here is the call graph for this function:

◆ getResults()

reqVarContainer_t OpalSimulation::getResults ( )

inlinevirtual

returns container containing all requested variables with results

Implements Simulation.

Definition at line 70 of file OpalSimulation.h.

References requestedVars_.

◆ getVariableDictionary()

void OpalSimulation::getVariableDictionary	(	variableDictionary_t &	dictionary,
		const std::string &	filename,
		const Expressions::Expr_t *const	expression
	)