RADomainSettings

class ansys.rocky.app.ra_domain_settings.RADomainSettings(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper for Domain Setings properties.

This wrapper corresponds to the “Domain Settings” item on a project’s data tree. Access it from the RAStudy with:

domain_settings = study.GetDomainSettings()

Overview

Constructors

GetWrappedClass
GetClassName

Methods

CoordinateLimitsAtBoundaryLimits
GetCoordinateLimitsMinMax
ResetDomainToGeometriesLimits	Reset the domain settings coordinate limits based on the geometry bounding box.
GetCoordinateLimitsMaxValues	Get the value of “Coordinate Limits Max Values”.
SetCoordinateLimitsMaxValues	Set the values of “Coordinate Limits Max Values”.
GetCoordinateLimitsMinValues	Get the value of “Coordinate Limits Min Values”.
SetCoordinateLimitsMinValues	Set the values of “Coordinate Limits Min Values”.
GetUseBoundaryLimits	Get the value of “Use Boundary Limits”.
SetUseBoundaryLimits	Set the value of “Use Boundary Limits”.
EnableUseBoundaryLimits	Set the value of “Use Boundary Limits” to True.
DisableUseBoundaryLimits	Set the value of “Use Boundary Limits” to False.
IsUseBoundaryLimitsEnabled	Check if the “Use Boundary Limits” is enabled.
GetPeriodicLimitsMaxCoordinates	Get the value of “Periodic Limits Max Coordinates”.
SetPeriodicLimitsMaxCoordinates	Set the values of “Periodic Limits Max Coordinates”.
GetPeriodicLimitsMinCoordinates	Get the value of “Periodic Limits Min Coordinates”.
SetPeriodicLimitsMinCoordinates	Set the values of “Periodic Limits Min Coordinates”.
GetPeriodicAtGeometryLimits	Get the value of “Periodic At Geometry Limits”.
SetPeriodicAtGeometryLimits	Set the value of “Periodic At Geometry Limits”.
EnablePeriodicAtGeometryLimits	Set the value of “Periodic At Geometry Limits” to True.
DisablePeriodicAtGeometryLimits	Set the value of “Periodic At Geometry Limits” to False.
IsPeriodicAtGeometryLimitsEnabled	Check if the “Periodic At Geometry Limits” is enabled.
GetCartesianPeriodicDirections	Get “Cartesian Periodic Directions” as a string.
SetCartesianPeriodicDirections	Set the value of “Cartesian Periodic Directions”.
GetValidCartesianPeriodicDirectionsValues	Get a list of all possible values for “Cartesian Periodic Directions”.
GetInitialAngle	Get the value of “Initial Angle”.
SetInitialAngle	Set the value of “Initial Angle”.
GetNumberOfDivisions	Get the value of “Number of Divisions”.
SetNumberOfDivisions	Set the value of “Number of Divisions”.
GetCylindricalPeriodicDirections	Get “Cylindrical Periodic Directions” as a string.
SetCylindricalPeriodicDirections	Set the value of “Cylindrical Periodic Directions”.
GetValidCylindricalPeriodicDirectionsValues	Get a list of all possible values for “Cylindrical Periodic Directions”.
GetDomainType	Get “Domain Type” as a string.
SetDomainType	Set the value of “Domain Type”.
GetValidDomainTypeValues	Get a list of all possible values for “Domain Type”.

Import detail

from ansys.rocky.app.ra_domain_settings import RADomainSettings

Method detail

classmethod RADomainSettings.GetWrappedClass()

classmethod RADomainSettings.GetClassName() → str

RADomainSettings.CoordinateLimitsAtBoundaryLimits() → bool

RADomainSettings.GetCoordinateLimitsMinMax()

RADomainSettings.ResetDomainToGeometriesLimits() → None

Reset the domain settings coordinate limits based on the geometry bounding box.

RADomainSettings.GetCoordinateLimitsMaxValues(unit: str | None = None) → list[float]

Get the value of “Coordinate Limits Max Values”.

Parameters:

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

RADomainSettings.SetCoordinateLimitsMaxValues(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Coordinate Limits Max Values”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

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

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RADomainSettings.GetCoordinateLimitsMinValues(unit: str | None = None) → list[float]

Get the value of “Coordinate Limits Min Values”.

Parameters:

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

RADomainSettings.SetCoordinateLimitsMinValues(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Coordinate Limits Min Values”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

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

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RADomainSettings.GetUseBoundaryLimits() → bool

Get the value of “Use Boundary Limits”.

RADomainSettings.SetUseBoundaryLimits(value: bool) → None

Set the value of “Use Boundary Limits”.

Parameters:

value – The value to set.

RADomainSettings.EnableUseBoundaryLimits() → None

Set the value of “Use Boundary Limits” to True.

RADomainSettings.DisableUseBoundaryLimits() → None

Set the value of “Use Boundary Limits” to False.

RADomainSettings.IsUseBoundaryLimitsEnabled() → bool

Check if the “Use Boundary Limits” is enabled.

RADomainSettings.GetPeriodicLimitsMaxCoordinates(unit: str | None = None) → list[float]

Get the value of “Periodic Limits Max Coordinates”.

Parameters:

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

RADomainSettings.SetPeriodicLimitsMaxCoordinates(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Periodic Limits Max Coordinates”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

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

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RADomainSettings.GetPeriodicLimitsMinCoordinates(unit: str | None = None) → list[float]

Get the value of “Periodic Limits Min Coordinates”.

Parameters:

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

RADomainSettings.SetPeriodicLimitsMinCoordinates(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Periodic Limits Min Coordinates”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

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

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RADomainSettings.GetPeriodicAtGeometryLimits() → bool

Get the value of “Periodic At Geometry Limits”.

RADomainSettings.SetPeriodicAtGeometryLimits(value: bool) → None

Set the value of “Periodic At Geometry Limits”.

Parameters:

value – The value to set.

RADomainSettings.EnablePeriodicAtGeometryLimits() → None

Set the value of “Periodic At Geometry Limits” to True.

RADomainSettings.DisablePeriodicAtGeometryLimits() → None

Set the value of “Periodic At Geometry Limits” to False.

RADomainSettings.IsPeriodicAtGeometryLimitsEnabled() → bool

Check if the “Periodic At Geometry Limits” is enabled.

RADomainSettings.GetCartesianPeriodicDirections() → str

Get “Cartesian Periodic Directions” as a string.

Returns:

The returned value will be one of [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’].

RADomainSettings.SetCartesianPeriodicDirections(value: str) → None

Set the value of “Cartesian Periodic Directions”.

Parameters:

value – The value to set. Must be one of [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’].

Raises:

RockyApiError – If value is not a valid “Cartesian Periodic Directions” option.

RADomainSettings.GetValidCartesianPeriodicDirectionsValues() → list[str]

Get a list of all possible values for “Cartesian Periodic Directions”.

Returns:

The returned list is [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’].

RADomainSettings.GetInitialAngle(unit: str | None = None) → float

Get the value of “Initial Angle”.

Parameters:

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

RADomainSettings.SetInitialAngle(value: str | float, unit: str | None = None) → None

Set the value of “Initial Angle”.

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 “dega”.

RADomainSettings.GetNumberOfDivisions() → int

Get the value of “Number of Divisions”.

RADomainSettings.SetNumberOfDivisions(value: str | int) → None

Set the value of “Number of Divisions”.

Parameters:

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

RADomainSettings.GetCylindricalPeriodicDirections() → str

Get “Cylindrical Periodic Directions” as a string.

Returns:

The returned value will be one of [‘X’, ‘Y’, ‘Z’].

RADomainSettings.SetCylindricalPeriodicDirections(value: str) → None

Set the value of “Cylindrical Periodic Directions”.

Parameters:

value – The value to set. Must be one of [‘X’, ‘Y’, ‘Z’].

Raises:

RockyApiError – If value is not a valid “Cylindrical Periodic Directions” option.

RADomainSettings.GetValidCylindricalPeriodicDirectionsValues() → list[str]

Get a list of all possible values for “Cylindrical Periodic Directions”.

Returns:

The returned list is [‘X’, ‘Y’, ‘Z’].

RADomainSettings.GetDomainType() → str

Get “Domain Type” as a string.

Returns:

The returned value will be one of [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’].

RADomainSettings.SetDomainType(value: str) → None

Set the value of “Domain Type”.

Parameters:

value – The value to set. Must be one of [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’].

Raises:

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

RADomainSettings.GetValidDomainTypeValues() → list[str]

Get a list of all possible values for “Domain Type”.

Returns:

The returned list is [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’].