solver.datamodel.flicing#

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

Bases: PyMenu

Singleton Root.

Classes:

Case(service, rules, path)

Singleton Case.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton Case.

Classes:

App(service, rules, path)

Singleton App.

AppLocal(service, rules, path)

Singleton AppLocal.

AppName(service, rules[, path])

Parameter AppName of value type str.

AuxiliaryInfo(service, rules, path)

Singleton AuxiliaryInfo.

CaseInfo(service, rules, path)

Singleton CaseInfo.

ClearDatamodel(service, rules, command[, path])

Command ClearDatamodel.

MeshInfo(service, rules, path)

Singleton MeshInfo.

ReadCase(service, rules, command[, path])

Command ReadCase.

ReadCaseAndData(service, rules, command[, path])

Command ReadCaseAndData.

ReadData(service, rules, command[, path])

Command ReadData.

Results(service, rules, path)

Singleton Results.

ResultsInfo(service, rules, path)

Singleton ResultsInfo.

SendCommand(service, rules, command[, path])

Command SendCommand.

Setup(service, rules, path)

Singleton Setup.

Solution(service, rules, path)

Singleton Solution.

Streaming(service, rules, path)

Singleton Streaming.

WriteCase(service, rules, command[, path])

Command WriteCase.

WriteCaseAndData(service, rules, command[, path])

Command WriteCaseAndData.

WriteData(service, rules, command[, path])

Command WriteData.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton App.

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

Singleton AppLocal.

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

Singleton AuxiliaryInfo.

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

Singleton CaseInfo.

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.

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

Command ClearDatamodel.

Returns:
None
class MeshInfo(service, rules, path)#

Bases: PyMenu

Singleton MeshInfo.

Classes:

MeshExtents(service, rules, path)

Singleton MeshExtents.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton MeshExtents.

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

Command ReadCase.

Parameters:
FileNamestr
Returns:
bool
class ReadCaseAndData(service, rules, command, path=None)#

Bases: PyCommand

Command ReadCaseAndData.

Parameters:
FileNamestr
Returns:
bool
class ReadData(service, rules, command, path=None)#

Bases: PyCommand

Command ReadData.

Parameters:
FileNamestr
Returns:
bool
class Results(service, rules, path)#

Bases: PyMenu

Singleton Results.

Classes:

CreateCellZoneSurfaces(service, rules, command)

Command CreateCellZoneSurfaces.

CreateMultipleIsosurfaces(service, rules, ...)

Command CreateMultipleIsosurfaces.

CreateMultiplePlanes(service, rules, command)

Command CreateMultiplePlanes.

GetFieldMinMax(service, rules, command[, path])

Command GetFieldMinMax.

GetXYData(service, rules, command[, path])

Command GetXYData.

Graphics(service, rules, path)

Singleton Graphics.

Plots(service, rules, path)

Singleton Plots.

Reports(service, rules[, path])

ResultsExternalInfo(service, rules, path)

Singleton ResultsExternalInfo.

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

Command CreateCellZoneSurfaces.

Returns:
List[int]
class CreateMultipleIsosurfaces(service, rules, command, path=None)#

Bases: PyCommand

Command CreateMultipleIsosurfaces.

Parameters:
NameFormatstr
Fieldstr
SpecifyBystr
FirstValuefloat
Incrementfloat
Stepsint
LastValuefloat
Returns:
None
class CreateMultiplePlanes(service, rules, command, path=None)#

Bases: PyCommand

Command CreateMultiplePlanes.

Parameters:
NameFormatstr
NumberOfPlanesint
Optionstr
NormalSpecificationstr
NormalVectorDict[str, Any]
StartPointDict[str, Any]
EndPointDict[str, Any]
Spacingfloat
Returns:
None
class GetFieldMinMax(service, rules, command, path=None)#

Bases: PyCommand

Command GetFieldMinMax.

Parameters:
Fieldstr
SurfacesList[str]
Returns:
List[float]
class GetXYData(service, rules, command, path=None)#

Bases: PyCommand

Command GetXYData.

Parameters:
SurfacesList[str]
FieldsList[str]
Returns:
None
class Graphics(service, rules, path)#

Bases: PyMenu

Singleton Graphics.

Classes:

CameraSettings(service, rules, path)

Singleton CameraSettings.

Contour(service, rules[, path])

GraphicsCreationCount(service, rules[, path])

Parameter GraphicsCreationCount of value type int.

GridColors(service, rules, path)

Singleton GridColors.

LIC(service, rules[, path])

Mesh(service, rules[, path])

ParticleTracks(service, rules[, path])

Pathlines(service, rules[, path])

SaveImage(service, rules, command[, path])

Command SaveImage.

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

Singleton CameraSettings.

Classes:

Position(service, rules, path)

Singleton Position.

