RAMaterialsInteraction

class RAMaterialsInteraction

Rocky PrePost Scripting wrapper for the interaction between two materials.

Retrieve a RAMaterialsInteraction from a RAMaterialsInteractionCollection and two RASolidMaterial:

material_1 = study.GetElement('Default Particles')
material_2 = study.GetElement('Default Boundaries')
interaction_collection = study.GetMaterialsInteractionCollection()
interaction = interaction_collection.GetMaterialsInteraction(material_1, material_2)

Note that the materials to which a RAMaterialsInteraction refers are fixed - while they can be retrieved with GetFirstMaterial() and GetSecondMaterial(), they can’t be set.

Methods:

Name	Description
GetAdhesiveDistance([unit])	Get the value of "Adhesive Distance".
GetAdhesiveFraction([unit])	Get the value of "Adhesive Fraction".
GetContactStiffnessMultiplier([unit])	Get the value of "Contact Stiffness Multiplier".
GetDynamicFriction([unit])	Get the value of "Dynamic Friction".
GetFirstMaterial()	Get this interaction's first material.
GetModuleProperties()	Get the names of the module properties.
GetModuleProperty(property_name[, unit])	Get the value of a module property.
GetRestitutionCoefficient([unit])	Get the value of "Restitution Coefficient".
GetSecondMaterial()	Get this interaction's second material.
GetStaticFriction([unit])	Get the value of "Static Friction".
GetSurfaceEnergy([unit])	Get the value of "Surface Energy".
GetTangentialStiffnessRatio([unit])	Get the value of "Tangential Stiffness Ratio".
GetValidOptionsForModuleProperty(property_name)	Get all valid options only for properties that have a list of possible options.
GetVelocityExponent([unit])	Get the value of "Velocity Exponent".
GetVelocityLimit([unit])	Get the value of "Velocity Limit".
SetAdhesiveDistance(value[, unit])	Set the value of "Adhesive Distance".
SetAdhesiveFraction(value[, unit])	Set the value of "Adhesive Fraction".
SetContactStiffnessMultiplier(value[, unit])	Set the value of "Contact Stiffness Multiplier".
SetDynamicFriction(value[, unit])	Set the value of "Dynamic Friction".
SetModuleProperty(property_name, value[, unit])	Set the value of a module property.
SetRestitutionCoefficient(value[, unit])	Set the value of "Restitution Coefficient".
SetStaticFriction(value[, unit])	Set the value of "Static Friction".
SetSurfaceEnergy(value[, unit])	Set the value of "Surface Energy".
SetTangentialStiffnessRatio(value[, unit])	Set the value of "Tangential Stiffness Ratio".
SetVelocityExponent(value[, unit])	Set the value of "Velocity Exponent".
SetVelocityLimit(value[, unit])	Set the value of "Velocity Limit".

GetAdhesiveDistance(unit: Optional[str] = None)

Get the value of “Adhesive Distance”.

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

GetAdhesiveFraction(unit: Optional[str] = None)

Get the value of “Adhesive Fraction”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetContactStiffnessMultiplier(unit: Optional[str] = None)

Get the value of “Contact Stiffness Multiplier”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetDynamicFriction(unit: Optional[str] = None)

Get the value of “Dynamic Friction”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetFirstMaterial()

Get this interaction’s first material.

GetModuleProperties()

Get the names of the module properties.

• Return type: tuple(ModulePropertyIdentifier)

GetModuleProperty(property_name: str | rocky30.plugins.api.ra_addins.ModulePropertyIdentifier, unit: str | None = None)

Get the value of a module property.

• Parameters:
  • property_name (Union *[*str , ModulePropertyIdentifier ]) – The name of the module property to get.
  • unit (str) – The unit for value, just for scalar properties. If no unit is provided, the returned value will be in the unit that was set before (via SetModuleProperty()).
• Return type: float, bool, str or RAModulePropertyList
• Returns:
  • For basic module properties like numbers and booleans, the returned value is a basic Python type (float, bool, or string)
  • For input files, the returned value is the string of the full path to the file
  • For properties that are lists of other properties, the returned value is a : RAModulePropertyList.

GetRestitutionCoefficient(unit: Optional[str] = None)

Get the value of “Restitution Coefficient”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetSecondMaterial()

Get this interaction’s second material.

GetStaticFriction(unit: Optional[str] = None)

Get the value of “Static Friction”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetSurfaceEnergy(unit: Optional[str] = None)

Get the value of “Surface Energy”.

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

GetTangentialStiffnessRatio(unit: Optional[str] = None)

Get the value of “Tangential Stiffness Ratio”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetValidOptionsForModuleProperty(property_name)

Get all valid options only for properties that have a list of possible options.

• Parameters: property_name (str) – The name of the module property.
• Return type: List[str]

GetVelocityExponent(unit: Optional[str] = None)

Get the value of “Velocity Exponent”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetVelocityLimit(unit: Optional[str] = None)

Get the value of “Velocity Limit”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”.

SetAdhesiveDistance(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Adhesive Distance”.

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

SetAdhesiveFraction(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Adhesive Fraction”.

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

SetContactStiffnessMultiplier(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Contact Stiffness Multiplier”.

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

SetDynamicFriction(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Dynamic Friction”.

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

SetModuleProperty(property_name: str | rocky30.plugins.api.ra_addins.ModulePropertyIdentifier, value: float | bool | str, unit: Optional[str] = None)

Set the value of a module property.

• Parameters:
  • property_name (Union *[*str , ModulePropertyIdentifier ]) – The name of the module property to set.
  • value (float , bool or str) – The value to set. If the property_name references to an enum property then value must be an str value.
  • unit (str) – The unit for value, just for scalar properties. If no unit is provided, value is assumed to be the unit was set before.

SetRestitutionCoefficient(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Restitution Coefficient”.

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

SetStaticFriction(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Static Friction”.

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

SetSurfaceEnergy(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Surface Energy”.

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

SetTangentialStiffnessRatio(value: Union[str, float], unit: Optional[str] = None)

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

SetVelocityExponent(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Velocity Exponent”.

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

SetVelocityLimit(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Velocity Limit”.

• 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/s”.