ansys::Project::Run Class Reference

Constructor from Iterator.

The input Iterator must be of subclass Run If the subclass is not Run, the Run object is invalid ( !ok() )

Register an output variable for this run.

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

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 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

Get the Output sequence, ordered by the specified parameter.

Retrieve the output list, as ordered by a specific recipe and based on the value of a variable.

The default getOutput() will return the outputs as ordered by their creation order. In a simple transient or steady run, this will be sufficient to get the ordered datasets. Transient postprocessing typically assumes a monotonic (increasing, unique values) sequence. Parametric runs might have their dataset generated in any order, and a sorted list of outputs might be desirable.

Parameters

pOrcer

: Indicate the order of the outputs CreationID : Order by creation index, the pVariable argument is unused MonotonicIncreasing : Strictly increating sequence of values for the specified variable. If the sequence reverts to a prior step, only the newer values are returned. 1,2,[3,4,5]{3,4,5,6} -> 1,2,{3,4,5,6} Increasing : Outputs are sorted by the specified variable low to high value IncreasingUnique : As Increasing, but duplicates are removed in case of duplicate, the newest entry is kept. Decreasing : Outputs are sorted by the specified variable high to low value DecreasingUnique : As Increasing, but duplicates are removed in case of duplicate, the newest entry is kept.

pVariable

: Variable name to use in comparison Must be an integer or floating point property. The variable must be defined for all outputs.

RunOutputAttr contains the list of standard variable names See: RunOutputAttr::sVarTime, RunOutputAttr::sVarSolverIteration, etc.

Parameters

pOutputs

: Array with Output ordered as specified

Returns

: Error in case of unknown variable or invalid parameters

Get the list of outputs matching the specified condition.

Returns the subset of outputs matching the specified condition, the outputs will not have any specified order. See also getOutputSequence()

Parameters

pVariable	: Name of the variable to check
pOperator	: Operator to use
pValue	: Value for comparison

Return the list of results in the current Run and Output subfolders, as vector of Iterator.

Parameters

pType	The type queried. Typically "Result"
pSubtype	The ResultType queried (for example "fluent-dat")

Return the list of results in the current Run and Output subfolders.

Parameters

pType	The type queried. Typically "Result"
pSubtype	The ResultType queried (for example "fluent-dat")

For transient runs - return the list of output results and their time values.

The output runs are processed to return a monotonic (increasing, unique values) sequence (see getOutputSequence()). For each output of that sequence, if a result of the specified type exist, its returned alongside with the time value.

Parameters

pResultType	File type (ResultType metadata) of the result query
pOutIterators	(output)
pOutTimeval	(output)

Search the metadata (local and inherited) for the specified key and return the value as string.

Parameters

pFlagInherited

: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally

Implements ansys::Project::RunOutputAttr.

Search the metadata (local and inherited) for the specified key and return the value as double.

Parameters

pFlagInherited

: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally

Implements ansys::Project::RunOutputAttr.

Search the metadata (local and inherited) for the specified key and return the value as integer.

Parameters

pFlagInherited

: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally

Implements ansys::Project::RunOutputAttr.

Search the metadata (local and inherited) for the specified metadata link and return the value as an iterator.

Parameters

pFlagInherited

: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally

Search the metadata (local and inherited) for the specified key and return the its data type.

Parameters

pFlagInherited

: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally

Implements ansys::Project::RunOutputAttr.

Search the metadata (local and inherited) for the specified key.

Parameters

pFlagInherited

: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally

Implements ansys::Project::RunOutputAttr.

Create a Output folder in the current Run folder.

The Output folder is by default a virtual (project-only) folder and no folder is created in the filesystem. By default, all Result owned by a Run/Output are stored in the same disk folder, but the Project structure regroup each group of Result in an Output block.

Parameters

pName

: Name of the output folder , use "" to have a default automatic name generated ( o###### )

Remove the specified list of Output from the children of this run.

Parameters

pEraseFiles

If true, the associated files to the outputs will be erased

Remove a variable from the list of inputs.

Mandatory variables cannot be removed

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.