Solution

class ansys.fluent.core.datamodel_241.flicing.Root.Case.App.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.
SaveAsFensap(service, rules[, path])	Parameter SaveAsFensap 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 SaveAsFensap(service, rules, path=None)

Bases: PyParameter

Parameter SaveAsFensap 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.
NumberofTimeSteps(service, rules[, path])	Parameter NumberofTimeSteps 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.
TimeScaleFactor(service, rules[, path])	Parameter TimeScaleFactor of value type float.
TimeStep(service, rules[, path])	Parameter TimeStep of value type float.
TimeTransient(service, rules[, path])	Parameter TimeTransient of value type bool.

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

Bases: PyNumerical

Parameter NumberofTimeSteps 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 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 TimeTransient(service, rules, path=None)

Bases: PyParameter

Parameter TimeTransient of value type 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 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:

CHTControl(service, rules, path)	Singleton CHTControl.
CHTOutput(service, rules, path)	Singleton CHTOutput.
CHTOutputSolution(service, rules, path)	Singleton CHTOutputSolution.
CHTTransient(service, rules, path)	Singleton CHTTransient.
Calculate(service, rules, command[, path])	Command Calculate.
Interrupt(service, rules, command[, path])	Command Interrupt.
Reset(service, rules, command[, path])	Command Reset.
SolutionAvailable(service, rules[, path])	Parameter SolutionAvailable of value type bool.

class CHTControl(service, rules, path)

Bases: PyMenu

Singleton CHTControl.

Classes:

Equations(service, rules[, path])	Parameter Equations of value type str.
NumberLoops(service, rules[, path])	Parameter NumberLoops of value type int.
SolverIterations(service, rules[, path])	Parameter SolverIterations of value type int.

class Equations(service, rules, path=None)

Bases: PyTextual

Parameter Equations of value type str.

class NumberLoops(service, rules, path=None)

Bases: PyNumerical

Parameter NumberLoops of value type int.

class SolverIterations(service, rules, path=None)

Bases: PyNumerical

Parameter SolverIterations of value type int.

class CHTOutput(service, rules, path)

Bases: PyMenu

Singleton CHTOutput.

Classes:

SaveAirSoln(service, rules[, path])	Parameter SaveAirSoln of value type bool.
SaveInterval(service, rules[, path])	Parameter SaveInterval of value type int.

class SaveAirSoln(service, rules, path=None)

Bases: PyParameter

Parameter SaveAirSoln of value type bool.

class SaveInterval(service, rules, path=None)

Bases: PyNumerical

Parameter SaveInterval 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 CHTTransient(service, rules, path)

Bases: PyMenu

Singleton CHTTransient.

Classes:

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

class NumberofTimeSteps(service, rules, path=None)

Bases: PyNumerical

Parameter NumberofTimeSteps of value type float.

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

Bases: PyCommand

Command Calculate.

Returns:

bool

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

Bases: PyCommand

Command Interrupt.

Returns:

bool

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

Bases: PyCommand

Command Reset.

Returns:

bool

class SolutionAvailable(service, rules, path=None)

Bases: PyParameter

Parameter SolutionAvailable of value type bool.

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.
firstCellHeight(service, rules[, path])	Parameter firstCellHeight of value type float.
lastCellRatio(service, rules[, path])	Parameter lastCellRatio 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 firstCellHeight(service, rules, path=None)

Bases: PyNumerical

Parameter firstCellHeight of value type float.

class lastCellRatio(service, rules, path=None)

Bases: PyNumerical

Parameter lastCellRatio 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.
CrystalPrimaryOutputSolution(service, rules, ...)	Singleton CrystalPrimaryOutputSolution.
DropletOutputSolution(service, rules, path)	Singleton DropletOutputSolution.
DropletPrimaryOutputSolution(service, rules, ...)	Singleton DropletPrimaryOutputSolution.
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 CrystalPrimaryOutputSolution(service, rules, path)

Bases: PyMenu

Singleton CrystalPrimaryOutputSolution.

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 DropletPrimaryOutputSolution(service, rules, path)

Bases: PyMenu

Singleton DropletPrimaryOutputSolution.

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.
ReinjNumIterations(service, rules[, path])	Parameter ReinjNumIterations 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 ReinjNumIterations(service, rules, path=None)

Bases: PyNumerical

Parameter ReinjNumIterations 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.