Interactions (extended list of attributes)¶

This page displays all inherited members for each data type. To get back to normal display click here

Classes¶

`base_interaction`()	This is generic pair interaction and this is a long comment continuing here
`base_thermal`()	This material describes thermal behaviour
`intr3D`()	3 DOFs interaction combining normal and shear forces
`linear_3D`()	linear elastic interaction
`linear_frictional_3D`()	linear frictional interaction
`liquid_bridge`()	interaction to store base information needed for liquid bridges
`liquid_bridge_dynamic`()	liquid bridge interaction, where the volume can change
`normal`()	interaction in the normal direction
`normal_basic_luding`()	This material describes linear-elastic behaviour with spring constants
`normal_hertz`()	Hertzian interaction in the normal direction
`normal_linear`()	linear-elasticity
`normal_linear_viscoelastic`()	linear-elasticity with viscosity (linear spring dashpot)
`shear`()	interaction in the tangential (or shear) direction
`shear_linear`()	linear-elasticity
`shear_linear_viscoelastic`()	linear-elasticity with viscosity
`thermal_Blaze`()	This material describes thermal behaviour dependent on friction and cohesion

Class Inheritance Diagram¶

Inheritance diagram of interaction.base_interaction, interaction.base_thermal, interaction.intr3D, interaction.linear_3D, interaction.linear_frictional_3D, interaction.liquid_bridge, interaction.liquid_bridge_dynamic, interaction.normal, interaction.normal_basic_luding, interaction.normal_hertz, interaction.normal_linear, interaction.normal_linear_viscoelastic, interaction.shear, interaction.shear_linear, interaction.shear_linear_viscoelastic, interaction.thermal_Blaze

Detailed contents¶

class interaction.base_interaction[source]

Bases: object

This is generic pair interaction and this is a long comment continuing here

model: str = None: [mandatory] which model applies to this interaction

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

class interaction.normal[source]

Bases: base_interaction

interaction in the normal direction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.shear[source]

Bases: base_interaction

interaction in the tangential (or shear) direction

shear_force: Vector3 = Vector3(0, 0, 0): shear force [\(F\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.intr3D[source]

Bases: normal, shear

3 DOFs interaction combining normal and shear forces

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

shear_force: Vector3 = Vector3(0, 0, 0): shear force [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.shear_linear[source]

Bases: shear

linear-elasticity

ks: float = None: [mandatory] shear stiffness [\(F/L\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

shear_force: Vector3 = Vector3(0, 0, 0): shear force [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.shear_linear_viscoelastic[source]

Bases: shear_linear

linear-elasticity with viscosity

shear_viscosity: float = None: [mandatory] shear damping ratio, \(c_{s}\), [\(FT/L\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

ks: float = None: [mandatory] shear stiffness [\(F/L\)]

model: str = None: [mandatory] which model applies to this interaction

shear_force: Vector3 = Vector3(0, 0, 0): shear force [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.normal_linear[source]

Bases: normal

linear-elasticity

kn: float = None: [mandatory] normal stiffness [\(F/L\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.normal_linear_viscoelastic[source]

Bases: normal_linear

linear-elasticity with viscosity (linear spring dashpot)

normal_viscosity: float = None: [mandatory] normal damping ratio, \(c_{n}\), [\(FT/L\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

kn: float = None: [mandatory] normal stiffness [\(F/L\)]

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.normal_hertz[source]

Bases: normal

Hertzian interaction in the normal direction

hertz_young: float = None: [mandatory] equivalent Young modulus [\(F/L²\)]

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

hertz_poisson: float = None: [mandatory] equivalent Poisson coefficient [\(-\)]

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.linear_3D[source]

Bases: intr3D, normal_linear, shear_linear

linear elastic interaction

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

kn: float = None: [mandatory] normal stiffness [\(F/L\)]

ks: float = None: [mandatory] shear stiffness [\(F/L\)]

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

shear_force: Vector3 = Vector3(0, 0, 0): shear force [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.linear_frictional_3D[source]

Bases: linear_3D

linear frictional interaction

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

kn: float = None: [mandatory] normal stiffness [\(F/L\)]

ks: float = None: [mandatory] shear stiffness [\(F/L\)]

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

shear_force: Vector3 = Vector3(0, 0, 0): shear force [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

friction_coefficient: float = None: [mandatory] friction coefficient, \(\mu\), [\(-\)]

class interaction.base_thermal[source]

Bases: base_interaction

This material describes thermal behaviour

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.thermal_Blaze[source]

Bases: base_thermal

This material describes thermal behaviour dependent on friction and cohesion

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

class interaction.liquid_bridge[source]

Bases: base_interaction

interaction to store base information needed for liquid bridges

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

model: str = None: [mandatory] which model applies to this interaction

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

is_formed: bool = None: [mandatory] whether a liquid bridge was formed previously

class interaction.liquid_bridge_dynamic[source]

Bases: liquid_bridge

liquid bridge interaction, where the volume can change

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

is_formed: bool = None: [mandatory] whether a liquid bridge was formed previously

model: str = None: [mandatory] which model applies to this interaction

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

liquid_bridge_volume: float = None: [mandatory] the liquid volume stored in the bridge, \(V\) [\(L^3\)]

class interaction.normal_basic_luding[source]

Bases: normal_linear

This material describes linear-elastic behaviour with spring constants

creation_time: float = 0: [optional] time when the interaction was created (example of optional data)

id1: int = None: [mandatory] id of body 1

id2: int = None: [mandatory] id of body 2

kn: float = None: [mandatory] normal stiffness [\(F/L\)]

model: str = None: [mandatory] which model applies to this interaction

normal: Vector3 = Vector3(0, 0, 0): [mandatory] unit normal [\(-\)]

normal_force: float = 0: [mandatory] normal force magnitude (positive in traction) [\(F\)]

virtual: bool = False: [optional] weither the interaction is real (else it is in a virtual state - typically without contact)

k1: float = None: [mandatory] normal stiffness in plastic branch, \(K_{1}\), [\(FL^{-1}\)]

k2: float = None: [mandatory] normal stiffness in unloading and reloading elastic branch, \(K_{n}^{U}\), [\(FL^{-1}\)]

kc: float = None: [mandatory] normal stiffness in tensile adhesive branch, \(K_{adh}^{U}\), [\(FL^{-1}\)]

Table of Contents

Search

Interactions (extended list of attributes)¶

Classes¶

Class Inheritance Diagram¶

Detailed contents¶