flicing#

class ansys.fluent.core.generated.v261.object_model.flicing.Root(service, rules, path)#

Bases: PyMenu

Root group.

Classes:

Case(service, rules, path)

Case group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Case(service, rules, path)#

Bases: PyMenu

Case group.

Classes:

`App`(service, rules, path)	App group.
`AppLocal`(service, rules, path)	AppLocal group.
`AppName`(service, rules[, path])	Parameter AppName of value type str.
`AuxiliaryInfo`(service, rules, path)	AuxiliaryInfo group.
`CaseInfo`(service, rules, path)	CaseInfo group.
`ClearDatamodel`(service, rules, command[, path])	ClearDatamodel command.
`MeshInfo`(service, rules, path)	MeshInfo group.
`ReadCase`(service, rules, command[, path])	ReadCase command.
`ReadCaseAndData`(service, rules, command[, path])	ReadCaseAndData command.
`ReadData`(service, rules, command[, path])	ReadData command.
`Results`(service, rules, path)	Results group.
`ResultsInfo`(service, rules, path)	ResultsInfo group.
`SendCommand`(service, rules, command[, path])	SendCommand command.
`Setup`(service, rules, path)	Setup group.
`Solution`(service, rules, path)	Solution group.
`Streaming`(service, rules, path)	Streaming group.
`WriteCase`(service, rules, command[, path])	WriteCase command.
`WriteCaseAndData`(service, rules, command[, path])	WriteCaseAndData command.
`WriteData`(service, rules, command[, path])	WriteData command.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class App(service, rules, path)#

Bases: PyMenu

App group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class AppLocal(service, rules, path)#

Bases: PyMenu

AppLocal group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class AppName(service, rules, path=None)#

Bases: PyTextual

Parameter AppName of value type str.

class AuxiliaryInfo(service, rules, path)#

Bases: PyMenu

AuxiliaryInfo group.

Classes:

`DefaultField`(service, rules[, path])	Parameter DefaultField of value type str.
`DefaultVectorField`(service, rules[, path])	Parameter DefaultVectorField of value type str.
`FluentBoundaryZones`(service, rules[, path])	Parameter FluentBoundaryZones of value type list[str].
`IsCourantNumberActive`(service, rules[, path])	Parameter IsCourantNumberActive of value type bool.
`IsDPMWallFilmBC`(service, rules[, path])	Parameter IsDPMWallFilmBC of value type bool.
`IsOversetReadOnly`(service, rules[, path])	Parameter IsOversetReadOnly of value type bool.
`IsPVCouplingActive`(service, rules[, path])	Parameter IsPVCouplingActive of value type bool.
`IsSgPDFTransport`(service, rules[, path])	Parameter IsSgPDFTransport of value type bool.
`IsUnsteadyParticleTracking`(service, rules[, ...])	Parameter IsUnsteadyParticleTracking of value type bool.
`MultiPhaseDomainList`(service, rules[, path])	Parameter MultiPhaseDomainList of value type list[str].
`MultiPhaseModel`(service, rules[, path])	Parameter MultiPhaseModel of value type str.
`TimeStepSpecification`(service, rules[, path])	Parameter TimeStepSpecification of value type bool.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class DefaultField(service, rules, path=None)#

Bases: PyTextual

Parameter DefaultField of value type str.

class DefaultVectorField(service, rules, path=None)#

Bases: PyTextual

Parameter DefaultVectorField of value type str.

class FluentBoundaryZones(service, rules, path=None)#

Bases: PyTextual

Parameter FluentBoundaryZones of value type list[str].

class IsCourantNumberActive(service, rules, path=None)#

Bases: PyParameter

Parameter IsCourantNumberActive of value type bool.

class IsDPMWallFilmBC(service, rules, path=None)#

Bases: PyParameter

Parameter IsDPMWallFilmBC of value type bool.

class IsOversetReadOnly(service, rules, path=None)#

Bases: PyParameter

Parameter IsOversetReadOnly of value type bool.

class IsPVCouplingActive(service, rules, path=None)#

