FLUENT Setup

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

Methods

CopyLauncherSettings

Copies the FLUENT Launcher Settings from one FLUENT Setup or Solution container to another FLUENT Setup or Solution container.

Edit

Opens the FLUENT editor to allow modification of FLUENT data.

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

Exit

Exits the FLUENT editor.

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

GetFluentLauncherSettings

Returns the Data Entity which contains the Setup container's settings for the FLUENT Launcher.

Import

Imports the FLUENT mesh and FLUENT case settings into the FLUENT editor from an existing FLUENT .msh or .cas file; replacing the current FLUENT mesh and FLUENT case settings. If the imported file contains only a mesh, then the FLUENT case settings will be set to FLUENT's default values.

SendCommand

Execute a scheme, FLUENT GUI, or FLUENT TUI command(s) in the currently open FLUENT session. FLUENT GUI commands cannot be run if the currently open FLUENT session is running in no GUI mode.

If the FLUENT editor is not open, it will throw an error message suggesting to start editor first.

Example

The following code shows how to execute the commands in a FLUENT journal file:

    >> setup1.SendCommand(Command="/file/read-journal \"E:\\WB Projects\\Fluent Case-Data Files\elbow.jou\" " )

Data Entities

ChartVariable

Entity representing a variable in Convergence Chart

Properties

Color

Color of the curve represnting this variable entity.

Type Color
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

LineWidth

Line width of the curve represnting this variable entity.

Type float
Read Only No

QuantityName

The variable quantity to display.

Type string
Read Only No

SymbolSize

Symbol size of the points on the curve.

Type uint
Read Only No

Methods

DeleteChartVariable

Deletes a specified chart variable.

ConvergenceChart

Entity to store a convergence chart information.

Properties

AxisX

Associated X Axis

Type DataReference
Read Only No

AxisY

Associated Y Axis

Type DataReference
Read Only No

ChartType

MonitorChartType: Residual or UserDefined

Type MonitorChartType
Read Only No

Variables

Collection of variables to be plotted.

Type DataReferenceSet
Read Only No

XAxis

Label for the x-axis/Horizontal Axis.

Type string
Read Only No

Methods

GetAxis

Returns the axis for a specified convergence chart

Return The axis
Type DataReference

Required Arguments

Name Name of the Axis
Type string

GetChartVariable

Returns the chart variable of a given name from a convergence chart

Return The chart variable that matches the specified name.
Type DataReference

Required Arguments

Name The name of the chart variable.
Type string

GetChartVariables

Returns the collection of chart variables for a given convergence chart

Return A collection of the variables in the chart.
Type DataReferenceSet

FluentLauncherSettings

Allows you to specify FLUENT Launcher settings for Fluent Setup/Solution cells.

Properties

CachePassword

Specify whether or not you want to save the HP-MPI password for later use.

Type bool
Read Only No

ClusterHeadNode

Specify the name of the compute cluster head node.

This property is only available on Windows.

Type string
Read Only No

ClusterJobTemplate

A custom submission policy created by an IT administrator to define the job parameters for an application and employed by the cluster users to submit jobs. Relevant for Microsoft Job Scheduler.

Type string
Read Only No

ClusterNodeGroup

Used to set specific node group(s) on which to run the job. Relevant for Microsoft Job Scheduler.

Type string
Read Only No

ClusterProcessorUnit

Select the unit type (node/socket/core) on which the job would be running. Relevant for Microsoft Job Scheduler.

Type ProcessorUnit
Read Only No

ConvertUNCPath

Specify whether or not to convert a local path to a UNC path if any matching shared directory is found.

Type bool
Read Only No

CreateJobSubmissionXML

Specify whether or not to create the job submission XML file.

This property is only available on Windows.

Type bool
Read Only No

DisplayMesh

Specify whether or not to show the mesh after the mesh file or the case/data file has been read into FLUENT.

Type bool
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

EmbedGraphicsWindows

