_SurfaceDefs

class ansys.fluent.core.datamodel_231.flicing.Root.Case.Results.SurfaceDefs._SurfaceDefs(service, rules, path)

Bases: PyMenu

Singleton _SurfaceDefs.

Classes:

Display(service, rules, command[, path])	Command Display.
GroupName(service, rules[, path])	Parameter GroupName of value type str.
IsoClipSettings(service, rules, path)	Singleton IsoClipSettings.
IsosurfaceSettings(service, rules, path)	Singleton IsosurfaceSettings.
LineSettings(service, rules, path)	Singleton LineSettings.
PlaneSettings(service, rules, path)	Singleton PlaneSettings.
PointSettings(service, rules, path)	Singleton PointSettings.
RakeSettings(service, rules, path)	Singleton RakeSettings.
SaveImage(service, rules, command[, path])	Command SaveImage.
SurfaceDim(service, rules[, path])	Parameter SurfaceDim of value type List[str].
SurfaceId(service, rules[, path])	Parameter SurfaceId of value type int.
SurfaceType(service, rules[, path])	Parameter SurfaceType of value type str.
Surfaces(service, rules[, path])	Parameter Surfaces of value type List[str].
Ungroup(service, rules, command[, path])	Command Ungroup.
ZoneSettings(service, rules, path)	Singleton ZoneSettings.

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

Bases: PyCommand

Command Display.

Returns:

bool

class GroupName(service, rules, path=None)

Bases: PyTextual

Parameter GroupName of value type str.

class IsoClipSettings(service, rules, path)

Bases: PyMenu

Singleton IsoClipSettings.

Classes:

Field(service, rules[, path])	Parameter Field of value type str.
Maximum(service, rules[, path])	Parameter Maximum of value type float.
Minimum(service, rules[, path])	Parameter Minimum of value type float.
Surfaces(service, rules[, path])	Parameter Surfaces of value type List[str].
UpdateMinMax(service, rules, command[, path])	Command UpdateMinMax.

class Field(service, rules, path=None)

Bases: PyTextual

Parameter Field of value type str.

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

Bases: PyTextual

Parameter Surfaces of value type List[str].

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

Bases: PyCommand

Command UpdateMinMax.

Returns:

None

class IsosurfaceSettings(service, rules, path)

Bases: PyMenu

Singleton IsosurfaceSettings.

Classes:

Field(service, rules[, path])	Parameter Field of value type str.
IsoValue(service, rules[, path])	Parameter IsoValue of value type float.
Maximum(service, rules[, path])	Parameter Maximum of value type float.
Minimum(service, rules[, path])	Parameter Minimum of value type float.
RestrictToSpecificSurfaces(service, rules[, ...])	Parameter RestrictToSpecificSurfaces of value type bool.
RestrictToSpecificZones(service, rules[, path])	Parameter RestrictToSpecificZones of value type bool.
Surfaces(service, rules[, path])	Parameter Surfaces of value type List[str].
UpdateMinMax(service, rules, command[, path])	Command UpdateMinMax.
Zones(service, rules[, path])	Parameter Zones of value type List[str].

class Field(service, rules, path=None)

Bases: PyTextual

Parameter Field of value type str.

class IsoValue(service, rules, path=None)

Bases: PyNumerical

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

Bases: PyParameter

Parameter RestrictToSpecificSurfaces of value type bool.

class RestrictToSpecificZones(service, rules, path=None)

Bases: PyParameter

Parameter RestrictToSpecificZones of value type bool.

class Surfaces(service, rules, path=None)

Bases: PyTextual

Parameter Surfaces of value type List[str].

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

Bases: PyCommand

Command UpdateMinMax.

Returns:

None

class Zones(service, rules, path=None)

Bases: PyTextual

Parameter Zones of value type List[str].

class LineSettings(service, rules, path)

Bases: PyMenu

Singleton LineSettings.

Classes:

EndPoint(service, rules, path)	Singleton EndPoint.
StartPoint(service, rules, path)	Singleton StartPoint.

class EndPoint(service, rules, path)

Bases: PyMenu

Singleton EndPoint.

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

Bases: PyMenu

Singleton StartPoint.

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

Bases: PyMenu

Singleton PlaneSettings.

Classes:

Bounded(service, rules[, path])	Parameter Bounded of value type bool.
CreationMode(service, rules[, path])	Parameter CreationMode of value type str.
FirstPoint(service, rules, path)	Singleton FirstPoint.
Normal(service, rules, path)	Singleton Normal.
SecondPoint(service, rules, path)	Singleton SecondPoint.
ThirdPoint(service, rules, path)	Singleton ThirdPoint.
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 Bounded(service, rules, path=None)

Bases: PyParameter

Parameter Bounded of value type bool.

class CreationMode(service, rules, path=None)

Bases: PyTextual

Parameter CreationMode of value type str.

class FirstPoint(service, rules, path)

Bases: PyMenu

Singleton FirstPoint.

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

Bases: PyMenu

Singleton Normal.

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

Bases: PyMenu

Singleton SecondPoint.

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

Bases: PyMenu

Singleton ThirdPoint.

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

Bases: PyMenu

Singleton PointSettings.

Classes:

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

Bases: PyParameter

Parameter LbClipping of value type bool.

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

Bases: PyMenu

Singleton RakeSettings.

Classes:

EndPoint(service, rules, path)	Singleton EndPoint.
NumberOfPoints(service, rules[, path])	Parameter NumberOfPoints of value type int.
StartPoint(service, rules, path)	Singleton StartPoint.

class EndPoint(service, rules, path)

Bases: PyMenu

Singleton EndPoint.

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

Bases: PyNumerical

Parameter NumberOfPoints of value type int.

class StartPoint(service, rules, path)

Bases: PyMenu

Singleton StartPoint.

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

Bases: PyCommand

Command SaveImage.

Parameters:

FileNamestr

Formatstr

FileTypestr

Coloringstr

Orientationstr

UseWhiteBackgroundbool

ResolutionDict[str, Any]

Returns:

bool

class SurfaceDim(service, rules, path=None)

Bases: PyTextual

Parameter SurfaceDim of value type List[str].

class SurfaceId(service, rules, path=None)

Bases: PyNumerical

Parameter SurfaceId of value type int.

class SurfaceType(service, rules, path=None)

Bases: PyTextual

Parameter SurfaceType of value type str.

class Surfaces(service, rules, path=None)

Bases: PyTextual

Parameter Surfaces of value type List[str].

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

Bases: PyCommand

Command Ungroup.

Returns:

bool

class ZoneSettings(service, rules, path)

Bases: PyMenu

Singleton ZoneSettings.

Classes:

IdList(service, rules[, path])	Parameter IdList of value type List[int].
Type(service, rules[, path])	Parameter Type of value type str.
ZId(service, rules[, path])	Parameter ZId of value type int.
ZType(service, rules[, path])	Parameter ZType of value type str.

class IdList(service, rules, path=None)

Bases: PyParameter

Parameter IdList of value type List[int].

class Type(service, rules, path=None)

Bases: PyTextual

Parameter Type of value type str.

class ZId(service, rules, path=None)

Bases: PyNumerical

Parameter ZId of value type int.

class ZType(service, rules, path=None)

Bases: PyTextual

Parameter ZType of value type str.