ansys::Project::RunGroup Class Reference

Register an output variable for this run.

All Output subfolders should define a specific value for this variable.

Register a Run in the RunGroup.

The Run is referenced as a project Link in the virtual subfolder

Add the CaseId variable - Id is incremented when the case settings are changed.

Add the ConnectivityId variable - Id should be incremented when the cells of a mesh are changed (number changed, connectivity changed, ...)

Add the CoordinatesId variable - Id should be incremented when the node locations of a mesh have changed.

Add the built-in variable.

Add the DomainTransformationId variable - Id should be incremented when the mesh transformation metadata has changed.

Register an input variable for this run.

This registration is not required for automatic variables (Transient=Time, etc.)

All Output subfolders should define a specific value for this variable.

Add the Index variable (not required if mandatory for the run type)

Add the InputSettings variable - Id is incremented when the input case settings are changed.

If provided, this should be incremented when any of the dependent input settings are changed, such as PhysicsId or DomainTransformationId

Add the MeshId variable - Id should be incremented when the mesh has changed.

Add the OutputSettings variable - Id is incremented when the case output settings are changed.

Add the PhysicsId variable - Id should be incremented when the physics settings have changed.

Add the SolverIteration variable (not required if mandatory for the run type)

Add the Time variable (not required if mandatory for the run type)

Add the TopologyId variable - Id should be incremented when the topology (list of boundaries, domains) has changed.

Returns the list of all variables ( input and output )

Reimplemented from ansys::Project::Run.

Returns the list of output variables.

Return the RunOutputType as the enum.

Return the RunOutputType as a string.

Returns the list of runs for this RunGroup.

Returns the RunStatus state for this Output. See setRunStatus()

Return the list of input variables for this Run.

Returns error with message if invalid.

Reimplemented from ansys::Project::Run.

Remove an output variable.

Remove a variable from the list of inputs.

Mandatory variables cannot be removed

Set/replace the list of output variables.

Set the run output type, will add automatically the mandatory variables (if any)

The RunOutputType::Simple cannot be used for a RunGroup

Set the RunStatus state for this Run.

(Optional API) The run status permits to indicate if a Run is running, completed, waiting for execution, etc. This status can also be defined at the Output level

Set/replace the list of variables for this run.

The operation will fail if the list of variables does not contain the mandatory variable for the RunOutputType

All Output subfolders should define a specific value for each variable.