pyfluent_enums#

Provides a module for enums used in the PyFluent.

Classes:

class ansys.fluent.core.launcher.pyfluent_enums.Dimension(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Geometric dimensionality of the Fluent simulation.

Attributes:

THREE
TWO

THREE = ('3d',)#

TWO = ('2d',)#

class ansys.fluent.core.launcher.pyfluent_enums.FluentEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Provides the base class for Fluent-related enums.

Accepts lowercase member names as values and supports comparison operators.

Methods:

str_value()

Returns string value of the enum.

str_value()#

Returns string value of the enum.

class ansys.fluent.core.launcher.pyfluent_enums.FluentLinuxGraphicsDriver(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: FluentEnum

Provides supported graphics driver of Fluent in Linux.

Attributes:

AUTO
NULL
OPENGL
OPENGL2
X11

AUTO = ('',)#

NULL = ('null',)#

OPENGL = ('opengl',)#

OPENGL2 = ('opengl2',)#

X11 = ('x11',)#

class ansys.fluent.core.launcher.pyfluent_enums.FluentMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Enumerates over supported Fluent modes.

Attributes:

MESHING
PURE_MESHING
SOLVER
SOLVER_ICING

Methods:

get_mode(mode)	Get the FluentMode based on the provided mode string.
is_meshing(mode)	Check if the current mode is meshing.

MESHING = (<class 'ansys.fluent.core.session_meshing.Meshing'>, 'meshing')#

PURE_MESHING = (<class 'ansys.fluent.core.session_pure_meshing.PureMeshing'>, 'pure-meshing')#

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

SOLVER_ICING = (<class 'ansys.fluent.core.session_solver_icing.SolverIcing'>, 'solver-icing')#

static get_mode(mode)#

Get the FluentMode based on the provided mode string.

Parameters:

modestr

Mode

Returns:

FluentMode

Fluent mode.

Raises:

DisallowedValuesError

If an unknown mode is passed.

static is_meshing(mode)#

Check if the current mode is meshing.

Parameters:

modeFluentMode

mode

Returns:

bool

True if the mode is FluentMode.MESHING or FluentMode.PURE_MESHING, False otherwise.

class ansys.fluent.core.launcher.pyfluent_enums.FluentWindowsGraphicsDriver(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: FluentEnum

Provides supported graphics driver of Fluent in Windows.

Attributes:

AUTO
DX11
MSW
NULL
OPENGL
OPENGL2

AUTO = ('',)#

DX11 = ('dx11',)#

MSW = ('msw',)#

NULL = ('null',)#

OPENGL = ('opengl',)#

OPENGL2 = ('opengl2',)#

class ansys.fluent.core.launcher.pyfluent_enums.LaunchMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Enumerates over supported Fluent launch modes.

Attributes:

CONTAINER
PIM
SLURM
STANDALONE

CONTAINER = 3#

PIM = 2#

SLURM = 4#

STANDALONE = 1#

class ansys.fluent.core.launcher.pyfluent_enums.Precision(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: FluentEnum

Floating point precision.

Attributes:

DOUBLE
SINGLE

DOUBLE = ('dp',)#

SINGLE = ('',)#

class ansys.fluent.core.launcher.pyfluent_enums.UIMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: FluentEnum

Provides supported user interface mode of Fluent.

Attributes:

GUI
HIDDEN_GUI
NO_GRAPHICS
NO_GUI
NO_GUI_OR_GRAPHICS

GUI = ('',)#

HIDDEN_GUI = ('hidden',)#

NO_GRAPHICS = ('gr',)#

NO_GUI = ('gu',)#

NO_GUI_OR_GRAPHICS = ('g',)#