_Vector

class ansys.fluent.core.datamodel_231.flicing.Root.Case.Results.Graphics.Vector._Vector(service, rules, path)

Bases: PyMenu

Singleton _Vector.

Classes:

AddToViewport(service, rules, command[, path])	Command AddToViewport.
ColorMap(service, rules, path)	Singleton ColorMap.
Diff(service, rules, command[, path])	Command Diff.
Display(service, rules, command[, path])	Command Display.
DisplayInViewport(service, rules, command[, ...])	Command DisplayInViewport.
DrawMesh(service, rules[, path])	Parameter DrawMesh of value type bool.
Field(service, rules[, path])	Parameter Field of value type str.
OverlayedMesh(service, rules[, path])	Parameter OverlayedMesh of value type str.
Pull(service, rules, command[, path])	Command Pull.
Push(service, rules, command[, path])	Command Push.
Range(service, rules, path)	Singleton Range.
SaveAnimation(service, rules, command[, path])	Command SaveAnimation.
SaveImage(service, rules, command[, path])	Command SaveImage.
Scale(service, rules, path)	Singleton Scale.
Skip(service, rules[, path])	Parameter Skip of value type int.
Style(service, rules[, path])	Parameter Style of value type str.
Surfaces(service, rules[, path])	Parameter Surfaces of value type List[str].
SyncStatus(service, rules[, path])	Parameter SyncStatus of value type str.
UpdateMinMax(service, rules, command[, path])	Command UpdateMinMax.
VectorField(service, rules[, path])	Parameter VectorField of value type str.
VectorOptions(service, rules, path)	Singleton VectorOptions.
WindowId(service, rules[, path])	Parameter WindowId of value type int.

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

Bases: PyCommand

Command AddToViewport.

Parameters:

Viewportstr

Returns:

bool

class ColorMap(service, rules, path)

Bases: PyMenu

Singleton ColorMap.

Classes:

ColorMap(service, rules[, path])	Parameter ColorMap of value type str.
IsLogScale(service, rules[, path])	Parameter IsLogScale of value type bool.
Position(service, rules[, path])	Parameter Position of value type str.
Precision(service, rules[, path])	Parameter Precision of value type int.
ShowAll(service, rules[, path])	Parameter ShowAll of value type bool.
Size(service, rules[, path])	Parameter Size of value type int.
Skip(service, rules[, path])	Parameter Skip of value type int.
Type(service, rules[, path])	Parameter Type of value type str.
Visible(service, rules[, path])	Parameter Visible of value type bool.

class ColorMap(service, rules, path=None)

Bases: PyTextual

Parameter ColorMap of value type str.

class IsLogScale(service, rules, path=None)

Bases: PyParameter

Parameter IsLogScale of value type bool.

class Position(service, rules, path=None)

Bases: PyTextual

Parameter Position of value type str.

class Precision(service, rules, path=None)

Bases: PyNumerical

Parameter Precision of value type int.

class ShowAll(service, rules, path=None)

Bases: PyParameter

Parameter ShowAll of value type bool.

class Size(service, rules, path=None)

Bases: PyNumerical

Parameter Size of value type int.

class Skip(service, rules, path=None)

Bases: PyNumerical

Parameter Skip of value type int.

class Type(service, rules, path=None)

Bases: PyTextual

Parameter Type of value type str.

class Visible(service, rules, path=None)

Bases: PyParameter

Parameter Visible of value type bool.

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

Bases: PyCommand

Command Diff.

Returns:

bool

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

Bases: PyCommand

Command Display.

Returns:

bool

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

Bases: PyCommand

Command DisplayInViewport.

Parameters:

Viewportstr

Returns:

bool

class DrawMesh(service, rules, path=None)

Bases: PyParameter

Parameter DrawMesh of value type bool.

class Field(service, rules, path=None)

Bases: PyTextual

Parameter Field of value type str.

class OverlayedMesh(service, rules, path=None)

Bases: PyTextual

Parameter OverlayedMesh of value type str.

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

Bases: PyCommand

Command Pull.

Returns:

bool

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

Bases: PyCommand

Command Push.

Returns:

bool

