RAMaterialsInteractionCollection

class ansys.rocky.app.ra_materials_interaction_collection.RAMaterialsInteractionCollection(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.ra_list.RAList[ansys.rocky.app.ra_materials_interaction.RAMaterialsInteraction]

Rocky PrePost Scripting wrapper for the collection of materials interactions in a project.

This wrapper corresponds to the “Materials Interactions” item on the project’s data tree. Retrieve the RAMaterialsInteractionCollection from a RAStudy via:

interaction_collection = RAMaterialCollection.GetMaterialsInteractionCollection()

Instances of the RAMaterialsInteractionCollection class act as regular Python lists and can be iterated on, individual materials accessed via index, etc:

interaction_1 = interaction_collection[3]
for interaction in interaction_collection:
    interaction.SetAdhesiveFraction(80, '%')
interaction_2 = interaction_collection.GetMaterialsInteraction('Default Particles', 'Default Boundaries')

Note that individual interactions can’t be created or removed by the user: they are created and removed as necessary as new materials are created or removed.

Items in this list are of type RAMaterialsInteraction.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

New	Unused: Materials Interactions are automatically created when Materials are created.
Remove	Unused: Materials Interactions are automatically deleted when Materials are created.
Clear	Unused: Materials Interactions are automatically deleted when Materials are created.
GetMaterialsInteraction	Get the materials interaction for the given pair of materials.

Special methods

__delitem__

Unused: Materials Interactions are automatically deleted when Materials are created.

Import detail

from ansys.rocky.app.ra_materials_interaction_collection import RAMaterialsInteractionCollection

Method detail

classmethod RAMaterialsInteractionCollection.GetWrappedClass()

classmethod RAMaterialsInteractionCollection.GetClassName()

RAMaterialsInteractionCollection.New() → None

Unused: Materials Interactions are automatically created when Materials are created.

RAMaterialsInteractionCollection.__delitem__(index) → None

Unused: Materials Interactions are automatically deleted when Materials are created.

RAMaterialsInteractionCollection.Remove(item) → None

Unused: Materials Interactions are automatically deleted when Materials are created.

RAMaterialsInteractionCollection.Clear() → None

Unused: Materials Interactions are automatically deleted when Materials are created.

RAMaterialsInteractionCollection.GetMaterialsInteraction(material_1, material_2) → ansys.rocky.app.ra_materials_interaction.RAMaterialsInteraction

Get the materials interaction for the given pair of materials.

For both material_1 and material_2 parameters, the parameter can be either an instance of RASolidMaterial or the material’s name.