IcePak Setup

IcePak Setup
This container holds Setup data for an instance of IcePak.

Methods

Edit

User can launch the Icepak application by executing the Edit command

Optional Arguments

Interactive    Passing True will run Icepak in interactive mode
    Type     bool
    Default Value    True
SystemCoordinate Optional parameter to specify the system coordinate to be displayed in the application title
Type string

EnableUpdate

Enables Setup update

Exit

Close the Icepak session

Import

Import on the Setup container with an existing Icepak project or the compressed tzr Icepak project will launch an Icepak session and opens the imported project

Import on the Solution container allow users to set different set of case and data files for post processing.By default, the case and data files from the latest solution are available on the solution component.

Required Arguments

FilePath Path to the project or tzr file when operated on Setup container. Path to the case file to be imported when operated on the Solution container
Type string

Example

When the Import is called on the Setup container

    Icepak.Import(FilePath=r"E:\DSModels\ICE\demo1_files\dp0\IPK\Icepak\IcepakProj")

When the Import is called on the Setup container with tzr file

    Icepak.Import(FilePath=r"c:\Temp\test.tzr")

When the Import is called on the Solution container

    Icepak.Import(FilePath=r"D:\IcepakProj00.cfd.cas")

Data Entities

ComponentSolveSettingsForAddin

This class contains the solve settings for Addin solution components to use

Properties

ConfiguredQueue

A configured queue used for new RSM architecture

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

EnablePolling

whether enable polling during remote solve

Type bool
Read Only No

ExecutionMode

execution mode

Type string
Read Only No

NumberOfProcesses

number of processes for parallel solve

Type int
Read Only No

PollingInterval

polling internal during remote solve

Type Quantity
Read Only No

RsmJobName

RSM job name

Type string
Read Only No

RsmQueueDetails

Configured queue details

Type RsmQueueDetails
Read Only No

UpdateOption

Update mode

Type JobRunMode
Read Only No

IcePakSetup

Represents the IcepakSetup data entity

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

WorkbenchColorScheme

Setting this property will force Icepak to use the Workbench color scheme. Unsetting this property will allow Icepak to use the default color scheme set inside Icepak

Type bool
Read Only No

XmlFile

XML Input file

Type DataReference
Read Only No