RAWall

class ansys.rocky.app.ra_wall.RAWall

Bases: ansys.rocky.app.ra_base_geometry.RABaseGeometry, ansys.rocky.app.ra_addins.ElementWithAddins, ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin

Rocky API Geometry model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

LoadFile	Replace the geometry representation for a new one contained on a file.
HasMotionFrame	Whether the boundary is linked to a motion frame.
GetOrientation	Get the orientation angles. For more specific cases, see: “GetOrientationFromAngles”,
SetOrientation	The rotation is the angles in x, y and z of the rotation in the given unit. For more
SetOrientationFromAngles	The rotation is the angles in x, y and z of the rotation. The default unit is dega.
SetOrientationFromAngleAndVector	The rotation uses the angle and a vector, using unit and changes the orientation mode to
SetOrientationFromBasisVector	Sets the rotation using three basis vector and changes the orientation mode to Basis Vector.
GetOrientationFromAngles	Get the current orientation in the form of angles.
GetOrientationFromAngleAndVector	Get the current orientation in the form of an angle and a vector.
GetOrientationFromBasisVector	Get the current orientation in the form of three basis vectors.
GetCapillaryFrictionCoefficient	Get the value of “Capillary Friction Coefficient”.
SetCapillaryFrictionCoefficient	Set the value of “Capillary Friction Coefficient”.
GetDisableTime	Get the value of “Disable Time”.
SetDisableTime	Set the value of “Disable Time”.
GetEnableTime	Get the value of “Enable Time”.
SetEnableTime	Set the value of “Enable Time”.
GetPivotPoint	Get the value of “Pivot Point”.
SetPivotPoint	Set the values of “Pivot Point”.
GetTemperature	Get the value of “Temperature”.
SetTemperature	Set the value of “Temperature”.
GetThermalBoundaryConditionType	Get “Thermal Boundary Condition Type” as a string.
SetThermalBoundaryConditionType	Set the value of “Thermal Boundary Condition Type”.
GetValidThermalBoundaryConditionTypeValues	Get a list of all possible values for “Thermal Boundary Condition Type”.
GetTranslation	Get the value of “Translation”.
SetTranslation	Set the values of “Translation”.
GetTriangleSize	Get the value of “Triangle Size”.
SetTriangleSize	Set the value of “Triangle Size”.
GetBoundaryMass	Get the value of “Boundary Mass”.
SetBoundaryMass	Set the value of “Boundary Mass”.
GetGravityCenter	Get the value of “Gravity Center”.
SetGravityCenter	Set the values of “Gravity Center”.
GetMomentXDirection	Get the value of “Moment X Direction”.
SetMomentXDirection	Set the values of “Moment X Direction”.
GetMomentYDirection	Get the value of “Moment Y Direction”.
SetMomentYDirection	Set the values of “Moment Y Direction”.
GetMomentZDirection	Get the value of “Moment Z Direction”.
SetMomentZDirection	Set the values of “Moment Z Direction”.
GetPrincipalMomentOfInertia	Get the value of “Principal Moment of Inertia”.
SetPrincipalMomentOfInertia	Set the values of “Principal Moment of Inertia”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetPeriodicReplication	Get the value of “Periodic Replication”.
SetPeriodicReplication	Set the value of “Periodic Replication”.
GetNumberOfReplications	Get the value of “Number of Replications”.
SetNumberOfReplications	Set the value of “Number of Replications”.
GetReplicateGeometry	Get the value of “Replicate Geometry”.
SetReplicateGeometry	Set the value of “Replicate Geometry”.
GetReplicateTime	Get the value of “Replicate Time”.
SetReplicateTime	Set the value of “Replicate Time”.
GetSphBoundaryType	Get “Sph Boundary Type” as a string.
SetSphBoundaryType	Set the value of “Sph Boundary Type”.
GetValidSphBoundaryTypeValues	Get a list of all possible values for “Sph Boundary Type”.
GetSurfaceTensionContactAngle	Get the value of “Surface Tension Contact Angle”.
SetSurfaceTensionContactAngle	Set the value of “Surface Tension Contact Angle”.
GetVolumeShearWorkRatio	Get the value of “Volume Shear Work Ratio”.
SetVolumeShearWorkRatio	Set the value of “Volume Shear Work Ratio”.
GetWearModel	Get “Wear Model” as a string.
SetWearModel	Set the value of “Wear Model”.
GetValidWearModelValues	Get a list of all possible values for “Wear Model”.
GetMaterial	Get the “Material”.
SetMaterial	Set the “Material”.
GetAvailableMaterials	Get all available Materials.