Specify whether or not to embed the graphics windows in the FLUENT application window, or to have the graphics windows free-standing.

Type bool
Read Only No

EnvPath

Specify the list of environment variables to set before starting FLUENT.

Type Dictionary<string, string>
Read Only No

Initialization

Specify which initialization method to use.

Type InitializationMethods
Read Only No

InitSolutionDataFile

Spepcify the solution data file to be used for initializing the solution.

Type string
Read Only No

Interconnect

Specify the interconnect that you wish to use for parallel calculations

(e.g., ethernet, infiniband, etc.).

Type string
Read Only No

JobScheduler

Use available Resource Manager (LSF, SGE, PBSPro) to launch FLUENT job

This property is only available when using compute nodes on Linux.

Type SchedulerSpecification
Read Only No

JobSubmissionXmlFile

Specify the name of the job submission XML file.

This property is only available on Windows.

Type string
Read Only No

LoadACTStartPage

Specify whether or not to show ACt Start Page.

Type bool
Read Only No

LSFCheckpointPeriod

Specify the interval of automatic checkpointing for LSF.

This property is only available when using compute nodes on Linux.

Type int
Read Only No

LSFQueue

Specify the name of the LSF queue.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

LSFUseAutomaticCheckpointing

Specify whether or not you want to use automatic checkpointing with LSF. The specific interval for checkpointing is determined by the LSFCheckpointPeriod property.

This property is only available when using compute nodes on Linux.

Type bool
Read Only No

MachineFileName

Specify the name of the file that contains a list of machine names to run the parallel job.

Type string
Read Only No

MachineList

Specify a list of machine names to run the parallel job.

Type string
Read Only No

MachineSpec

Specify a list of machine names, or a file that contains machine names.

Type MachineSpecification
Read Only No

MpiType

Specify the MPI type that you wish to use for the parallel calculations

(e.g., ibmmpi, intel, etc.).

Type string
Read Only No

NumberOfProcessors

Specify the number of processors you wish to use for the parallel calculations (e.g., 2, 4, etc.).

Type int
Read Only No

NumberOfProcessorsMeshing

Specify the number of processors you wish to use for the meshing parallel calculations (e.g., 2, 4, etc.).

Type int
Read Only No

Precision

Specify whether to use the single-precision or the double-precision solver.

Type CasePrecision
Read Only No

PrePostOnly

Specify whether or not you want to run FLUENT in PrePost mode, which only allows you to set up or postprocess a problem (i.e., no calculations can be performed)

Type bool
Read Only No

RemoteFluentRootPath

Specify the root path of the remote FLUENT Linux installation.

This property is only available on Windows.

Type string
Read Only No

RemoteHostName

Specify the name of the head machine on the remote Linux cluster.

This property is only available on Windows.

Type string
Read Only No

RemoteRshCommand

Specify the command to connect to the remote node (the default is SSH).

This property is only available on Windows.

Type RshSpecification
Read Only No

RemoteRshOtherCommand

Specify the custom SSH spawn command used to connect to the remote Linux machine.

This property is only available on Windows.

Type string
Read Only No

RemoteRunOnLinux

Specify whether or not you want to run your FLUENT simulation on 64-bit Linux machines.

This property is only available on Windows.

Type bool
Read Only No

RemoteUseHost

Specify whether or not to use the remote cluster head node that FLUENT will connect to for spawning (e.g., via rsh or ssh).

Use the RemoteHostName property to specify the name of the remote cluster head node.

This property is only available on Windows.

Type bool
Read Only No

RemoteUseWorkingDirectory

Specify whether or not to use a working directory for remote Linux nodes.

Use the RemoteWorkingDirectory property to specify the name of the working directory.

This property is only available on Windows.

Type bool
Read Only No

RemoteWorkingDirectory

Specify the name of the working directory for remote Linux nodes.

This property is only available on Windows.

Type string
Read Only No

RunParallel

Specify whether or not you want to run the parallel version of FLUENT.

Type bool
Read Only No

