Polyflow Solution

Polyflow Solution
This container holds Solution data for an instance of Polyflow.

Methods

ClearTemporaryFiles

Clear temporary files generated by Polyflow solver (if the solver is not running!) given a Polyflow Solution Container

    solution1.ClearTemporaryFiles()

Exit

Stops the editor (Polydata) or the solver (Polyflow) given a Polyflow Setup or Solution Container

    setup1.Exit()
    This command will stop the editor (Polydata) of the selected Setup cell. 


    solver1.Exit()
    This command will stop the solver (Polyflow) of the selected Solution cell.

GetComponentSettingsForRsmDpUpdate

This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and Scripting

GetPolyflowSolution

Returns the PolyflowSolution object stored in the Polyflow Solution component.

Return     The PolyflowSolution object stored in the Polyflow Solution component.
    Type     DataReference

GetSolutionSettings

This query is used to obtain the component solve settings object for Journaling and Scripting

SetResultsPreferences

Allows to specify which result (res/rst/csv) of upstream polyflow system will be used in the current polyflow system : one does not provide filenames, but specific keys to the corresponding result files.

The solver restart mode can take the following values:

"No initialization from upstream system",
"Restart with a single Polyflow results file",
"Restart with Polyflow results and restart files",
"Restart with a single Polyflow CSV file",
"Restart with Polyflow CSV and restart files",
"Restart with a list of Polyflow results files (for transient mixing tasks only!)",
"Restart with a list of Polyflow CSV files (for conversion of a list of Polyflow CSV files)"

Note : the result (res,rst,csv) keys can be found in the "last_result.pub" file generated by the Polyflow solver in the upstream system!

Required Arguments

csvKey    Csv key (among the list of available csv created by an upstream polyflow system)
    Type    string
restartKey    Restart key (among the list of available restart created by an upstream polyflow system)
    Type    string
resultKey    Result key (among the list of available results created by an upstream polyflow system)
    Type    string
solverRestartMode    Solver restart mode
    Type    SolverRestartMode
Example

    solution1.SetResultsPreferences(
    solverRestartMode="Restart with a single Polyflow CSV file", 
    resultKey="undefined",
    restartKey="undefined",
    csvKey="csv (t=0.5000000E+00)[formatted]")

This command will take the csv generated by the upstream polyflow system at time t=0.5 (and that is formatted)

StartCFDPost

Starts CFD-Post given a Polyflow Solution Container in order to see the initial state of a simulation.

    solution1.StartCFDPost()
    This command will launch CFD-Post on the selected Solution cell.

StartCurveTool

Starts Polycurve (curves viewer) given a Polyflow Solution Container

    solution1.StartCurveTool()
    This command will launch Polycurve of the selected Solution cell.

StartDiagnosticsTool

Starts Diagnostics tool (Polydiag) given a Polyflow Solution Container

    solution1.StartDiagnosticsTool()
    This command will launch the Diagnostics tool (Polydiag) of the selected Solution cell.

StartListingViewer

Starts the listing viewer, given a Polyflow Solution Container, to present the content of a text file

    solution1.StartListingViewer(FilePath="D:/temp/polyflow.lst")
    This command will launch the listing viewer tool (Polylst) on the selected Solution cell.

Required Arguments

ListingFilePath    Input : listing filename (absolute path)
    Type    string

StartPreferences

Starts the Editor of Polydata preferences given a Polyflow Setup Container or Starts the Editor of Polyflow preferences given a Polyflow Solution Container

    This command applies to Setup and Solution cells.
        setup1.StartPreferences()
        This command will launch the Preferences setting tool (Polypref) of the selected Setup cell. 
        solution1.StartPreferences()
        This command will launch the Preferences setting tool (Polypref) of the selected Solution cell.

StartStatisticsTool

Starts Polystat given a Polyflow Solution Container

    solution1.StartStatisticsTool()
    This command will launch the statistical analyzer tool (Polystat) on the selected Solution cell.

SwitchToBackgroundMode

Switch the Update in progress into background mode. This will enable operations that are not allowed during an Update in foreground mode (e.g. Project Save).

This command is not normally useful in a script. Journals may record the invocation of this command after an Update invoke, as the result of GUI activity while the Update is in progress. However, replay of these journals will always wait for the Update invoke to complete before invoking the next command, rendering this step ineffectual.

Data Entities

HiddenPollingComponentSolveSettings

This class contains a derived version of solve settings where polling is disabled

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

PolyflowPreference

Contains a reference to the preferences file for Polyflow (solver). It is a provider of the preferences file.

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
File

Data reference to the preferences file for Polyflow.

Type     DataReference
Read Only    No

PolyflowSolution

Contains a reference to a Polyflow listing file. It is a provider of the listing file (containing a summary of the simulation).

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
File

Data reference to the listing file generated by the Polyflow solver and containing a summary of the simulation.

Type     DataReference
Read Only    No