RAParticleAssemblyCustom

class ansys.rocky.app.ra_particle_assembly.RAParticleAssemblyCustom(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Base wrapper class for all subjects.

Variables:

• id (unicode) – The id of the subject

• _model_id (unicode) – The id of the input reader associated with the subject

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetMomentOfInertia	Deprecated: Use GetPrincipalMomentOfInertia() instead.
SetMomentOfInertia	Deprecated: Use SetPrincipalMomentOfInertia() instead.
GetArea	Get the value of “Area”.
SetArea	Set the value of “Area”.
GetCenterOfMass	Get the value of “Center of Mass”.
SetCenterOfMass	Set the values of “Center of Mass”.
GetEnabled	Get the value of “Enabled”.
SetEnabled	Set the value of “Enabled”.
GetGeometricCenter	Get the value of “Geometric Center”.
SetGeometricCenter	Set the values of “Geometric Center”.
GetInertiaXAxis	Get the value of “Inertia X Axis”.
SetInertiaXAxis	Set the values of “Inertia X Axis”.
GetInertiaYAxis	Get the value of “Inertia Y Axis”.
SetInertiaYAxis	Set the values of “Inertia Y Axis”.
GetInertiaZAxis	Get the value of “Inertia Z Axis”.
SetInertiaZAxis	Set the values of “Inertia Z Axis”.
GetMass	Get the value of “Mass”.
SetMass	Set the value of “Mass”.
GetPrincipalMomentOfInertia	Get the value of “Principal Moment of Inertia”.
SetPrincipalMomentOfInertia	Set the values of “Principal Moment of Inertia”.
GetPorosity	Get the value of “Porosity”.
SetPorosity	Set the value of “Porosity”.
GetVolume	Get the value of “Volume”.
SetVolume	Set the value of “Volume”.

Import detail

from ansys.rocky.app.ra_particle_assembly import RAParticleAssemblyCustom

Method detail

classmethod RAParticleAssemblyCustom.GetWrappedClass() → type[rocky30.models.particle.particle_assembly.ParticleAssemblyCustom]

classmethod RAParticleAssemblyCustom.GetClassName()

RAParticleAssemblyCustom.GetMomentOfInertia(unit: str | None = None) → list[float]

Deprecated: Use GetPrincipalMomentOfInertia() instead.

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

Deprecated: Use SetPrincipalMomentOfInertia() instead.

RAParticleAssemblyCustom.GetArea(unit: str | None = None) → float

Get the value of “Area”.

Parameters:

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

RAParticleAssemblyCustom.SetArea(value: str | float, unit: str | None = None) → None

Set the value of “Area”.

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

RAParticleAssemblyCustom.GetCenterOfMass(unit: str | None = None) → list[float]

Get the value of “Center of Mass”.

Parameters:

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

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

Set the values of “Center of Mass”.

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.

RAParticleAssemblyCustom.GetEnabled() → bool

Get the value of “Enabled”.

RAParticleAssemblyCustom.SetEnabled(value: bool) → None

Set the value of “Enabled”.

Parameters:

value – The value to set.

RAParticleAssemblyCustom.GetGeometricCenter(unit: str | None = None) → list[float]

Get the value of “Geometric Center”.

Parameters:

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

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

Set the values of “Geometric 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.

RAParticleAssemblyCustom.GetInertiaXAxis(unit: str | None = None) → list[float]

Get the value of “Inertia X Axis”.

Parameters:

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

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

Set the values of “Inertia X Axis”.

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

Raises:

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

RAParticleAssemblyCustom.GetInertiaYAxis(unit: str | None = None) → list[float]

Get the value of “Inertia Y Axis”.

Parameters:

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

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

Set the values of “Inertia Y Axis”.

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

Raises:

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

RAParticleAssemblyCustom.GetInertiaZAxis(unit: str | None = None) → list[float]

Get the value of “Inertia Z Axis”.

Parameters:

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

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

Set the values of “Inertia Z Axis”.

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

Raises:

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

RAParticleAssemblyCustom.GetMass(unit: str | None = None) → float

Get the value of “Mass”.

Parameters:

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

RAParticleAssemblyCustom.SetMass(value: str | float, unit: str | None = None) → None

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

RAParticleAssemblyCustom.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 “m5”.

RAParticleAssemblyCustom.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 “m5”.

Raises:

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

RAParticleAssemblyCustom.GetPorosity(unit: str | None = None) → float

Get the value of “Porosity”.

Parameters:

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

RAParticleAssemblyCustom.SetPorosity(value: str | float, unit: str | None = None) → None

Set the value of “Porosity”.

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

RAParticleAssemblyCustom.GetVolume(unit: str | None = None) → float

Get the value of “Volume”.

Parameters:

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

RAParticleAssemblyCustom.SetVolume(value: str | float, unit: str | None = None) → None

Set the value of “Volume”.

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