Bases: PyParameter

Parameter IsPVCouplingActive of value type bool.

class IsSgPDFTransport(service, rules, path=None)#

Bases: PyParameter

Parameter IsSgPDFTransport of value type bool.

class IsUnsteadyParticleTracking(service, rules, path=None)#

Bases: PyParameter

Parameter IsUnsteadyParticleTracking of value type bool.

class MultiPhaseDomainList(service, rules, path=None)#

Bases: PyTextual

Parameter MultiPhaseDomainList of value type list[str].

class MultiPhaseModel(service, rules, path=None)#

Bases: PyTextual

Parameter MultiPhaseModel of value type str.

class TimeStepSpecification(service, rules, path=None)#

Bases: PyParameter

Parameter TimeStepSpecification of value type bool.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class CaseInfo(service, rules, path)#

Bases: PyMenu

CaseInfo group.

Classes:

`CaseFileName`(service, rules[, path])	Parameter CaseFileName of value type str.
`CaseFileNameDirStripped`(service, rules[, path])	Parameter CaseFileNameDirStripped of value type str.
`Configuration`(service, rules[, path])	Parameter Configuration of value type str.
`Dimension`(service, rules[, path])	Parameter Dimension of value type str.
`HostName`(service, rules[, path])	Parameter HostName of value type str.
`IsEduOnlyLogo`(service, rules[, path])	Parameter IsEduOnlyLogo of value type bool.
`IsStudentOnly`(service, rules[, path])	Parameter IsStudentOnly of value type bool.
`SolverName`(service, rules[, path])	Parameter SolverName of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CaseFileName(service, rules, path=None)#

Bases: PyTextual

Parameter CaseFileName of value type str.

class CaseFileNameDirStripped(service, rules, path=None)#

Bases: PyTextual

Parameter CaseFileNameDirStripped of value type str.

class Configuration(service, rules, path=None)#

Bases: PyTextual

Parameter Configuration of value type str.

class Dimension(service, rules, path=None)#

Bases: PyTextual

Parameter Dimension of value type str.

class HostName(service, rules, path=None)#

Bases: PyTextual

Parameter HostName of value type str.

class IsEduOnlyLogo(service, rules, path=None)#

Bases: PyParameter

Parameter IsEduOnlyLogo of value type bool.

class IsStudentOnly(service, rules, path=None)#

Bases: PyParameter

Parameter IsStudentOnly of value type bool.

class SolverName(service, rules, path=None)#

Bases: PyTextual

Parameter SolverName of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class ClearDatamodel(service, rules, command, path=None)#

Bases: PyCommand

ClearDatamodel command.

Returns:

None

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class MeshInfo(service, rules, path)#

Bases: PyMenu

MeshInfo group.

Classes:

MeshExtents(service, rules, path)

MeshExtents group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class MeshExtents(service, rules, path)#

Bases: PyMenu

MeshExtents group.

Classes:

`XMax`(service, rules[, path])	Parameter XMax of value type float.
`XMin`(service, rules[, path])	Parameter XMin of value type float.
`YMax`(service, rules[, path])	Parameter YMax of value type float.
`YMin`(service, rules[, path])	Parameter YMin of value type float.
`ZMax`(service, rules[, path])	Parameter ZMax of value type float.
`ZMin`(service, rules[, path])	Parameter ZMin of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class XMax(service, rules, path=None)#

Bases: PyNumerical

Parameter XMax of value type float.

class XMin(service, rules, path=None)#

Bases: PyNumerical

Parameter XMin of value type float.

class YMax(service, rules, path=None)#

Bases: PyNumerical

Parameter YMax of value type float.

class YMin(service, rules, path=None)#

Bases: PyNumerical

Parameter YMin of value type float.

class ZMax(service, rules, path=None)#

Bases: PyNumerical

Parameter ZMax of value type float.

class ZMin(service, rules, path=None)#

Bases: PyNumerical

Parameter ZMin of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class ReadCase(service, rules, command, path=None)#

Bases: PyCommand

ReadCase command.

