pycfx_enums#

Provides a module for enums used in PyCFX.

Classes:

`CFXEnum`(new_class_name, /, names, *[, ...])	Provides the base class for CFX-related enums.
`CFXMode`(*values)	Enumerates over supported CFX modes.
`LaunchMode`(*values)	Enumerates over supported CFX launch modes.
`UIMode`(*values)	Provides the supported user interface mode of CFX.

class ansys.cfx.core.launcher.pycfx_enums.CFXEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Provides the base class for CFX-related enums.

Accepts lowercase member names as values and supports comparison operators.

class ansys.cfx.core.launcher.pycfx_enums.CFXMode(*values)#

Bases: Enum

Enumerates over supported CFX modes.

Attributes:

`POST_PROCESSING`
`PRE_PROCESSING`
`SOLVER`

Methods:

`get_mode`(mode)	Get the CFX mode based on the provided mode string.
`is_post`(mode)	Check if the current mode is postprocessing.
`is_pre`(mode)	Check if the current mode is preprocessing.
`is_solver`(mode)	Check if the current mode is solver.

POST_PROCESSING = (<class 'ansys.cfx.core.session_post.PostProcessing'>, 'post-processing')#

PRE_PROCESSING = (<class 'ansys.cfx.core.session_pre.PreProcessing'>, 'pre-processing')#

SOLVER = (<class 'ansys.cfx.core.session_solver.Solver'>, 'solver')#

static get_mode(mode: str) → CFXMode#

Get the CFX mode based on the provided mode string.

Parameters:

modestr: Mode.

Returns:

CFXMode: CFX mode.

Raises:

DisallowedValuesError: If an unknown mode is passed.

static is_post(mode: CFXMode) → bool#

Check if the current mode is postprocessing.

Parameters:

modeCFXMode: Mode.

Returns:

bool: True if the mode is CFXMode.POST_PROCESSING, False otherwise.

static is_pre(mode: CFXMode) → bool#

Check if the current mode is preprocessing.

Parameters:

modeCFXMode: Mode.

Returns:

bool: True if the mode is CFXMode.PRE_PROCESSING, False otherwise.

static is_solver(mode: CFXMode) → bool#

Check if the current mode is solver.

Parameters:

modeCFXMode: Mode.

Returns:

bool: True if the mode is CFXMode.SOLVER, False otherwise.

class ansys.cfx.core.launcher.pycfx_enums.LaunchMode(*values)#

Bases: Enum

Enumerates over supported CFX launch modes.

Attributes:

`CONTAINER`
`PIM`
`SLURM`
`STANDALONE`

CONTAINER = 3#

PIM = 2#

SLURM = 4#

STANDALONE = 1#

class ansys.cfx.core.launcher.pycfx_enums.UIMode(*values)#

Bases: CFXEnum

Provides the supported user interface mode of CFX.

Attributes:

`GUI`
`HIDDEN_GUI`
`NO_GUI`

GUI = ('',)#

HIDDEN_GUI = ('',)#

NO_GUI = ('batch',)#