class Range(service, rules, path)

Bases: PyMenu

Singleton Range.

Classes:

AutoRange(service, rules[, path])	Parameter AutoRange of value type bool.
ClipToRange(service, rules[, path])	Parameter ClipToRange of value type bool.
GlobalRange(service, rules[, path])	Parameter GlobalRange of value type bool.
MaxValue(service, rules[, path])	Parameter MaxValue of value type float.
MinValue(service, rules[, path])	Parameter MinValue of value type float.

class AutoRange(service, rules, path=None)

Bases: PyParameter

Parameter AutoRange of value type bool.

class ClipToRange(service, rules, path=None)

Bases: PyParameter

Parameter ClipToRange of value type bool.

class GlobalRange(service, rules, path=None)

Bases: PyParameter

Parameter GlobalRange of value type bool.

class MaxValue(service, rules, path=None)

Bases: PyNumerical

Parameter MaxValue of value type float.

class MinValue(service, rules, path=None)

Bases: PyNumerical

Parameter MinValue of value type float.

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

Bases: PyCommand

Command SaveAnimation.

Parameters:

FileNamestr

Formatstr

FPSfloat

AntiAliasingPassesstr

Qualitystr

H264bool

Compressionstr

BitRateint

JPegQualityint

PPMFormatstr

UseWhiteBackgroundbool

Orientationstr

ResolutionDict[str, Any]

Returns:

None

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

Bases: PyCommand

Command SaveImage.

Parameters:

FileNamestr

Formatstr

FileTypestr

Coloringstr

Orientationstr

UseWhiteBackgroundbool

ResolutionDict[str, Any]

Returns:

bool

class Scale(service, rules, path)

Bases: PyMenu

Singleton Scale.

Classes:

AutoScale(service, rules[, path])	Parameter AutoScale of value type bool.
Scale(service, rules[, path])	Parameter Scale of value type float.

class AutoScale(service, rules, path=None)

Bases: PyParameter

Parameter AutoScale of value type bool.

class Scale(service, rules, path=None)

Bases: PyNumerical

Parameter Scale of value type float.

class Skip(service, rules, path=None)

Bases: PyNumerical

Parameter Skip of value type int.

class Style(service, rules, path=None)

Bases: PyTextual

Parameter Style of value type str.

class Surfaces(service, rules, path=None)

Bases: PyTextual

Parameter Surfaces of value type List[str].

class SyncStatus(service, rules, path=None)

Bases: PyTextual

Parameter SyncStatus of value type str.

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

Bases: PyCommand

Command UpdateMinMax.

Returns:

None

class VectorField(service, rules, path=None)

Bases: PyTextual

Parameter VectorField of value type str.

class VectorOptions(service, rules, path)

Bases: PyMenu

Singleton VectorOptions.

Classes:

Color(service, rules[, path])	Parameter Color of value type str.
FixedLength(service, rules[, path])	Parameter FixedLength of value type bool.
HeadScale(service, rules[, path])	Parameter HeadScale of value type float.
InPlane(service, rules[, path])	Parameter InPlane of value type bool.
XComponent(service, rules[, path])	Parameter XComponent of value type bool.
YComponent(service, rules[, path])	Parameter YComponent of value type bool.
ZComponent(service, rules[, path])	Parameter ZComponent of value type bool.

class Color(service, rules, path=None)

Bases: PyTextual

Parameter Color of value type str.

class FixedLength(service, rules, path=None)

Bases: PyParameter

Parameter FixedLength of value type bool.

class HeadScale(service, rules, path=None)

Bases: PyNumerical

Parameter HeadScale of value type float.

class InPlane(service, rules, path=None)

Bases: PyParameter

Parameter InPlane of value type bool.

class XComponent(service, rules, path=None)

Bases: PyParameter

Parameter XComponent of value type bool.

class YComponent(service, rules, path=None)

Bases: PyParameter

Parameter YComponent of value type bool.

class ZComponent(service, rules, path=None)

Bases: PyParameter

Parameter ZComponent of value type bool.

class WindowId(service, rules, path=None)

Bases: PyNumerical

Parameter WindowId of value type int.