RACoupledWall

class ansys.rocky.app.ra_coupled_wall.RACoupledWall

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

HasMotionFrame	Whether the boundary is linked to a motion frame.
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”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetMaterial	Get the “Material”.
SetMaterial	Set the “Material”.
GetAvailableMaterials	Get all available Materials.

Import detail

from ansys.rocky.app.ra_coupled_wall import RACoupledWall

Method detail

classmethod RACoupledWall.GetWrappedClass() → type[object]

classmethod RACoupledWall.GetClassName() → str

RACoupledWall.HasMotionFrame() → bool

Whether the boundary is linked to a motion frame.

Returns:

True if boundary is linked to a motion frame False otherwise

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

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

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

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

RACoupledWall.GetName() → str

Get the value of “Name”.

RACoupledWall.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RACoupledWall.GetMaterial()

Get the “Material”.

Return type:

RASolidMaterial

RACoupledWall.SetMaterial(value) → None

Set the “Material”.

:param unicode, RASolidMaterial value:

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

RACoupledWall.GetAvailableMaterials()

Get all available Materials.

Return type:

List[RASolidMaterial] A list of RASolidMaterial.