:class:`RAParticle` =================== .. py:class:: ansys.rocky.app.ra_particle.RAParticle Bases: :py:obj:`ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem`, :py:obj:`ansys.rocky.app.ra_addins.ElementWithAddins`, :py:obj:`ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin` Rocky PrePost Scripting wrapper for a particle in the project. The wrapper corresponds to an individual Particle entry in the project's data tree, below the "Particles" item. Particles can be retrieved from the :class:`RAStudy` or the :class:`RAParticleCollection` via: .. code-block:: python particle_1 = study.GetElement('Particle 1') particle_2 = particle_collection[1] particle_3 = particle_collection.GetParticle('Particle 3') Most particle properties, such as name, shape, aspect ratios, etc can be set directly via methods in this wrapper class. An exception is size-related methods, which must be configured via the :class:`RASizeDistributionList` returned in :meth:`GetSizeDistributionList()`. .. !! processed by numpydoc !! .. py:currentmodule:: RAParticle Overview -------- .. tab-set:: .. tab-item:: Constructors .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~GetWrappedClass` - * - :py:attr:`~GetClassName` - .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ImportFromSTL` - Import a custom shape from the given stl filename into this particle. * - :py:attr:`~ImportCustomFiber` - Import a custom fiber shape from the given filename into this particle. * - :py:attr:`~GetSizeDistributionList` - Get a list of size distribution entries * - :py:attr:`~GetUseMultipleElements` - Whether the particle's Composition is "Multiple Elements". * - :py:attr:`~SetUseMultipleElements` - Set the particle's Composition to "Multiple Elements" (True) or "Single Elements" (False). * - :py:attr:`~IsConcave` - Returns True if the particle is a concave custom polyhedron, and False otherwise. * - :py:attr:`~GetBreakageModel` - This docstring is overridden by the _GetBreakageModel's at the end of the file. * - :py:attr:`~GetValidBreakageModelValues` - This docstring is overridden by the _GetValidBreakageModelValues's at the end of the file. * - :py:attr:`~SetBreakageModel` - Set the value of "Breakage Model". * - :py:attr:`~GetAssemblyParts` - * - :py:attr:`~GetAssemblyCustom` - Deprecated: Use :meth:`GetCustomProperties()` instead. * - :py:attr:`~GetCustomProperties` - * - :py:attr:`~GetAbt10MaximumT10Value` - Get the value of "Abt10 Maximum T10 Value". * - :py:attr:`~SetAbt10MaximumT10Value` - Set the value of "Abt10 Maximum T10 Value". * - :py:attr:`~GetAbt10ReferenceMinimumSpecificEnergy` - Get the value of "Abt10 Reference Minimum Specific Energy". * - :py:attr:`~SetAbt10ReferenceMinimumSpecificEnergy` - Set the value of "Abt10 Reference Minimum Specific Energy". * - :py:attr:`~GetAbt10MinimumSpecificEnergy` - Deprecated: Use :meth:`GetAbt10ReferenceMinimumSpecificEnergy()` instead. * - :py:attr:`~SetAbt10MinimumSpecificEnergy` - Deprecated: Use :meth:`SetAbt10ReferenceMinimumSpecificEnergy()` instead. * - :py:attr:`~GetAbt10ReferenceSize` - Get the value of "Abt10 Reference Size". * - :py:attr:`~SetAbt10ReferenceSize` - Set the value of "Abt10 Reference Size". * - :py:attr:`~GetAbt10SelectFunctionCoefficient` - Get the value of "Abt10 Select Function Coefficient". * - :py:attr:`~SetAbt10SelectFunctionCoefficient` - Set the value of "Abt10 Select Function Coefficient". * - :py:attr:`~GetDistributionModel` - Get "Distribution Model" as a string. * - :py:attr:`~SetDistributionModel` - Set the value of "Distribution Model". * - :py:attr:`~GetValidDistributionModelValues` - Get a list of all possible values for "Distribution Model". * - :py:attr:`~GetSurfaceEnergy` - Get the value of "Surface Energy". * - :py:attr:`~SetSurfaceEnergy` - Set the value of "Surface Energy". * - :py:attr:`~GetIncludeRotationalDeformations` - Get the value of "Include Rotational Deformations". * - :py:attr:`~SetIncludeRotationalDeformations` - Set the value of "Include Rotational Deformations". * - :py:attr:`~EnableIncludeRotationalDeformations` - Set the value of "Include Rotational Deformations" to True. * - :py:attr:`~DisableIncludeRotationalDeformations` - Set the value of "Include Rotational Deformations" to False. * - :py:attr:`~IsIncludeRotationalDeformationsEnabled` - Check if the "Include Rotational Deformations" is enabled. * - :py:attr:`~GetMinimumSize` - Get the value of "Minimum Size". * - :py:attr:`~SetMinimumSize` - Set the value of "Minimum Size". * - :py:attr:`~GetMinimumSizeRatio` - Get the value of "Minimum Size Ratio". * - :py:attr:`~SetMinimumSizeRatio` - Set the value of "Minimum Size Ratio". * - :py:attr:`~GetMinimumVolumeFractionForFragmentDisabling` - Get the value of "Minimum Volume Fraction For Fragment Disabling". * - :py:attr:`~SetMinimumVolumeFractionForFragmentDisabling` - Set the value of "Minimum Volume Fraction For Fragment Disabling". * - :py:attr:`~GetTavaresA` - Get the value of "Tavares A". * - :py:attr:`~SetTavaresA` - Set the value of "Tavares A". * - :py:attr:`~GetTavaresB` - Get the value of "Tavares B". * - :py:attr:`~SetTavaresB` - Set the value of "Tavares B". * - :py:attr:`~GetTavaresD0` - Get the value of "Tavares D0". * - :py:attr:`~SetTavaresD0` - Set the value of "Tavares D0". * - :py:attr:`~GetTavaresEInf` - Get the value of "Tavares E Inf". * - :py:attr:`~SetTavaresEInf` - Set the value of "Tavares E Inf". * - :py:attr:`~GetTavaresGamma` - Get the value of "Tavares Gamma". * - :py:attr:`~SetTavaresGamma` - Set the value of "Tavares Gamma". * - :py:attr:`~GetTavaresMinimumEnergy` - Get the value of "Tavares Minimum Energy". * - :py:attr:`~SetTavaresMinimumEnergy` - Set the value of "Tavares Minimum Energy". * - :py:attr:`~GetTavaresPhi` - Get the value of "Tavares Phi". * - :py:attr:`~SetTavaresPhi` - Set the value of "Tavares Phi". * - :py:attr:`~GetTavaresRatioEmax` - Get the value of "Tavares Ratio Emax". * - :py:attr:`~SetTavaresRatioEmax` - Set the value of "Tavares Ratio Emax". * - :py:attr:`~GetRatioEnergyAfterBreakage` - Get the value of "Ratio Energy After Breakage". * - :py:attr:`~SetRatioEnergyAfterBreakage` - Set the value of "Ratio Energy After Breakage". * - :py:attr:`~GetTavaresSigmaSquared` - Get the value of "Tavares Sigma Squared". * - :py:attr:`~SetTavaresSigmaSquared` - Set the value of "Tavares Sigma Squared". * - :py:attr:`~GetT10Formula` - Get "T10 Formula" as a string. * - :py:attr:`~SetT10Formula` - Set the value of "T10 Formula". * - :py:attr:`~GetValidT10FormulaValues` - Get a list of all possible values for "T10 Formula". * - :py:attr:`~GetShearStressLimit` - Get the value of "Shear Stress Limit". * - :py:attr:`~SetShearStressLimit` - Set the value of "Shear Stress Limit". * - :py:attr:`~GetTensileStressLimit` - Get the value of "Tensile Stress Limit". * - :py:attr:`~SetTensileStressLimit` - Set the value of "Tensile Stress Limit". * - :py:attr:`~GetEnableBreakage` - Get the value of "Enable Breakage". * - :py:attr:`~SetEnableBreakage` - Set the value of "Enable Breakage". * - :py:attr:`~EnableBreakage` - Set the value of "Breakage" to True. * - :py:attr:`~DisableBreakage` - Set the value of "Breakage" to False. * - :py:attr:`~IsBreakageEnabled` - Check if the "Breakage" is enabled. * - :py:attr:`~GetVonMisesStressLimit` - Get the value of "Von Mises Stress Limit". * - :py:attr:`~SetVonMisesStressLimit` - Set the value of "Von Mises Stress Limit". * - :py:attr:`~GetAllowSelfContacts` - Get the value of "Allow Self Contacts". * - :py:attr:`~SetAllowSelfContacts` - Set the value of "Allow Self Contacts". * - :py:attr:`~GetDeformationModel` - Get "Deformation Model" as a string. * - :py:attr:`~SetDeformationModel` - Set the value of "Deformation Model". * - :py:attr:`~GetValidDeformationModelValues` - Get a list of all possible values for "Deformation Model". * - :py:attr:`~GetInternalFriction` - Get the value of "Internal Friction". * - :py:attr:`~SetInternalFriction` - Set the value of "Internal Friction". * - :py:attr:`~GetPlasticLimit` - Get the value of "Plastic Limit". * - :py:attr:`~SetPlasticLimit` - Set the value of "Plastic Limit". * - :py:attr:`~GetFlexible` - Get the value of "Flexible". * - :py:attr:`~SetFlexible` - Set the value of "Flexible". * - :py:attr:`~GetCenterOfMassOffset` - Get the value of "Center of Mass Offset". * - :py:attr:`~SetCenterOfMassOffset` - Set the values of "Center of Mass Offset". * - :py:attr:`~GetChangeMassProperties` - Get the value of "Change Mass Properties". * - :py:attr:`~SetChangeMassProperties` - Set the value of "Change Mass Properties". * - :py:attr:`~GetEnableRotations` - Get the value of "Enable Rotations". * - :py:attr:`~SetEnableRotations` - Set the value of "Enable Rotations". * - :py:attr:`~GetHorizontalAspectRatio` - Get the value of "Horizontal Aspect Ratio". * - :py:attr:`~SetHorizontalAspectRatio` - Set the value of "Horizontal Aspect Ratio". * - :py:attr:`~GetPrincipalMomentOfInertia` - Get the value of "Principal Moment of Inertia". * - :py:attr:`~SetPrincipalMomentOfInertia` - Set the values of "Principal Moment of Inertia". * - :py:attr:`~GetNumberOfCorners` - Get the value of "Number of Corners". * - :py:attr:`~SetNumberOfCorners` - Set the value of "Number of Corners". * - :py:attr:`~GetXDirection` - Get the value of "X Direction". * - :py:attr:`~SetXDirection` - Set the values of "X Direction". * - :py:attr:`~GetYDirection` - Get the value of "Y Direction". * - :py:attr:`~SetYDirection` - Set the values of "Y Direction". * - :py:attr:`~GetZDirection` - Get the value of "Z Direction". * - :py:attr:`~SetZDirection` - Set the values of "Z Direction". * - :py:attr:`~GetRollingResistance` - Get the value of "Rolling Resistance". * - :py:attr:`~SetRollingResistance` - Set the value of "Rolling Resistance". * - :py:attr:`~GetSideAngle` - Get the value of "Side Angle". * - :py:attr:`~SetSideAngle` - Set the value of "Side Angle". * - :py:attr:`~GetSmoothness` - Get the value of "Smoothness". * - :py:attr:`~SetSmoothness` - Set the value of "Smoothness". * - :py:attr:`~GetSuperquadricDegree` - Get the value of "Superquadric Degree". * - :py:attr:`~SetSuperquadricDegree` - Set the value of "Superquadric Degree". * - :py:attr:`~GetThickness` - Get the value of "Thickness". * - :py:attr:`~SetThickness` - Set the value of "Thickness". * - :py:attr:`~GetVerticalAspectRatio` - Get the value of "Vertical Aspect Ratio". * - :py:attr:`~SetVerticalAspectRatio` - Set the value of "Vertical Aspect Ratio". * - :py:attr:`~GetBendingAngleLimit` - Get the value of "Bending Angle Limit". * - :py:attr:`~SetBendingAngleLimit` - Set the value of "Bending Angle Limit". * - :py:attr:`~GetWithFailure` - Get the value of "With Failure". * - :py:attr:`~SetWithFailure` - Set the value of "With Failure". * - :py:attr:`~GetEdgeAngle` - Get the value of "Edge Angle". * - :py:attr:`~SetEdgeAngle` - Set the value of "Edge Angle". * - :py:attr:`~GetElasticRatioBending` - Get the value of "Elastic Ratio Bending". * - :py:attr:`~SetElasticRatioBending` - Set the value of "Elastic Ratio Bending". * - :py:attr:`~GetElasticRatioNormal` - Get the value of "Elastic Ratio Normal". * - :py:attr:`~SetElasticRatioNormal` - Set the value of "Elastic Ratio Normal". * - :py:attr:`~GetElasticRatioTangential` - Get the value of "Elastic Ratio Tangential". * - :py:attr:`~SetElasticRatioTangential` - Set the value of "Elastic Ratio Tangential". * - :py:attr:`~GetElasticRatioTorsion` - Get the value of "Elastic Ratio Torsion". * - :py:attr:`~SetElasticRatioTorsion` - Set the value of "Elastic Ratio Torsion". * - :py:attr:`~GetElasticity` - Get "Elasticity" as a string. * - :py:attr:`~SetElasticity` - Set the value of "Elasticity". * - :py:attr:`~GetValidElasticityValues` - Get a list of all possible values for "Elasticity". * - :py:attr:`~GetTargetNumberOfElements` - Get the value of "Target Number of Elements". * - :py:attr:`~SetTargetNumberOfElements` - Set the value of "Target Number of Elements". * - :py:attr:`~GetElementDampingRatio` - Get the value of "Element Damping Ratio". * - :py:attr:`~SetElementDampingRatio` - Set the value of "Element Damping Ratio". * - :py:attr:`~GetFailureRatio` - Get the value of "Failure Ratio". * - :py:attr:`~SetFailureRatio` - Set the value of "Failure Ratio". * - :py:attr:`~GetJointDampingRatio` - Get the value of "Joint Damping Ratio". * - :py:attr:`~SetJointDampingRatio` - Set the value of "Joint Damping Ratio". * - :py:attr:`~GetJointElasticRatio` - Get the value of "Joint Elastic Ratio". * - :py:attr:`~SetJointElasticRatio` - Set the value of "Joint Elastic Ratio". * - :py:attr:`~GetJointThermalRatio` - Get the value of "Joint Thermal Ratio". * - :py:attr:`~SetJointThermalRatio` - Set the value of "Joint Thermal Ratio". * - :py:attr:`~GetPlasticRatio` - Get the value of "Plastic Ratio". * - :py:attr:`~SetPlasticRatio` - Set the value of "Plastic Ratio". * - :py:attr:`~GetPlasticityModel` - Get "Plasticity Model" as a string. * - :py:attr:`~SetPlasticityModel` - Set the value of "Plasticity Model". * - :py:attr:`~GetValidPlasticityModelValues` - Get a list of all possible values for "Plasticity Model". * - :py:attr:`~GetRemeshToTarget` - Get the value of "Remesh To Target". * - :py:attr:`~SetRemeshToTarget` - Set the value of "Remesh To Target". * - :py:attr:`~GetSecondBendingAngleLimit` - Get the value of "Second Bending Angle Limit". * - :py:attr:`~SetSecondBendingAngleLimit` - Set the value of "Second Bending Angle Limit". * - :py:attr:`~GetTorsionAngleLimit` - Get the value of "Torsion Angle Limit". * - :py:attr:`~SetTorsionAngleLimit` - Set the value of "Torsion Angle Limit". * - :py:attr:`~GetName` - Get the value of "Name". * - :py:attr:`~SetName` - Set the value of "Name". * - :py:attr:`~GetPorosity` - Get the value of "Porosity". * - :py:attr:`~SetPorosity` - Set the value of "Porosity". * - :py:attr:`~GetRandomAnglesHalfRange` - Get the value of "Random Angles Half Range". * - :py:attr:`~SetRandomAnglesHalfRange` - Set the values of "Random Angles Half Range". * - :py:attr:`~GetShape` - Get "Shape" as a string. * - :py:attr:`~SetShape` - Set the value of "Shape". * - :py:attr:`~GetValidShapeValues` - Get a list of all possible values for "Shape". * - :py:attr:`~GetCgmScaleFactor` - Get the value of "Cgm Scale Factor". * - :py:attr:`~SetCgmScaleFactor` - Set the value of "Cgm Scale Factor". * - :py:attr:`~GetSizeType` - Get "Size Type" as a string. * - :py:attr:`~SetSizeType` - Set the value of "Size Type". * - :py:attr:`~GetValidSizeTypeValues` - Get a list of all possible values for "Size Type". * - :py:attr:`~GetEnableRandomAngle` - Get the value of "Enable Random Angle". * - :py:attr:`~SetEnableRandomAngle` - Set the value of "Enable Random Angle". * - :py:attr:`~EnableRandomOrientation` - Set the value of "Random Orientation" to True. * - :py:attr:`~DisableRandomOrientation` - Set the value of "Random Orientation" to False. * - :py:attr:`~IsRandomOrientationEnabled` - Check if the "Random Orientation" is enabled. * - :py:attr:`~GetMaterial` - Get the "Material". * - :py:attr:`~SetMaterial` - Set the "Material". * - :py:attr:`~GetAvailableMaterials` - Get all available Materials. * - :py:attr:`~GetAnisotropic` - Deprecated: Use :meth:`GetElasticity()` instead. * - :py:attr:`~SetAnisotropic` - Set the value of "Anisotropic". Import detail ------------- .. code-block:: python from ansys.rocky.app.ra_particle import RAParticle Method detail ------------- .. py:method:: GetWrappedClass() :classmethod: .. py:method:: GetClassName() -> str :classmethod: .. py:method:: ImportFromSTL(stl_filename: str, as_concave: bool, is_open: bool = False) -> bool Import a custom shape from the given stl filename into this particle. :param stl_filename: The full path to the STL file. :param as_concave: True whether the particle should be treated as Concave, or False otherwise :param is_open: True whether the stl is an open one :returns: Possible return values: * True if everything went fine with the import process. * False if the import process failed. .. !! processed by numpydoc !! .. py:method:: ImportCustomFiber(filename: str) -> bool Import a custom fiber shape from the given filename into this particle. :param filename: The full path to the TXT/CSV/Excel file. :returns: Whether it was possible to import the particle .. !! processed by numpydoc !! .. py:method:: GetSizeDistributionList() -> ansys.rocky.app.ra_size_distribution.RASizeDistributionList Get a list of size distribution entries .. !! processed by numpydoc !! .. py:method:: GetUseMultipleElements() -> bool Whether the particle's Composition is "Multiple Elements". .. !! processed by numpydoc !! .. py:method:: SetUseMultipleElements(value) -> None Set the particle's Composition to "Multiple Elements" (True) or "Single Elements" (False). :param bool value: .. !! processed by numpydoc !! .. py:method:: IsConcave() Returns True if the particle is a concave custom polyhedron, and False otherwise. :rtype: bool .. !! processed by numpydoc !! .. py:method:: GetBreakageModel() -> str This docstring is overridden by the _GetBreakageModel's at the end of the file. .. !! processed by numpydoc !! .. py:method:: GetValidBreakageModelValues() -> list[str] This docstring is overridden by the _GetValidBreakageModelValues's at the end of the file. .. !! processed by numpydoc !! .. py:method:: SetBreakageModel(value: str) -> None Set the value of "Breakage Model". If the particle is not flexible, setting the model to any value other than "none" also enables breakage. :param str value: The value to set. Must be one of ['none', 'ab_t10', 'professor_tavares', 'instantaneous_custom', 'griffith_surface_energy', 'shear_stress_criterion', 'tensile_stress_criterion', 'tensile_or_shear_criterion', 'von_mises_stress_criterion', 'discrete_custom']. :raises RockyApiError: If `value` is not a valid "Breakage Model" option. .. !! processed by numpydoc !! .. py:method:: GetAssemblyParts() -> ansys.rocky.app.ra_particle_assembly.RAParticleAssemblyPartList .. py:method:: GetAssemblyCustom() -> ansys.rocky.app.ra_particle_assembly.RAParticleAssemblyCustom Deprecated: Use :meth:`GetCustomProperties()` instead. .. !! processed by numpydoc !! .. py:method:: GetCustomProperties() -> ansys.rocky.app.ra_particle_assembly.RAParticleAssemblyCustom .. py:method:: GetAbt10MaximumT10Value(unit: str | None = None) -> float Get the value of "Abt10 Maximum T10 Value". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "%". .. !! processed by numpydoc !! .. py:method:: SetAbt10MaximumT10Value(value: str | float, unit: str | None = None) -> None Set the value of "Abt10 Maximum T10 Value". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "%". .. !! processed by numpydoc !! .. py:method:: GetAbt10ReferenceMinimumSpecificEnergy(unit: str | None = None) -> float Get the value of "Abt10 Reference Minimum Specific Energy". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/kg". .. !! processed by numpydoc !! .. py:method:: SetAbt10ReferenceMinimumSpecificEnergy(value: str | float, unit: str | None = None) -> None Set the value of "Abt10 Reference Minimum Specific Energy". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "J/kg". .. !! processed by numpydoc !! .. py:method:: GetAbt10MinimumSpecificEnergy(unit: str | None = None) -> float Deprecated: Use :meth:`GetAbt10ReferenceMinimumSpecificEnergy()` instead. :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/kg". .. !! processed by numpydoc !! .. py:method:: SetAbt10MinimumSpecificEnergy(value: float, unit: str | None = None) -> None Deprecated: Use :meth:`SetAbt10ReferenceMinimumSpecificEnergy()` instead. :param value: The value to set. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "J/kg". .. !! processed by numpydoc !! .. py:method:: GetAbt10ReferenceSize(unit: str | None = None) -> float Get the value of "Abt10 Reference Size". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m". .. !! processed by numpydoc !! .. py:method:: SetAbt10ReferenceSize(value: str | float, unit: str | None = None) -> None Set the value of "Abt10 Reference Size". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m". .. !! processed by numpydoc !! .. py:method:: GetAbt10SelectFunctionCoefficient(unit: str | None = None) -> float Get the value of "Abt10 Select Function Coefficient". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "kg/J". .. !! processed by numpydoc !! .. py:method:: SetAbt10SelectFunctionCoefficient(value: str | float, unit: str | None = None) -> None Set the value of "Abt10 Select Function Coefficient". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "kg/J". .. !! processed by numpydoc !! .. py:method:: GetDistributionModel() -> str Get "Distribution Model" as a string. :return: The returned value will be one of ['gaudin_schumann', 'incomplete_beta', 'custom']. .. !! processed by numpydoc !! .. py:method:: SetDistributionModel(value: str) -> None Set the value of "Distribution Model". :param value: The value to set. Must be one of ['gaudin_schumann', 'incomplete_beta', 'custom']. :raises RockyApiError: If `value` is not a valid "Distribution Model" option. .. !! processed by numpydoc !! .. py:method:: GetValidDistributionModelValues() -> list[str] Get a list of all possible values for "Distribution Model". :return: The returned list is ['gaudin_schumann', 'incomplete_beta', 'custom']. .. !! processed by numpydoc !! .. py:method:: GetSurfaceEnergy(unit: str | None = None) -> float Get the value of "Surface Energy". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/m2". .. !! processed by numpydoc !! .. py:method:: SetSurfaceEnergy(value: str | float, unit: str | None = None) -> None Set the value of "Surface Energy". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "J/m2". .. !! processed by numpydoc !! .. py:method:: GetIncludeRotationalDeformations() -> bool Get the value of "Include Rotational Deformations". .. !! processed by numpydoc !! .. py:method:: SetIncludeRotationalDeformations(value: bool) -> None Set the value of "Include Rotational Deformations". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableIncludeRotationalDeformations() -> None Set the value of "Include Rotational Deformations" to True. .. !! processed by numpydoc !! .. py:method:: DisableIncludeRotationalDeformations() -> None Set the value of "Include Rotational Deformations" to False. .. !! processed by numpydoc !! .. py:method:: IsIncludeRotationalDeformationsEnabled() -> bool Check if the "Include Rotational Deformations" is enabled. .. !! processed by numpydoc !! .. py:method:: GetMinimumSize(unit: str | None = None) -> float Get the value of "Minimum Size". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m". .. !! processed by numpydoc !! .. py:method:: SetMinimumSize(value: str | float, unit: str | None = None) -> None Set the value of "Minimum Size". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m". .. !! processed by numpydoc !! .. py:method:: GetMinimumSizeRatio() -> float Get the value of "Minimum Size Ratio". .. !! processed by numpydoc !! .. py:method:: SetMinimumSizeRatio(value: str | float) -> None Set the value of "Minimum Size Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetMinimumVolumeFractionForFragmentDisabling() -> float Get the value of "Minimum Volume Fraction For Fragment Disabling". .. !! processed by numpydoc !! .. py:method:: SetMinimumVolumeFractionForFragmentDisabling(value: str | float) -> None Set the value of "Minimum Volume Fraction For Fragment Disabling". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetTavaresA(unit: str | None = None) -> float Get the value of "Tavares A". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "%". .. !! processed by numpydoc !! .. py:method:: SetTavaresA(value: str | float, unit: str | None = None) -> None Set the value of "Tavares A". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "%". .. !! processed by numpydoc !! .. py:method:: GetTavaresB(unit: str | None = None) -> float Get the value of "Tavares B". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "-". .. !! processed by numpydoc !! .. py:method:: SetTavaresB(value: str | float, unit: str | None = None) -> None Set the value of "Tavares B". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "-". .. !! processed by numpydoc !! .. py:method:: GetTavaresD0(unit: str | None = None) -> float Get the value of "Tavares D0". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m". .. !! processed by numpydoc !! .. py:method:: SetTavaresD0(value: str | float, unit: str | None = None) -> None Set the value of "Tavares D0". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m". .. !! processed by numpydoc !! .. py:method:: GetTavaresEInf(unit: str | None = None) -> float Get the value of "Tavares E Inf". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/kg". .. !! processed by numpydoc !! .. py:method:: SetTavaresEInf(value: str | float, unit: str | None = None) -> None Set the value of "Tavares E Inf". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "J/kg". .. !! processed by numpydoc !! .. py:method:: GetTavaresGamma(unit: str | None = None) -> float Get the value of "Tavares Gamma". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "-". .. !! processed by numpydoc !! .. py:method:: SetTavaresGamma(value: str | float, unit: str | None = None) -> None Set the value of "Tavares Gamma". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "-". .. !! processed by numpydoc !! .. py:method:: GetTavaresMinimumEnergy(unit: str | None = None) -> float Get the value of "Tavares Minimum Energy". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/kg". .. !! processed by numpydoc !! .. py:method:: SetTavaresMinimumEnergy(value: str | float, unit: str | None = None) -> None Set the value of "Tavares Minimum Energy". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "J/kg". .. !! processed by numpydoc !! .. py:method:: GetTavaresPhi(unit: str | None = None) -> float Get the value of "Tavares Phi". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "-". .. !! processed by numpydoc !! .. py:method:: SetTavaresPhi(value: str | float, unit: str | None = None) -> None Set the value of "Tavares Phi". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "-". .. !! processed by numpydoc !! .. py:method:: GetTavaresRatioEmax(unit: str | None = None) -> float Get the value of "Tavares Ratio Emax". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "-". .. !! processed by numpydoc !! .. py:method:: SetTavaresRatioEmax(value: str | float, unit: str | None = None) -> None Set the value of "Tavares Ratio Emax". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "-". .. !! processed by numpydoc !! .. py:method:: GetRatioEnergyAfterBreakage(unit: str | None = None) -> float Get the value of "Ratio Energy After Breakage". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "-". .. !! processed by numpydoc !! .. py:method:: SetRatioEnergyAfterBreakage(value: str | float, unit: str | None = None) -> None Set the value of "Ratio Energy After Breakage". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "-". .. !! processed by numpydoc !! .. py:method:: GetTavaresSigmaSquared(unit: str | None = None) -> float Get the value of "Tavares Sigma Squared". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "-". .. !! processed by numpydoc !! .. py:method:: SetTavaresSigmaSquared(value: str | float, unit: str | None = None) -> None Set the value of "Tavares Sigma Squared". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "-". .. !! processed by numpydoc !! .. py:method:: GetT10Formula() -> str Get "T10 Formula" as a string. :return: The returned value will be one of ['it10E_50b', 'it10E_fract']. .. !! processed by numpydoc !! .. py:method:: SetT10Formula(value: str) -> None Set the value of "T10 Formula". :param value: The value to set. Must be one of ['it10E_50b', 'it10E_fract']. :raises RockyApiError: If `value` is not a valid "T10 Formula" option. .. !! processed by numpydoc !! .. py:method:: GetValidT10FormulaValues() -> list[str] Get a list of all possible values for "T10 Formula". :return: The returned list is ['it10E_50b', 'it10E_fract']. .. !! processed by numpydoc !! .. py:method:: GetShearStressLimit(unit: str | None = None) -> float Get the value of "Shear Stress Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "N/m2". .. !! processed by numpydoc !! .. py:method:: SetShearStressLimit(value: str | float, unit: str | None = None) -> None Set the value of "Shear Stress Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "N/m2". .. !! processed by numpydoc !! .. py:method:: GetTensileStressLimit(unit: str | None = None) -> float Get the value of "Tensile Stress Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "N/m2". .. !! processed by numpydoc !! .. py:method:: SetTensileStressLimit(value: str | float, unit: str | None = None) -> None Set the value of "Tensile Stress Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "N/m2". .. !! processed by numpydoc !! .. py:method:: GetEnableBreakage() -> bool Get the value of "Enable Breakage". .. !! processed by numpydoc !! .. py:method:: SetEnableBreakage(value: bool) -> None Set the value of "Enable Breakage". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableBreakage() -> None Set the value of "Breakage" to True. .. !! processed by numpydoc !! .. py:method:: DisableBreakage() -> None Set the value of "Breakage" to False. .. !! processed by numpydoc !! .. py:method:: IsBreakageEnabled() -> bool Check if the "Breakage" is enabled. .. !! processed by numpydoc !! .. py:method:: GetVonMisesStressLimit(unit: str | None = None) -> float Get the value of "Von Mises Stress Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "N/m2". .. !! processed by numpydoc !! .. py:method:: SetVonMisesStressLimit(value: str | float, unit: str | None = None) -> None Set the value of "Von Mises Stress Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "N/m2". .. !! processed by numpydoc !! .. py:method:: GetAllowSelfContacts() -> bool Get the value of "Allow Self Contacts". .. !! processed by numpydoc !! .. py:method:: SetAllowSelfContacts(value: bool) -> None Set the value of "Allow Self Contacts". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetDeformationModel() -> str Get "Deformation Model" as a string. :return: The returned value will be one of ['none', 'elastic', 'plastic']. .. !! processed by numpydoc !! .. py:method:: SetDeformationModel(value: str) -> None Set the value of "Deformation Model". :param value: The value to set. Must be one of ['none', 'elastic', 'plastic']. :raises RockyApiError: If `value` is not a valid "Deformation Model" option. .. !! processed by numpydoc !! .. py:method:: GetValidDeformationModelValues() -> list[str] Get a list of all possible values for "Deformation Model". :return: The returned list is ['none', 'elastic', 'plastic']. .. !! processed by numpydoc !! .. py:method:: GetInternalFriction() -> float Get the value of "Internal Friction". .. !! processed by numpydoc !! .. py:method:: SetInternalFriction(value: str | float) -> None Set the value of "Internal Friction". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetPlasticLimit(unit: str | None = None) -> float Get the value of "Plastic Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "Pa". .. !! processed by numpydoc !! .. py:method:: SetPlasticLimit(value: str | float, unit: str | None = None) -> None Set the value of "Plastic Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "Pa". .. !! processed by numpydoc !! .. py:method:: GetFlexible() -> bool Get the value of "Flexible". .. !! processed by numpydoc !! .. py:method:: SetFlexible(value: bool) -> None Set the value of "Flexible". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetCenterOfMassOffset(unit: str | None = None) -> list[float] Get the value of "Center of Mass Offset". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "%". .. !! processed by numpydoc !! .. py:method:: SetCenterOfMassOffset(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "Center of Mass Offset". :param 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. :param 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. .. !! processed by numpydoc !! .. py:method:: GetChangeMassProperties() -> bool Get the value of "Change Mass Properties". .. !! processed by numpydoc !! .. py:method:: SetChangeMassProperties(value: bool) -> None Set the value of "Change Mass Properties". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetEnableRotations() -> bool Get the value of "Enable Rotations". .. !! processed by numpydoc !! .. py:method:: SetEnableRotations(value: bool) -> None Set the value of "Enable Rotations". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetHorizontalAspectRatio() -> float Get the value of "Horizontal Aspect Ratio". .. !! processed by numpydoc !! .. py:method:: SetHorizontalAspectRatio(value: str | float) -> None Set the value of "Horizontal Aspect Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetPrincipalMomentOfInertia(unit: str | None = None) -> list[float] Get the value of "Principal Moment of Inertia". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "m5". .. !! processed by numpydoc !! .. py:method:: SetPrincipalMomentOfInertia(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "Principal Moment of Inertia". :param 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. :param 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. .. !! processed by numpydoc !! .. py:method:: GetNumberOfCorners() -> int Get the value of "Number of Corners". .. !! processed by numpydoc !! .. py:method:: SetNumberOfCorners(value: str | int) -> None Set the value of "Number of Corners". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetXDirection(unit: str | None = None) -> list[float] Get the value of "X Direction". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "-". .. !! processed by numpydoc !! .. py:method:: SetXDirection(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "X Direction". :param 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. :param 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. .. !! processed by numpydoc !! .. py:method:: GetYDirection(unit: str | None = None) -> list[float] Get the value of "Y Direction". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "-". .. !! processed by numpydoc !! .. py:method:: SetYDirection(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "Y Direction". :param 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. :param 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. .. !! processed by numpydoc !! .. py:method:: GetZDirection(unit: str | None = None) -> list[float] Get the value of "Z Direction". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "-". .. !! processed by numpydoc !! .. py:method:: SetZDirection(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "Z Direction". :param 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. :param 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. .. !! processed by numpydoc !! .. py:method:: GetRollingResistance() -> float Get the value of "Rolling Resistance". .. !! processed by numpydoc !! .. py:method:: SetRollingResistance(value: str | float) -> None Set the value of "Rolling Resistance". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSideAngle() -> float Get the value of "Side Angle". .. !! processed by numpydoc !! .. py:method:: SetSideAngle(value: str | float) -> None Set the value of "Side Angle". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSmoothness() -> float Get the value of "Smoothness". .. !! processed by numpydoc !! .. py:method:: SetSmoothness(value: str | float) -> None Set the value of "Smoothness". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSuperquadricDegree() -> float Get the value of "Superquadric Degree". .. !! processed by numpydoc !! .. py:method:: SetSuperquadricDegree(value: str | float) -> None Set the value of "Superquadric Degree". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetThickness(unit: str | None = None) -> float Get the value of "Thickness". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m". .. !! processed by numpydoc !! .. py:method:: SetThickness(value: str | float, unit: str | None = None) -> None Set the value of "Thickness". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m". .. !! processed by numpydoc !! .. py:method:: GetVerticalAspectRatio() -> float Get the value of "Vertical Aspect Ratio". .. !! processed by numpydoc !! .. py:method:: SetVerticalAspectRatio(value: str | float) -> None Set the value of "Vertical Aspect Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetBendingAngleLimit(unit: str | None = None) -> float Get the value of "Bending Angle Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "dega". .. !! processed by numpydoc !! .. py:method:: SetBendingAngleLimit(value: str | float, unit: str | None = None) -> None Set the value of "Bending Angle Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "dega". .. !! processed by numpydoc !! .. py:method:: GetWithFailure() -> bool Get the value of "With Failure". .. !! processed by numpydoc !! .. py:method:: SetWithFailure(value: bool) -> None Set the value of "With Failure". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetEdgeAngle(unit: str | None = None) -> float Get the value of "Edge Angle". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "dega". .. !! processed by numpydoc !! .. py:method:: SetEdgeAngle(value: str | float, unit: str | None = None) -> None Set the value of "Edge Angle". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "dega". .. !! processed by numpydoc !! .. py:method:: GetElasticRatioBending() -> float Get the value of "Elastic Ratio Bending". .. !! processed by numpydoc !! .. py:method:: SetElasticRatioBending(value: str | float) -> None Set the value of "Elastic Ratio Bending". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetElasticRatioNormal() -> float Get the value of "Elastic Ratio Normal". .. !! processed by numpydoc !! .. py:method:: SetElasticRatioNormal(value: str | float) -> None Set the value of "Elastic Ratio Normal". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetElasticRatioTangential() -> float Get the value of "Elastic Ratio Tangential". .. !! processed by numpydoc !! .. py:method:: SetElasticRatioTangential(value: str | float) -> None Set the value of "Elastic Ratio Tangential". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetElasticRatioTorsion() -> float Get the value of "Elastic Ratio Torsion". .. !! processed by numpydoc !! .. py:method:: SetElasticRatioTorsion(value: str | float) -> None Set the value of "Elastic Ratio Torsion". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetElasticity() -> str Get "Elasticity" as a string. :return: The returned value will be one of ['isotropic', 'anisotropic']. .. !! processed by numpydoc !! .. py:method:: SetElasticity(value: str) -> None Set the value of "Elasticity". :param value: The value to set. Must be one of ['isotropic', 'anisotropic']. :raises RockyApiError: If `value` is not a valid "Elasticity" option. .. !! processed by numpydoc !! .. py:method:: GetValidElasticityValues() -> list[str] Get a list of all possible values for "Elasticity". :return: The returned list is ['isotropic', 'anisotropic']. .. !! processed by numpydoc !! .. py:method:: GetTargetNumberOfElements() -> int Get the value of "Target Number of Elements". .. !! processed by numpydoc !! .. py:method:: SetTargetNumberOfElements(value: str | int) -> None Set the value of "Target Number of Elements". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetElementDampingRatio() -> float Get the value of "Element Damping Ratio". .. !! processed by numpydoc !! .. py:method:: SetElementDampingRatio(value: str | float) -> None Set the value of "Element Damping Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetFailureRatio() -> float Get the value of "Failure Ratio". .. !! processed by numpydoc !! .. py:method:: SetFailureRatio(value: str | float) -> None Set the value of "Failure Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetJointDampingRatio() -> float Get the value of "Joint Damping Ratio". .. !! processed by numpydoc !! .. py:method:: SetJointDampingRatio(value: str | float) -> None Set the value of "Joint Damping Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetJointElasticRatio() -> float Get the value of "Joint Elastic Ratio". .. !! processed by numpydoc !! .. py:method:: SetJointElasticRatio(value: str | float) -> None Set the value of "Joint Elastic Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetJointThermalRatio() -> float Get the value of "Joint Thermal Ratio". .. !! processed by numpydoc !! .. py:method:: SetJointThermalRatio(value: str | float) -> None Set the value of "Joint Thermal Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetPlasticRatio() -> float Get the value of "Plastic Ratio". .. !! processed by numpydoc !! .. py:method:: SetPlasticRatio(value: str | float) -> None Set the value of "Plastic Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetPlasticityModel() -> str Get "Plasticity Model" as a string. :return: The returned value will be one of ['LinearElastic', 'BilinearElastoplastic', 'Custom']. .. !! processed by numpydoc !! .. py:method:: SetPlasticityModel(value: str) -> None Set the value of "Plasticity Model". :param value: The value to set. Must be one of ['LinearElastic', 'BilinearElastoplastic', 'Custom']. :raises RockyApiError: If `value` is not a valid "Plasticity Model" option. .. !! processed by numpydoc !! .. py:method:: GetValidPlasticityModelValues() -> list[str] Get a list of all possible values for "Plasticity Model". :return: The returned list is ['LinearElastic', 'BilinearElastoplastic', 'Custom']. .. !! processed by numpydoc !! .. py:method:: GetRemeshToTarget() -> bool Get the value of "Remesh To Target". .. !! processed by numpydoc !! .. py:method:: SetRemeshToTarget(value: bool) -> None Set the value of "Remesh To Target". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetSecondBendingAngleLimit(unit: str | None = None) -> float Get the value of "Second Bending Angle Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "dega". .. !! processed by numpydoc !! .. py:method:: SetSecondBendingAngleLimit(value: str | float, unit: str | None = None) -> None Set the value of "Second Bending Angle Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "dega". .. !! processed by numpydoc !! .. py:method:: GetTorsionAngleLimit(unit: str | None = None) -> float Get the value of "Torsion Angle Limit". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "dega". .. !! processed by numpydoc !! .. py:method:: SetTorsionAngleLimit(value: str | float, unit: str | None = None) -> None Set the value of "Torsion Angle Limit". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "dega". .. !! processed by numpydoc !! .. py:method:: GetName() -> str Get the value of "Name". .. !! processed by numpydoc !! .. py:method:: SetName(value: str) -> None Set the value of "Name". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetPorosity(unit: str | None = None) -> float Get the value of "Porosity". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "". .. !! processed by numpydoc !! .. py:method:: SetPorosity(value: str | float, unit: str | None = None) -> None Set the value of "Porosity". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "". .. !! processed by numpydoc !! .. py:method:: GetRandomAnglesHalfRange(unit: str | None = None) -> list[float] Get the value of "Random Angles Half Range". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "rad". .. !! processed by numpydoc !! .. py:method:: SetRandomAnglesHalfRange(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "Random Angles Half Range". :param 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. :param unit: The unit for `values`. If no unit is provided, `values` is assumed to be in "rad". :raises RockyApiError: If `values` doesn't have exactly 3 elements. .. !! processed by numpydoc !! .. py:method:: GetShape() -> str Get "Shape" as a string. :return: The returned value will be one of ['sphere', 'polyhedron', 'sphero_cylinder', 'sphero_polygon', 'sphero_polyhedron', 'briquete', 'faceted_cylinder', 'assembly', 'straight_fiber', 'custom_fiber', 'custom_shell', 'custom_polyhedron']. .. !! processed by numpydoc !! .. py:method:: SetShape(value: str) -> None Set the value of "Shape". :param value: The value to set. Must be one of ['sphere', 'polyhedron', 'sphero_cylinder', 'sphero_polygon', 'sphero_polyhedron', 'briquete', 'faceted_cylinder', 'assembly', 'straight_fiber', 'custom_fiber', 'custom_shell', 'custom_polyhedron']. :raises RockyApiError: If `value` is not a valid "Shape" option. .. !! processed by numpydoc !! .. py:method:: GetValidShapeValues() -> list[str] Get a list of all possible values for "Shape". :return: The returned list is ['sphere', 'polyhedron', 'sphero_cylinder', 'sphero_polygon', 'sphero_polyhedron', 'briquete', 'faceted_cylinder', 'assembly', 'straight_fiber', 'custom_fiber', 'custom_shell', 'custom_polyhedron']. .. !! processed by numpydoc !! .. py:method:: GetCgmScaleFactor() -> float Get the value of "Cgm Scale Factor". .. !! processed by numpydoc !! .. py:method:: SetCgmScaleFactor(value: str | float) -> None Set the value of "Cgm Scale Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSizeType() -> str Get "Size Type" as a string. :return: The returned value will be one of ['sieve', 'equivalent_diameter', 'original_size_scale']. .. !! processed by numpydoc !! .. py:method:: SetSizeType(value: str) -> None Set the value of "Size Type". :param value: The value to set. Must be one of ['sieve', 'equivalent_diameter', 'original_size_scale']. :raises RockyApiError: If `value` is not a valid "Size Type" option. .. !! processed by numpydoc !! .. py:method:: GetValidSizeTypeValues() -> list[str] Get a list of all possible values for "Size Type". :return: The returned list is ['sieve', 'equivalent_diameter', 'original_size_scale']. .. !! processed by numpydoc !! .. py:method:: GetEnableRandomAngle() -> bool Get the value of "Enable Random Angle". .. !! processed by numpydoc !! .. py:method:: SetEnableRandomAngle(value: bool) -> None Set the value of "Enable Random Angle". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableRandomOrientation() -> None Set the value of "Random Orientation" to True. .. !! processed by numpydoc !! .. py:method:: DisableRandomOrientation() -> None Set the value of "Random Orientation" to False. .. !! processed by numpydoc !! .. py:method:: IsRandomOrientationEnabled() -> bool Check if the "Random Orientation" is enabled. .. !! processed by numpydoc !! .. py:method:: GetMaterial() Get the "Material". :rtype: :class:`RASolidMaterial` .. !! processed by numpydoc !! .. py:method:: SetMaterial(value) -> None Set the "Material". :param unicode, :class:`RASolidMaterial` value: Either the API object wrapping the desired entity or its name. .. !! processed by numpydoc !! .. py:method:: GetAvailableMaterials() Get all available Materials. :rtype: List[:class:`RASolidMaterial`] A list of :class:`RASolidMaterial`. .. !! processed by numpydoc !! .. py:method:: GetAnisotropic() -> bool Deprecated: Use :meth:`GetElasticity()` instead. :rtype: bool .. !! processed by numpydoc !! .. py:method:: SetAnisotropic(value: bool) -> None Set the value of "Anisotropic". :param bool value: The value to set. .. !! processed by numpydoc !!