Materials (extended list of attributes)

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

Classes

base_material()

General properties shared by all materials.

base_thermal()

Material with linear-elastic and thermal behaviour.

basic_luding()

Material with Luding-type elasto-plastic adhesive behaviour.

frictional_3D()

Adds sliding friction behaviour to any material.

frictional_6D()

Adds sliding, rolling and torsional friction to any material.

hertz_elastic()

Material with Hertzian-elastic behaviour.

linear_elastic()

Material with linear-elastic behaviour.

linear_elastic_frictional_3D()

Material with linear-elastic behaviour and sliding friction.

linear_elastic_frictional_6D()

Material with linear-elastic behaviour and sliding, rolling and torsional friction.

linear_visco_elastic()

Material with linear visco-elastic damping behaviour.

linear_visco_elastic_constant_cor()

Material with linear visco-elastic damping behaviour and mass-independent coefficient of restitution.

linear_visco_elastic_frictional_3D()

Material with linear visco-elastic behaviour and sliding friction.

linear_visco_elastic_frictional_3D_liquid_bridge()

Material with linear visco-elastic behaviour, sliding friction and liquid-bridge forces.

linear_visco_elastic_variable_cor()

Material with linear visco-elastic damping behaviour and velocity-dependent coefficient of restitution.

liquid_bridge()

Adds a liquid-bridge model to any material.

liquid_bridge_migration()

Adds a liquid-bridge migration model to any material.

liquid_bridge_static()

Adds a liquid-bridge model in which every contact has the same liquid volume.

thermal_blaze()

Material with frictional heat generation and cohesion evolution.

Class Inheritance Diagram

Inheritance diagram of materials.base_material, materials.base_thermal, materials.basic_luding, materials.frictional_3D, materials.frictional_6D, materials.hertz_elastic, materials.linear_elastic, materials.linear_elastic_frictional_3D, materials.linear_elastic_frictional_6D, materials.linear_visco_elastic, materials.linear_visco_elastic_constant_cor, materials.linear_visco_elastic_frictional_3D, materials.linear_visco_elastic_frictional_3D_liquid_bridge, materials.linear_visco_elastic_variable_cor, materials.liquid_bridge, materials.liquid_bridge_migration, materials.liquid_bridge_static, materials.thermal_blaze

Detailed contents

class materials.base_material[source]

Bases: object

General properties shared by all materials.

id: int = None

