RASystemCouplingWall

class ansys.rocky.app.ra_system_coupling_wall.RASystemCouplingWall

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

Rocky API “System Coupling Wall” model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

HasMotionFrame	Whether the geometry is linked to a motion frame.
GetCapillaryFrictionCoefficient	Get the value of “Capillary Friction Coefficient”.
SetCapillaryFrictionCoefficient	Set the value of “Capillary Friction Coefficient”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
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”.
GetStructuralCouplingTypeEnabled	Get the value of “Structural Coupling Type Enabled”.
SetStructuralCouplingTypeEnabled	Set the value of “Structural Coupling Type Enabled”.
EnableStructuralCouplingType	Set the value of “Structural Coupling Type” to True.
DisableStructuralCouplingType	Set the value of “Structural Coupling Type” to False.
IsStructuralCouplingTypeEnabled	Check if the “Structural Coupling Type” is enabled.
GetSurfaceTensionContactAngle	Get the value of “Surface Tension Contact Angle”.
SetSurfaceTensionContactAngle	Set the value of “Surface Tension Contact Angle”.
GetThermalCouplingTypeEnabled	Get the value of “Thermal Coupling Type Enabled”.
SetThermalCouplingTypeEnabled	Set the value of “Thermal Coupling Type Enabled”.
EnableThermalCouplingType	Set the value of “Thermal Coupling Type” to True.
DisableThermalCouplingType	Set the value of “Thermal Coupling Type” to False.
IsThermalCouplingTypeEnabled	Check if the “Thermal Coupling Type” is enabled.
GetTriangleSize	Get the value of “Triangle Size”.
SetTriangleSize	Set the value of “Triangle Size”.
GetMaterial	Get the “Material”.
SetMaterial	Set the “Material”.
GetAvailableMaterials	Get all available Materials.

Import detail

from ansys.rocky.app.ra_system_coupling_wall import RASystemCouplingWall

Method detail

classmethod RASystemCouplingWall.GetWrappedClass() → type[object]

classmethod RASystemCouplingWall.GetClassName() → str

RASystemCouplingWall.HasMotionFrame() → bool

Whether the geometry is linked to a motion frame.

Returns:

True if geometry is linked to a motion frame False otherwise

RASystemCouplingWall.GetCapillaryFrictionCoefficient() → float

Get the value of “Capillary Friction Coefficient”.

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

RASystemCouplingWall.GetName() → str

Get the value of “Name”.

RASystemCouplingWall.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RASystemCouplingWall.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’].

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

RASystemCouplingWall.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’].

RASystemCouplingWall.GetStructuralCouplingTypeEnabled() → bool

Get the value of “Structural Coupling Type Enabled”.

RASystemCouplingWall.SetStructuralCouplingTypeEnabled(value: bool) → None

Set the value of “Structural Coupling Type Enabled”.

Parameters:

value – The value to set.

RASystemCouplingWall.EnableStructuralCouplingType() → None

Set the value of “Structural Coupling Type” to True.

RASystemCouplingWall.DisableStructuralCouplingType() → None

Set the value of “Structural Coupling Type” to False.

RASystemCouplingWall.IsStructuralCouplingTypeEnabled() → bool

Check if the “Structural Coupling Type” is enabled.

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

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

RASystemCouplingWall.GetThermalCouplingTypeEnabled() → bool

Get the value of “Thermal Coupling Type Enabled”.

RASystemCouplingWall.SetThermalCouplingTypeEnabled(value: bool) → None

Set the value of “Thermal Coupling Type Enabled”.

Parameters:

value – The value to set.

RASystemCouplingWall.EnableThermalCouplingType() → None

Set the value of “Thermal Coupling Type” to True.

RASystemCouplingWall.DisableThermalCouplingType() → None

Set the value of “Thermal Coupling Type” to False.

RASystemCouplingWall.IsThermalCouplingTypeEnabled() → bool

Check if the “Thermal Coupling Type” is enabled.

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

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

RASystemCouplingWall.GetMaterial()

Get the “Material”.

Return type:

RASolidMaterial

RASystemCouplingWall.SetMaterial(value) → None

Set the “Material”.

:param unicode, RASolidMaterial value:

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

RASystemCouplingWall.GetAvailableMaterials()

Get all available Materials.

Return type:

List[RASolidMaterial] A list of RASolidMaterial.