Public Member Functions | Protected Member Functions | List of all members
openfluid::ware::PluggableSimulator Class Referenceabstract

Abstract class for simulator plugin. More...

#include <ware/PluggableSimulator.hpp>

Inheritance diagram for openfluid::ware::PluggableSimulator:
Inheritance graph
[legend]
Collaboration diagram for openfluid::ware::PluggableSimulator:
Collaboration graph
[legend]

Public Member Functions

 PluggableSimulator ()
 
virtual ~PluggableSimulator ()
 
void initializeWare (const WareID_t &SimID, const unsigned int &MaxThreads)
 
virtual void initParams (const openfluid::ware::WareParams_t &Params)=0
 
virtual void prepareData ()=0
 
virtual void checkConsistency ()=0
 
virtual openfluid::base::SchedulingRequest initializeRun ()=0
 
virtual openfluid::base::SchedulingRequest runStep ()=0
 
virtual void finalizeRun ()=0
 
- Public Member Functions inherited from openfluid::ware::SimulationContributorWare
virtual ~SimulationContributorWare ()
 
- Public Member Functions inherited from openfluid::ware::SimulationInspectorWare
virtual ~SimulationInspectorWare ()
 
void linkToSpatialGraph (openfluid::core::SpatialGraph *SGraph)
 
void linkToDatastore (openfluid::core::Datastore *DStore)
 
- Public Member Functions inherited from openfluid::ware::SimulationDrivenWare
virtual ~SimulationDrivenWare ()
 
void linkToSimulation (const openfluid::base::SimulationStatus *SimStatus)
 
void linkToSimulationLogger (openfluid::base::SimulationLogger *SimLogger)
 
void initializeWare (const WareID_t &ID)
 
void finalizeWare ()
 
void setPreviousTimeIndex (const openfluid::core::TimeIndex_t &TimeIndex)
 
- Public Member Functions inherited from openfluid::ware::PluggableWare
virtual ~PluggableWare ()
 
void linkToRunEnvironment (const openfluid::core::MapValue *Env)
 

Protected Member Functions

bool OPENFLUID_IsSimulatorParameterExist (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName) const
 
openfluid::core::StringValue OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::StringValue &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::DoubleValue &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::VectorValue &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::MatrixValue &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, double &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, long &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, float &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, int &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::string &Val) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::vector< std::string > &Vals) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::vector< double > &Vals) const
 
bool OPENFLUID_GetSimulatorParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::vector< long > &Vals) const
 
int OPENFLUID_GetSimulatorMaxThreads () const
 
void OPENFLUID_SetSimulatorMaxThreads (const int &MaxNumThreads)
 
openfluid::base::SchedulingRequest AtTheEnd () const
 
openfluid::base::SchedulingRequest Never () const
 
openfluid::base::SchedulingRequest DefaultDeltaT () const
 
openfluid::base::SchedulingRequest MultipliedDefaultDeltaT (const double &Mult) const
 
openfluid::base::SchedulingRequest Duration (const openfluid::core::Duration_t &D) const
 
- Protected Member Functions inherited from openfluid::ware::SimulationContributorWare
void OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const openfluid::core::Value &Val)
 
void OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const double &Val)
 
void OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, bool Val)
 
void OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const long &Val)
 
void OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const std::string &Val)
 
void OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
 
void OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit &aUnit, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
 
void OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const double &Val)
 
void OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const long &Val)
 
void OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const bool &Val)
 
void OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const std::string &Val)
 
void OPENFLUID_AppendVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
 
void OPENFLUID_AppendVariable (openfluid::core::SpatialUnit &aUnit, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
 
void OPENFLUID_AppendVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const double &Val)
 
void OPENFLUID_AppendVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const long &Val)
 
void OPENFLUID_AppendVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const bool &Val)
 
void OPENFLUID_AppendVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const std::string &Val)
 
void OPENFLUID_SetVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
 
void OPENFLUID_SetVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const double &Val)
 
void OPENFLUID_SetVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const long &Val)
 
void OPENFLUID_SetVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const bool &Val)
 