[mandatory] material id, \(id\), [\(-\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

class materials.linear_elastic[source]

Bases: base_material

Material with linear-elastic behaviour.

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

class materials.hertz_elastic[source]

Bases: base_material

Material with Hertzian-elastic behaviour.

young_modulus: float = None

[mandatory] Young’s modulus, \(E\), [\(FL^{-2}\)]

poisson_ratio: float = None

[mandatory] Poisson’s ratio, \(\nu\), [\(-\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

class materials.linear_visco_elastic[source]

Bases: linear_elastic

Material with linear visco-elastic damping behaviour.

normal_damping: float = None

[mandatory] normal damping coefficient, \(c_n\), [\(MT^{-1}\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

class materials.linear_visco_elastic_constant_cor[source]

Bases: linear_elastic

Material with linear visco-elastic damping behaviour and mass-independent coefficient of restitution.

normal_damping_ratio: float = None

[mandatory] normal damping coefficient, \(\beta_n\) [\(-\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

class materials.linear_visco_elastic_variable_cor[source]

Bases: linear_elastic

Material with linear visco-elastic damping behaviour and velocity-dependent coefficient of restitution.

relaxation_time: float = None

[mandatory] relaxation time, \(A\), [\(T\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

class materials.frictional_3D[source]

Bases: object

Adds sliding friction behaviour to any material.

shear_friction: float = None

[mandatory] sliding-friction coefficient, \(\mu_s\), [\(-\)]

shear_damping: float = None

[mandatory] shear damping coefficient, \(c_s\), [\(MT^{-1}\)]

class materials.frictional_6D[source]

Bases: frictional_3D

Adds sliding, rolling and torsional friction to any material.

model: str = 'frictional_6D'

Friction model.

rolling_friction: float = None

[mandatory] rolling-friction coefficient, \(\mu_r\), [\(-\)]

rolling_damping: float = None

[mandatory] rolling damping coefficient, \(c_r\), [\(MT^{-1}\)]

torsion_friction: float = None

[mandatory] torsional-friction coefficient, \(\mu_t\), [\(-\)]

torsion_damping: float = None

[mandatory] torsional damping coefficient, \(c_t\), [\(MT^{-1}\)]

shear_damping: float = None

[mandatory] shear damping coefficient, \(c_s\), [\(MT^{-1}\)]

shear_friction: float = None

[mandatory] sliding-friction coefficient, \(\mu_s\), [\(-\)]

class materials.base_thermal[source]

Bases: linear_elastic

Material with linear-elastic and thermal behaviour.

thermal_conductivity: float = None

[mandatory] thermal conductivity, \(k\), [\(E/(LT\theta)\)]

thermal_capacity: float = None

[mandatory] thermal capacity, \(c_p\), [\(E/\theta\)]

initial_temperature: float = None

[mandatory] initial temperature, \(T_0\), [\(\theta\)]

min_temp: float = None

[optional] minimum temperature, \(T_\mathrm{min}\), [\(\theta\)]

max_temp: float = None

[optional] maximum temperature, \(T_\mathrm{max}\), [\(\theta\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

class materials.thermal_blaze[source]

Bases: base_thermal

Material with frictional heat generation and cohesion evolution.

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

friction_source: float = None

[mandatory] friction coefficient used for heat generation, \(\mu_\theta\), [\(-\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

initial_temperature: float = None

[mandatory] initial temperature, \(T_0\), [\(\theta\)]

max_temp: float = None

[optional] maximum temperature, \(T_\mathrm{max}\), [\(\theta\)]

min_temp: float = None

[optional] minimum temperature, \(T_\mathrm{min}\), [\(\theta\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

thermal_capacity: float = None

[mandatory] thermal capacity, \(c_p\), [\(E/\theta\)]

thermal_conductivity: float = None

[mandatory] thermal conductivity, \(k\), [\(E/(LT\theta)\)]

contact_area_effective: float = None

[mandatory] effective fraction of the contact area, \(A_\mathrm{eff}\), [\(-\)]

cohesion_rate: float = None

[mandatory] cohesion rate, \(SE_\mathrm{rate}\), [\(E/(L^2T)\)]

cohesion_limit: float = None

[optional] maximum surface energy, \(SE_\mathrm{max}\), [\(E/L^2\)]

thickness: float = None

[optional] artificial geometrical thickness, \(\delta d\), [\(L\)]

class materials.basic_luding[source]

Bases: linear_elastic

Material with Luding-type elasto-plastic adhesive behaviour.

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

normal_stiffness_plastic: float = None

[mandatory] plastic loading stiffness, \(K_1\), [\(FL^{-1}\)]

normal_stiffness_unloading_reloading: float = None

[mandatory] unloading and reloading stiffness, \(K_n^U\), [\(FL^{-1}\)]

normal_stiffness_tensile: float = None

[mandatory] tensile adhesive stiffness, \(K_\mathrm{adh}^U\), [\(FL^{-1}\)]

class materials.liquid_bridge[source]

Bases: object

Adds a liquid-bridge model to any material.

surface_tension: float = None

[mandatory] surface tension of the liquid, \(\gamma\) [\(F/L\)]

contact_angle: float = None

[mandatory] contact angle between particle and liquid bridge surface, \(\Theta\) [\(-\)]

class materials.liquid_bridge_migration[source]

Bases: liquid_bridge

Adds a liquid-bridge migration model to any material.

contact_angle: float = None

[mandatory] contact angle between particle and liquid bridge surface, \(\Theta\) [\(-\)]

surface_tension: float = None

[mandatory] surface tension of the liquid, \(\gamma\) [\(F/L\)]

liquid_bridge_volume_min: float = None

[mandatory] the minimum liquid volume needed to form a bridge, \(V_\mathrm{min}\) [\(L^3\)]

liquid_bridge_volume_max: float = None

[mandatory] the maximum liquid volume, a liquid bridge gets during formation, \(V_\mathrm{max}\) [\(L^3\)]

distribution_coefficient: float = None

[mandatory] the fraction of the liquid that is to be distributed to the neighboring contacts of the particles after a liquid bridge rupture, \(f\) [\(-\)]

class materials.liquid_bridge_static[source]

Bases: liquid_bridge

Adds a liquid-bridge model in which every contact has the same liquid volume.

contact_angle: float = None

[mandatory] contact angle between particle and liquid bridge surface, \(\Theta\) [\(-\)]

surface_tension: float = None

[mandatory] surface tension of the liquid, \(\gamma\) [\(F/L\)]

liquid_bridge_volume: float = None

[mandatory] the liquid volume of a bridge, \(V\) [\(L^3\)]

class materials.linear_elastic_frictional_3D[source]

Bases: linear_elastic, frictional_3D

Material with linear-elastic behaviour and sliding friction.

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_damping: float = None

[mandatory] shear damping coefficient, \(c_s\), [\(MT^{-1}\)]

shear_friction: float = None

[mandatory] sliding-friction coefficient, \(\mu_s\), [\(-\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

class materials.linear_visco_elastic_frictional_3D[source]

Bases: linear_visco_elastic, frictional_3D

Material with linear visco-elastic behaviour and sliding friction.

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_damping: float = None

[mandatory] normal damping coefficient, \(c_n\), [\(MT^{-1}\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_damping: float = None

[mandatory] shear damping coefficient, \(c_s\), [\(MT^{-1}\)]

shear_friction: float = None

[mandatory] sliding-friction coefficient, \(\mu_s\), [\(-\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

class materials.linear_elastic_frictional_6D[source]

Bases: linear_elastic, frictional_6D

Material with linear-elastic behaviour and sliding, rolling and torsional friction.

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

model: str = 'frictional_6D'

Friction model.

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

rolling_damping: float = None

[mandatory] rolling damping coefficient, \(c_r\), [\(MT^{-1}\)]

rolling_friction: float = None

[mandatory] rolling-friction coefficient, \(\mu_r\), [\(-\)]

shear_damping: float = None

[mandatory] shear damping coefficient, \(c_s\), [\(MT^{-1}\)]

shear_friction: float = None

[mandatory] sliding-friction coefficient, \(\mu_s\), [\(-\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

torsion_damping: float = None

[mandatory] torsional damping coefficient, \(c_t\), [\(MT^{-1}\)]

torsion_friction: float = None

[mandatory] torsional-friction coefficient, \(\mu_t\), [\(-\)]

class materials.linear_visco_elastic_frictional_3D_liquid_bridge[source]

Bases: linear_visco_elastic, frictional_3D, liquid_bridge

Material with linear visco-elastic behaviour, sliding friction and liquid-bridge forces.

contact_angle: float = None

[mandatory] contact angle between particle and liquid bridge surface, \(\Theta\) [\(-\)]

density: float = None

[mandatory] particle density, \(\rho\), [\(ML^{-3}\)]

id: int = None

[mandatory] material id, \(id\), [\(-\)]

normal_damping: float = None

[mandatory] normal damping coefficient, \(c_n\), [\(MT^{-1}\)]

normal_stiffness: float = None

[mandatory] normal stiffness, \(K_n\), [\(FL^{-1}\)]

shear_damping: float = None

[mandatory] shear damping coefficient, \(c_s\), [\(MT^{-1}\)]

shear_friction: float = None

[mandatory] sliding-friction coefficient, \(\mu_s\), [\(-\)]

shear_stiffness: float = None

[mandatory] shear stiffness, \(K_s\), [\(FL^{-1}\)]

surface_tension: float = None

[mandatory] surface tension of the liquid, \(\gamma\) [\(F/L\)]