Parameters:

FileNamestr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class ReadCaseAndData(service, rules, command, path=None)#

Bases: PyCommand

ReadCaseAndData command.

Parameters:

FileNamestr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class ReadData(service, rules, command, path=None)#

Bases: PyCommand

ReadData command.

Parameters:

FileNamestr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Results(service, rules, path)#

Bases: PyMenu

Results group.

Classes:

`CreateCellZoneSurfaces`(service, rules, command)	CreateCellZoneSurfaces command.
`CreateMultipleIsosurfaces`(service, rules, ...)	CreateMultipleIsosurfaces command.
`CreateMultiplePlanes`(service, rules, command)	CreateMultiplePlanes command.
`GetFieldMinMax`(service, rules, command[, path])	GetFieldMinMax command.
`GetXYData`(service, rules, command[, path])	GetXYData command.
`Graphics`(service, rules, path)	Graphics group.
`Plots`(service, rules, path)	Plots group.
`Reports`(service, rules[, path])
`ResultsExternalInfo`(service, rules, path)	ResultsExternalInfo group.
`SurfaceDefs`(service, rules[, path])
`View`(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CreateCellZoneSurfaces(service, rules, command, path=None)#

Bases: PyCommand

CreateCellZoneSurfaces command.

Returns:

list[int]

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class CreateMultipleIsosurfaces(service, rules, command, path=None)#

Bases: PyCommand

CreateMultipleIsosurfaces command.

Parameters:

NameFormatstr
Fieldstr
SpecifyBystr
FirstValuefloat
Incrementfloat
Stepsint
LastValuefloat

Returns:

None

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class CreateMultiplePlanes(service, rules, command, path=None)#

Bases: PyCommand

CreateMultiplePlanes command.

Parameters:

NameFormatstr
NumberOfPlanesint
Optionstr
NormalSpecificationstr
NormalVectordict[str, Any]
StartPointdict[str, Any]
EndPointdict[str, Any]
Spacingfloat

Returns:

None

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class GetFieldMinMax(service, rules, command, path=None)#

Bases: PyCommand

GetFieldMinMax command.

Parameters:

Fieldstr
Surfaceslist[str]

Returns:

list[float]

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class GetXYData(service, rules, command, path=None)#

Bases: PyCommand

GetXYData command.

Parameters:

Surfaceslist[str]
Fieldslist[str]

Returns:

None

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Graphics(service, rules, path)#

Bases: PyMenu

Graphics group.

Classes:

`CameraSettings`(service, rules, path)	CameraSettings group.
`Contour`(service, rules[, path])
`GraphicsCreationCount`(service, rules[, path])	Parameter GraphicsCreationCount of value type int.
`GridColors`(service, rules, path)	GridColors group.
`LIC`(service, rules[, path])
`Mesh`(service, rules[, path])
`ParticleTracks`(service, rules[, path])
`Pathlines`(service, rules[, path])
`SaveImage`(service, rules, command[, path])	SaveImage command.
`Scene`(service, rules[, path])
`Vector`(service, rules[, path])
`XYPlot`(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CameraSettings(service, rules, path)#

Bases: PyMenu

CameraSettings group.

Classes:

`Position`(service, rules, path)	Position group.
`Target`(service, rules, path)	Target group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Position(service, rules, path)#

Bases: PyMenu

Position group.

Classes:

`X`(service, rules[, path])	Parameter X of value type float.
`Y`(service, rules[, path])	Parameter Y of value type float.
`Z`(service, rules[, path])	Parameter Z of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class X(service, rules, path=None)#

Bases: PyNumerical

Parameter X of value type float.

class Y(service, rules, path=None)#

Bases: PyNumerical

Parameter Y of value type float.

class Z(service, rules, path=None)#

Bases: PyNumerical

Parameter Z of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Target(service, rules, path)#

Bases: PyMenu

Target group.

Classes:

`X`(service, rules[, path])	Parameter X of value type float.
`Y`(service, rules[, path])	Parameter Y of value type float.
`Z`(service, rules[, path])	Parameter Z of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class X(service, rules, path=None)#

Bases: PyNumerical

Parameter X of value type float.

class Y(service, rules, path=None)#

Bases: PyNumerical

Parameter Y of value type float.

class Z(service, rules, path=None)#

Bases: PyNumerical

Parameter Z of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Contour(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class GraphicsCreationCount(service, rules, path=None)#

Bases: PyNumerical

Parameter GraphicsCreationCount of value type int.

class GridColors(service, rules, path)#

Bases: PyMenu

GridColors group.

Classes:

`ColorGridAxis`(service, rules[, path])	Parameter ColorGridAxis of value type str.
`ColorGridFar`(service, rules[, path])	Parameter ColorGridFar of value type str.
`ColorGridFreeSurface`(service, rules[, path])	Parameter ColorGridFreeSurface of value type str.
`ColorGridInlet`(service, rules[, path])	Parameter ColorGridInlet of value type str.
`ColorGridInterior`(service, rules[, path])	Parameter ColorGridInterior of value type str.
`ColorGridInternal`(service, rules[, path])	Parameter ColorGridInternal of value type str.
`ColorGridOutlet`(service, rules[, path])	Parameter ColorGridOutlet of value type str.
`ColorGridOverset`(service, rules[, path])	Parameter ColorGridOverset of value type str.
`ColorGridPeriodic`(service, rules[, path])	Parameter ColorGridPeriodic of value type str.
`ColorGridRansLesInterface`(service, rules[, path])	Parameter ColorGridRansLesInterface of value type str.
`ColorGridSymmetry`(service, rules[, path])	Parameter ColorGridSymmetry of value type str.
`ColorGridTraction`(service, rules[, path])	Parameter ColorGridTraction of value type str.
`ColorGridWall`(service, rules[, path])	Parameter ColorGridWall of value type str.
`ColorInterface`(service, rules[, path])	Parameter ColorInterface of value type str.
`ColorSurface`(service, rules[, path])	Parameter ColorSurface of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class ColorGridAxis(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridAxis of value type str.

class ColorGridFar(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridFar of value type str.

class ColorGridFreeSurface(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridFreeSurface of value type str.

class ColorGridInlet(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridInlet of value type str.

class ColorGridInterior(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridInterior of value type str.

class ColorGridInternal(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridInternal of value type str.

class ColorGridOutlet(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridOutlet of value type str.

class ColorGridOverset(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridOverset of value type str.

class ColorGridPeriodic(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridPeriodic of value type str.

class ColorGridRansLesInterface(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridRansLesInterface of value type str.

class ColorGridSymmetry(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridSymmetry of value type str.

class ColorGridTraction(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridTraction of value type str.

class ColorGridWall(service, rules, path=None)#

Bases: PyTextual

Parameter ColorGridWall of value type str.

class ColorInterface(service, rules, path=None)#

Bases: PyTextual

Parameter ColorInterface of value type str.

class ColorSurface(service, rules, path=None)#

Bases: PyTextual

Parameter ColorSurface of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class LIC(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Mesh(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class ParticleTracks(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Pathlines(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class SaveImage(service, rules, command, path=None)#

Bases: PyCommand

SaveImage command.

Parameters:

FileNamestr
Formatstr
FileTypestr
Coloringstr
Orientationstr
UseWhiteBackgroundbool
Resolutiondict[str, Any]

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Scene(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Vector(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class XYPlot(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Plots(service, rules, path)#

Bases: PyMenu

Plots group.

Classes:

PlotFromFile(service, rules, path)

PlotFromFile group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class PlotFromFile(service, rules, path)#

Bases: PyMenu

PlotFromFile group.

Classes:

`Axes`(service, rules, path)	Axes group.
`Curves`(service, rules, path)	Curves group.
`Filename`(service, rules[, path])	Parameter Filename of value type str.
`Plot`(service, rules, command[, path])	Plot command.
`XAxisFunction`(service, rules, path)	XAxisFunction group.
`YAxisFunction`(service, rules, path)	YAxisFunction group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Axes(service, rules, path)#

Bases: PyMenu

Axes group.

Classes:

`X`(service, rules, path)	X group.
`Y`(service, rules, path)	Y group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class X(service, rules, path)#

Bases: PyMenu

X group.

Classes:

`Label`(service, rules[, path])	Parameter Label of value type str.
`MajorRules`(service, rules, path)	MajorRules group.
`MinorRules`(service, rules, path)	MinorRules group.
`NumberFormat`(service, rules, path)	NumberFormat group.
`Options`(service, rules, path)	Options group.
`Range`(service, rules, path)	Range group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Label(service, rules, path=None)#

Bases: PyTextual

Parameter Label of value type str.

class MajorRules(service, rules, path)#

Bases: PyMenu

MajorRules group.

Classes:

`Color`(service, rules[, path])	Parameter Color of value type str.
`Weight`(service, rules[, path])	Parameter Weight of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Color(service, rules, path=None)#

Bases: PyTextual

Parameter Color of value type str.

class Weight(service, rules, path=None)#

Bases: PyNumerical

Parameter Weight of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class MinorRules(service, rules, path)#

Bases: PyMenu

MinorRules group.

Classes:

`Color`(service, rules[, path])	Parameter Color of value type str.
`Weight`(service, rules[, path])	Parameter Weight of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Color(service, rules, path=None)#

Bases: PyTextual

Parameter Color of value type str.

class Weight(service, rules, path=None)#

Bases: PyNumerical

Parameter Weight of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class NumberFormat(service, rules, path)#

Bases: PyMenu

NumberFormat group.

Classes:

`Precision`(service, rules[, path])	Parameter Precision of value type int.
`Type`(service, rules[, path])	Parameter Type of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Precision(service, rules, path=None)#

Bases: PyNumerical

Parameter Precision of value type int.

class Type(service, rules, path=None)#

Bases: PyTextual

Parameter Type of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Options(service, rules, path)#

Bases: PyMenu

Options group.

Classes:

`AutoRange`(service, rules[, path])	Parameter AutoRange of value type bool.
`Log`(service, rules[, path])	Parameter Log of value type bool.
`MajorRules`(service, rules[, path])	Parameter MajorRules of value type bool.
`MinorRules`(service, rules[, path])	Parameter MinorRules of value type bool.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class AutoRange(service, rules, path=None)#

Bases: PyParameter

Parameter AutoRange of value type bool.

class Log(service, rules, path=None)#

Bases: PyParameter

Parameter Log of value type bool.

class MajorRules(service, rules, path=None)#

Bases: PyParameter

Parameter MajorRules of value type bool.

class MinorRules(service, rules, path=None)#

Bases: PyParameter

Parameter MinorRules of value type bool.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Range(service, rules, path)#

Bases: PyMenu

Range group.

Classes:

`Maximum`(service, rules[, path])	Parameter Maximum of value type float.
`Minimum`(service, rules[, path])	Parameter Minimum of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Maximum(service, rules, path=None)#

Bases: PyNumerical

Parameter Maximum of value type float.

class Minimum(service, rules, path=None)#

Bases: PyNumerical

Parameter Minimum of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Y(service, rules, path)#

Bases: PyMenu

Y group.

Classes:

`Label`(service, rules[, path])	Parameter Label of value type str.
`MajorRules`(service, rules, path)	MajorRules group.
`MinorRules`(service, rules, path)	MinorRules group.
`NumberFormat`(service, rules, path)	NumberFormat group.
`Options`(service, rules, path)	Options group.
`Range`(service, rules, path)	Range group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Label(service, rules, path=None)#

Bases: PyTextual

Parameter Label of value type str.

class MajorRules(service, rules, path)#

Bases: PyMenu

MajorRules group.

Classes:

`Color`(service, rules[, path])	Parameter Color of value type str.
`Weight`(service, rules[, path])	Parameter Weight of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Color(service, rules, path=None)#

Bases: PyTextual

Parameter Color of value type str.

class Weight(service, rules, path=None)#

Bases: PyNumerical

Parameter Weight of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class MinorRules(service, rules, path)#

Bases: PyMenu

MinorRules group.

Classes:

`Color`(service, rules[, path])	Parameter Color of value type str.
`Weight`(service, rules[, path])	Parameter Weight of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Color(service, rules, path=None)#

Bases: PyTextual

Parameter Color of value type str.

class Weight(service, rules, path=None)#

Bases: PyNumerical

Parameter Weight of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class NumberFormat(service, rules, path)#

Bases: PyMenu

NumberFormat group.

Classes:

`Precision`(service, rules[, path])	Parameter Precision of value type int.
`Type`(service, rules[, path])	Parameter Type of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Precision(service, rules, path=None)#

Bases: PyNumerical

Parameter Precision of value type int.

class Type(service, rules, path=None)#

Bases: PyTextual

Parameter Type of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Options(service, rules, path)#

Bases: PyMenu

Options group.

Classes:

`AutoRange`(service, rules[, path])	Parameter AutoRange of value type bool.
`Log`(service, rules[, path])	Parameter Log of value type bool.
`MajorRules`(service, rules[, path])	Parameter MajorRules of value type bool.
`MinorRules`(service, rules[, path])	Parameter MinorRules of value type bool.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class AutoRange(service, rules, path=None)#

Bases: PyParameter

Parameter AutoRange of value type bool.

class Log(service, rules, path=None)#

Bases: PyParameter

Parameter Log of value type bool.

class MajorRules(service, rules, path=None)#

Bases: PyParameter

Parameter MajorRules of value type bool.

class MinorRules(service, rules, path=None)#

Bases: PyParameter

Parameter MinorRules of value type bool.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Range(service, rules, path)#

Bases: PyMenu

Range group.

Classes:

`Maximum`(service, rules[, path])	Parameter Maximum of value type float.
`Minimum`(service, rules[, path])	Parameter Minimum of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Maximum(service, rules, path=None)#

Bases: PyNumerical

Parameter Maximum of value type float.

class Minimum(service, rules, path=None)#

Bases: PyNumerical

Parameter Minimum of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Curves(service, rules, path)#

Bases: PyMenu

Curves group.

Classes:

`LineStyle`(service, rules, path)	LineStyle group.
`MarkerStyle`(service, rules, path)	MarkerStyle group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class LineStyle(service, rules, path)#

Bases: PyMenu

LineStyle group.

Classes:

`Color`(service, rules[, path])	Parameter Color of value type str.
`Pattern`(service, rules[, path])	Parameter Pattern of value type str.
`Weight`(service, rules[, path])	Parameter Weight of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Color(service, rules, path=None)#

Bases: PyTextual

Parameter Color of value type str.

class Pattern(service, rules, path=None)#

Bases: PyTextual

Parameter Pattern of value type str.

class Weight(service, rules, path=None)#

Bases: PyNumerical

Parameter Weight of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class MarkerStyle(service, rules, path)#

Bases: PyMenu

MarkerStyle group.

Classes:

`Color`(service, rules[, path])	Parameter Color of value type str.
`Size`(service, rules[, path])	Parameter Size of value type float.
`Symbol`(service, rules[, path])	Parameter Symbol of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Color(service, rules, path=None)#

Bases: PyTextual

Parameter Color of value type str.

class Size(service, rules, path=None)#

Bases: PyNumerical

Parameter Size of value type float.

class Symbol(service, rules, path=None)#

Bases: PyTextual

Parameter Symbol of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Filename(service, rules, path=None)#

Bases: PyTextual

Parameter Filename of value type str.

class Plot(service, rules, command, path=None)#

Bases: PyCommand

Plot command.

Returns:

None

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class XAxisFunction(service, rules, path)#

Bases: PyMenu

XAxisFunction group.

Classes:

Field(service, rules[, path])

Parameter Field of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Field(service, rules, path=None)#

Bases: PyTextual

Parameter Field of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class YAxisFunction(service, rules, path)#

Bases: PyMenu

YAxisFunction group.

Classes:

Field(service, rules[, path])

Parameter Field of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Field(service, rules, path=None)#

Bases: PyTextual

Parameter Field of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Reports(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class ResultsExternalInfo(service, rules, path)#

Bases: PyMenu

ResultsExternalInfo group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class SurfaceDefs(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class View(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class ResultsInfo(service, rules, path)#

Bases: PyMenu

ResultsInfo group.

Classes:

`DPMInjections`(service, rules[, path])
`DPMParticleVectorFields`(service, rules[, path])
`Fields`(service, rules[, path])
`ParticleTracksFields`(service, rules[, path])
`ParticleVariables`(service, rules[, path])
`PathlinesFields`(service, rules[, path])
`VectorFields`(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class DPMInjections(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class DPMParticleVectorFields(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Fields(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class ParticleTracksFields(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class ParticleVariables(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class PathlinesFields(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class VectorFields(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class SendCommand(service, rules, command, path=None)#

Bases: PyCommand

SendCommand command.

Parameters:

Commandstr
PythonCommandbool

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Setup(service, rules, path)#

Bases: PyMenu

Setup group.

Classes:

`Beta`(service, rules[, path])	Parameter Beta of value type bool.
`Boundary`(service, rules[, path])
`CellZone`(service, rules[, path])
`Material`(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Beta(service, rules, path=None)#

Bases: PyParameter

Parameter Beta of value type bool.

class Boundary(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class CellZone(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Material(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Solution(service, rules, path)#

Bases: PyMenu

Solution group.

Classes:

`Calculation`(service, rules, path)	Calculation group.
`CalculationActivities`(service, rules, path)	CalculationActivities group.
`Controls`(service, rules, path)	Controls group.
`Methods`(service, rules, path)	Methods group.
`Monitors`(service, rules, path)	Monitors group.
`State`(service, rules, path)	State group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Calculation(service, rules, path)#

Bases: PyMenu

Calculation group.

Classes:

`AnalysisType`(service, rules[, path])	Parameter AnalysisType of value type str.
`Calculate`(service, rules, command[, path])	Calculate command.
`Initialize`(service, rules, command[, path])	Initialize command.
`Interrupt`(service, rules, command[, path])	Interrupt command.
`MaxIterationsPerTimeStep`(service, rules[, path])	Parameter MaxIterationsPerTimeStep of value type int.
`NumberOfIterations`(service, rules[, path])	Parameter NumberOfIterations of value type int.
`NumberOfTimeSteps`(service, rules[, path])	Parameter NumberOfTimeSteps of value type int.
`Pause`(service, rules, command[, path])	Pause command.
`Resume`(service, rules, command[, path])	Resume command.
`TimeStepSize`(service, rules[, path])	Parameter TimeStepSize of value type float.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class AnalysisType(service, rules, path=None)#

Bases: PyTextual

Parameter AnalysisType of value type str.

class Calculate(service, rules, command, path=None)#

Bases: PyCommand

Calculate command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Initialize(service, rules, command, path=None)#

Bases: PyCommand

Initialize command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Interrupt(service, rules, command, path=None)#

Bases: PyCommand

Interrupt command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class MaxIterationsPerTimeStep(service, rules, path=None)#

Bases: PyNumerical

Parameter MaxIterationsPerTimeStep of value type int.

class NumberOfIterations(service, rules, path=None)#

Bases: PyNumerical

Parameter NumberOfIterations of value type int.

class NumberOfTimeSteps(service, rules, path=None)#

Bases: PyNumerical

Parameter NumberOfTimeSteps of value type int.

class Pause(service, rules, command, path=None)#

Bases: PyCommand

Pause command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class Resume(service, rules, command, path=None)#

Bases: PyCommand

Resume command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class TimeStepSize(service, rules, path=None)#

Bases: PyNumerical

Parameter TimeStepSize of value type float.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class CalculationActivities(service, rules, path)#

Bases: PyMenu

CalculationActivities group.

Classes:

SolutionAnimations(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class SolutionAnimations(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Controls(service, rules, path)#

Bases: PyMenu

Controls group.

Classes:

`CourantNumber`(service, rules[, path])	Parameter CourantNumber of value type float.
`UnderRelaxationFactors`(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CourantNumber(service, rules, path=None)#

Bases: PyNumerical

Parameter CourantNumber of value type float.

class UnderRelaxationFactors(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Methods(service, rules, path)#

Bases: PyMenu

Methods group.

Classes:

`DiscretizationSchemes`(service, rules[, path])
`PVCouplingScheme`(service, rules[, path])	Parameter PVCouplingScheme of value type str.
`PVCouplingSchemeAllowedValues`(service, rules)	Parameter PVCouplingSchemeAllowedValues of value type list[str].

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class DiscretizationSchemes(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class PVCouplingScheme(service, rules, path=None)#

Bases: PyTextual

Parameter PVCouplingScheme of value type str.

class PVCouplingSchemeAllowedValues(service, rules, path=None)#

Bases: PyTextual

Parameter PVCouplingSchemeAllowedValues of value type list[str].

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Monitors(service, rules, path)#

Bases: PyMenu

Monitors group.

Classes:

`ReportPlots`(service, rules[, path])
`Residuals`(service, rules, path)	Residuals group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class ReportPlots(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Residuals(service, rules, path)#

Bases: PyMenu

Residuals group.

Classes:

`ConvergenceCriterionType`(service, rules[, path])	Parameter ConvergenceCriterionType of value type str.
`Equation`(service, rules[, path])

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class ConvergenceCriterionType(service, rules, path=None)#

Bases: PyTextual

Parameter ConvergenceCriterionType of value type str.

class Equation(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class State(service, rules, path)#

Bases: PyMenu

State group.

Classes:

`AeroOn`(service, rules[, path])	Parameter AeroOn of value type bool.
`CaseFileName`(service, rules[, path])	Parameter CaseFileName of value type str.
`CaseId`(service, rules[, path])	Parameter CaseId of value type int.
`CaseValid`(service, rules[, path])	Parameter CaseValid of value type bool.
`DataId`(service, rules[, path])	Parameter DataId of value type int.
`DataValid`(service, rules[, path])	Parameter DataValid of value type bool.
`GridId`(service, rules[, path])	Parameter GridId of value type int.
`IcingOn`(service, rules[, path])	Parameter IcingOn of value type bool.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class AeroOn(service, rules, path=None)#

Bases: PyParameter

Parameter AeroOn of value type bool.

class CaseFileName(service, rules, path=None)#

Bases: PyTextual

Parameter CaseFileName of value type str.

class CaseId(service, rules, path=None)#

Bases: PyNumerical

Parameter CaseId of value type int.

class CaseValid(service, rules, path=None)#

Bases: PyParameter

Parameter CaseValid of value type bool.

class DataId(service, rules, path=None)#

Bases: PyNumerical

Parameter DataId of value type int.

class DataValid(service, rules, path=None)#

Bases: PyParameter

Parameter DataValid of value type bool.

class GridId(service, rules, path=None)#

Bases: PyNumerical

Parameter GridId of value type int.

class IcingOn(service, rules, path=None)#

Bases: PyParameter

Parameter IcingOn of value type bool.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class Streaming(service, rules, path)#

Bases: PyMenu

Streaming group.

Classes:

Ack(service, rules[, path])

Parameter Ack of value type bool.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Ack(service, rules, path=None)#

Bases: PyParameter

Parameter Ack of value type bool.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class WriteCase(service, rules, command, path=None)#

Bases: PyCommand

WriteCase command.

Parameters:

FileNamestr
Binarybool
Overwritebool

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class WriteCaseAndData(service, rules, command, path=None)#

Bases: PyCommand

WriteCaseAndData command.

Parameters:

FileNamestr
Binarybool
Overwritebool

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class WriteData(service, rules, command, path=None)#

Bases: PyCommand

WriteData command.

Parameters:

FileNamestr
Binarybool
Overwritebool

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.