Project

Project
This container holds the Systems, Components and Templates in the project.

Data Entities

Component

No details are provided for this entry.

Properties

DirectoryName

No details are provided for this entry.

Type string
Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Notes

No details are provided for this entry.

Type string
Read Only No

UserId

No details are provided for this entry.

Type string
Read Only Yes

Methods

Clean

No details are provided for this entry.

DeleteShare

No details are provided for this entry.

Optional Arguments

System No details are provided for this entry.
Type DataReference

DeleteTransfer

No details are provided for this entry.

Required Arguments

TargetComponent No details are provided for this entry.
Type DataReference

GetAIMMechanicalPhysicsDefinitionOutput

This method is available only in AIM. For the given Physics Definition schematic component, return it's valid Mechanical Physics Definition output

Return The AIMMechanicalPhysicsDefinitionOutput object associated with the project schematic component.
Type DataReference

GetContainer

No details are provided for this entry.

Return No details are provided for this entry.
Type DataContainerReference

GetFluentMeshOutput

This method is available only in AIM. For the given Meshing schematic component, return it's valid FluentMesh output

Return The AIMFluentMeshOutput object associated with the project schematic component.
Type DataReference

GetFluentPartMeshOutputProvider

This method is available only in AIM. For the given Meshing schematic component, return it's valid FluentMesh output

Return The AIMFluentPartMeshOutputProvider object associated with the project schematic component.
Type DataReference

GetFluentPhysicsDefinitionOutput

This method is available only in AIM. For the given Meshing schematic component, return it's valid FluentPhysicsDefinition output for Fluent

Return The AIMFluentPhysicsDefinitionOutput object associated with the project schematic component.
Type DataReference

GetGeometryMeshOutput

This method is available only in AIM. For the given Meshing schematic component, return it's valid GeometryMesh output

Return The AIMGeometryMeshOutput object associated with the project schematic component.
Type DataReference

GetTaskObject

This method is available only in AIM. For the given project schematic component, return it's anchor object.

Return The anchor object associated with the project schematic component.
Type DataReference

HasValidPartMesh

For the given Meshing schematic component, check whether it supports Part Mesh

Return Returns true if it supports Part Mesh otherwise false
Type bool

HasValidVolumeFillMesh

For the given Meshing schematic component, check whether it supports volume Fill Mesh

Return Returns true if it supports Volume Fill Mesh otherwise false
Type bool

Refresh

No details are provided for this entry.

RemoveFromSystem

No details are provided for this entry.

Required Arguments

System No details are provided for this entry.
Type DataReference

ReplaceWithShare

No details are provided for this entry.

Required Arguments

ComponentToShare No details are provided for this entry.
Type DataReference

Optional Arguments

SourceSystem No details are provided for this entry.
Type DataReference
TargetSystem No details are provided for this entry.
Type DataReference

Example: Required example does not exist.

Reset

No details are provided for this entry.

TransferData

No details are provided for this entry.

Required Arguments

TargetComponent No details are provided for this entry.
Type DataReference

TransferSpecificData

No details are provided for this entry.

Required Arguments

TargetComponent No details are provided for this entry.
Type DataReference
TransferDataName No details are provided for this entry.
Type string

Update

No details are provided for this entry.

Optional Arguments

AllDependencies No details are provided for this entry.
Type bool
Continue    No details are provided for this entry.
    Type     UpdateContinuation
    Default Value    None

UpdateUpstreamComponents

No details are provided for this entry.

ComponentTemplate

No details are provided for this entry.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Methods

CreateComponent

No details are provided for this entry.

Required Arguments

System No details are provided for this entry.
Type DataReference

Optional Arguments

AllSystemProperties No details are provided for this entry.
Type SystemPropertyDictionary
CreatedComponent No details are provided for this entry.
Type Output<DataReference>
Name No details are provided for this entry.
Type string
UpstreamComponent No details are provided for this entry.
Type List<DataReference>

Example: Required example does not exist.

CustomProjectTemplate

No details are provided for this entry.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

SystemNames

No details are provided for this entry.

Type List<string>
Read Only No

SystemTemplates

No details are provided for this entry.

Type List<DataReference>
Read Only No

Methods

CreateProject

No details are provided for this entry.

Delete

No details are provided for this entry.

DesignPointSolveSettings

No details are provided for this entry.

Properties

ComponentExecutionMode

No details are provided for this entry.

Type string
Read Only No

ConfiguredQueue

A configured queue used for new RSM architecture

Type string
Read Only No

DesignPointRetainedOrExportedUpdate

No details are provided for this entry.

Type DesignPointRetainedOrExportedUpdate
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