void OPENFLUID_SetVariable (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const std::string &Val)
 
void OPENFLUID_AppendEvent (openfluid::core::SpatialUnit *UnitPtr, openfluid::core::Event &Ev)
 
void OPENFLUID_AddUnit (const openfluid::core::UnitsClass_t &ClassName, openfluid::core::UnitID_t ID, openfluid::core::PcsOrd_t PcsOrder)
 
void OPENFLUID_DeleteUnit (const openfluid::core::UnitsClass_t &ClassName, openfluid::core::UnitID_t ID)
 
bool OPENFLUID_AddFromToConnection (const openfluid::core::UnitsClass_t &ClassNameFrom, openfluid::core::UnitID_t IDFrom, const openfluid::core::UnitsClass_t &ClassNameTo, openfluid::core::UnitID_t IDTo)
 
bool OPENFLUID_AddFromToConnection (openfluid::core::SpatialUnit *FromUnit, openfluid::core::SpatialUnit *ToUnit)
 
bool OPENFLUID_RemoveFromToConnection (const openfluid::core::UnitsClass_t &ClassNameFrom, openfluid::core::UnitID_t IDFrom, const openfluid::core::UnitsClass_t &ClassNameTo, openfluid::core::UnitID_t IDTo)
 
bool OPENFLUID_RemoveFromToConnection (openfluid::core::SpatialUnit *FromUnit, openfluid::core::SpatialUnit *ToUnit)
 
bool OPENFLUID_AddChildParentConnection (const openfluid::core::UnitsClass_t &ClassNameChild, openfluid::core::UnitID_t IDChild, const openfluid::core::UnitsClass_t &ClassNameParent, openfluid::core::UnitID_t IDParent)
 
bool OPENFLUID_AddChildParentConnection (openfluid::core::SpatialUnit *ChildUnit, openfluid::core::SpatialUnit *ParentUnit)
 
bool OPENFLUID_RemoveChildParentConnection (const openfluid::core::UnitsClass_t &ClassNameChild, openfluid::core::UnitID_t IDChild, const openfluid::core::UnitsClass_t &ClassNameParent, openfluid::core::UnitID_t IDParent)
 
bool OPENFLUID_RemoveChildParentConnection (openfluid::core::SpatialUnit *ChildUnit, openfluid::core::SpatialUnit *ParentUnit)
 
void OPENFLUID_BuildUnitsMatrix (const openfluid::core::UnitsClass_t &UnitsClass, const unsigned int &ColsNbr, const unsigned int &RowsNbr)
 
 SimulationContributorWare (WareType WType)
 
- Protected Member Functions inherited from openfluid::ware::SimulationInspectorWare
virtual bool isLinked () const
 
bool OPENFLUID_IsAttributeExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName) const
 
void OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, openfluid::core::Value &Val) const
 
void OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, double &Val) const
 
void OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, long &Val) const
 
void OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, std::string &Val) const
 
const openfluid::core::ValueOPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName) const
 
bool OPENFLUID_IsVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
 
bool OPENFLUID_IsVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index) const
 
bool OPENFLUID_IsVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, const openfluid::core::Value::Type ValueType) const
 
bool OPENFLUID_IsTypedVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value::Type VarType) const
 
bool OPENFLUID_IsTypedVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, const openfluid::core::Value::Type VarType) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, openfluid::core::Value &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, double &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, long &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, bool &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, std::string &Val) const
 
const openfluid::core::ValueOPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, openfluid::core::Value &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, double &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, long &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, bool &Val) const
 
void OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, std::string &Val) const
 
const openfluid::core::ValueOPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
 
void OPENFLUID_GetLatestVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, openfluid::core::IndexedValue &IndVal) const
 
openfluid::core::IndexedValue OPENFLUID_GetLatestVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
 
void OPENFLUID_GetLatestVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, openfluid::core::IndexedValueList &IndValList) const
 
openfluid::core::IndexedValueList OPENFLUID_GetLatestVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex) const
 