Import detail

from ansys.rocky.app.ra_wall import RAWall

Method detail

classmethod RAWall.GetWrappedClass()

classmethod RAWall.GetClassName() → str

RAWall.LoadFile(file_path: str, import_scale: float = 1.0, convert_yz: bool = False) → None

Replace the geometry representation for a new one contained on a file.

Parameters:

• file_path – The file path of the STL, DXF or XGL file to import.

• import_scale – The import scale to be applied to the imported geometry.

• convert_yz – Whether the y and z axes of the imported geometry should be converted.

RAWall.HasMotionFrame() → bool

Whether the boundary is linked to a motion frame.

Returns:

True if boundary is linked to a motion frame False otherwise

RAWall.GetOrientation(unit: str = ...) → rocky30.base_types.Tuple3F

Get the orientation angles. For more specific cases, see: “GetOrientationFromAngles”, “GetOrientationFromAngleAndVector” and “GetOrientationFromBasisVector”.

RAWall.SetOrientation(rotation: rocky30.base_types.Tuple3F, unit: str = ...) → None

The rotation is the angles in x, y and z of the rotation in the given unit. For more specific methods, see: “SetOrientationFromAngles”, “SetOrientationFromAngleAndVector” and “SetOrientationFromBasisVector”.

RAWall.SetOrientationFromAngles(rotation: rocky30.base_types.Tuple3F, unit: str = ..., local_angles: bool = True, order: str = 'XYZ') → None

The rotation is the angles in x, y and z of the rotation. The default unit is dega. Additionally, local_angles can be used as well an order of the values via kwargs.

RAWall.SetOrientationFromAngleAndVector(angle: float, vector: rocky30.base_types.Tuple3F, unit: str = ...) → None

The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector.

RAWall.SetOrientationFromBasisVector(vector_x: rocky30.base_types.Tuple3F, vector_y: rocky30.base_types.Tuple3F, vector_z: rocky30.base_types.Tuple3F) → None

Sets the rotation using three basis vector and changes the orientation mode to Basis Vector.

RAWall.GetOrientationFromAngles(unit: str = ...) → rocky30.base_types.Tuple3F

Get the current orientation in the form of angles.

RAWall.GetOrientationFromAngleAndVector(unit: str = ...) → tuple[float, rocky30.base_types.Tuple3F]

Get the current orientation in the form of an angle and a vector.

RAWall.GetOrientationFromBasisVector() → tuple[rocky30.base_types.Tuple3F, rocky30.base_types.Tuple3F, rocky30.base_types.Tuple3F]

Get the current orientation in the form of three basis vectors.

RAWall.GetCapillaryFrictionCoefficient() → float

Get the value of “Capillary Friction Coefficient”.

RAWall.SetCapillaryFrictionCoefficient(value: str | float) → None

Set the value of “Capillary Friction Coefficient”.

Parameters:

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

RAWall.GetDisableTime(unit: str | None = None) → float

Get the value of “Disable Time”.

Parameters:

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

RAWall.SetDisableTime(value: str | float, unit: str | None = None) → None

Set the value of “Disable Time”.

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

RAWall.GetEnableTime(unit: str | None = None) → float

Get the value of “Enable Time”.

Parameters:

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

RAWall.SetEnableTime(value: str | float, unit: str | None = None) → None

Set the value of “Enable Time”.

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

RAWall.GetPivotPoint(unit: str | None = None) → list[float]

Get the value of “Pivot Point”.

Parameters:

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

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

Set the values of “Pivot Point”.

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.

RAWall.GetTemperature(unit: str | None = None) → float

Get the value of “Temperature”.

Parameters:

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

RAWall.SetTemperature(value: str | float, unit: str | None = None) → None

Set the value of “Temperature”.

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

RAWall.GetThermalBoundaryConditionType() → str

Get “Thermal Boundary Condition Type” as a string.

Returns:

The returned value will be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’].

RAWall.SetThermalBoundaryConditionType(value: str) → None

Set the value of “Thermal Boundary Condition Type”.

Parameters:

value – The value to set. Must be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’].

Raises:

RockyApiError – If value is not a valid “Thermal Boundary Condition Type” option.

RAWall.GetValidThermalBoundaryConditionTypeValues() → list[str]

Get a list of all possible values for “Thermal Boundary Condition Type”.

Returns:

The returned list is [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’].

RAWall.GetTranslation(unit: str | None = None) → list[float]

Get the value of “Translation”.

Parameters:

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

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

