RAStreamlinesUserProcess

class ansys.rocky.app.ra_streamlines_user_process.RAStreamlinesUserProcess

Bases: ansys.rocky.app.ra_process_element.RAUserProcess

Base class for UserProcesses

Overview

Constructors

GetWrappedClass
GetClassName

Methods

UpdateStreamlines	Recompute the streamlines from the current values of sources, spacing, direction and
GetSources	Get the surfaces defined as sources to generate Streamlines.
SetSources	Set the surfaces as sources to generate Streamlines.
GetAvailableSources	Get available planar surfaces that can be used to generate Streamlines.
GetDirection	Get “Direction” as a string.
SetDirection	Set the value of “Direction”.
GetValidDirectionValues	Get a list of all possible values for “Direction”.
GetMaximumLength	Get the value of “Maximum Length”.
SetMaximumLength	Set the value of “Maximum Length”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetSpacing	Get the value of “Spacing”.
SetSpacing	Set the value of “Spacing”.

Import detail

from ansys.rocky.app.ra_streamlines_user_process import RAStreamlinesUserProcess

Method detail

classmethod RAStreamlinesUserProcess.GetWrappedClass() → type[rocky30.plugins.sph.streamlines_user_process.streamlines_user_process.StreamlinesUserProcessSubject]

classmethod RAStreamlinesUserProcess.GetClassName() → str

RAStreamlinesUserProcess.UpdateStreamlines() → None

Recompute the streamlines from the current values of sources, spacing, direction and maximum length.

Since computing the streamlines is potentially slow when the spacing is small, this method must be explicitly called in order to update the streamlines.

RAStreamlinesUserProcess.GetSources() → list[SurfaceTypes] | None

Get the surfaces defined as sources to generate Streamlines.

RAStreamlinesUserProcess.SetSources(surfaces: str | SurfaceTypes | list) → None

Set the surfaces as sources to generate Streamlines.

RAStreamlinesUserProcess.GetAvailableSources() → list[SurfaceTypes]

Get available planar surfaces that can be used to generate Streamlines.

RAStreamlinesUserProcess.GetDirection() → str

Get “Direction” as a string.

Returns:

The returned value will be one of [‘forward’, ‘backward’, ‘both’].

RAStreamlinesUserProcess.SetDirection(value: str) → None

Set the value of “Direction”.

Parameters:

value – The value to set. Must be one of [‘forward’, ‘backward’, ‘both’].

Raises:

RockyApiError – If value is not a valid “Direction” option.

RAStreamlinesUserProcess.GetValidDirectionValues() → list[str]

Get a list of all possible values for “Direction”.

Returns:

The returned list is [‘forward’, ‘backward’, ‘both’].

RAStreamlinesUserProcess.GetMaximumLength(unit: str | None = None) → float

Get the value of “Maximum Length”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAStreamlinesUserProcess.SetMaximumLength(value: str | float, unit: str | None = None) → None

Set the value of “Maximum Length”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RAStreamlinesUserProcess.GetName() → str

Get the value of “Name”.

RAStreamlinesUserProcess.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAStreamlinesUserProcess.GetSpacing(unit: str | None = None) → float

Get the value of “Spacing”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAStreamlinesUserProcess.SetSpacing(value: str | float, unit: str | None = None) → None

Set the value of “Spacing”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.