After launching Fluent Icing, this option reads and executes the file.py python script.

By default, the python script will be exited and then the application will be exited (the exit status code of the application will be non-zero if the Python script has thrown an exception or some other error occurred).

Runs Fluent Icing in interactive batch with-GUI mode (the graphical user interface will be displayed)

When using this argument, the application will not exit after completion of the python script.

Runs Fluent Icing in full batch no-GUI mode (the graphical user interface will not be displayed).

Runs Fluent Icing in full batch no-GUI mode (the graphical user interface will not be displayed).

In this mode, background graphics objects will not be generated, preventing you from accessing many post-processing or image creation operations.

Waits until execution of the file.py script is complete before continuing batch execution.

Launches the solver using the specified number of CPUs.

When executing bin/icing using only the -R file.py argument, this command should be specified at the beginning of the file.py script to ensure the script waits for the execution to finish. Using this command is an alternative to adding the -I -wait command line options.

Case

new("filename")

Create a new project file in the specified path/filename, the path must be available. For example Project.new("/tmp/DEMO") will create /tmp/DEMO.flprj and /tmp/DEMO.cffdb/

open("filename")

Open an existing project file.

close()

Close the current project.

erase("filename")

Erase the specified project, filename.flprj and filename.cffcb folder recursively.

isOpen()

Returns True if a project is currently opened.

getURL()

Returns the project file (.flprj) with with full path.

getFolder()

Returns the full path of the project folder (cffdb).

openSimulation("name")

Load the specified simulation, by name, from the current project. Fluent is launched with the default.

importCase("file.cas")

Create a new simulation, importing the case file (.cas or .cas.h5, with path) to the project. This is equivalent to using the ribbon option Import Case, with default options.

saveCase()

Save the current settings to the case file (similar to File → Save Case)

newRun("flow","name",iterations)

newRun("particles","name",iterations)

newRun("ice","name",time)

newRun("multishot","name",iterations)

Create a new run in the current simulation, of the following type, flow, particles, ice or multishot. The new run name is specified, and is executed for the specified number of iterations (for ice, the number is a floating point for the time value).

Project.erase("demoProject") 
Project.new("demoProject") 
Project.importCase("grid.cas")

Project.newRun("flow","runA",12) 
Project.newRun("particles","runB",12) 
Project.newRun("ice","runC",0.001)

Project.close()

Init()

Initialize the post-processing framework (this will open the EnSight process and consume a post-processing license). Automatically invoked as required if LoadCase or LoadResult are used.

LoadCase(Filename="file.cas.h5”)

Loads the specified case or mesh file. The return value is the identifier of the newly loaded dataset and can be used as a key in the PostAnalysis.Dataset[key] index. .cas, .cas.h5 and .cas.fsp can be loaded.

LoadResult(Filename1="file.cas.h5”,Filename2=”file.dat.h5”)

LoadResult(Filename1="file.cas.h5”,Filename2=”file.dat.h5”,FieldName=”Fieldname”)

Loads the specified case and result. The return value is the identifier of the newly loaded dataset and can be used as a key in the PostAnalysis.Dataset[key] index. .cas/.dat .cas.h5/.dat.h5 .cas.fsp/.dat.fsp must be loaded in matching pairs. If a FieldName is provided, the specified field.

Dataset

Dictionary of loaded datasets

Dataset[key].Case.Results

Object containing the dataset’s graphical elements and their settings. Use the () operator to query the content.

DisplaySettings

Object containing the viewports and their display settings. Use the () operator to query the content, and dir() to get the list of available commands.

GlobalScene

Object containing the scenes and their display settings. Use the () operator to query the content.

file/

settings/

flow/

drop/

ice/

multishot/

load-file / save-file

load-all / save-all

reset-file

reset-all

status

get variable

set variable value

auto-save?

save-converg? save-gmres?

verbosity

init

calculate

init, calculate, end (Similar to flow/ commands)

run

end

run

Flow

Particles

Ice

Multishot

Setup Airflow

Setup Particles

Setup Ice

BC (will apply to all boundary conditions)

Solution Airflow

Solution Particles

Solution Ice

Solution Multishot

Walls

Inlets

Outlets

The name of a specific boundary condition (example: wall-1, leading-edge or pressure-far-field-11)