Target(service, rules, path)

Singleton Target.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton Position.

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

Singleton Target.

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

Singleton GridColors.

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

Command SaveImage.

Parameters:
FileNamestr
Formatstr
FileTypestr
Coloringstr
Orientationstr
UseWhiteBackgroundbool
ResolutionDict[str, Any]
Returns:
bool
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

Singleton Plots.

Classes:

PlotFromFile(service, rules, path)

Singleton PlotFromFile.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton PlotFromFile.

Classes:

Axes(service, rules, path)

Singleton Axes.

Curves(service, rules, path)

Singleton Curves.

Filename(service, rules[, path])

Parameter Filename of value type str.

Plot(service, rules, command[, path])

Command Plot.

XAxisFunction(service, rules, path)

Singleton XAxisFunction.

YAxisFunction(service, rules, path)

Singleton YAxisFunction.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton Axes.

Classes:

X(service, rules, path)

Singleton X.

Y(service, rules, path)

Singleton Y.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton X.

Classes:

Label(service, rules[, path])

Parameter Label of value type str.

MajorRules(service, rules, path)

Singleton MajorRules.

MinorRules(service, rules, path)

Singleton MinorRules.

NumberFormat(service, rules, path)

Singleton NumberFormat.

Options(service, rules, path)

Singleton Options.

Range(service, rules, path)

Singleton Range.

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

Singleton MajorRules.

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

Singleton MinorRules.

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

Singleton NumberFormat.

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

Singleton Options.

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

Singleton Range.

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

Singleton Y.

Classes:

Label(service, rules[, path])

Parameter Label of value type str.

MajorRules(service, rules, path)

Singleton MajorRules.

MinorRules(service, rules, path)

Singleton MinorRules.

NumberFormat(service, rules, path)

Singleton NumberFormat.

Options(service, rules, path)

Singleton Options.

Range(service, rules, path)

Singleton Range.

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

Singleton MajorRules.

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

Singleton MinorRules.

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

Singleton NumberFormat.

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

Singleton Options.

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

Singleton Range.

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

Singleton Curves.

Classes:

LineStyle(service, rules, path)

Singleton LineStyle.

MarkerStyle(service, rules, path)

Singleton MarkerStyle.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton LineStyle.

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

Singleton MarkerStyle.

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

Command Plot.

Returns:
None
class XAxisFunction(service, rules, path)#

Bases: PyMenu

Singleton XAxisFunction.

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

Singleton YAxisFunction.

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

Singleton ResultsExternalInfo.

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

Singleton ResultsInfo.

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

Command SendCommand.

Parameters:
Commandstr
PythonCommandbool
Returns:
bool
class Setup(service, rules, path)#

Bases: PyMenu

Singleton Setup.

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

Singleton Solution.

Classes:

Calculation(service, rules, path)

Singleton Calculation.

CalculationActivities(service, rules, path)

Singleton CalculationActivities.

Controls(service, rules, path)

Singleton Controls.

Methods(service, rules, path)

Singleton Methods.

Monitors(service, rules, path)

Singleton Monitors.

State(service, rules, path)

Singleton State.

Methods:

__init__(service, rules, path)

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

Bases: PyMenu

Singleton Calculation.

Classes:

AnalysisType(service, rules[, path])

Parameter AnalysisType of value type str.

Calculate(service, rules, command[, path])

Command Calculate.

Initialize(service, rules, command[, path])

Command Initialize.

Interrupt(service, rules, command[, path])

Command Interrupt.

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])

Command Pause.

Resume(service, rules, command[, path])

Command Resume.

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

Command Calculate.

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

Bases: PyCommand

Command Initialize.

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

Bases: PyCommand

Command Interrupt.

Returns:
bool
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

Command Pause.

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

Bases: PyCommand

Command Resume.

Returns:
bool
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

Singleton CalculationActivities.

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

Singleton Controls.

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

Singleton Methods.

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

Singleton Monitors.

Classes:

ReportPlots(service, rules[, path])

Residuals(service, rules, path)

Singleton Residuals.

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

Singleton Residuals.

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

Singleton State.

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

Singleton Streaming.

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

Command WriteCase.

Parameters:
FileNamestr
Binarybool
Overwritebool
Returns:
bool
class WriteCaseAndData(service, rules, command, path=None)#

Bases: PyCommand

Command WriteCaseAndData.

Parameters:
FileNamestr
Binarybool
Overwritebool
Returns:
bool
class WriteData(service, rules, command, path=None)#

Bases: PyCommand

Command WriteData.

Parameters:
FileNamestr
Binarybool
Overwritebool
Returns:
bool
__init__(service, rules, path)#

__init__ method of PyMenu class.

__init__(service, rules, path)#

__init__ method of PyMenu class.

On this page
Show Source