Study

CreatePredefinedGroup

Create a new pre-defined task group based on the given task group name.

Return The newly created group
Type DataReference

Required Arguments

System The system where the task group component should be created.
Type DataReference
Type The type of the new group
Type string

CreateTask

Create a task, given the name for the task type.

Return The component created for the task.
Type DataReference

Required Arguments

System The system where the task component should be created.
Type DataReference
Type The task type to create.
Type string

Optional Arguments

Input Optional, the task component which should be an upstream source for the created component.
Type DataReference
Output Optional, the task component which should be downstream of the created component.
Type DataReference

Example

This example details how to create a Modeling task and a Physics Defintion task where the Modeling task is an input to the Physics Definition task.

    system1 = GetSystem(Name="Study")
    geometryModelingComponent1 = Study.CreateTask(
      Type="Geometry Modeling",
      System=system1)
    physicsDefinitionComponent1 = Study.CreateTask(
      Type="Physics Definition",
      System=system1,
      Input=geometryModelingComponent1)

CreateGroup

Create a new task group based on the given task group name.+

Return The newly created group
Type DataReference

Required Arguments

Name The name of the new group
Type string

EvaluateResults

Evaluates the a group of Results to update their outputs based on the current solution

Required Arguments

Entities The result objects to evaluate
Type DataReferenceSet

GetAllEngineeringDataInProject

Find all engineering data objects in the project.

Return All engineering data objects in the project
Type DataReferenceSet

GetAllLeafTasksInProject

Returns all leaf tasks in the project.

Return All leaf tasks in the project.
Type DataReferenceSet

GetAllObjectsOfType

Returns all the objects of a given type for the study

Return A DataReferenceSet with the objects of the given type
Type DataReferenceSet

Required Arguments

Type The type for which the objects are returned
Type string

GetAllRootTasksInProject

Returns all root tasks in the project.

Return All root tasks in the project.
Type DataReferenceSet

GetAllTaskObjectsOfType

For a given task, returns all the objects of a given type

Return A DataReferenceSet with the objects of the given type
Type DataReferenceSet

Required Arguments

Task The task for which the objects are returned
Type DataReference
Type The type for which the objects are returned
Type string

GetAllTasksInProject

Returns all tasks in the project.

Return All tasks in the project.
Type DataReferenceSet

GetTaskObjectForTask

Return the task object for a given task.

Return The anchor object associated with the task.
Type DataReference

Required Arguments

Task The task to query.
Type DataReference

GetCurrentModelForExtension

Command to be invoked from within a callback in order to get the current model in use for the extension The command SetCurrentModelForExtension must be invoked in order to set the model

Return The current model
Type DataReference

GetInputMesh

If available for a task, return the input mesh; otherwise null.

Return The input mesh.
Type DataReference

Required Arguments

Task The task to query.
Type DataReference

GetInputModel

If available for a task, return the input model; otherwise null.

Return The input model.
Type DataReference

Required Arguments

Task The task to query.
Type DataReference

GetObjectOfTypeAndName

Returns all the objects of a given type and name for the study. Include the "@" prefix if searching by display text

Return A DataReferenceSet with the objects of the given type
Type DataReference

Required Arguments

Name The name of the object. Use @ prefix if searching by display text
Type string
Type The type for which the objects are returned
Type string

GetOutputMesh

If available for a task, return the output mesh; otherwise null.

Return The output mesh.
Type DataReference

Required Arguments

Task The task to query.
Type DataReference

GetOutputModel

If available for a task, return the output model; otherwise null.

Return The output model.
Type DataReference

Required Arguments

Task The task to query.
Type DataReference

GetReferences

Returns a list of reference strings of the specified model components.

Return A List of the reference strings of the specified model components.
Type List<string>

Required Arguments

ModelComponents The DataReferenceSet of the model components of interest.
Type DataReferenceSet

GetReferenceString

Returns a reference string for a user object. This is a special case query, for those objects that contain references, not stored in LocationSets. For now, works on Locator objects only, and is to be used to retrieve the surface area of bounded surfaces: Sphere, Torus, and CappingSurface only.

Return Reference string for the specified object.
Type string

Required Arguments

ObjectReference The DataReference for the specified object that is assumed to be Analytic.
Type DataReference

GetTasksForTaskGroup

Returns the tasks for a given task group

Return The tasks for the task group
Type DataReferenceSet

Required Arguments

TaskGroup The task group for which to search.
Type DataReference

GetTaskUserObjectBelongsTo

Returns a data reference to a Task that the provided UserObject maps to. May return null.

Return The input tasks for the given task.
Type DataReference

Required Arguments

UserObjectReference The user object to map to a task.
Type DataReference

InitializeGuidedSimulations

Initializes data when executing Guided Simulations.

InsertPredefinedGroup

Inserts a new task group based on the given task group name.

Return The newly created group
Type DataReference

Required Arguments

Input The Task or TaskGroup DataReference which should be upstream of the created component.
Type DataReference
Output The Task or TaskGroup DataReference which should be downstream of the created component.
Type DataReference
System The system where the task component should be created.
Type DataReference
Type The name of the new group
Type string

Example

This example will create a connection between two tasks and then insert a Physics Task Group between the two

    system1 = GetSystem(Name="Study")
    solvePhysicsComponent1 = Study.CreateTask(
      Type="Solve Physics",
      System=system1)
           
    resultsEvaluationComponent1 = Study.CreateTask(
      Type="Results Evaluation",
      System=system1,
      Input=solvePhysicsComponent1)
    physicsSolutionGroup1 = Study.InsertPredefinedGroup(
      Type="Physics Solution",
      System=system1,
      Input=solvePhysicsComponent1,
      Output=resultsEvaluationComponent1)

InsertTask

Create a task, given the name for the task type.

Return The component created for the task.
Type DataReference

Required Arguments

Input The Task or TaskGroup DataReference which should be an upstream source for the created component.
Type DataReference
Output The Task or TaskGroup DataReference which should be downstream of the created component.
Type DataReference
System The system where the task component should be created.
Type DataReference
Type The task type to create.
Type string

Example

This example will create two Tasks and insert a third Tasks between the two

    system1 = GetSystem(Name="Study")
    importComponent1 = Study.CreateTask(
      Type="Import",
      System=system1)
    physicsDefinitionComponent1 = Study.CreateTask(
      Type="Physics Definition",
      System=system1,
      Input=importComponent1)
    meshingComponent1 = Study.InsertTask(
      Type="Meshing",
      System=system1,
      Input=importComponent1,
      Output=physicsDefinitionComponent1)

RemovePropertyTables

Removes all property tables from an expression property.

Required Arguments

Parent The DataReference of the object that has the Propety parameter which tables will be removed from.
Type DataReference
Property The String which provides the path of the property on the Parent.
Type string