JobStatusCheckIntervalInSeconds

No details are provided for this entry.

Type int
Read Only No

NumberOfCoresPerJob

No details are provided for this entry.

Type int
Read Only No

NumberOfJobsToBeCreated

No details are provided for this entry.

Type int
Read Only No

NumberOfTasksToBeCreated

No details are provided for this entry.

Type int
Read Only No

PartialUpdate

No details are provided for this entry.

Type PartialDesignPointUpdate
Read Only No

PreRSMUpdate

No details are provided for this entry.

Type PartialDesignPointUpdate
Read Only No

RetainPartialUpdate

No details are provided for this entry.

Type PartialDesignPointUpdate
Read Only No

RsmJobName

RSM job name

Type string
Read Only No

RsmQueueDetails

Configured queue details

Type RsmQueueDetails
Read Only No

UpdateMethod

No details are provided for this entry.

Type string
Read Only No

UpdateOption

Update mode

Type JobRunMode
Read Only No

UpdateOrder

No details are provided for this entry.

Type DesignPointUpdateOrder
Read Only No

UpfrontLicenseCheckout

No details are provided for this entry.

Type string
Read Only No

SchematicSettings

No details are provided for this entry.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Notes

No details are provided for this entry.

Type string
Read Only No

System

No details are provided for this entry.

Properties

AnalysisType

No details are provided for this entry.

Type string
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Notes

No details are provided for this entry.

Type string
Read Only No

Physics

No details are provided for this entry.

Type List<string>
Read Only No

Solver

No details are provided for this entry.

Type List<string>
Read Only Yes

UserId

No details are provided for this entry.

Type string
Read Only Yes

Methods

Copy

No details are provided for this entry.

Return No details are provided for this entry.
Type DataReference

Required Arguments

KeepConnections No details are provided for this entry.
Type bool

Delete

No details are provided for this entry.

Duplicate

No details are provided for this entry.

Return No details are provided for this entry.
Type DataReference

Optional Arguments

ComponentsToShare No details are provided for this entry.
Type List<DataReference>
Name No details are provided for this entry.
Type string
Position No details are provided for this entry.
Type PositionType
RelativeTo No details are provided for this entry.
Type DataReference

Example: Required example does not exist.

Export

No details are provided for this entry.

Required Arguments

FilePath No details are provided for this entry.
Type string
IncludeExternalFiles No details are provided for this entry.
Type bool
IncludeResultFiles No details are provided for this entry.
Type bool
IncludeUserFiles No details are provided for this entry.
Type bool

Example: Required example does not exist.

GetComponent

No details are provided for this entry.

Return No details are provided for this entry.
Type DataReference

Required Arguments

Name No details are provided for this entry.
Type string

GetContainer

No details are provided for this entry.

Return No details are provided for this entry.
Type DataContainerReference

Required Arguments

ComponentName No details are provided for this entry.
Type string

GetReplaceableTemplates

No details are provided for this entry.

Return No details are provided for this entry.
Type List<DataReference>

Move

No details are provided for this entry.

Required Arguments

Position No details are provided for this entry.
Type PositionType
RelativeTo No details are provided for this entry.
Type DataReference

RecreateDeletedComponents

No details are provided for this entry.

Refresh

No details are provided for this entry.

Update

No details are provided for this entry.

Optional Arguments

AllDependencies No details are provided for this entry.
Type bool

Template

No details are provided for this entry.

Properties

AnalysisType

No details are provided for this entry.

Type string
Read Only No

DisplayName

No details are provided for this entry.

Type string
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Physics

No details are provided for this entry.

Type List<string>
Read Only No

Solver

No details are provided for this entry.

Type List<string>
Read Only Yes

SystemType

No details are provided for this entry.

Type string
Read Only No

SystemTypeAbbreviation

No details are provided for this entry.

Type string
Read Only No

Methods

CreateSystem

No details are provided for this entry.

Return No details are provided for this entry.
Type DataReference

Optional Arguments

ComponentsToShare No details are provided for this entry.
Type List<DataReference>
DataTransferFrom No details are provided for this entry.
Type List<TransferDataToNewComponentSpec>
DataTransferTo No details are provided for this entry.
Type List<TransferDataFromNewComponentSpec>
Name No details are provided for this entry.
Type string
Position    No details are provided for this entry.
    Type     PositionType
    Default Value    Default
RelativeTo No details are provided for this entry.
Type DataReference

Example: Required example does not exist.

ReplaceSystem

No details are provided for this entry.

Return No details are provided for this entry.
Type DataReference

Required Arguments

System No details are provided for this entry.
Type DataReference

Optional Arguments

Name No details are provided for this entry.
Type string