Set the values of “Translation”.

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.

RAWall.GetTriangleSize(unit: str | None = None) → float

Get the value of “Triangle Size”.

Parameters:

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

RAWall.SetTriangleSize(value: str | float, unit: str | None = None) → None

Set the value of “Triangle Size”.

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

RAWall.GetBoundaryMass(unit: str | None = None) → float

Get the value of “Boundary Mass”.

Parameters:

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

RAWall.SetBoundaryMass(value: str | float, unit: str | None = None) → None

Set the value of “Boundary Mass”.

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

RAWall.GetGravityCenter(unit: str | None = None) → list[float]

Get the value of “Gravity Center”.

Parameters:

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

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

Set the values of “Gravity Center”.

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.

RAWall.GetMomentXDirection() → list[float]

Get the value of “Moment X Direction”.

RAWall.SetMomentXDirection(values: list[str | float]) → None

Set the values of “Moment X Direction”.

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.

Raises:

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

RAWall.GetMomentYDirection() → list[float]

Get the value of “Moment Y Direction”.

RAWall.SetMomentYDirection(values: list[str | float]) → None

Set the values of “Moment Y Direction”.

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.

Raises:

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

RAWall.GetMomentZDirection() → list[float]

Get the value of “Moment Z Direction”.

RAWall.SetMomentZDirection(values: list[str | float]) → None

Set the values of “Moment Z Direction”.

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.

Raises:

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

RAWall.GetPrincipalMomentOfInertia(unit: str | None = None) → list[float]

Get the value of “Principal Moment of Inertia”.

Parameters:

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

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

Set the values of “Principal Moment of Inertia”.

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 “kg.m2”.

Raises:

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

RAWall.GetName() → str

Get the value of “Name”.

RAWall.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAWall.GetPeriodicReplication() → bool

Get the value of “Periodic Replication”.

RAWall.SetPeriodicReplication(value: bool) → None

Set the value of “Periodic Replication”.

Parameters:

value – The value to set.

RAWall.GetNumberOfReplications() → int

Get the value of “Number of Replications”.

RAWall.SetNumberOfReplications(value: str | int) → None

Set the value of “Number of Replications”.

Parameters:

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

RAWall.GetReplicateGeometry() → bool

Get the value of “Replicate Geometry”.

RAWall.SetReplicateGeometry(value: bool) → None

Set the value of “Replicate Geometry”.

Parameters:

value – The value to set.

RAWall.GetReplicateTime(unit: str | None = None) → float

Get the value of “Replicate Time”.

Parameters:

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

RAWall.SetReplicateTime(value: str | float, unit: str | None = None) → None

Set the value of “Replicate Time”.

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

RAWall.GetSphBoundaryType() → str

Get “Sph Boundary Type” as a string.

Returns:

The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’].

RAWall.SetSphBoundaryType(value: str) → None

Set the value of “Sph Boundary Type”.

Parameters:

value – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’].

Raises:

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

RAWall.GetValidSphBoundaryTypeValues() → list[str]

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

Returns:

The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’].

RAWall.GetSurfaceTensionContactAngle(unit: str | None = None) → float

Get the value of “Surface Tension Contact Angle”.

Parameters:

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

RAWall.SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) → None

Set the value of “Surface Tension Contact 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”.

RAWall.GetVolumeShearWorkRatio(unit: str | None = None) → float

Get the value of “Volume Shear Work Ratio”.

Parameters:

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

RAWall.SetVolumeShearWorkRatio(value: str | float, unit: str | None = None) → None

Set the value of “Volume Shear Work Ratio”.

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 “m3/J”.

RAWall.GetWearModel() → str

Get “Wear Model” as a string.

Returns:

The returned value will be one of [‘none’, ‘archard’, ‘custom’].

RAWall.SetWearModel(value: str) → None

Set the value of “Wear Model”.

Parameters:

value – The value to set. Must be one of [‘none’, ‘archard’, ‘custom’].

Raises:

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

RAWall.GetValidWearModelValues() → list[str]

Get a list of all possible values for “Wear Model”.

Returns:

The returned list is [‘none’, ‘archard’, ‘custom’].

RAWall.GetMaterial()

Get the “Material”.

Return type:

RASolidMaterial

RAWall.SetMaterial(value) → None

Set the “Material”.

:param unicode, RASolidMaterial value:

Either the API object wrapping the desired entity or its name.

RAWall.GetAvailableMaterials()

Get all available Materials.

Return type:

List[RASolidMaterial] A list of RASolidMaterial.