Abstract class for simulator plugin. More...
#include <ware/PluggableSimulator.hpp>
Abstract class for simulator plugin.
Abstract class for simulator plugin interface, defining the minimal structure for a simulator.
All simulators must inherit from this class.
Constructor
virtual openfluid::ware::PluggableSimulator::~PluggableSimulator | ( | ) | [virtual] |
Virtual destructor
openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::AtTheEnd | ( | ) | const [inline, protected] |
virtual void openfluid::ware::PluggableSimulator::checkConsistency | ( | ) | [pure virtual] |
Checks the simulator consistency. Internally called by the framework.
Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.
openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::DefaultDeltaT | ( | ) | const [inline, protected] |
openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::Duration | ( | const openfluid::core::Duration_t & | D | ) | const [inline, protected] |
virtual void openfluid::ware::PluggableSimulator::finalizeRun | ( | ) | [pure virtual] |
Internally called by the framework.
Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.
virtual openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::initializeRun | ( | ) | [pure virtual] |
Internally called by the framework.
Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.
void openfluid::ware::PluggableSimulator::initializeWare | ( | const WareID_t & | SimID, |
const unsigned int & | MaxThreads | ||
) |
Internally called by the framework.
virtual void openfluid::ware::PluggableSimulator::initParams | ( | const openfluid::ware::WareParams_t & | Params | ) | [pure virtual] |
Initializes simulator parameters of the simulator, given as a hash map. Internally called by the framework.
Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.
openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::MultipliedDefaultDeltaT | ( | const double & | Mult | ) | const [inline, protected] |
openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::Never | ( | ) | const [inline, protected] |
unsigned int openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorMaxThreads | ( | ) | const [inline, protected] |
Returns the maximum number of threads that can be concurrently run in threaded spatial loops
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
openfluid::core::StringValue & | Val | ||
) | const [protected] |
Gets a simulator parameter from the parameters set, as a StringValue
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
openfluid::core::DoubleValue & | Val | ||
) | const [protected] |
Gets a simulator parameter from the parameters set, as a DoubleValue
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
openfluid::core::VectorValue & | Val | ||
) | const [protected] |
Gets a simulator parameter from the parameters set, as a VectorValue
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
openfluid::core::MatrixValue & | Val | ||
) | const [protected] |
Gets a simulator parameter from the parameters set, as a MatrixValue
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
double & | Val | ||
) | const [protected] |
Gets a simulator parameter from the parameters set, as a double
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
long & | Val | ||
) | const [protected] |
Gets a simulator parameter value from the parameters set, as a long int
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
float & | Val | ||
) | const [protected] |
Gets a simulator parameter from the parameters set, as a float
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
int & | Val | ||
) | const [protected] |
Gets a simulator parameter value from the parameters set, as an int
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
std::string & | Val | ||
) | const [protected] |
Gets a simulator parameter value from the parameters set, as a string
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Val | the value of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
std::vector< std::string > & | Vals | ||
) | const [protected] |
Gets a simulator parameter vector of values from the parameters set, as a vector of strings
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Vals | the vector of values of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
std::vector< double > & | Vals | ||
) | const [protected] |
Gets a simulator parameter vector of values from the parameters set, as a vector of doubles
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Vals | the vector of values of the requested parameter |
bool openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter | ( | const openfluid::ware::WareParams_t & | Params, |
const openfluid::ware::WareParamKey_t & | ParamName, | ||
std::vector< long > & | Vals | ||
) | const [protected] |
Gets a simulator parameter vector of values from the parameters set, as a vector of long ints
[in] | Params | the parameters set for the simulator |
[in] | ParamName | the name of the requested parameter |
[out] | Vals | the vector of values of the requested parameter |
void openfluid::ware::PluggableSimulator::OPENFLUID_SetSimulatorMaxThreads | ( | const unsigned int & | MaxNumThreads | ) | [protected] |
Sets the maximum number of threads that can be concurrently run in threaded spatial loops
[in] | MaxNumThreads | the number of threads |
virtual void openfluid::ware::PluggableSimulator::prepareData | ( | ) | [pure virtual] |
Prepares data. Internally called by the framework.
Implemented in openfluid::machine::Generator, openfluid::machine::InjectGenerator, and openfluid::machine::InterpGenerator.
virtual openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::runStep | ( | ) | [pure virtual] |
Internally called by the framework.
Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.