solver.datamodel.flicing

class ansys.fluent.core.datamodel_231.flicing.Root(service, rules, path)

Bases: PyMenu

Singleton Root.

Classes:

Case(service, rules, path)

Singleton Case.

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.

class App(service, rules, path)

Bases: PyMenu

Singleton App.

Classes:

Adaptation(service, rules, path)	Singleton Adaptation.
Airflow(service, rules, path)	Singleton Airflow.
BC(service, rules[, path])	.
CheckSetup(service, rules, command[, path])	Command CheckSetup.
Domain(service, rules, path)	Singleton Domain.
GlobalSettings(service, rules, path)	Singleton GlobalSettings.
Ice(service, rules, path)	Singleton Ice.
IcingImportCase(service, rules, command[, path])	Command IcingImportCase.
IcingImportMesh(service, rules, command[, path])	Command IcingImportMesh.
ImportCase(service, rules, command[, path])	Command ImportCase.
ImportMesh(service, rules, command[, path])	Command ImportMesh.
InProgress(service, rules[, path])	Parameter InProgress of value type bool.
InitAddOn(service, rules, command[, path])	Command InitAddOn.
InitAddOnAero(service, rules, command[, path])	Command InitAddOnAero.
InitDM(service, rules, command[, path])	Command InitDM.
IsBusy(service, rules[, path])	Parameter IsBusy of value type bool.
LoadCase(service, rules, command[, path])	Command LoadCase.
LoadCaseAndData(service, rules, command[, path])	Command LoadCaseAndData.
Particles(service, rules, path)	Singleton Particles.
ReloadCase(service, rules, command[, path])	Command ReloadCase.
ReloadDomain(service, rules, command[, path])	Command ReloadDomain.
RunType(service, rules, path)	Singleton RunType.
SaveCase(service, rules, command[, path])	Command SaveCase.
SaveCaseAndData(service, rules, command[, path])	Command SaveCaseAndData.
SaveCaseAs(service, rules, command[, path])	Command SaveCaseAs.
SaveData(service, rules, command[, path])	Command SaveData.
SavePostCaseAndData(service, rules, command)	Command SavePostCaseAndData.
SendCommandQuiet(service, rules, command[, path])	Command SendCommandQuiet.
SetupErrors(service, rules[, path])	Parameter SetupErrors of value type str.
SetupWarnings(service, rules[, path])	Parameter SetupWarnings of value type str.
Solution(service, rules, path)	Singleton Solution.
SyncDM(service, rules, command[, path])	Command SyncDM.
WriteAll(service, rules, command[, path])	Command WriteAll.

class Adaptation(service, rules, path)

Bases: PyMenu

Singleton Adaptation.

Classes:

Boundaries(service, rules, path)	Singleton Boundaries.
Constraints(service, rules, path)	Singleton Constraints.
EditCAD(service, rules, command[, path])	Command EditCAD.
GenerateCAD(service, rules, command[, path])	Command GenerateCAD.
Input(service, rules, path)	Singleton Input.
ResetCAD(service, rules, command[, path])	Command ResetCAD.
State(service, rules, path)	Singleton State.

class Boundaries(service, rules, path)

Bases: PyMenu

Singleton Boundaries.

Classes:

DeadZones(service, rules[, path])	Parameter DeadZones of value type List[str].
YFamilies(service, rules[, path])	Parameter YFamilies of value type List[str].

class DeadZones(service, rules, path=None)

Bases: PyTextual

Parameter DeadZones of value type List[str].

class YFamilies(service, rules, path=None)

Bases: PyTextual

Parameter YFamilies of value type List[str].

class Constraints(service, rules, path)

Bases: PyMenu

Singleton Constraints.

Classes:

DegAnisotropy(service, rules[, path])	Parameter DegAnisotropy of value type float.
DihedralAngle(service, rules[, path])	Parameter DihedralAngle of value type float.
FaceAngle(service, rules[, path])	Parameter FaceAngle of value type float.
HasHexa(service, rules[, path])	Parameter HasHexa of value type bool.
HasPrism(service, rules[, path])	Parameter HasPrism of value type bool.
HasPyra(service, rules[, path])	Parameter HasPyra of value type bool.
HasTetra(service, rules[, path])	Parameter HasTetra of value type bool.
HexaDeterminant(service, rules[, path])	Parameter HexaDeterminant of value type float.
HexaWarpage(service, rules[, path])	Parameter HexaWarpage of value type float.
MaxCoarseningCurvature(service, rules[, path])	Parameter MaxCoarseningCurvature of value type float.
MaxEdge(service, rules[, path])	Parameter MaxEdge of value type float.
MaxEdgeRef(service, rules[, path])	Parameter MaxEdgeRef of value type float.
MinEdge(service, rules[, path])	Parameter MinEdge of value type float.
MinEdgeRef(service, rules[, path])	Parameter MinEdgeRef of value type float.
Mode(service, rules[, path])	Parameter Mode of value type str.
PrismAspectRatio(service, rules[, path])	Parameter PrismAspectRatio of value type float.
PrismWarpage(service, rules[, path])	Parameter PrismWarpage of value type float.
TetraAspectRatio(service, rules[, path])	Parameter TetraAspectRatio of value type float.

class DegAnisotropy(service, rules, path=None)

Bases: PyNumerical

Parameter DegAnisotropy of value type float.

class DihedralAngle(service, rules, path=None)

Bases: PyNumerical

Parameter DihedralAngle of value type float.

class FaceAngle(service, rules, path=None)

Bases: PyNumerical

Parameter FaceAngle of value type float.

class HasHexa(service, rules, path=None)

Bases: PyParameter

Parameter HasHexa of value type bool.

class HasPrism(service, rules, path=None)

Bases: PyParameter

Parameter HasPrism of value type bool.

class HasPyra(service, rules, path=None)

Bases: PyParameter

Parameter HasPyra of value type bool.

class HasTetra(service, rules, path=None)

Bases: PyParameter

Parameter HasTetra of value type bool.

class HexaDeterminant(service, rules, path=None)

Bases: PyNumerical

Parameter HexaDeterminant of value type float.

class HexaWarpage(service, rules, path=None)

Bases: PyNumerical

Parameter HexaWarpage of value type float.

class MaxCoarseningCurvature(service, rules, path=None)

Bases: PyNumerical

Parameter MaxCoarseningCurvature of value type float.

class MaxEdge(service, rules, path=None)

Bases: PyNumerical

Parameter MaxEdge of value type float.

class MaxEdgeRef(service, rules, path=None)

Bases: PyNumerical

Parameter MaxEdgeRef of value type float.

class MinEdge(service, rules, path=None)

Bases: PyNumerical

Parameter MinEdge of value type float.

class MinEdgeRef(service, rules, path=None)

Bases: PyNumerical

Parameter MinEdgeRef of value type float.

class Mode(service, rules, path=None)

Bases: PyTextual

Parameter Mode of value type str.

class PrismAspectRatio(service, rules, path=None)

Bases: PyNumerical

Parameter PrismAspectRatio of value type float.

class PrismWarpage(service, rules, path=None)

Bases: PyNumerical

Parameter PrismWarpage of value type float.

class TetraAspectRatio(service, rules, path=None)

Bases: PyNumerical

Parameter TetraAspectRatio of value type float.

class EditCAD(service, rules, command, path=None)

Bases: PyCommand

Command EditCAD.

Returns:

bool

class GenerateCAD(service, rules, command, path=None)

Bases: PyCommand

Command GenerateCAD.

Returns:

bool

class Input(service, rules, path)

Bases: PyMenu

Singleton Input.

Classes:

CADFile(service, rules[, path])	Parameter CADFile of value type str.
Convolution(service, rules[, path])	Parameter Convolution of value type int.
Deconvolution(service, rules[, path])	Parameter Deconvolution of value type int.
Expression(service, rules[, path])	Parameter Expression of value type str.
Mode(service, rules[, path])	Parameter Mode of value type str.
PostDeconvolution(service, rules[, path])	Parameter PostDeconvolution of value type int.
ScalarVariable(service, rules[, path])	Parameter ScalarVariable of value type str.
ScalarVariableList(service, rules[, path])	Parameter ScalarVariableList of value type str.
ScalarVariableSelect(service, rules[, path])	Parameter ScalarVariableSelect of value type str.
ScalarVariableTranslation(service, rules[, path])	Parameter ScalarVariableTranslation of value type str.
Smoothing(service, rules[, path])	Parameter Smoothing of value type str.
VarList(service, rules, path)	Singleton VarList.
Variables(service, rules[, path])	Parameter Variables of value type List[str].
VariablesPost(service, rules[, path])	Parameter VariablesPost of value type List[str].

class CADFile(service, rules, path=None)

Bases: PyTextual

Parameter CADFile of value type str.

class Convolution(service, rules, path=None)

Bases: PyNumerical

Parameter Convolution of value type int.

class Deconvolution(service, rules, path=None)

Bases: PyNumerical

Parameter Deconvolution of value type int.

class Expression(service, rules, path=None)

Bases: PyTextual

Parameter Expression of value type str.

class Mode(service, rules, path=None)

Bases: PyTextual

Parameter Mode of value type str.

class PostDeconvolution(service, rules, path=None)

Bases: PyNumerical

Parameter PostDeconvolution of value type int.

class ScalarVariable(service, rules, path=None)

Bases: PyTextual

Parameter ScalarVariable of value type str.

class ScalarVariableList(service, rules, path=None)

Bases: PyTextual

Parameter ScalarVariableList of value type str.

class ScalarVariableSelect(service, rules, path=None)

Bases: PyTextual

Parameter ScalarVariableSelect of value type str.

class ScalarVariableTranslation(service, rules, path=None)

Bases: PyTextual

Parameter ScalarVariableTranslation of value type str.

class Smoothing(service, rules, path=None)

Bases: PyTextual

Parameter Smoothing of value type str.

class VarList(service, rules, path)

Bases: PyMenu

Singleton VarList.

Classes:

Var(service, rules[, path])

.

