RunGroup
Last update: 16.07.2025The return state / error value of a Project function call.
Definition: Error.hpp:11
Optional concept - Virtual folder with a list of Run.
Definition: RunGroup.hpp:17
Subfolder of a Simulation, regrouping Output/Result for a step.
Definition: Run.hpp:18
void addVarTime()
Add the Time variable (not required if mandatory for the run type)
Definition: Run.cpp:615
bool setOutputVariables(const std::vector< std::string > &pVars)
Set/replace the list of output variables.
Definition: Run.cpp:375
void addVarCaseId()
Add the CaseId variable - Id is incremented when the case settings are changed.
Definition: Run.cpp:698
bool setVariables(const std::vector< std::string > &pVars)
Set/replace the list of variables for this run.
Definition: Run.cpp:265
void addVarSolverIteration()
Add the SolverIteration variable (not required if mandatory for the run type)
Definition: Run.cpp:623
void addVarCoordinatesId()
Add the CoordinatesId variable - Id should be incremented when the node locations of a mesh have chan...
Definition: Run.cpp:672
void addVarConnectivityId()
Add the ConnectivityId variable - Id should be incremented when the cells of a mesh are changed (numb...
Definition: Run.cpp:690
void addVarCrankAngle()
Add the built-in variable.
Definition: Run.cpp:631
bool removeVariable(const std::string &pVar)
Remove a variable from the list of inputs.
Definition: Run.cpp:293
void addVarTopologyId()
Add the TopologyId variable - Id should be incremented when the topology (list of boundaries,...
Definition: Run.cpp:663
RunStatus getRunStatus() const
Returns the RunStatus state for this Output. See setRunStatus()
Definition: Run.cpp:1258
std::string getRunOutputTypeAsString() const
Return the RunOutputType as a string.
Definition: Run.cpp:455
void addVarIndex()
Add the Index variable (not required if mandatory for the run type)
Definition: Run.cpp:607
bool addOutputVariable(const std::string &pVar)
Register an output variable for this run.
Definition: Run.cpp:358
std::vector< std::string > getOutputVariables() const
Returns the list of output variables.
Definition: Run.cpp:402
void addVarPhysicsId()
Add the PhysicsId variable - Id should be incremented when the physics settings have changed.
Definition: Run.cpp:655
bool addVariable(const std::string &pVar)
Register an input variable for this run.
Definition: Run.cpp:243
void addVarMeshId()
Add the MeshId variable - Id should be incremented when the mesh has changed.
Definition: Run.cpp:639
void addVarInputSettingsId()
Add the InputSettings variable - Id is incremented when the input case settings are changed.
Definition: Run.cpp:709
void setRunStatus(RunStatus pStatus)
Set the RunStatus state for this Run.
Definition: Run.cpp:1249
bool removeOutputVariable(const std::string &pVar)
Remove an output variable.
Definition: Run.cpp:384
std::vector< std::string > getAllVariables() const
Returns the list of all variables ( input and output )
Definition: Run.cpp:410
void addVarOutputSettingsId()
Add the OutputSettings variable - Id is incremented when the case output settings are changed.
Definition: Run.cpp:717
std::vector< std::string > getVariables() const
Return the list of input variables for this Run.
Definition: Run.cpp:330
RunOutputType getRunOutputType() const
Return the RunOutputType as the enum.
Definition: Run.cpp:463
void addVarDomainTransformationId()
Add the DomainTransformationId variable - Id should be incremented when the mesh transformation metad...
Definition: Run.cpp:647
Definition: API.dox:1