SetupCompilationEnvironment

Specify whether or not you want to define settings for compiling user-defined functions (UDFs) with FLUENT.

This property is only available on Windows.

Type bool
Read Only No

SGEPE

Specify the SGE parallel environment where you want to submit your FLUENT jobs.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

SGEQMaster

Specify the name of the Qmaster host.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

SGEQueue

Specify the name of the queue where you want to submit your FLUENT jobs.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

SGESettings

Specify SGE Settings to be used

This property is only available when using compute nodes on Linux.

Type string
Read Only No

SGEUseSettings

Specify whether or not to use the specified SGE Settings.

Use the SGESettings property to specify the SGE Settings.

This property is only available when using compute nodes on Linux.

Type bool
Read Only No

ShowLauncher

Specify whether or not to show FLUENT Launcher when FLUENT starts.

Type bool
Read Only No

SLURMAccount

Specify the name of the SLURM Account.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

SLURMPartition

Specify the name of the SLURM Partition.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

SLURMSubmissionHost

Specify the name of the SLURM Submission host.

This property is only available when using compute nodes on Linux.

Type string
Read Only No

StartWhenResourcesAvailable

Specify whether or not to start the FLUENT job when resources are available.

This property is only available on Windows.

Type bool
Read Only No

UDFPath

Specify the path to the UDF compilation script (available when SetupCompilationEnvironment is TRUE).

This property is only available on Windows.

Type string
Read Only No

UseJobScheduler

Specify whether or not to use a job scheduler to run FLUENT jobs.

Type bool
Read Only No

UseLSFCheckpoint

Specify whether or not to use LSF checkpointing.

This property is only available when using compute nodes on Linux.

Type bool
Read Only No

UseLSFQueue

Specify whether or not to use the LSF queue.

This property is only available when using compute nodes on Linux.

Type bool
Read Only No

UseSharedMemory

Specify whether or not to use shared memory on the local machine or to use distributed memory on a cluster.

Type bool
Read Only No

UseUpstreamLauncherSettings

Specify whether or not the current system's Solution cell should use FLUENT Launcher's property settings from the current system's Setup cell.

Type bool
Read Only No

WorkbenchColorScheme

Specify whether or not to use the Workbench color scheme in the graphics window, or the classic black background color.

Type bool
Read Only No

ROMSetup

Entity which manages the setup of the ROM feature. This DataObject must be held by a solver addin container. The solver addin container will then be used as an identifier for the solver addin system.

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

Setup

Setup object that contains all the solver setup information.

Type Setup
Read Only No

Solver

Identification of the solver. The import of an evaluation archive will only be allowed if the solver that wrote the archive has the same name as the one consuming it.

Type string
Read Only Yes

SetupData

Data entity of Setup cell. Allows you to change attributes of Setup cell.

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

GenerateSetupOutput

Allows you to generate case file for Setup cell if mesh file is input or mesh operations are defined

Type bool
Read Only No

SolverSystemHandler

This entity handles the output produced by a solver addin. There is one instance of SolverSystemHandlerDataObject per registered solver system. It holds all the outputs coming from a solver system (snapshot files, mesh files, solver specific files).

Properties

ActionMode

No details are provided for this entry.

Type ActionMode
Read Only No

ContainedApprovedGeneratedData

Indicate that the data for this system have been outdated by a non parametric change then approved as still valid by the user.

Type bool
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

MeshFile

No details are provided for this entry.

Type DataReference
Read Only No

OutdatedDueToNonParametricChange

Indicate that the data of this system are outdated and not usable.

Type bool
Read Only No

ProcessedMeshFile

No details are provided for this entry.

Type DataReference
Read Only No

ProjectHandler

No details are provided for this entry.

Type ProjectHandler
Read Only No

Setup

No details are provided for this entry.

Type DataReference
Read Only Yes

SnapshotCache

Handle the snapshot cache of this solver system. Will be assigned only in Production, and null overwise.

Type SnapshotCacheHandler
Read Only No