class Var(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class Variables(service, rules, path=None)

Bases: PyTextual

Parameter Variables of value type List[str].

class VariablesPost(service, rules, path=None)

Bases: PyTextual

Parameter VariablesPost of value type List[str].

class ResetCAD(service, rules, command, path=None)

Bases: PyCommand

Command ResetCAD.

Returns:

bool

class State(service, rules, path)

Bases: PyMenu

Singleton State.

Classes:

CADLoaded(service, rules[, path])

Parameter CADLoaded of value type bool.

class CADLoaded(service, rules, path=None)

Bases: PyParameter

Parameter CADLoaded of value type bool.

class Airflow(service, rules, path)

Bases: PyMenu

Singleton Airflow.

Classes:

AirDirection(service, rules, path)	Singleton AirDirection.
Conditions(service, rules, path)	Singleton Conditions.
Fensap(service, rules, path)	Singleton Fensap.
Fluent(service, rules, path)	Singleton Fluent.
General(service, rules, path)	Singleton General.
Refresh(service, rules, command[, path])	Command Refresh.

class AirDirection(service, rules, path)

Bases: PyMenu

Singleton AirDirection.

Classes:

Alpha(service, rules[, path])	Parameter Alpha of value type float.
Beta(service, rules[, path])	Parameter Beta of value type float.
DragDir(service, rules[, path])	Parameter DragDir of value type str.
LiftDir(service, rules[, path])	Parameter LiftDir of value type str.
Magnitude(service, rules[, path])	Parameter Magnitude of value type float.
Mode(service, rules[, path])	Parameter Mode of value type str.
SetAirDirection(service, rules, command[, path])	Command SetAirDirection.
VelocityX(service, rules[, path])	Parameter VelocityX of value type float.
VelocityY(service, rules[, path])	Parameter VelocityY of value type float.
VelocityZ(service, rules[, path])	Parameter VelocityZ of value type float.

class Alpha(service, rules, path=None)

Bases: PyNumerical

Parameter Alpha of value type float.

class Beta(service, rules, path=None)

Bases: PyNumerical

Parameter Beta of value type float.

class DragDir(service, rules, path=None)

Bases: PyTextual

Parameter DragDir of value type str.

class LiftDir(service, rules, path=None)

Bases: PyTextual

Parameter LiftDir of value type str.

class Magnitude(service, rules, path=None)

Bases: PyNumerical

Parameter Magnitude of value type float.

class Mode(service, rules, path=None)

Bases: PyTextual

Parameter Mode of value type str.

class SetAirDirection(service, rules, command, path=None)

Bases: PyCommand

Command SetAirDirection.

Parameters:

aoafloat

aosfloat

magfloat

liftstr

dragstr

Returns:

bool

class VelocityX(service, rules, path=None)

Bases: PyNumerical

Parameter VelocityX of value type float.

class VelocityY(service, rules, path=None)

Bases: PyNumerical

Parameter VelocityY of value type float.

class VelocityZ(service, rules, path=None)

Bases: PyNumerical

Parameter VelocityZ of value type float.

class Conditions(service, rules, path)

Bases: PyMenu

Singleton Conditions.

Classes:

AbsolutePressure(service, rules[, path])	Parameter AbsolutePressure of value type float.
AdiabaticStagnationTemperature(service, rules)	Parameter AdiabaticStagnationTemperature of value type float.
CharLen(service, rules[, path])	Parameter CharLen of value type float.
Mach(service, rules[, path])	Parameter Mach of value type float.
OperatingPressure(service, rules[, path])	Parameter OperatingPressure of value type float.
Pressure(service, rules[, path])	Parameter Pressure of value type float.
Reynolds(service, rules[, path])	Parameter Reynolds of value type float.
SyncFluent(service, rules[, path])	Parameter SyncFluent of value type bool.
Temperature(service, rules[, path])	Parameter Temperature of value type float.
Velocity(service, rules[, path])	Parameter Velocity of value type float.

class AbsolutePressure(service, rules, path=None)

Bases: PyNumerical

Parameter AbsolutePressure of value type float.

class AdiabaticStagnationTemperature(service, rules, path=None)

Bases: PyNumerical

Parameter AdiabaticStagnationTemperature of value type float.

class CharLen(service, rules, path=None)

Bases: PyNumerical

Parameter CharLen of value type float.

class Mach(service, rules, path=None)

Bases: PyNumerical

Parameter Mach of value type float.

class OperatingPressure(service, rules, path=None)

Bases: PyNumerical

Parameter OperatingPressure of value type float.

class Pressure(service, rules, path=None)

Bases: PyNumerical

Parameter Pressure of value type float.

class Reynolds(service, rules, path=None)

Bases: PyNumerical

Parameter Reynolds of value type float.

class SyncFluent(service, rules, path=None)

Bases: PyParameter

Parameter SyncFluent of value type bool.

class Temperature(service, rules, path=None)

Bases: PyNumerical

Parameter Temperature of value type float.

class Velocity(service, rules, path=None)

Bases: PyNumerical

Parameter Velocity of value type float.

class Fensap(service, rules, path)

Bases: PyMenu

Singleton Fensap.

Classes:

AV(service, rules, path)	Singleton AV.
Advanced(service, rules, path)	Singleton Advanced.
Model(service, rules, path)	Singleton Model.
Turbulence(service, rules, path)	Singleton Turbulence.

class AV(service, rules, path)

Bases: PyMenu

Singleton AV.

Classes:

CW(service, rules[, path])	Parameter CW of value type float.
Option(service, rules[, path])	Parameter Option of value type str.
Order(service, rules[, path])	Parameter Order of value type float.

class CW(service, rules, path=None)

Bases: PyNumerical

Parameter CW of value type float.

class Option(service, rules, path=None)

Bases: PyTextual

Parameter Option of value type str.

class Order(service, rules, path=None)

Bases: PyNumerical

Parameter Order of value type float.

class Advanced(service, rules, path)

Bases: PyMenu

Singleton Advanced.

Classes:

SolverParameters(service, rules[, path])

Parameter SolverParameters of value type str.

class SolverParameters(service, rules, path=None)

Bases: PyTextual

Parameter SolverParameters of value type str.

class Model(service, rules, path)

Bases: PyMenu

Singleton Model.

Classes:

CoupledFlag(service, rules[, path])	Parameter CoupledFlag of value type bool.
EnergyConservativeFlag(service, rules[, path])	Parameter EnergyConservativeFlag of value type bool.
EnergyEquation(service, rules[, path])	Parameter EnergyEquation of value type str.

class CoupledFlag(service, rules, path=None)

Bases: PyParameter

Parameter CoupledFlag of value type bool.

class EnergyConservativeFlag(service, rules, path=None)

Bases: PyParameter

Parameter EnergyConservativeFlag of value type bool.

class EnergyEquation(service, rules, path=None)

Bases: PyTextual

Parameter EnergyEquation of value type str.

class Turbulence(service, rules, path)

Bases: PyMenu

Singleton Turbulence.

Classes:

CustomFlag(service, rules[, path])	Parameter CustomFlag of value type bool.
Model(service, rules[, path])	Parameter Model of value type str.
TransitionSA(service, rules[, path])	Parameter TransitionSA of value type str.
TransitionSST(service, rules[, path])	Parameter TransitionSST of value type str.

class CustomFlag(service, rules, path=None)

Bases: PyParameter

Parameter CustomFlag of value type bool.

class Model(service, rules, path=None)

Bases: PyTextual

Parameter Model of value type str.

class TransitionSA(service, rules, path=None)

Bases: PyTextual

Parameter TransitionSA of value type str.

class TransitionSST(service, rules, path=None)

Bases: PyTextual

Parameter TransitionSST of value type str.

class Fluent(service, rules, path)

Bases: PyMenu

Singleton Fluent.

Classes:

DiscretizationSchemes(service, rules[, path])	.
Materials(service, rules, path)	Singleton Materials.
Models(service, rules, path)	Singleton Models.
Refresh(service, rules, command[, path])	Command Refresh.
SetAir(service, rules, command[, path])	Command SetAir.
SetModel(service, rules, command[, path])	Command SetModel.
Solver(service, rules, path)	Singleton Solver.

class DiscretizationSchemes(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class Materials(service, rules, path)

Bases: PyMenu

Singleton Materials.

Classes:

AirCp(service, rules[, path])	Parameter AirCp of value type str.
AirCpConstant(service, rules[, path])	Parameter AirCpConstant of value type float.
AirDensity(service, rules[, path])	Parameter AirDensity of value type str.
AirDensityConstant(service, rules[, path])	Parameter AirDensityConstant of value type float.
AirThermalConductivity(service, rules[, path])	Parameter AirThermalConductivity of value type str.
AirThermalConductivityConstant(service, rules)	Parameter AirThermalConductivityConstant of value type float.
AirViscosity(service, rules[, path])	Parameter AirViscosity of value type str.
AirViscosityConstant(service, rules[, path])	Parameter AirViscosityConstant of value type float.
SettingsSync(service, rules[, path])	Parameter SettingsSync of value type str.

class AirCp(service, rules, path=None)

Bases: PyTextual

Parameter AirCp of value type str.

class AirCpConstant(service, rules, path=None)

Bases: PyNumerical

Parameter AirCpConstant of value type float.

class AirDensity(service, rules, path=None)

Bases: PyTextual

Parameter AirDensity of value type str.

class AirDensityConstant(service, rules, path=None)

Bases: PyNumerical

Parameter AirDensityConstant of value type float.

class AirThermalConductivity(service, rules, path=None)

Bases: PyTextual

Parameter AirThermalConductivity of value type str.

class AirThermalConductivityConstant(service, rules, path=None)

Bases: PyNumerical

Parameter AirThermalConductivityConstant of value type float.

class AirViscosity(service, rules, path=None)

Bases: PyTextual

Parameter AirViscosity of value type str.

class AirViscosityConstant(service, rules, path=None)

Bases: PyNumerical

Parameter AirViscosityConstant of value type float.

class SettingsSync(service, rules, path=None)

Bases: PyTextual

Parameter SettingsSync of value type str.

class Models(service, rules, path)

Bases: PyMenu

Singleton Models.

Classes:

Energy(service, rules[, path])	Parameter Energy of value type bool.
KwModel(service, rules[, path])	Parameter KwModel of value type str.
ProductionLimiter(service, rules[, path])	Parameter ProductionLimiter of value type bool.
TransitionSSTRoughnessConstant(service, rules)	Parameter TransitionSSTRoughnessConstant of value type float.
TransitionSSTRoughnessCorrelation(service, rules)	Parameter TransitionSSTRoughnessCorrelation of value type bool.
Turbulence(service, rules[, path])	Parameter Turbulence of value type str.
ViscousHeating(service, rules[, path])	Parameter ViscousHeating of value type bool.

class Energy(service, rules, path=None)

Bases: PyParameter

Parameter Energy of value type bool.

class KwModel(service, rules, path=None)

Bases: PyTextual

Parameter KwModel of value type str.

class ProductionLimiter(service, rules, path=None)

Bases: PyParameter

Parameter ProductionLimiter of value type bool.

class TransitionSSTRoughnessConstant(service, rules, path=None)

Bases: PyNumerical

Parameter TransitionSSTRoughnessConstant of value type float.

class TransitionSSTRoughnessCorrelation(service, rules, path=None)

Bases: PyParameter

Parameter TransitionSSTRoughnessCorrelation of value type bool.

class Turbulence(service, rules, path=None)

Bases: PyTextual

Parameter Turbulence of value type str.

class ViscousHeating(service, rules, path=None)

Bases: PyParameter

Parameter ViscousHeating of value type bool.

class Refresh(service, rules, command, path=None)

Bases: PyCommand

Command Refresh.

Returns:

bool

class SetAir(service, rules, command, path=None)

Bases: PyCommand

Command SetAir.

Returns:

bool

class SetModel(service, rules, command, path=None)

Bases: PyCommand

Command SetModel.

Returns:

bool

class Solver(service, rules, path)

Bases: PyMenu

Singleton Solver.

Classes:

SolverType(service, rules[, path])

Parameter SolverType of value type str.

class SolverType(service, rules, path=None)

Bases: PyTextual

Parameter SolverType of value type str.

class General(service, rules, path)

Bases: PyMenu

Singleton General.

Classes:

SolverType(service, rules[, path])

Parameter SolverType of value type str.

class SolverType(service, rules, path=None)

Bases: PyTextual

Parameter SolverType of value type str.

class Refresh(service, rules, command, path=None)

Bases: PyCommand

Command Refresh.

Returns:

bool

class BC(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class CheckSetup(service, rules, command, path=None)

Bases: PyCommand

Command CheckSetup.

Returns:

str

class Domain(service, rules, path)

Bases: PyMenu

Singleton Domain.

Classes:

AxisDirectionX(service, rules[, path])	Parameter AxisDirectionX of value type float.
AxisDirectionY(service, rules[, path])	Parameter AxisDirectionY of value type float.
AxisDirectionZ(service, rules[, path])	Parameter AxisDirectionZ of value type float.
Filter(service, rules[, path])	Parameter Filter of value type str.
Frame(service, rules[, path])	Parameter Frame of value type str.
Mode(service, rules[, path])	Parameter Mode of value type str.
NodeOrderId(service, rules[, path])	Parameter NodeOrderId of value type str.
RotationSpeed(service, rules[, path])	Parameter RotationSpeed of value type float.
SingleDomain(service, rules[, path])	Parameter SingleDomain of value type bool.

class AxisDirectionX(service, rules, path=None)

Bases: PyNumerical

Parameter AxisDirectionX of value type float.

class AxisDirectionY(service, rules, path=None)

Bases: PyNumerical

Parameter AxisDirectionY of value type float.

class AxisDirectionZ(service, rules, path=None)

Bases: PyNumerical

Parameter AxisDirectionZ of value type float.

class Filter(service, rules, path=None)

Bases: PyTextual

Parameter Filter of value type str.

class Frame(service, rules, path=None)

Bases: PyTextual

Parameter Frame of value type str.

class Mode(service, rules, path=None)

Bases: PyTextual

Parameter Mode of value type str.

class NodeOrderId(service, rules, path=None)

Bases: PyTextual

Parameter NodeOrderId of value type str.

class RotationSpeed(service, rules, path=None)

Bases: PyNumerical

Parameter RotationSpeed of value type float.

class SingleDomain(service, rules, path=None)

Bases: PyParameter

Parameter SingleDomain of value type bool.

class GlobalSettings(service, rules, path)

Bases: PyMenu

Singleton GlobalSettings.

Classes:

AdvancedFlag(service, rules[, path])	Parameter AdvancedFlag of value type bool.
BetaFlag(service, rules[, path])	Parameter BetaFlag of value type bool.
BetaOrAdvancedFlag(service, rules[, path])	Parameter BetaOrAdvancedFlag of value type bool.
CFFOutput(service, rules[, path])	Parameter CFFOutput of value type bool.
PlotInterval(service, rules[, path])	Parameter PlotInterval of value type int.

class AdvancedFlag(service, rules, path=None)

Bases: PyParameter

Parameter AdvancedFlag of value type bool.

class BetaFlag(service, rules, path=None)

Bases: PyParameter

Parameter BetaFlag of value type bool.

class BetaOrAdvancedFlag(service, rules, path=None)

Bases: PyParameter

Parameter BetaOrAdvancedFlag of value type bool.

class CFFOutput(service, rules, path=None)

Bases: PyParameter

Parameter CFFOutput of value type bool.

class PlotInterval(service, rules, path=None)

Bases: PyNumerical

Parameter PlotInterval of value type int.

class Ice(service, rules, path)

Bases: PyMenu

Singleton Ice.

Classes:

Advanced(service, rules, path)	Singleton Advanced.
Conditions(service, rules, path)	Singleton Conditions.
Crystals(service, rules, path)	Singleton Crystals.
IceConditions(service, rules, path)	Singleton IceConditions.
IcingModel(service, rules, path)	Singleton IcingModel.

class Advanced(service, rules, path)

Bases: PyMenu

Singleton Advanced.

Classes:

SolverParameters(service, rules[, path])

Parameter SolverParameters of value type str.

class SolverParameters(service, rules, path=None)

Bases: PyTextual

Parameter SolverParameters of value type str.

class Conditions(service, rules, path)

Bases: PyMenu

Singleton Conditions.

Classes:

CrackDetectionCriteria(service, rules[, path])	Parameter CrackDetectionCriteria of value type str.
FractureToughness(service, rules[, path])	Parameter FractureToughness of value type float.
IceConstantDensity(service, rules[, path])	Parameter IceConstantDensity of value type float.
IceDensityType(service, rules[, path])	Parameter IceDensityType of value type str.
IceEmissivity(service, rules[, path])	Parameter IceEmissivity of value type float.
IceJonesLEDiameter(service, rules[, path])	Parameter IceJonesLEDiameter of value type float.
PoissonRatio(service, rules[, path])	Parameter PoissonRatio of value type float.
PrincipalStrength(service, rules[, path])	Parameter PrincipalStrength of value type float.
SurfaceInterface(service, rules[, path])	Parameter SurfaceInterface of value type str.
YoungModulus(service, rules[, path])	Parameter YoungModulus of value type float.

class CrackDetectionCriteria(service, rules, path=None)

Bases: PyTextual

Parameter CrackDetectionCriteria of value type str.

class FractureToughness(service, rules, path=None)

Bases: PyNumerical

Parameter FractureToughness of value type float.

class IceConstantDensity(service, rules, path=None)

Bases: PyNumerical

Parameter IceConstantDensity of value type float.

class IceDensityType(service, rules, path=None)

Bases: PyTextual

Parameter IceDensityType of value type str.

class IceEmissivity(service, rules, path=None)

Bases: PyNumerical

Parameter IceEmissivity of value type float.

class IceJonesLEDiameter(service, rules, path=None)

Bases: PyNumerical

Parameter IceJonesLEDiameter of value type float.

class PoissonRatio(service, rules, path=None)

Bases: PyNumerical

Parameter PoissonRatio of value type float.

class PrincipalStrength(service, rules, path=None)

Bases: PyNumerical

Parameter PrincipalStrength of value type float.

class SurfaceInterface(service, rules, path=None)

Bases: PyTextual

Parameter SurfaceInterface of value type str.

class YoungModulus(service, rules, path=None)

Bases: PyNumerical

Parameter YoungModulus of value type float.

class Crystals(service, rules, path)

Bases: PyMenu

Singleton Crystals.

Classes:

BouncingModel(service, rules[, path])	Parameter BouncingModel of value type str.
Erosion(service, rules[, path])	Parameter Erosion of value type bool.

class BouncingModel(service, rules, path=None)

Bases: PyTextual

Parameter BouncingModel of value type str.

class Erosion(service, rules, path=None)

Bases: PyParameter

Parameter Erosion of value type bool.

class IceConditions(service, rules, path)

Bases: PyMenu

Singleton IceConditions.

Classes:

IcingAirTemperature(service, rules[, path])	Parameter IcingAirTemperature of value type float.
IcingAirTemperatureFlag(service, rules[, path])	Parameter IcingAirTemperatureFlag of value type bool.
RecoveryFactor(service, rules[, path])	Parameter RecoveryFactor of value type float.
RelativeHumidity(service, rules[, path])	Parameter RelativeHumidity of value type float.

class IcingAirTemperature(service, rules, path=None)

Bases: PyNumerical

Parameter IcingAirTemperature of value type float.

class IcingAirTemperatureFlag(service, rules, path=None)

Bases: PyParameter

Parameter IcingAirTemperatureFlag of value type bool.

class RecoveryFactor(service, rules, path=None)

Bases: PyNumerical

Parameter RecoveryFactor of value type float.

class RelativeHumidity(service, rules, path=None)

Bases: PyNumerical

Parameter RelativeHumidity of value type float.

class IcingModel(service, rules, path)

Bases: PyMenu

Singleton IcingModel.

Classes:

Beading(service, rules[, path])	Parameter Beading of value type bool.
HeatFlux(service, rules[, path])	Parameter HeatFlux of value type str.
Model(service, rules[, path])	Parameter Model of value type str.
SheddingFlag(service, rules[, path])	Parameter SheddingFlag of value type str.

class Beading(service, rules, path=None)

Bases: PyParameter

Parameter Beading of value type bool.

class HeatFlux(service, rules, path=None)

Bases: PyTextual

Parameter HeatFlux of value type str.

class Model(service, rules, path=None)

Bases: PyTextual

Parameter Model of value type str.

class SheddingFlag(service, rules, path=None)

Bases: PyTextual

Parameter SheddingFlag of value type str.

class IcingImportCase(service, rules, command, path=None)

Bases: PyCommand

Command IcingImportCase.

Parameters:

Filenamestr

Returns:

bool

class IcingImportMesh(service, rules, command, path=None)

Bases: PyCommand

Command IcingImportMesh.

Parameters:

Filenamestr

Returns:

bool

class ImportCase(service, rules, command, path=None)

Bases: PyCommand

Command ImportCase.

Parameters:

Filenamestr

Returns:

bool

class ImportMesh(service, rules, command, path=None)

Bases: PyCommand

Command ImportMesh.

Parameters:

Filenamestr

Returns:

bool

class InProgress(service, rules, path=None)

Bases: PyParameter

Parameter InProgress of value type bool.

class InitAddOn(service, rules, command, path=None)

Bases: PyCommand

Command InitAddOn.

Returns:

bool

class InitAddOnAero(service, rules, command, path=None)

Bases: PyCommand

Command InitAddOnAero.

Returns:

bool

class InitDM(service, rules, command, path=None)

Bases: PyCommand

Command InitDM.

Returns:

bool

class IsBusy(service, rules, path=None)

Bases: PyParameter

Parameter IsBusy of value type bool.

class LoadCase(service, rules, command, path=None)

Bases: PyCommand

Command LoadCase.

Parameters:

FileNamestr

Returns:

bool

class LoadCaseAndData(service, rules, command, path=None)

Bases: PyCommand

Command LoadCaseAndData.

Parameters:

FileNamestr

Returns:

bool

class Particles(service, rules, path)

Bases: PyMenu

Singleton Particles.

Classes:

Advanced(service, rules, path)	Singleton Advanced.
Crystals(service, rules, path)	Singleton Crystals.
Droplets(service, rules, path)	Singleton Droplets.
General(service, rules, path)	Singleton General.
Model(service, rules, path)	Singleton Model.
Type(service, rules, path)	Singleton Type.
Vapor(service, rules, path)	Singleton Vapor.

class Advanced(service, rules, path)

Bases: PyMenu

Singleton Advanced.

Classes:

SolverParameters(service, rules[, path])

Parameter SolverParameters of value type str.

class SolverParameters(service, rules, path=None)

Bases: PyTextual

Parameter SolverParameters of value type str.

class Crystals(service, rules, path)

Bases: PyMenu

Singleton Crystals.

Classes:

Conditions(service, rules, path)	Singleton Conditions.
ParticlesDistribution(service, rules, path)	Singleton ParticlesDistribution.

class Conditions(service, rules, path)

Bases: PyMenu

Singleton Conditions.

Classes:

AR(service, rules[, path])	Parameter AR of value type float.
Appendix(service, rules[, path])	Parameter Appendix of value type str.
AppendixLWCPriorityMode(service, rules[, path])	Parameter AppendixLWCPriorityMode of value type bool.
AppendixTWCFactor(service, rules[, path])	Parameter AppendixTWCFactor of value type bool.
CheckAppendixD(service, rules, command[, path])	Command CheckAppendixD.
Density(service, rules[, path])	Parameter Density of value type float.
Diameter(service, rules[, path])	Parameter Diameter of value type float.
ICC(service, rules[, path])	Parameter ICC of value type float.
ViewAppendix(service, rules, command[, path])	Command ViewAppendix.

class AR(service, rules, path=None)

Bases: PyNumerical

Parameter AR of value type float.

class Appendix(service, rules, path=None)

Bases: PyTextual

Parameter Appendix of value type str.

class AppendixLWCPriorityMode(service, rules, path=None)

Bases: PyParameter

Parameter AppendixLWCPriorityMode of value type bool.

class AppendixTWCFactor(service, rules, path=None)

Bases: PyParameter

Parameter AppendixTWCFactor of value type bool.

class CheckAppendixD(service, rules, command, path=None)

Bases: PyCommand

Command CheckAppendixD.

Parameters:

UpdateTWCbool

Returns:

bool

class Density(service, rules, path=None)

Bases: PyNumerical

Parameter Density of value type float.

class Diameter(service, rules, path=None)

Bases: PyNumerical

Parameter Diameter of value type float.

class ICC(service, rules, path=None)

Bases: PyNumerical

Parameter ICC of value type float.

class ViewAppendix(service, rules, command, path=None)

Bases: PyCommand

Command ViewAppendix.

Parameters:

Targetstr

Returns:

bool

class ParticlesDistribution(service, rules, path)

Bases: PyMenu

Singleton ParticlesDistribution.

Classes:

CrystalAspectRatios(service, rules[, path])	Parameter CrystalAspectRatios of value type str.
CrystalDiameters(service, rules[, path])	Parameter CrystalDiameters of value type str.
CrystalDistribution(service, rules[, path])	Parameter CrystalDistribution of value type str.
ExportDistribution(service, rules, command)	Command ExportDistribution.
ImportDistribution(service, rules, command)	Command ImportDistribution.
ViewDistribution(service, rules, command[, path])	Command ViewDistribution.

class CrystalAspectRatios(service, rules, path=None)

Bases: PyTextual

Parameter CrystalAspectRatios of value type str.

class CrystalDiameters(service, rules, path=None)

Bases: PyTextual

Parameter CrystalDiameters of value type str.

class CrystalDistribution(service, rules, path=None)

Bases: PyTextual

Parameter CrystalDistribution of value type str.

class ExportDistribution(service, rules, command, path=None)

Bases: PyCommand

Command ExportDistribution.

Parameters:

Filenamestr

Returns:

bool

class ImportDistribution(service, rules, command, path=None)

Bases: PyCommand

Command ImportDistribution.

Parameters:

Filenamestr

Returns:

bool

class ViewDistribution(service, rules, command, path=None)

Bases: PyCommand

Command ViewDistribution.

Parameters:

Targetstr

Returns:

bool

class Droplets(service, rules, path)

Bases: PyMenu

Singleton Droplets.

Classes:

Conditions(service, rules, path)	Singleton Conditions.
Model(service, rules, path)	Singleton Model.
ParticlesDistribution(service, rules, path)	Singleton ParticlesDistribution.

class Conditions(service, rules, path)

Bases: PyMenu

Singleton Conditions.

Classes:

Appendix(service, rules[, path])	Parameter Appendix of value type str.
AppendixEnvironment(service, rules[, path])	Parameter AppendixEnvironment of value type int.
AppendixLWCFactor(service, rules[, path])	Parameter AppendixLWCFactor of value type bool.
AppendixODiameter(service, rules[, path])	Parameter AppendixODiameter of value type int.
AppendixOEnvironment(service, rules[, path])	Parameter AppendixOEnvironment of value type int.
AppendixOLWCFactor(service, rules[, path])	Parameter AppendixOLWCFactor of value type bool.
CheckAppendixC(service, rules, command[, path])	Command CheckAppendixC.
CheckAppendixO(service, rules, command[, path])	Command CheckAppendixO.
Diameter(service, rules[, path])	Parameter Diameter of value type float.
LWC(service, rules[, path])	Parameter LWC of value type float.
SLDFlag(service, rules[, path])	Parameter SLDFlag of value type bool.
ViewAppendix(service, rules, command[, path])	Command ViewAppendix.
WaterDensity(service, rules[, path])	Parameter WaterDensity of value type float.

class Appendix(service, rules, path=None)

Bases: PyTextual

Parameter Appendix of value type str.

class AppendixEnvironment(service, rules, path=None)

Bases: PyNumerical

Parameter AppendixEnvironment of value type int.

class AppendixLWCFactor(service, rules, path=None)

Bases: PyParameter

Parameter AppendixLWCFactor of value type bool.

class AppendixODiameter(service, rules, path=None)

Bases: PyNumerical

Parameter AppendixODiameter of value type int.

class AppendixOEnvironment(service, rules, path=None)

Bases: PyNumerical

Parameter AppendixOEnvironment of value type int.

class AppendixOLWCFactor(service, rules, path=None)

Bases: PyParameter

Parameter AppendixOLWCFactor of value type bool.

class CheckAppendixC(service, rules, command, path=None)

Bases: PyCommand

Command CheckAppendixC.

Parameters:

UpdateLWCbool

Returns:

bool

class CheckAppendixO(service, rules, command, path=None)

Bases: PyCommand

Command CheckAppendixO.

Returns:

bool

class Diameter(service, rules, path=None)

Bases: PyNumerical

Parameter Diameter of value type float.

class LWC(service, rules, path=None)

Bases: PyNumerical

Parameter LWC of value type float.

class SLDFlag(service, rules, path=None)

Bases: PyParameter

Parameter SLDFlag of value type bool.

class ViewAppendix(service, rules, command, path=None)

Bases: PyCommand

Command ViewAppendix.

Parameters:

Targetstr

Returns:

bool

class WaterDensity(service, rules, path=None)

Bases: PyNumerical

Parameter WaterDensity of value type float.

class Model(service, rules, path)

Bases: PyMenu

Singleton Model.

Classes:

BreakupModel(service, rules[, path])	Parameter BreakupModel of value type str.
DpmDragModel(service, rules[, path])	Parameter DpmDragModel of value type str.
DragCunninghamCorrection(service, rules[, path])	Parameter DragCunninghamCorrection of value type float.
DragModel(service, rules[, path])	Parameter DragModel of value type str.
DragShapeFactor(service, rules[, path])	Parameter DragShapeFactor of value type float.
NTries(service, rules[, path])	Parameter NTries of value type int.
RefreshNames(service, rules, command[, path])	Command RefreshNames.
Splashing(service, rules[, path])	Parameter Splashing of value type str.
SplashingActivationTrigger(service, rules[, ...])	Parameter SplashingActivationTrigger of value type float.
SplashingDelay(service, rules[, path])	Parameter SplashingDelay of value type int.
SplashingModel(service, rules[, path])	Parameter SplashingModel of value type str.
TerminalVelocity(service, rules[, path])	Parameter TerminalVelocity of value type str.
TurbulentDispersion(service, rules[, path])	Parameter TurbulentDispersion of value type bool.
UDFDrag(service, rules[, path])	Parameter UDFDrag of value type str.

class BreakupModel(service, rules, path=None)

Bases: PyTextual

Parameter BreakupModel of value type str.

class DpmDragModel(service, rules, path=None)

Bases: PyTextual

Parameter DpmDragModel of value type str.

class DragCunninghamCorrection(service, rules, path=None)

Bases: PyNumerical

Parameter DragCunninghamCorrection of value type float.

class DragModel(service, rules, path=None)

Bases: PyTextual

Parameter DragModel of value type str.

class DragShapeFactor(service, rules, path=None)

Bases: PyNumerical

Parameter DragShapeFactor of value type float.

class NTries(service, rules, path=None)

Bases: PyNumerical

Parameter NTries of value type int.

class RefreshNames(service, rules, command, path=None)

Bases: PyCommand

Command RefreshNames.

Parameters:

Targetstr

Returns:

bool

class Splashing(service, rules, path=None)

Bases: PyTextual

Parameter Splashing of value type str.

class SplashingActivationTrigger(service, rules, path=None)

Bases: PyNumerical

Parameter SplashingActivationTrigger of value type float.

class SplashingDelay(service, rules, path=None)

Bases: PyNumerical

Parameter SplashingDelay of value type int.

class SplashingModel(service, rules, path=None)

Bases: PyTextual

Parameter SplashingModel of value type str.

class TerminalVelocity(service, rules, path=None)

Bases: PyTextual

Parameter TerminalVelocity of value type str.

class TurbulentDispersion(service, rules, path=None)

Bases: PyParameter

Parameter TurbulentDispersion of value type bool.

class UDFDrag(service, rules, path=None)

Bases: PyTextual

Parameter UDFDrag of value type str.

class ParticlesDistribution(service, rules, path)

Bases: PyMenu

Singleton ParticlesDistribution.

Classes:

AppODistribution(service, rules[, path])	Parameter AppODistribution of value type str.
DPMDropletDistribution(service, rules[, path])	Parameter DPMDropletDistribution of value type str.
DropletDiameters(service, rules[, path])	Parameter DropletDiameters of value type str.
DropletDistribution(service, rules[, path])	Parameter DropletDistribution of value type str.
ExportDistribution(service, rules, command)	Command ExportDistribution.
ImportDistribution(service, rules, command)	Command ImportDistribution.
ViewDistribution(service, rules, command[, path])	Command ViewDistribution.
Weights(service, rules[, path])	Parameter Weights of value type str.

class AppODistribution(service, rules, path=None)

Bases: PyTextual

Parameter AppODistribution of value type str.

class DPMDropletDistribution(service, rules, path=None)

Bases: PyTextual

Parameter DPMDropletDistribution of value type str.

class DropletDiameters(service, rules, path=None)

Bases: PyTextual

Parameter DropletDiameters of value type str.

class DropletDistribution(service, rules, path=None)

Bases: PyTextual

Parameter DropletDistribution of value type str.

class ExportDistribution(service, rules, command, path=None)

Bases: PyCommand

Command ExportDistribution.

Parameters:

Filenamestr

Returns:

bool

class ImportDistribution(service, rules, command, path=None)

Bases: PyCommand

Command ImportDistribution.

Parameters:

Filenamestr

Returns:

bool

class ViewDistribution(service, rules, command, path=None)

Bases: PyCommand

Command ViewDistribution.

Parameters:

Targetstr

Returns:

bool

class Weights(service, rules, path=None)

Bases: PyTextual

Parameter Weights of value type str.

class General(service, rules, path)

Bases: PyMenu

Singleton General.

Classes:

SolverType(service, rules[, path])	Parameter SolverType of value type str.
UseCaseInjection(service, rules[, path])	Parameter UseCaseInjection of value type str.

class SolverType(service, rules, path=None)

Bases: PyTextual

Parameter SolverType of value type str.

class UseCaseInjection(service, rules, path=None)

Bases: PyTextual

Parameter UseCaseInjection of value type str.

class Model(service, rules, path)

Bases: PyMenu

Singleton Model.

Classes:

ThermalEquation(service, rules[, path])

Parameter ThermalEquation of value type bool.

class ThermalEquation(service, rules, path=None)

Bases: PyParameter

Parameter ThermalEquation of value type bool.

class Type(service, rules, path)

Bases: PyMenu

Singleton Type.

Classes:

CrystalsFlag(service, rules[, path])	Parameter CrystalsFlag of value type bool.
DropletsFlag(service, rules[, path])	Parameter DropletsFlag of value type bool.
VaporFlag(service, rules[, path])	Parameter VaporFlag of value type bool.

class CrystalsFlag(service, rules, path=None)

Bases: PyParameter

Parameter CrystalsFlag of value type bool.

class DropletsFlag(service, rules, path=None)

Bases: PyParameter

Parameter DropletsFlag of value type bool.

class VaporFlag(service, rules, path=None)

Bases: PyParameter

Parameter VaporFlag of value type bool.

class Vapor(service, rules, path)

Bases: PyMenu

Singleton Vapor.

Classes:

Conditions(service, rules, path)	Singleton Conditions.
Model(service, rules, path)	Singleton Model.

class Conditions(service, rules, path)

Bases: PyMenu

Singleton Conditions.

Classes:

VaporConcentration(service, rules[, path])	Parameter VaporConcentration of value type float.
VaporInitialMode(service, rules[, path])	Parameter VaporInitialMode of value type str.
VaporRH(service, rules[, path])	Parameter VaporRH of value type float.

class VaporConcentration(service, rules, path=None)

Bases: PyNumerical

Parameter VaporConcentration of value type float.

class VaporInitialMode(service, rules, path=None)

Bases: PyTextual

Parameter VaporInitialMode of value type str.

class VaporRH(service, rules, path=None)

Bases: PyNumerical

Parameter VaporRH of value type float.

class Model(service, rules, path)

Bases: PyMenu

Singleton Model.

Classes:

TurbSchmidtNumber(service, rules[, path])

Parameter TurbSchmidtNumber of value type float.

class TurbSchmidtNumber(service, rules, path=None)

Bases: PyNumerical

Parameter TurbSchmidtNumber of value type float.

class ReloadCase(service, rules, command, path=None)

Bases: PyCommand

Command ReloadCase.

Parameters:

Filenamestr

Returns:

bool

class ReloadDomain(service, rules, command, path=None)

Bases: PyCommand

Command ReloadDomain.

Parameters:

CheckNodeOrderbool

Returns:

bool

class RunType(service, rules, path)

Bases: PyMenu

Singleton RunType.

Classes:

Adapt(service, rules[, path])	Parameter Adapt of value type bool.
Airflow(service, rules[, path])	Parameter Airflow of value type bool.
CHT(service, rules[, path])	Parameter CHT of value type bool.
Ice(service, rules[, path])	Parameter Ice of value type bool.
Particles(service, rules[, path])	Parameter Particles of value type bool.

class Adapt(service, rules, path=None)

Bases: PyParameter

Parameter Adapt of value type bool.

class Airflow(service, rules, path=None)

Bases: PyParameter

Parameter Airflow of value type bool.

class CHT(service, rules, path=None)

Bases: PyParameter

Parameter CHT of value type bool.

class Ice(service, rules, path=None)

Bases: PyParameter

Parameter Ice of value type bool.

class Particles(service, rules, path=None)

Bases: PyParameter

Parameter Particles of value type bool.

class SaveCase(service, rules, command, path=None)

Bases: PyCommand

Command SaveCase.

Parameters:

FileNamestr

Returns:

bool

class SaveCaseAndData(service, rules, command, path=None)

Bases: PyCommand

Command SaveCaseAndData.

Parameters:

FileNamestr

Returns:

bool

class SaveCaseAs(service, rules, command, path=None)

Bases: PyCommand

Command SaveCaseAs.

Parameters:

FileNamestr

Returns:

bool

class SaveData(service, rules, command, path=None)

Bases: PyCommand

Command SaveData.

Parameters:

FileNamestr

Returns:

bool

class SavePostCaseAndData(service, rules, command, path=None)

Bases: PyCommand

Command SavePostCaseAndData.

Parameters:

FileNamestr

Returns:

bool

class SendCommandQuiet(service, rules, command, path=None)

Bases: PyCommand

Command SendCommandQuiet.

Parameters:

Commandstr

Returns:

bool

class SetupErrors(service, rules, path=None)

Bases: PyTextual

Parameter SetupErrors of value type str.

class SetupWarnings(service, rules, path=None)

Bases: PyTextual

Parameter SetupWarnings of value type str.

class Solution(service, rules, path)

Bases: PyMenu

Singleton Solution.

Classes:

AdaptationGlobalSettings(service, rules, path)	Singleton AdaptationGlobalSettings.
AdaptationRun(service, rules, path)	Singleton AdaptationRun.
AirflowRun(service, rules, path)	Singleton AirflowRun.
CHT(service, rules, path)	Singleton CHT.
Calculate(service, rules, command[, path])	Command Calculate.
CalculateOG(service, rules, command[, path])	Command CalculateOG.
ConfigureShots(service, rules, command[, path])	Command ConfigureShots.
FensapGridSave(service, rules, command[, path])	Command FensapGridSave.
GlobalSettings(service, rules, path)	Singleton GlobalSettings.
IceRun(service, rules, path)	Singleton IceRun.
Interrupt(service, rules, command[, path])	Command Interrupt.
MultishotRun(service, rules, path)	Singleton MultishotRun.
ParticlesRun(service, rules, path)	Singleton ParticlesRun.
Reset(service, rules, command[, path])	Command Reset.
ResetMultishot(service, rules, command[, path])	Command ResetMultishot.
RunState(service, rules, path)	Singleton RunState.

class AdaptationGlobalSettings(service, rules, path)

Bases: PyMenu

Singleton AdaptationGlobalSettings.

Classes:

NumberLoops(service, rules[, path])	Parameter NumberLoops of value type int.
RunSolver(service, rules[, path])	Parameter RunSolver of value type bool.
SolutionRestart(service, rules[, path])	Parameter SolutionRestart of value type str.

class NumberLoops(service, rules, path=None)

Bases: PyNumerical

Parameter NumberLoops of value type int.

class RunSolver(service, rules, path=None)

Bases: PyParameter

Parameter RunSolver of value type bool.

class SolutionRestart(service, rules, path=None)

Bases: PyTextual

Parameter SolutionRestart of value type str.

class AdaptationRun(service, rules, path)

Bases: PyMenu

Singleton AdaptationRun.

Classes:

ComputeCarpet(service, rules, command[, path])	Command ComputeCarpet.
Interrupt(service, rules, command[, path])	Command Interrupt.
Operations(service, rules, path)	Singleton Operations.
Options(service, rules, path)	Singleton Options.
OutputCase(service, rules, path)	Singleton OutputCase.
Reset(service, rules, command[, path])	Command Reset.
RunOG(service, rules, command[, path])	Command RunOG.
State(service, rules, path)	Singleton State.
Target(service, rules, path)	Singleton Target.
UpdateMesh(service, rules, command[, path])	Command UpdateMesh.
ViewMesh(service, rules, command[, path])	Command ViewMesh.

class ComputeCarpet(service, rules, command, path=None)

Bases: PyCommand

Command ComputeCarpet.

Returns:

bool

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

Bases: PyCommand

Command Interrupt.

Returns:

bool

class Operations(service, rules, path)

Bases: PyMenu

Singleton Operations.

Classes:

AdaptCurv(service, rules[, path])	Parameter AdaptCurv of value type bool.
AdjustY(service, rules[, path])	Parameter AdjustY of value type str.
ComputeError(service, rules[, path])	Parameter ComputeError of value type bool.
MainIter(service, rules[, path])	Parameter MainIter of value type int.
Mode(service, rules[, path])	Parameter Mode of value type str.
NMPost(service, rules[, path])	Parameter NMPost of value type int.
NMPre(service, rules[, path])	Parameter NMPre of value type int.
Swap(service, rules[, path])	Parameter Swap of value type int.
Type(service, rules[, path])	Parameter Type of value type str.

class AdaptCurv(service, rules, path=None)

Bases: PyParameter

Parameter AdaptCurv of value type bool.

class AdjustY(service, rules, path=None)

Bases: PyTextual

Parameter AdjustY of value type str.

class ComputeError(service, rules, path=None)

Bases: PyParameter

Parameter ComputeError of value type bool.

class MainIter(service, rules, path=None)

Bases: PyNumerical

Parameter MainIter of value type int.

class Mode(service, rules, path=None)

Bases: PyTextual

Parameter Mode of value type str.

class NMPost(service, rules, path=None)

Bases: PyNumerical

Parameter NMPost of value type int.

class NMPre(service, rules, path=None)

Bases: PyNumerical

Parameter NMPre of value type int.

class Swap(service, rules, path=None)

Bases: PyNumerical

Parameter Swap of value type int.

class Type(service, rules, path=None)

Bases: PyTextual

Parameter Type of value type str.

class Options(service, rules, path)

Bases: PyMenu

Singleton Options.

Classes:

NumberCPUs(service, rules[, path])	Parameter NumberCPUs of value type int.
SpecifyCPUs(service, rules[, path])	Parameter SpecifyCPUs of value type bool.

class NumberCPUs(service, rules, path=None)

Bases: PyNumerical

Parameter NumberCPUs of value type int.

class SpecifyCPUs(service, rules, path=None)

Bases: PyParameter

Parameter SpecifyCPUs of value type bool.

class OutputCase(service, rules, path)

Bases: PyMenu

Singleton OutputCase.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
FilenameDat(service, rules[, path])	Parameter FilenameDat of value type str.
FilenameIp(service, rules[, path])	Parameter FilenameIp of value type str.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class FilenameDat(service, rules, path=None)

Bases: PyTextual

Parameter FilenameDat of value type str.

class FilenameIp(service, rules, path=None)

Bases: PyTextual

Parameter FilenameIp of value type str.

class Reset(service, rules, command, path=None)

Bases: PyCommand

Command Reset.

Returns:

bool

class RunOG(service, rules, command, path=None)

Bases: PyCommand

Command RunOG.

Returns:

bool

class State(service, rules, path)

Bases: PyMenu

Singleton State.

Classes:

MeshAdapted(service, rules[, path])

Parameter MeshAdapted of value type bool.

class MeshAdapted(service, rules, path=None)

Bases: PyParameter

Parameter MeshAdapted of value type bool.

class Target(service, rules, path)

Bases: PyMenu

Singleton Target.

Classes:

ErrorValue(service, rules[, path])	Parameter ErrorValue of value type float.
Mode(service, rules[, path])	Parameter Mode of value type str.
NumCells(service, rules[, path])	Parameter NumCells of value type int.
NumCellsChange(service, rules[, path])	Parameter NumCellsChange of value type int.
NumCellsMax(service, rules[, path])	Parameter NumCellsMax of value type int.
NumCellsRef(service, rules[, path])	Parameter NumCellsRef of value type int.
NumNodes(service, rules[, path])	Parameter NumNodes of value type int.
NumNodesChange(service, rules[, path])	Parameter NumNodesChange of value type int.
NumNodesMax(service, rules[, path])	Parameter NumNodesMax of value type int.
NumNodesRef(service, rules[, path])	Parameter NumNodesRef of value type int.

class ErrorValue(service, rules, path=None)

Bases: PyNumerical

Parameter ErrorValue of value type float.

class Mode(service, rules, path=None)

Bases: PyTextual

Parameter Mode of value type str.

class NumCells(service, rules, path=None)

Bases: PyNumerical

Parameter NumCells of value type int.

class NumCellsChange(service, rules, path=None)

Bases: PyNumerical

Parameter NumCellsChange of value type int.

class NumCellsMax(service, rules, path=None)

Bases: PyNumerical

Parameter NumCellsMax of value type int.

class NumCellsRef(service, rules, path=None)

Bases: PyNumerical

Parameter NumCellsRef of value type int.

class NumNodes(service, rules, path=None)

Bases: PyNumerical

Parameter NumNodes of value type int.

class NumNodesChange(service, rules, path=None)

Bases: PyNumerical

Parameter NumNodesChange of value type int.

class NumNodesMax(service, rules, path=None)

Bases: PyNumerical

Parameter NumNodesMax of value type int.

class NumNodesRef(service, rules, path=None)

Bases: PyNumerical

Parameter NumNodesRef of value type int.

class UpdateMesh(service, rules, command, path=None)

Bases: PyCommand

Command UpdateMesh.

Returns:

bool

class ViewMesh(service, rules, command, path=None)

Bases: PyCommand

Command ViewMesh.

Returns:

bool

class AirflowRun(service, rules, path)

Bases: PyMenu

Singleton AirflowRun.

Classes:

AirflowFENSAPOutputSolution(service, rules, path)	Singleton AirflowFENSAPOutputSolution.
AirflowFluentOutputSolution(service, rules, path)	Singleton AirflowFluentOutputSolution.
AirflowInput(service, rules, path)	Singleton AirflowInput.
Calculate(service, rules, command[, path])	Command Calculate.
ConvergenceAvailable(service, rules[, path])	Parameter ConvergenceAvailable of value type bool.
FensapOutput(service, rules, path)	Singleton FensapOutput.
FensapTimeIntegration(service, rules, path)	Singleton FensapTimeIntegration.
FluentCFFPost(service, rules, path)	Singleton FluentCFFPost.
FluentInitSettings(service, rules, path)	Singleton FluentInitSettings.
FluentTimeIntegration(service, rules, path)	Singleton FluentTimeIntegration.
Initialize(service, rules, command[, path])	Command Initialize.
Interrupt(service, rules, command[, path])	Command Interrupt.
Load(service, rules, command[, path])	Command Load.
Reset(service, rules, command[, path])	Command Reset.
Save(service, rules, command[, path])	Command Save.
SaveAs(service, rules, command[, path])	Command SaveAs.
SolutionAvailable(service, rules[, path])	Parameter SolutionAvailable of value type bool.

class AirflowFENSAPOutputSolution(service, rules, path)

Bases: PyMenu

Singleton AirflowFENSAPOutputSolution.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
HasHFlux(service, rules[, path])	Parameter HasHFlux of value type bool.
HasShear(service, rules[, path])	Parameter HasShear of value type bool.
Loaded(service, rules[, path])	Parameter Loaded of value type bool.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class HasHFlux(service, rules, path=None)

Bases: PyParameter

Parameter HasHFlux of value type bool.

class HasShear(service, rules, path=None)

Bases: PyParameter

Parameter HasShear of value type bool.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class AirflowFluentOutputSolution(service, rules, path)

Bases: PyMenu

Singleton AirflowFluentOutputSolution.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
Loaded(service, rules[, path])	Parameter Loaded of value type bool.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class AirflowInput(service, rules, path)

Bases: PyMenu

Singleton AirflowInput.

Classes:

RoughnessInput(service, rules[, path])

Parameter RoughnessInput of value type bool.

class RoughnessInput(service, rules, path=None)

Bases: PyParameter

Parameter RoughnessInput of value type bool.

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

Bases: PyCommand

Command Calculate.

Returns:

bool

class ConvergenceAvailable(service, rules, path=None)

Bases: PyParameter

Parameter ConvergenceAvailable of value type bool.

class FensapOutput(service, rules, path)

Bases: PyMenu

Singleton FensapOutput.

Classes:

DragX(service, rules[, path])	Parameter DragX of value type float.
DragY(service, rules[, path])	Parameter DragY of value type float.
DragZ(service, rules[, path])	Parameter DragZ of value type float.
FensapOutputEID(service, rules[, path])	Parameter FensapOutputEID of value type bool.
FensapOutputForces(service, rules[, path])	Parameter FensapOutputForces of value type str.
LiftAxis(service, rules[, path])	Parameter LiftAxis of value type str.
MomentX(service, rules[, path])	Parameter MomentX of value type float.
MomentY(service, rules[, path])	Parameter MomentY of value type float.
MomentZ(service, rules[, path])	Parameter MomentZ of value type float.
MonitorH(service, rules[, path])	Parameter MonitorH of value type bool.
MonitorMass(service, rules[, path])	Parameter MonitorMass of value type bool.
MonitorTotalHeat(service, rules[, path])	Parameter MonitorTotalHeat of value type bool.
NumberedOutput(service, rules[, path])	Parameter NumberedOutput of value type bool.
RefArea(service, rules[, path])	Parameter RefArea of value type float.
SaveDelay(service, rules[, path])	Parameter SaveDelay of value type int.

class DragX(service, rules, path=None)

Bases: PyNumerical

Parameter DragX of value type float.

class DragY(service, rules, path=None)

Bases: PyNumerical

Parameter DragY of value type float.

class DragZ(service, rules, path=None)

Bases: PyNumerical

Parameter DragZ of value type float.

class FensapOutputEID(service, rules, path=None)

Bases: PyParameter

Parameter FensapOutputEID of value type bool.

class FensapOutputForces(service, rules, path=None)

Bases: PyTextual

Parameter FensapOutputForces of value type str.

class LiftAxis(service, rules, path=None)

Bases: PyTextual

Parameter LiftAxis of value type str.

class MomentX(service, rules, path=None)

Bases: PyNumerical

Parameter MomentX of value type float.

class MomentY(service, rules, path=None)

Bases: PyNumerical

Parameter MomentY of value type float.

class MomentZ(service, rules, path=None)

Bases: PyNumerical

Parameter MomentZ of value type float.

class MonitorH(service, rules, path=None)

Bases: PyParameter

Parameter MonitorH of value type bool.

class MonitorMass(service, rules, path=None)

Bases: PyParameter

Parameter MonitorMass of value type bool.

class MonitorTotalHeat(service, rules, path=None)

Bases: PyParameter

Parameter MonitorTotalHeat of value type bool.

class NumberedOutput(service, rules, path=None)

Bases: PyParameter

Parameter NumberedOutput of value type bool.

class RefArea(service, rules, path=None)

Bases: PyNumerical

Parameter RefArea of value type float.

class SaveDelay(service, rules, path=None)

Bases: PyNumerical

Parameter SaveDelay of value type int.

class FensapTimeIntegration(service, rules, path)

Bases: PyMenu

Singleton FensapTimeIntegration.

Classes:

CFL(service, rules[, path])	Parameter CFL of value type float.
NumIterations(service, rules[, path])	Parameter NumIterations of value type int.
RlxIter(service, rules[, path])	Parameter RlxIter of value type int.
TimeOrder(service, rules[, path])	Parameter TimeOrder of value type str.
TimeStep(service, rules[, path])	Parameter TimeStep of value type float.
TimeTotal(service, rules[, path])	Parameter TimeTotal of value type float.
VariableRelaxation(service, rules[, path])	Parameter VariableRelaxation of value type bool.

class CFL(service, rules, path=None)

Bases: PyNumerical

Parameter CFL of value type float.

class NumIterations(service, rules, path=None)

Bases: PyNumerical

Parameter NumIterations of value type int.

class RlxIter(service, rules, path=None)

Bases: PyNumerical

Parameter RlxIter of value type int.

class TimeOrder(service, rules, path=None)

Bases: PyTextual

Parameter TimeOrder of value type str.

class TimeStep(service, rules, path=None)

Bases: PyNumerical

Parameter TimeStep of value type float.

class TimeTotal(service, rules, path=None)

Bases: PyNumerical

Parameter TimeTotal of value type float.

class VariableRelaxation(service, rules, path=None)

Bases: PyParameter

Parameter VariableRelaxation of value type bool.

class FluentCFFPost(service, rules, path)

Bases: PyMenu

Singleton FluentCFFPost.

Classes:

Fields(service, rules[, path])	Parameter Fields of value type List[str].
ReadOnly(service, rules[, path])	Parameter ReadOnly of value type bool.
Surfaces(service, rules[, path])	Parameter Surfaces of value type List[str].
WriteLevel(service, rules[, path])	Parameter WriteLevel of value type str.
WriteMode(service, rules[, path])	Parameter WriteMode of value type str.
ZoneType(service, rules[, path])	Parameter ZoneType of value type str.

class Fields(service, rules, path=None)

Bases: PyTextual

Parameter Fields of value type List[str].

class ReadOnly(service, rules, path=None)

Bases: PyParameter

Parameter ReadOnly of value type bool.

class Surfaces(service, rules, path=None)

Bases: PyTextual

Parameter Surfaces of value type List[str].

class WriteLevel(service, rules, path=None)

Bases: PyTextual

Parameter WriteLevel of value type str.

class WriteMode(service, rules, path=None)

Bases: PyTextual

Parameter WriteMode of value type str.

class ZoneType(service, rules, path=None)

Bases: PyTextual

Parameter ZoneType of value type str.

class FluentInitSettings(service, rules, path)

Bases: PyMenu

Singleton FluentInitSettings.

Classes:

Boundaries(service, rules[, path])	Parameter Boundaries of value type List[str].
FMGCourantNumber(service, rules[, path])	Parameter FMGCourantNumber of value type float.
InitialPressure(service, rules[, path])	Parameter InitialPressure of value type float.
InitialTemperature(service, rules[, path])	Parameter InitialTemperature of value type float.
InitialTurbIntensity(service, rules[, path])	Parameter InitialTurbIntensity of value type float.
InitialTurbViscRatio(service, rules[, path])	Parameter InitialTurbViscRatio of value type float.
InitialVelocityX(service, rules[, path])	Parameter InitialVelocityX of value type float.
InitialVelocityY(service, rules[, path])	Parameter InitialVelocityY of value type float.
InitialVelocityZ(service, rules[, path])	Parameter InitialVelocityZ of value type float.
InitializationMethod(service, rules[, path])	Parameter InitializationMethod of value type str.
StandardInitSync(service, rules[, path])	Parameter StandardInitSync of value type str.

class Boundaries(service, rules, path=None)

Bases: PyTextual

Parameter Boundaries of value type List[str].

class FMGCourantNumber(service, rules, path=None)

Bases: PyNumerical

Parameter FMGCourantNumber of value type float.

class InitialPressure(service, rules, path=None)

Bases: PyNumerical

Parameter InitialPressure of value type float.

class InitialTemperature(service, rules, path=None)

Bases: PyNumerical

Parameter InitialTemperature of value type float.

class InitialTurbIntensity(service, rules, path=None)

Bases: PyNumerical

Parameter InitialTurbIntensity of value type float.

class InitialTurbViscRatio(service, rules, path=None)

Bases: PyNumerical

Parameter InitialTurbViscRatio of value type float.

class InitialVelocityX(service, rules, path=None)

Bases: PyNumerical

Parameter InitialVelocityX of value type float.

class InitialVelocityY(service, rules, path=None)

Bases: PyNumerical

Parameter InitialVelocityY of value type float.

class InitialVelocityZ(service, rules, path=None)

Bases: PyNumerical

Parameter InitialVelocityZ of value type float.

class InitializationMethod(service, rules, path=None)

Bases: PyTextual

Parameter InitializationMethod of value type str.

class StandardInitSync(service, rules, path=None)

Bases: PyTextual

Parameter StandardInitSync of value type str.

class FluentTimeIntegration(service, rules, path)

Bases: PyMenu

Singleton FluentTimeIntegration.

Classes:

CourantNumber(service, rules[, path])	Parameter CourantNumber of value type float.
NumIterations(service, rules[, path])	Parameter NumIterations of value type int.
SolutionControl(service, rules[, path])	Parameter SolutionControl of value type str.
SteeringBlending(service, rules[, path])	Parameter SteeringBlending of value type float.
SteeringCourantNumberInitial(service, rules)	Parameter SteeringCourantNumberInitial of value type float.
SteeringCourantNumberMax(service, rules[, path])	Parameter SteeringCourantNumberMax of value type float.
SteeringRelaxation(service, rules[, path])	Parameter SteeringRelaxation of value type float.
TimeOrder(service, rules[, path])	Parameter TimeOrder of value type str.
TimeScaleFactor(service, rules[, path])	Parameter TimeScaleFactor of value type float.
TimeStep(service, rules[, path])	Parameter TimeStep of value type float.
TimeTotal(service, rules[, path])	Parameter TimeTotal of value type float.

class CourantNumber(service, rules, path=None)

Bases: PyNumerical

Parameter CourantNumber of value type float.

class NumIterations(service, rules, path=None)

Bases: PyNumerical

Parameter NumIterations of value type int.

class SolutionControl(service, rules, path=None)

Bases: PyTextual

Parameter SolutionControl of value type str.

class SteeringBlending(service, rules, path=None)

Bases: PyNumerical

Parameter SteeringBlending of value type float.

class SteeringCourantNumberInitial(service, rules, path=None)

Bases: PyNumerical

Parameter SteeringCourantNumberInitial of value type float.

class SteeringCourantNumberMax(service, rules, path=None)

Bases: PyNumerical

Parameter SteeringCourantNumberMax of value type float.

class SteeringRelaxation(service, rules, path=None)

Bases: PyNumerical

Parameter SteeringRelaxation of value type float.

class TimeOrder(service, rules, path=None)

Bases: PyTextual

Parameter TimeOrder of value type str.

class TimeScaleFactor(service, rules, path=None)

Bases: PyNumerical

Parameter TimeScaleFactor of value type float.

class TimeStep(service, rules, path=None)

Bases: PyNumerical

Parameter TimeStep of value type float.

class TimeTotal(service, rules, path=None)

Bases: PyNumerical

Parameter TimeTotal of value type float.

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 Load(service, rules, command, path=None)

Bases: PyCommand

Command Load.

Parameters:

Filenamestr

Returns:

bool

class Reset(service, rules, command, path=None)

Bases: PyCommand

Command Reset.

Returns:

bool

class Save(service, rules, command, path=None)

Bases: PyCommand

Command Save.

Parameters:

Filenamestr

Returns:

bool

class SaveAs(service, rules, command, path=None)

Bases: PyCommand

Command SaveAs.

Parameters:

Filenamestr

Returns:

bool

class SolutionAvailable(service, rules, path=None)

Bases: PyParameter

Parameter SolutionAvailable of value type bool.

class CHT(service, rules, path)

Bases: PyMenu

Singleton CHT.

Classes:

CHTOutputSolution(service, rules, path)	Singleton CHTOutputSolution.
Calculate(service, rules, command[, path])	Command Calculate.
CalculateICE(service, rules, command[, path])	Command CalculateICE.
Interrupt(service, rules, command[, path])	Command Interrupt.
Load(service, rules, command[, path])	Command Load.
NumberLoops(service, rules[, path])	Parameter NumberLoops of value type int.
Reset(service, rules, command[, path])	Command Reset.
SaveInterval(service, rules[, path])	Parameter SaveInterval of value type int.
SolutionAvailable(service, rules[, path])	Parameter SolutionAvailable of value type bool.
SolverIterations(service, rules[, path])	Parameter SolverIterations of value type int.

class CHTOutputSolution(service, rules, path)

Bases: PyMenu

Singleton CHTOutputSolution.

Classes:

Loaded(service, rules[, path])

Parameter Loaded of value type bool.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

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

Bases: PyCommand

Command Calculate.

Returns:

bool

class CalculateICE(service, rules, command, path=None)

Bases: PyCommand

Command CalculateICE.

Returns:

bool

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

Bases: PyCommand

Command Interrupt.

Returns:

bool

class Load(service, rules, command, path=None)

Bases: PyCommand

Command Load.

Parameters:

Filenamestr

Returns:

bool

class NumberLoops(service, rules, path=None)

Bases: PyNumerical

Parameter NumberLoops of value type int.

class Reset(service, rules, command, path=None)

Bases: PyCommand

Command Reset.

Returns:

bool

class SaveInterval(service, rules, path=None)

Bases: PyNumerical

Parameter SaveInterval of value type int.

class SolutionAvailable(service, rules, path=None)

Bases: PyParameter

Parameter SolutionAvailable of value type bool.

class SolverIterations(service, rules, path=None)

Bases: PyNumerical

Parameter SolverIterations of value type int.

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

Bases: PyCommand

Command Calculate.

Returns:

bool

class CalculateOG(service, rules, command, path=None)

Bases: PyCommand

Command CalculateOG.

Returns:

bool

class ConfigureShots(service, rules, command, path=None)

Bases: PyCommand

Command ConfigureShots.

Returns:

bool

class FensapGridSave(service, rules, command, path=None)

Bases: PyCommand

Command FensapGridSave.

Parameters:

Filenamestr

Returns:

bool

class GlobalSettings(service, rules, path)

Bases: PyMenu

Singleton GlobalSettings.

Classes:

AutoSave(service, rules[, path])	Parameter AutoSave of value type bool.
MonitorMode(service, rules[, path])	Parameter MonitorMode of value type str.
PlotInterval(service, rules[, path])	Parameter PlotInterval of value type int.
SaveConverg(service, rules[, path])	Parameter SaveConverg of value type bool.
SaveGMRES(service, rules[, path])	Parameter SaveGMRES of value type bool.
Verbosity(service, rules[, path])	Parameter Verbosity of value type str.

class AutoSave(service, rules, path=None)

Bases: PyParameter

Parameter AutoSave of value type bool.

class MonitorMode(service, rules, path=None)

Bases: PyTextual

Parameter MonitorMode of value type str.

class PlotInterval(service, rules, path=None)

Bases: PyNumerical

Parameter PlotInterval of value type int.

class SaveConverg(service, rules, path=None)

Bases: PyParameter

Parameter SaveConverg of value type bool.

class SaveGMRES(service, rules, path=None)

Bases: PyParameter

Parameter SaveGMRES of value type bool.

class Verbosity(service, rules, path=None)

Bases: PyTextual

Parameter Verbosity of value type str.

class IceRun(service, rules, path)

Bases: PyMenu

Singleton IceRun.

Classes:

Calculate(service, rules, command[, path])	Command Calculate.
DisplacementOutputSolution(service, rules, path)	Singleton DisplacementOutputSolution.
IceAdvanced(service, rules, path)	Singleton IceAdvanced.
IceInit(service, rules, path)	Singleton IceInit.
IceOutput(service, rules, path)	Singleton IceOutput.
IceOutputSolution(service, rules, path)	Singleton IceOutputSolution.
IceRemeshing(service, rules, path)	Singleton IceRemeshing.
IceTime(service, rules, path)	Singleton IceTime.
Interrupt(service, rules, command[, path])	Command Interrupt.
Load(service, rules, command[, path])	Command Load.
MeshMorph(service, rules, command[, path])	Command MeshMorph.
Reset(service, rules, command[, path])	Command Reset.
Save(service, rules, command[, path])	Command Save.
SaveAs(service, rules, command[, path])	Command SaveAs.
SetupRemeshing(service, rules, command[, path])	Command SetupRemeshing.
SheddingOutput(service, rules, path)	Singleton SheddingOutput.
SolutionAvailable(service, rules[, path])	Parameter SolutionAvailable of value type bool.

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

Bases: PyCommand

Command Calculate.

Returns:

bool

class DisplacementOutputSolution(service, rules, path)

Bases: PyMenu

Singleton DisplacementOutputSolution.

Classes:

Loaded(service, rules[, path])

Parameter Loaded of value type bool.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class IceAdvanced(service, rules, path)

Bases: PyMenu

Singleton IceAdvanced.

Classes:

EIDDisable(service, rules[, path])

Parameter EIDDisable of value type bool.

class EIDDisable(service, rules, path=None)

Bases: PyParameter

Parameter EIDDisable of value type bool.

class IceInit(service, rules, path)

Bases: PyMenu

Singleton IceInit.

Classes:

Restart(service, rules[, path])

Parameter Restart of value type bool.

class Restart(service, rules, path=None)

Bases: PyParameter

Parameter Restart of value type bool.

class IceOutput(service, rules, path)

Bases: PyMenu

Singleton IceOutput.

Classes:

HybridRemeshing(service, rules[, path])	Parameter HybridRemeshing of value type bool.
RemeshingDelay(service, rules[, path])	Parameter RemeshingDelay of value type int.
RemeshingMode(service, rules[, path])	Parameter RemeshingMode of value type str.
RemeshingSetup(service, rules[, path])	Parameter RemeshingSetup of value type bool.

class HybridRemeshing(service, rules, path=None)

Bases: PyParameter

Parameter HybridRemeshing of value type bool.

class RemeshingDelay(service, rules, path=None)

Bases: PyNumerical

Parameter RemeshingDelay of value type int.

class RemeshingMode(service, rules, path=None)

Bases: PyTextual

Parameter RemeshingMode of value type str.

class RemeshingSetup(service, rules, path=None)

Bases: PyParameter

Parameter RemeshingSetup of value type bool.

class IceOutputSolution(service, rules, path)

Bases: PyMenu

Singleton IceOutputSolution.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
Loaded(service, rules[, path])	Parameter Loaded of value type bool.
Roughness(service, rules[, path])	Parameter Roughness of value type bool.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class Roughness(service, rules, path=None)

Bases: PyParameter

Parameter Roughness of value type bool.

class IceRemeshing(service, rules, path)

Bases: PyMenu

Singleton IceRemeshing.

Classes:

Advanced(service, rules[, path])	Parameter Advanced of value type bool.
CellSizingGrowthRate(service, rules[, path])	Parameter CellSizingGrowthRate of value type float.
CellSizingType(service, rules[, path])	Parameter CellSizingType of value type str.
CurvGrowthRate(service, rules[, path])	Parameter CurvGrowthRate of value type float.
CurvNormalAngle(service, rules[, path])	Parameter CurvNormalAngle of value type float.
CurvRange(service, rules[, path])	Parameter CurvRange of value type List[float].
Dimension(service, rules[, path])	Parameter Dimension of value type str.
GlobGrowthRate(service, rules[, path])	Parameter GlobGrowthRate of value type float.
GlobMaxGeoMinSpan3D(service, rules[, path])	Parameter GlobMaxGeoMinSpan3D of value type float.
GlobRange(service, rules[, path])	Parameter GlobRange of value type List[float].
MaterialPoint(service, rules[, path])	Parameter MaterialPoint of value type List[float].
PrismFirstCellAR(service, rules[, path])	Parameter PrismFirstCellAR of value type float.
PrismGrowthRate(service, rules[, path])	Parameter PrismGrowthRate of value type float.
PrismNLayers(service, rules[, path])	Parameter PrismNLayers of value type int.
ProxGrowthRate(service, rules[, path])	Parameter ProxGrowthRate of value type float.
ProxMin(service, rules[, path])	Parameter ProxMin of value type float.
ProxNCellGap(service, rules[, path])	Parameter ProxNCellGap of value type int.
RotPeriodicAngle(service, rules[, path])	Parameter RotPeriodicAngle of value type float.
RotPeriodicAxis(service, rules[, path])	Parameter RotPeriodicAxis of value type List[float].
RotPeriodicCenter(service, rules[, path])	Parameter RotPeriodicCenter of value type List[float].
RotPeriodicZones(service, rules[, path])	Parameter RotPeriodicZones of value type str.
RotationalPeriodic(service, rules[, path])	Parameter RotationalPeriodic of value type bool.
TransPeriodic(service, rules[, path])	Parameter TransPeriodic of value type List[float].
TransPeriodicZones(service, rules[, path])	Parameter TransPeriodicZones of value type str.
TranslationalPeriodic(service, rules[, path])	Parameter TranslationalPeriodic of value type bool.
WrapResolutionFactor(service, rules[, path])	Parameter WrapResolutionFactor of value type float.
ZSpan(service, rules[, path])	Parameter ZSpan of value type float.

class Advanced(service, rules, path=None)

Bases: PyParameter

Parameter Advanced of value type bool.

class CellSizingGrowthRate(service, rules, path=None)

Bases: PyNumerical

Parameter CellSizingGrowthRate of value type float.

class CellSizingType(service, rules, path=None)

Bases: PyTextual

Parameter CellSizingType of value type str.

class CurvGrowthRate(service, rules, path=None)

Bases: PyNumerical

Parameter CurvGrowthRate of value type float.

class CurvNormalAngle(service, rules, path=None)

Bases: PyNumerical

Parameter CurvNormalAngle of value type float.

class CurvRange(service, rules, path=None)

Bases: PyParameter

Parameter CurvRange of value type List[float].

class Dimension(service, rules, path=None)

Bases: PyTextual

Parameter Dimension of value type str.

class GlobGrowthRate(service, rules, path=None)

Bases: PyNumerical

Parameter GlobGrowthRate of value type float.

class GlobMaxGeoMinSpan3D(service, rules, path=None)

Bases: PyNumerical

Parameter GlobMaxGeoMinSpan3D of value type float.

class GlobRange(service, rules, path=None)

Bases: PyParameter

Parameter GlobRange of value type List[float].

class MaterialPoint(service, rules, path=None)

Bases: PyParameter

Parameter MaterialPoint of value type List[float].

class PrismFirstCellAR(service, rules, path=None)

Bases: PyNumerical

Parameter PrismFirstCellAR of value type float.

class PrismGrowthRate(service, rules, path=None)

Bases: PyNumerical

Parameter PrismGrowthRate of value type float.

class PrismNLayers(service, rules, path=None)

Bases: PyNumerical

Parameter PrismNLayers of value type int.

class ProxGrowthRate(service, rules, path=None)

Bases: PyNumerical

Parameter ProxGrowthRate of value type float.

class ProxMin(service, rules, path=None)

Bases: PyNumerical

Parameter ProxMin of value type float.

class ProxNCellGap(service, rules, path=None)

Bases: PyNumerical

Parameter ProxNCellGap of value type int.

class RotPeriodicAngle(service, rules, path=None)

Bases: PyNumerical

Parameter RotPeriodicAngle of value type float.

class RotPeriodicAxis(service, rules, path=None)

Bases: PyParameter

Parameter RotPeriodicAxis of value type List[float].

class RotPeriodicCenter(service, rules, path=None)

Bases: PyParameter

Parameter RotPeriodicCenter of value type List[float].

class RotPeriodicZones(service, rules, path=None)

Bases: PyTextual

Parameter RotPeriodicZones of value type str.

class RotationalPeriodic(service, rules, path=None)

Bases: PyParameter

Parameter RotationalPeriodic of value type bool.

class TransPeriodic(service, rules, path=None)

Bases: PyParameter

Parameter TransPeriodic of value type List[float].

class TransPeriodicZones(service, rules, path=None)

Bases: PyTextual

Parameter TransPeriodicZones of value type str.

class TranslationalPeriodic(service, rules, path=None)

Bases: PyParameter

Parameter TranslationalPeriodic of value type bool.

class WrapResolutionFactor(service, rules, path=None)

Bases: PyNumerical

Parameter WrapResolutionFactor of value type float.

class ZSpan(service, rules, path=None)

Bases: PyNumerical

Parameter ZSpan of value type float.

class IceTime(service, rules, path)

Bases: PyMenu

Singleton IceTime.

Classes:

AutoTimeStep(service, rules[, path])	Parameter AutoTimeStep of value type bool.
TimeStep(service, rules[, path])	Parameter TimeStep of value type float.
TotalTime(service, rules[, path])	Parameter TotalTime of value type float.

class AutoTimeStep(service, rules, path=None)

Bases: PyParameter

Parameter AutoTimeStep of value type bool.

class TimeStep(service, rules, path=None)

Bases: PyNumerical

Parameter TimeStep of value type float.

class TotalTime(service, rules, path=None)

Bases: PyNumerical

Parameter TotalTime of value type float.

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

Bases: PyCommand

Command Interrupt.

Returns:

bool

class Load(service, rules, command, path=None)

Bases: PyCommand

Command Load.

Parameters:

Filenamestr

Returns:

bool

class MeshMorph(service, rules, command, path=None)

Bases: PyCommand

Command MeshMorph.

Returns:

bool

class Reset(service, rules, command, path=None)

Bases: PyCommand

Command Reset.

Returns:

bool

class Save(service, rules, command, path=None)

Bases: PyCommand

Command Save.

Parameters:

Filenamestr

Returns:

bool

class SaveAs(service, rules, command, path=None)

Bases: PyCommand

Command SaveAs.

Parameters:

Filenamestr

Returns:

bool

class SetupRemeshing(service, rules, command, path=None)

Bases: PyCommand

Command SetupRemeshing.

Parameters:

Filenamestr

Returns:

bool

class SheddingOutput(service, rules, path)

Bases: PyMenu

Singleton SheddingOutput.

Classes:

OutputFiles(service, rules[, path])	Parameter OutputFiles of value type str.
SheddingInterval(service, rules[, path])	Parameter SheddingInterval of value type float.

class OutputFiles(service, rules, path=None)

Bases: PyTextual

Parameter OutputFiles of value type str.

class SheddingInterval(service, rules, path=None)

Bases: PyNumerical

Parameter SheddingInterval of value type float.

class SolutionAvailable(service, rules, path=None)

Bases: PyParameter

Parameter SolutionAvailable of value type bool.

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

Bases: PyCommand

Command Interrupt.

Returns:

bool

class MultishotRun(service, rules, path)

Bases: PyMenu

Singleton MultishotRun.

Classes:

AirflowRestart(service, rules[, path])	Parameter AirflowRestart of value type str.
FirstShotAirflowIterations(service, rules[, ...])	Parameter FirstShotAirflowIterations of value type int.
FirstShotParticlesIterations(service, rules)	Parameter FirstShotParticlesIterations of value type int.
IterationSettings(service, rules[, path])	Parameter IterationSettings of value type str.
NumberShots(service, rules[, path])	Parameter NumberShots of value type int.
RootFilename(service, rules[, path])	Parameter RootFilename of value type str.
SaveFiles(service, rules[, path])	Parameter SaveFiles of value type bool.
SettingsMode(service, rules[, path])	Parameter SettingsMode of value type str.
ShotRestart(service, rules[, path])	Parameter ShotRestart of value type int.
ShotRestartStep(service, rules[, path])	Parameter ShotRestartStep of value type str.
ShotRestartTime(service, rules[, path])	Parameter ShotRestartTime of value type float.
TotalTime(service, rules[, path])	Parameter TotalTime of value type float.

class AirflowRestart(service, rules, path=None)

Bases: PyTextual

Parameter AirflowRestart of value type str.

class FirstShotAirflowIterations(service, rules, path=None)

Bases: PyNumerical

Parameter FirstShotAirflowIterations of value type int.

class FirstShotParticlesIterations(service, rules, path=None)

Bases: PyNumerical

Parameter FirstShotParticlesIterations of value type int.

class IterationSettings(service, rules, path=None)

Bases: PyTextual

Parameter IterationSettings of value type str.

class NumberShots(service, rules, path=None)

Bases: PyNumerical

Parameter NumberShots of value type int.

class RootFilename(service, rules, path=None)

Bases: PyTextual

Parameter RootFilename of value type str.

class SaveFiles(service, rules, path=None)

Bases: PyParameter

Parameter SaveFiles of value type bool.

class SettingsMode(service, rules, path=None)

Bases: PyTextual

Parameter SettingsMode of value type str.

class ShotRestart(service, rules, path=None)

Bases: PyNumerical

Parameter ShotRestart of value type int.

class ShotRestartStep(service, rules, path=None)

Bases: PyTextual

Parameter ShotRestartStep of value type str.

class ShotRestartTime(service, rules, path=None)

Bases: PyNumerical

Parameter ShotRestartTime of value type float.

class TotalTime(service, rules, path=None)

Bases: PyNumerical

Parameter TotalTime of value type float.

class ParticlesRun(service, rules, path)

Bases: PyMenu

Singleton ParticlesRun.

Classes:

Calculate(service, rules, command[, path])	Command Calculate.
ConvergenceAvailable(service, rules[, path])	Parameter ConvergenceAvailable of value type bool.
CrystalOutputSolution(service, rules, path)	Singleton CrystalOutputSolution.
DropletOutputSolution(service, rules, path)	Singleton DropletOutputSolution.
InitConditions(service, rules, path)	Singleton InitConditions.
Initialize(service, rules, command[, path])	Command Initialize.
Interrupt(service, rules, command[, path])	Command Interrupt.
LoadCrystals(service, rules, command[, path])	Command LoadCrystals.
LoadDroplets(service, rules, command[, path])	Command LoadDroplets.
LoadParticles(service, rules, command[, path])	Command LoadParticles.
LoadVapor(service, rules, command[, path])	Command LoadVapor.
Monitors(service, rules, path)	Singleton Monitors.
Output(service, rules, path)	Singleton Output.
Reset(service, rules, command[, path])	Command Reset.
RunSettings(service, rules, path)	Singleton RunSettings.
Save(service, rules, command[, path])	Command Save.
SaveAs(service, rules, command[, path])	Command SaveAs.
SaveCrystals(service, rules, command[, path])	Command SaveCrystals.
SaveDroplets(service, rules, command[, path])	Command SaveDroplets.
SaveVapor(service, rules, command[, path])	Command SaveVapor.
SolutionAvailable(service, rules[, path])	Parameter SolutionAvailable of value type bool.
SolutionInfo(service, rules, path)	Singleton SolutionInfo.
Solver(service, rules, path)	Singleton Solver.
VaporOutputSolution(service, rules, path)	Singleton VaporOutputSolution.

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

Bases: PyCommand

Command Calculate.

Returns:

bool

class ConvergenceAvailable(service, rules, path=None)

Bases: PyParameter

Parameter ConvergenceAvailable of value type bool.

class CrystalOutputSolution(service, rules, path)

Bases: PyMenu

Singleton CrystalOutputSolution.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
Loaded(service, rules[, path])	Parameter Loaded of value type bool.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class DropletOutputSolution(service, rules, path)

Bases: PyMenu

Singleton DropletOutputSolution.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
Loaded(service, rules[, path])	Parameter Loaded of value type bool.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class InitConditions(service, rules, path)

Bases: PyMenu

Singleton InitConditions.

Classes:

Alpha(service, rules[, path])	Parameter Alpha of value type float.
Beta(service, rules[, path])	Parameter Beta of value type float.
DryInit(service, rules[, path])	Parameter DryInit of value type bool.
InitMode(service, rules[, path])	Parameter InitMode of value type str.
Magnitude(service, rules[, path])	Parameter Magnitude of value type float.
VelocityFlag(service, rules[, path])	Parameter VelocityFlag of value type bool.
VelocityX(service, rules[, path])	Parameter VelocityX of value type float.
VelocityY(service, rules[, path])	Parameter VelocityY of value type float.
VelocityZ(service, rules[, path])	Parameter VelocityZ of value type float.

class Alpha(service, rules, path=None)

Bases: PyNumerical

Parameter Alpha of value type float.

class Beta(service, rules, path=None)

Bases: PyNumerical

Parameter Beta of value type float.

class DryInit(service, rules, path=None)

Bases: PyParameter

Parameter DryInit of value type bool.

class InitMode(service, rules, path=None)

Bases: PyTextual

Parameter InitMode of value type str.

class Magnitude(service, rules, path=None)

Bases: PyNumerical

Parameter Magnitude of value type float.

class VelocityFlag(service, rules, path=None)

Bases: PyParameter

Parameter VelocityFlag of value type bool.

class VelocityX(service, rules, path=None)

Bases: PyNumerical

Parameter VelocityX of value type float.

class VelocityY(service, rules, path=None)

Bases: PyNumerical

Parameter VelocityY of value type float.

class VelocityZ(service, rules, path=None)

Bases: PyNumerical

Parameter VelocityZ of value type float.

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 LoadCrystals(service, rules, command, path=None)

Bases: PyCommand

Command LoadCrystals.

Parameters:

Filenamestr

Returns:

bool

class LoadDroplets(service, rules, command, path=None)

Bases: PyCommand

Command LoadDroplets.

Parameters:

Filenamestr

Returns:

bool

class LoadParticles(service, rules, command, path=None)

Bases: PyCommand

Command LoadParticles.

Parameters:

Filenamestr

Returns:

bool

class LoadVapor(service, rules, command, path=None)

Bases: PyCommand

Command LoadVapor.

Parameters:

Filenamestr

Returns:

bool

class Monitors(service, rules, path)

Bases: PyMenu

Singleton Monitors.

Classes:

ChangeBeta(service, rules[, path])	Parameter ChangeBeta of value type bool.
MassDeficit(service, rules[, path])	Parameter MassDeficit of value type bool.
TotalBeta(service, rules[, path])	Parameter TotalBeta of value type bool.
VaporCondensation(service, rules[, path])	Parameter VaporCondensation of value type bool.

class ChangeBeta(service, rules, path=None)

Bases: PyParameter

Parameter ChangeBeta of value type bool.

class MassDeficit(service, rules, path=None)

Bases: PyParameter

Parameter MassDeficit of value type bool.

class TotalBeta(service, rules, path=None)

Bases: PyParameter

Parameter TotalBeta of value type bool.

class VaporCondensation(service, rules, path=None)

Bases: PyParameter

Parameter VaporCondensation of value type bool.

class Output(service, rules, path)

Bases: PyMenu

Singleton Output.

Classes:

AutoSaveDistribution(service, rules[, path])	Parameter AutoSaveDistribution of value type bool.
DistributionRestart(service, rules[, path])	Parameter DistributionRestart of value type str.
NumberedOutput(service, rules[, path])	Parameter NumberedOutput of value type bool.
SaveDelay(service, rules[, path])	Parameter SaveDelay of value type int.

class AutoSaveDistribution(service, rules, path=None)

Bases: PyParameter

Parameter AutoSaveDistribution of value type bool.

class DistributionRestart(service, rules, path=None)

Bases: PyTextual

Parameter DistributionRestart of value type str.

class NumberedOutput(service, rules, path=None)

Bases: PyParameter

Parameter NumberedOutput of value type bool.

class SaveDelay(service, rules, path=None)

Bases: PyNumerical

Parameter SaveDelay of value type int.

class Reset(service, rules, command, path=None)

Bases: PyCommand

Command Reset.

Returns:

bool

class RunSettings(service, rules, path)

Bases: PyMenu

Singleton RunSettings.

Classes:

HighResTrack(service, rules[, path])	Parameter HighResTrack of value type bool.
MaxStepNumber(service, rules[, path])	Parameter MaxStepNumber of value type int.
NumIterations(service, rules[, path])	Parameter NumIterations of value type int.
StepLengthFactor(service, rules[, path])	Parameter StepLengthFactor of value type int.
StepLengthScale(service, rules[, path])	Parameter StepLengthScale of value type float.
UseStepLengthScale(service, rules[, path])	Parameter UseStepLengthScale of value type bool.

class HighResTrack(service, rules, path=None)

Bases: PyParameter

Parameter HighResTrack of value type bool.

class MaxStepNumber(service, rules, path=None)

Bases: PyNumerical

Parameter MaxStepNumber of value type int.

class NumIterations(service, rules, path=None)

Bases: PyNumerical

Parameter NumIterations of value type int.

class StepLengthFactor(service, rules, path=None)

Bases: PyNumerical

Parameter StepLengthFactor of value type int.

class StepLengthScale(service, rules, path=None)

Bases: PyNumerical

Parameter StepLengthScale of value type float.

class UseStepLengthScale(service, rules, path=None)

Bases: PyParameter

Parameter UseStepLengthScale of value type bool.

class Save(service, rules, command, path=None)

Bases: PyCommand

Command Save.

Returns:

bool

class SaveAs(service, rules, command, path=None)

Bases: PyCommand

Command SaveAs.

Returns:

bool

class SaveCrystals(service, rules, command, path=None)

Bases: PyCommand

Command SaveCrystals.

Parameters:

Filenamestr

Returns:

bool

class SaveDroplets(service, rules, command, path=None)

Bases: PyCommand

Command SaveDroplets.

Parameters:

Filenamestr

Returns:

bool

class SaveVapor(service, rules, command, path=None)

Bases: PyCommand

Command SaveVapor.

Parameters:

Filenamestr

Returns:

bool

class SolutionAvailable(service, rules, path=None)

Bases: PyParameter

Parameter SolutionAvailable of value type bool.

class SolutionInfo(service, rules, path)

Bases: PyMenu

Singleton SolutionInfo.

Classes:

InputSolutionType(service, rules[, path])

Parameter InputSolutionType of value type str.

class InputSolutionType(service, rules, path=None)

Bases: PyTextual

Parameter InputSolutionType of value type str.

class Solver(service, rules, path)

Bases: PyMenu

Singleton Solver.

Classes:

AVCoefficient(service, rules[, path])	Parameter AVCoefficient of value type float.
CFL(service, rules[, path])	Parameter CFL of value type float.
ConvergenceBeta(service, rules[, path])	Parameter ConvergenceBeta of value type float.
ResidualCutoff(service, rules[, path])	Parameter ResidualCutoff of value type float.

class AVCoefficient(service, rules, path=None)

Bases: PyNumerical

Parameter AVCoefficient of value type float.

class CFL(service, rules, path=None)

Bases: PyNumerical

Parameter CFL of value type float.

class ConvergenceBeta(service, rules, path=None)

Bases: PyNumerical

Parameter ConvergenceBeta of value type float.

class ResidualCutoff(service, rules, path=None)

Bases: PyNumerical

Parameter ResidualCutoff of value type float.

class VaporOutputSolution(service, rules, path)

Bases: PyMenu

Singleton VaporOutputSolution.

Classes:

Filename(service, rules[, path])	Parameter Filename of value type str.
Loaded(service, rules[, path])	Parameter Loaded of value type bool.

class Filename(service, rules, path=None)

Bases: PyTextual

Parameter Filename of value type str.

class Loaded(service, rules, path=None)

Bases: PyParameter

Parameter Loaded of value type bool.

class Reset(service, rules, command, path=None)

Bases: PyCommand

Command Reset.

Returns:

bool

class ResetMultishot(service, rules, command, path=None)

Bases: PyCommand

Command ResetMultishot.

Returns:

bool

class RunState(service, rules, path)

Bases: PyMenu

Singleton RunState.

Classes:

ClientProcessRunning(service, rules[, path])	Parameter ClientProcessRunning of value type bool.
CurrentStep(service, rules[, path])	Parameter CurrentStep of value type str.
MultishotState(service, rules[, path])	Parameter MultishotState of value type str.
ProjectRunIterator(service, rules[, path])	Parameter ProjectRunIterator of value type int.
RunMode(service, rules[, path])	Parameter RunMode of value type str.
ShotID(service, rules[, path])	Parameter ShotID of value type int.
SubStepID(service, rules[, path])	Parameter SubStepID of value type int.

class ClientProcessRunning(service, rules, path=None)

Bases: PyParameter

Parameter ClientProcessRunning of value type bool.

class CurrentStep(service, rules, path=None)

Bases: PyTextual

Parameter CurrentStep of value type str.

class MultishotState(service, rules, path=None)

Bases: PyTextual

Parameter MultishotState of value type str.

class ProjectRunIterator(service, rules, path=None)

Bases: PyNumerical

Parameter ProjectRunIterator of value type int.

class RunMode(service, rules, path=None)

Bases: PyTextual

Parameter RunMode of value type str.

class ShotID(service, rules, path=None)

Bases: PyNumerical

Parameter ShotID of value type int.

class SubStepID(service, rules, path=None)

Bases: PyNumerical

Parameter SubStepID of value type int.

class SyncDM(service, rules, command, path=None)

Bases: PyCommand

Command SyncDM.

Returns:

bool

class WriteAll(service, rules, command, path=None)

Bases: PyCommand

Command WriteAll.

Parameters:

FileNamestr

Returns:

bool

class AppLocal(service, rules, path)

Bases: PyMenu

Singleton AppLocal.

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.

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.

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.

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.

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.

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.

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.

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

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

class CameraSettings(service, rules, path)

Bases: PyMenu

Singleton CameraSettings.

Classes:

Position(service, rules, path)	Singleton Position.
Target(service, rules, path)	Singleton Target.

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.

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.

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.

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.

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.

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.

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

.

class Plots(service, rules, path)

Bases: PyMenu

Singleton Plots.

Classes:

PlotFromFile(service, rules, path)

Singleton PlotFromFile.

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.

class Axes(service, rules, path)

Bases: PyMenu

Singleton Axes.

Classes:

X(service, rules, path)	Singleton X.
Y(service, rules, path)	Singleton Y.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

class Curves(service, rules, path)

Bases: PyMenu

Singleton Curves.

Classes:

LineStyle(service, rules, path)	Singleton LineStyle.
MarkerStyle(service, rules, path)	Singleton MarkerStyle.

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.

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.

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.

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.

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.

class Field(service, rules, path=None)

Bases: PyTextual

Parameter Field of value type str.

class YAxisFunction(service, rules, path)

Bases: PyMenu

Singleton YAxisFunction.

Classes:

Field(service, rules[, path])

Parameter Field of value type str.

class Field(service, rules, path=None)

Bases: PyTextual

Parameter Field of value type str.

class Reports(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class ResultsExternalInfo(service, rules, path)

Bases: PyMenu

Singleton ResultsExternalInfo.

class SurfaceDefs(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class View(service, rules, path=None)

Bases: PyNamedObjectContainer

.

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

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

.

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

Bases: PyCommand

Command SendCommand.

Parameters:

Commandstr

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

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

.

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.

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.

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.

class CalculationActivities(service, rules, path)

Bases: PyMenu

Singleton CalculationActivities.

Classes:

SolutionAnimations(service, rules[, path])

.

class SolutionAnimations(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class Controls(service, rules, path)

Bases: PyMenu

Singleton Controls.

Classes:

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

class CourantNumber(service, rules, path=None)

Bases: PyNumerical

Parameter CourantNumber of value type float.

class UnderRelaxationFactors(service, rules, path=None)

Bases: PyNamedObjectContainer

.

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

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

class Monitors(service, rules, path)

Bases: PyMenu

Singleton Monitors.

Classes:

ReportPlots(service, rules[, path])	.
Residuals(service, rules, path)	Singleton Residuals.

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

class ConvergenceCriterionType(service, rules, path=None)

Bases: PyTextual

Parameter ConvergenceCriterionType of value type str.

class Equation(service, rules, path=None)

Bases: PyNamedObjectContainer

.

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.

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.

class Streaming(service, rules, path)

Bases: PyMenu

Singleton Streaming.

Classes:

Ack(service, rules[, path])

Parameter Ack of value type bool.

class Ack(service, rules, path=None)

Bases: PyParameter

Parameter Ack of value type bool.

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