CFX Setup

CFX Setup
This container holds Setup data for an instance of CFX-Pre.

Methods

BuildSystemCouplingParticipant

Command wrapper to build the System Coupling Participant object from XML

Return     Returns a valid SystemCouplingParticipant object.
    Type     DataReference

Required Arguments

Xml    Source Xml to build the SystemCouplingParticipant from.
    Type     string

Edit

Opens the CFX-Pre editor to allow modification of CFX Setup data.

This command will open the editor only if one is not already open on this component. If this component's editor is already open and in interactive mode, then it will be raised to the front.

Optional Arguments

Interactive     Run the editor in interactive mode if True, or in no GUI mode if False.
   If not specified, the editor runs in interactive mode.
    Type    bool
    Default Value    True

Exit

Exits the editor.

Any changes made in this editor will be retained on exit. These changes are made permanent by a Project Save, and will be discarded in the event of closing the project without saving.

If no editor is open on the component in question, this command will have no effect.


GetCFXSetupProperties

Returns the Data Entity which contains user settings and properties for the Setup container.

Return     The Data Entity containing settings for this component.
    Type     DataReference

Import

Imports CFX Setup data into the CFX-Pre editor from an existing CFX Case file.

The Case file's contents will be imported into a new case file within the project, managed by the Setup component. This operation is not valid if the component already contains Setup data.

Required Arguments

FilePath    Path of CFX Case File to be imported.
    Type    string

ReinitializeContainer

This command reinitialises the selected container, resetting the local data and using the cached initialisation CCL commands


SendCommand

Sends commands to the editor for this component using CFX Command Language (CCL) syntax. If the editor for this component is not open, it will be launched before the commands are sent and subsequently closed. In this mode, component data is loaded and saved as if calling Edit(Interactive=False) and Exit around the SendCommand invocation.

The instructions must be CFX Command Language session commands that are valid for the editor in question.

Required Arguments

Command    Valid CFX Command Language (CCL) commands
    Type    string

SetInitCCL

Sets the initialisation commands for this component using CFX Command Language (CCL) syntax. On setting the commands they may be applied to the editor in question using ApplyInitCCLCommand.

The instructions must be CFX Command Language session commands that are valid for the editor in question.

Required Arguments

Command    Valid CFX Command Language (CCL) commands
    Type    string

SuppressPhysicsErrors

Suppresses physics validation errors for the current CFX Setup component.

Normally, a CFX Setup component will not permit an update to proceed while validation errors exist in the case. However, in certain special situations, it may be that particular validation errors are tolerable and the case should be solvable.

This command can be used on CFX Setup components to bring the component from Attention Required to Up-to-Date, allowing the downstream Solution component to be updated.


Data Entities

CFXSetupProperties

Entity which manages settings and data for the CFX Setup component.

Properties

AllowAssemblyMeshImport

This is a beta option. Allow the user to import the assembly meshes

Type     bool
Read Only    No
CaseFile

CFX-Pre Case file location.

Do not modify this property directly.

Type    DataReference
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
PhysicsStatus

Physics state of the CFX-Pre editor, specifying validation errors, warnings and information on the current case.

This property is updated by CFX-Pre only.

Type    string
Read Only    No
SolverInputExtendedFiles

Extended CFX Solver Input Files for multiconfig cases

Do not modify this property directly.

Type    DataReferenceSet
Read Only    No
SolverInputFile

CFX-Solver Input file location.

Do not modify this property directly.

Type    DataReference
Read Only    No