void OPENFLUID_GetVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, const openfluid::core::TimeIndex_t EndIndex, openfluid::core::IndexedValueList &IndValList) const
 
openfluid::core::IndexedValueList OPENFLUID_GetVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, const openfluid::core::TimeIndex_t EndIndex) const
 
void OPENFLUID_GetEvents (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate, openfluid::core::EventsCollection &Events) const
 
openfluid::core::EventsCollection OPENFLUID_GetEvents (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate) const
 
bool OPENFLUID_IsUnitsClassExist (const openfluid::core::UnitsClass_t &ClassName) const
 
bool OPENFLUID_IsUnitClassExist (const openfluid::core::UnitsClass_t &ClassName) const OPENFLUID_DEPRECATED
 
bool OPENFLUID_IsUnitExist (const openfluid::core::UnitsClass_t &ClassName, openfluid::core::UnitID_t ID) const
 
void OPENFLUID_GetUnitsCount (unsigned int &UnitsCount) const
 
unsigned int OPENFLUID_GetUnitsCount () const
 
bool OPENFLUID_GetUnitsCount (const openfluid::core::UnitsClass_t &ClassName, unsigned int &UnitsCount) const
 
unsigned int OPENFLUID_GetUnitsCount (const openfluid::core::UnitsClass_t &ClassName) const
 
bool OPENFLUID_GetUnit (const openfluid::core::UnitsClass_t &ClassName, const openfluid::core::UnitID_t &ID, openfluid::core::SpatialUnit *aUnit) const
 
openfluid::core::SpatialUnitOPENFLUID_GetUnit (const openfluid::core::UnitsClass_t &ClassName, const openfluid::core::UnitID_t &ID) const
 
openfluid::core::UnitsPtrList_t OPENFLUID_GetUnits (const openfluid::core::UnitsClass_t &ClassName)
 
bool OPENFLUID_IsUnitConnectedTo (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameTo, const openfluid::core::UnitID_t &IDTo) const
 
bool OPENFLUID_IsUnitConnectedFrom (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameFrom, const openfluid::core::UnitID_t &IDFrom) const
 
bool OPENFLUID_IsUnitChildOf (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameParent, const openfluid::core::UnitID_t &IDParent) const
 
bool OPENFLUID_IsUnitParentOf (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameChild, const openfluid::core::UnitID_t &IDChild) const
 
 SimulationInspectorWare (WareType WType)
 
- Protected Member Functions inherited from openfluid::ware::SimulationDrivenWare
void appendToLog (openfluid::tools::FileLogger::LogType LType, const std::string &Msg) const
 
void displayToConsole (openfluid::tools::FileLogger::LogType LType, const std::string &Msg) const
 
openfluid::base::ExceptionContext computeWareContext (const std::string &CodeLoc="") const
 
openfluid::base::ExceptionContext computeFrameworkContext (const std::string &CodeLoc="") const
 
openfluid::core::DateTime OPENFLUID_GetBeginDate () const
 
openfluid::core::DateTime OPENFLUID_GetEndDate () const
 
openfluid::core::DateTime OPENFLUID_GetCurrentDate () const
 
openfluid::core::Duration_t OPENFLUID_GetSimulationDuration () const
 
openfluid::core::Duration_t OPENFLUID_GetDefaultDeltaT () const
 
openfluid::core::TimeIndex_t OPENFLUID_GetCurrentTimeIndex () const
 
openfluid::core::TimeIndex_t OPENFLUID_GetPreviousRunTimeIndex () const
 
openfluid::base::SimulationStatus::SimulationStage OPENFLUID_GetCurrentStage () const
 
std::string OPENFLUID_GetCurrentStageAsString () const
 
openfluid::base::SimulationStatus::SchedulingConstraint OPENFLUID_GetSchedulingConstraint () const
 
virtual void OPENFLUID_RaiseWarning (const std::string &Msg)
 
virtual void OPENFLUID_RaiseWarning (const std::string &Source, const std::string &Msg) OPENFLUID_DEPRECATED
 
virtual void OPENFLUID_RaiseError (const std::string &Msg)
 
virtual void OPENFLUID_RaiseError (const std::string &Source, const std::string &Msg) OPENFLUID_DEPRECATED
 
 SimulationDrivenWare (WareType WType)
 
- Protected Member Functions inherited from openfluid::ware::PluggableWare
bool OPENFLUID_GetRunEnvironment (const std::string &Key, std::string &Val)
 
bool OPENFLUID_GetRunEnvironment (const std::string &Key, bool &Val)
 
WareID_t OPENFLUID_GetWareID () const
 
WareType OPENFLUID_GetWareType () const
 
 PluggableWare (WareType WType)
 

Additional Inherited Members

- Static Public Member Functions inherited from openfluid::ware::PluggableWare
static bool isWellFormated (const openfluid::ware::WareParamKey_t &ParameterKey)
 
- Protected Attributes inherited from openfluid::ware::SimulationInspectorWare
openfluid::core::SpatialGraphmp_SpatialData
 
- Protected Attributes inherited from openfluid::ware::PluggableWare
bool m_Initialized
 

Detailed Description

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.

Author
Jean-Christophe FABRE jean-.nosp@m.chri.nosp@m.stoph.nosp@m.e.fa.nosp@m.bre@s.nosp@m.upag.nosp@m.ro.in.nosp@m.ra.f.nosp@m.r

Constructor & Destructor Documentation

openfluid::ware::PluggableSimulator::PluggableSimulator ( )

Constructor

virtual openfluid::ware::PluggableSimulator::~PluggableSimulator ( )
virtual

Virtual destructor

Member Function Documentation

openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::AtTheEnd ( ) const
inlineprotected

Returns a scheduling request to a single scheduling at the end Return the corresponding scheduling request

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
inlineprotected

Returns a scheduling request for the default DeltaT value Return the corresponding scheduling request

openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::Duration ( const openfluid::core::Duration_t D) const
inlineprotected

Returns a scheduling request for a given duration

Parameters
[in]Da duration in seconds Return the corresponding scheduling request
virtual void openfluid::ware::PluggableSimulator::finalizeRun ( )
pure virtual
virtual openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::initializeRun ( )
pure virtual
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
inlineprotected

Returns a scheduling request for the default DeltaT value multiplied by a factor

Parameters
[in]Multthe multiplication factor Return the corresponding scheduling request
openfluid::base::SchedulingRequest openfluid::ware::PluggableSimulator::Never ( ) const
inlineprotected

Returns a scheduling request to never be scheduled again Return the corresponding scheduling request

int openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorMaxThreads ( ) const
inlineprotected

Returns the maximum number of threads that can be concurrently run in threaded spatial loops

Returns
the number of threads
openfluid::core::StringValue openfluid::ware::PluggableSimulator::OPENFLUID_GetSimulatorParameter ( const openfluid::ware::WareParams_t Params,
const openfluid::ware::WareParamKey_t ParamName 
) const
protected

Returns a simulator parameter from the parameters set, as a StringValue

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
Returns
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::StringValue Val 
) const
protected

Gets a simulator parameter from the parameters set, as a StringValue

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valthe value of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valsthe vector of values of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valsthe vector of values of the requested parameter
Returns
true if the parameter exists, false otherwise
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

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
[out]Valsthe vector of values of the requested parameter
Returns
true if the parameter exists, false otherwise
bool openfluid::ware::PluggableSimulator::OPENFLUID_IsSimulatorParameterExist ( const openfluid::ware::WareParams_t Params,
const openfluid::ware::WareParamKey_t ParamName 
) const
protected

Returns true if the parameter exists

Parameters
[in]Paramsthe parameters set for the simulator
[in]ParamNamethe name of the requested parameter
Returns
true if the parameter exists, false otherwise
void openfluid::ware::PluggableSimulator::OPENFLUID_SetSimulatorMaxThreads ( const int &  MaxNumThreads)
protected

Sets the maximum number of threads that can be concurrently run in threaded spatial loops

Parameters
[in]MaxNumThreadsthe 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

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