mpacts.contact.models.springs.elastic. elastic_matrix

In order to be able to use this module import it like this:

import mpacts.contact.models.springs.elastic.elastic_matrix
#or assign it to a shorter name
import mpacts.contact.models.springs.elastic.elastic_matrix as ela

BiphasicSpringTensionMatrix

Description: Biphasic spring model, damping in friction matrix. Tension at the nodes is calculated in the array ‘tension’. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

BiphasicSpringTensionMatrix (SPH SPH)

Biphasic spring model, damping in friction matrix. Tension at the nodes is calculated in the array ‘tension’.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

BiphasicSpringTensionMatrix (Sphere Sphere)

Biphasic spring model, damping in friction matrix. Tension at the nodes is calculated in the array ‘tension’.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress — spring constant in compressive regime.
    • k_stretch — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • A (default value = 0) — constant that determines how fast the stiffness drops in function of the maximum historical stretch ratio
    • B (default value = 0) — constant that determines how much the stiffness drops at large strains (B=0 means pure elastic behaviour)
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • d_max (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointBiphasicSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

ElasticShellTensionMatrix

Description: Node-node spring model for a meshed shell that represents a visco-elastic solid, specified by a Young’s modulus, a Poisson ratio, a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements, and two-dimensional tension is computed in a ‘tension’ array of the nodes. Note that, in order to properly represent an elastic shell, an appropriate triangle-triangle bending model should be added in the simulation. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

ElasticShellTensionMatrix (Sphere Sphere)

Node-node spring model for a meshed shell that represents a visco-elastic solid, specified by a Young’s modulus, a Poisson ratio, a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements, and two-dimensional tension is computed in a ‘tension’ array of the nodes. Note that, in order to properly represent an elastic shell, an appropriate triangle-triangle bending model should be added in the simulation.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • E (kg . m^-1 . s^-2) — Young’s modulus of the elastic material from which the shell is composed
    • nu (1) — Poisson number of the elastic material from which the shell is composed. Warning: Currently only 1/3 is accepted as a valid value..
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance of the spring connections. If not given, the ‘current’ distance when the model is first executed will be used.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)
    • k — spring stiffness, computed from E, area and thickness (read-only).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellElasticShellSpringN_T_ShellViscositySpringStiffnessAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FENEMatrix

Description: Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

FENEMatrix (SPH SPH)

Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FENEMatrix (Sphere Sphere)

Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_stretch — FENE stretching stiffness
    • max_stretch_safety — Safety fraction [0,1] of max_stretch at which F starts behaving linear with local F/d slope
    • max_stretch — Maximum extension of FENE spring.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • modifier1 (default value = None) — ScalarArray to modify max_stretch constant for pc1.
    • modifier2 (default value = None) — ScalarArray to modify max_stretch constant for pc2.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointFENEN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FENETensionLocFricMatrix

Description: Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Moreover, for each connection, a local friction is determined from the two friction values of arrays provided per node. Tension is computed and stored in a array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

FENETensionLocFricMatrix (SPH SPH)

Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Moreover, for each connection, a local friction is determined from the two friction values of arrays provided per node. Tension is computed and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal1 — Normal friction coefficient for the material of particle 1 (array or single value).
    • gamma_normal2 — Normal friction coefficient for the material of particle 1 (array or single value).
    • gamma_tangential1 — Tangential friction coefficient for the material of particle 2 (array or single value).
    • gamma_tangential2 — Tangential friction coefficient for the material of particle 2 (array or single value).
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
  • Read only properties:
    • gamma_normal — Normal friction coefficient (kg/s)
    • gamma_tangential — Tangential friction coefficient (kg/s)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringArrayValue_Property  <double >
  ↓
N_T_MaterialSpecificMeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FENETensionLocFricMatrix (Sphere Sphere)

Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Moreover, for each connection, a local friction is determined from the two friction values of arrays provided per node. Tension is computed and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal1 — Normal friction coefficient for the material of particle 1 (array or single value).
    • gamma_normal2 — Normal friction coefficient for the material of particle 1 (array or single value).
    • gamma_tangential1 — Tangential friction coefficient for the material of particle 2 (array or single value).
    • gamma_tangential2 — Tangential friction coefficient for the material of particle 2 (array or single value).
    • k_stretch — FENE stretching stiffness
    • max_stretch_safety — Safety fraction [0,1] of max_stretch at which F starts behaving linear with local F/d slope
    • max_stretch — Maximum extension of FENE spring.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • modifier1 (default value = None) — ScalarArray to modify max_stretch constant for pc1.
    • modifier2 (default value = None) — ScalarArray to modify max_stretch constant for pc2.
  • Read only properties:
    • gamma_normal — Normal friction coefficient (kg/s)
    • gamma_tangential — Tangential friction coefficient (kg/s)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointFENEArrayValue_Property  <double >
  ↓
N_T_MaterialSpecificMeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FENETensionMatrix

Description: Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is computed and stored in a array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

FENETensionMatrix (SPH SPH)

Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is computed and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FENETensionMatrix (Sphere Sphere)

Node-node interaction model with FENE (finitely extensible nonlinear elastic) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is computed and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_stretch — FENE stretching stiffness
    • max_stretch_safety — Safety fraction [0,1] of max_stretch at which F starts behaving linear with local F/d slope
    • max_stretch — Maximum extension of FENE spring.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • modifier1 (default value = None) — ScalarArray to modify max_stretch constant for pc1.
    • modifier2 (default value = None) — ScalarArray to modify max_stretch constant for pc2.
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointFENEN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FluidShellFENETensionMatrix

Description: Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes. A FENE (finitely extensible non-linear elastic) spring is added to ensure that large strains beyond a ‘max_stretch’ can be prevented, while at the same time having little mechanical effect for small strains. Note that parameter ‘k_stretch’ should typically be chosen sufficiently LOW to prevent disturbing the mechanical description of the shell as a fluid-like structure. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

FluidShellFENETensionMatrix (Sphere Sphere)

Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes. A FENE (finitely extensible non-linear elastic) spring is added to ensure that large strains beyond a ‘max_stretch’ can be prevented, while at the same time having little mechanical effect for small strains. Note that parameter ‘k_stretch’ should typically be chosen sufficiently LOW to prevent disturbing the mechanical description of the shell as a fluid-like structure.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • k_stretch — FENE stretching stiffness
    • max_stretch_safety — Safety fraction [0,1] of max_stretch at which F starts behaving linear with local F/d slope
    • max_stretch — Maximum extension of FENE spring.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • modifier1 (default value = None) — ScalarArray to modify max_stretch constant for pc1.
    • modifier2 (default value = None) — ScalarArray to modify max_stretch constant for pc2.
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellFENEN_T_ShellViscosityAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FluidShellSpringTensionMatrix

Description: Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes. A simple spring is added to enable numerical stablization (usually using ‘k_compress’). Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

FluidShellSpringTensionMatrix (SPH SPH)

Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes. A simple spring is added to enable numerical stablization (usually using ‘k_compress’).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellSpringN_T_ShellViscosityAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FluidShellSpringTensionMatrix (Sphere Sphere)

Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes. A simple spring is added to enable numerical stablization (usually using ‘k_compress’).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellSpringN_T_ShellViscosityAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

FluidShellTensionMatrix

Description: Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

FluidShellTensionMatrix (Sphere Sphere)

Node-node interaction model for a meshed shell that represents a viscous material (fluid-like) specified by a viscosity and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and two-dimensional tension is computed in a ‘tension’ array of the nodes.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellN_T_ShellViscosityComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

HyperelasticBiphasicShellTensionMatrix

Description: Hyperelastic biphasic for thin shell. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

HyperelasticBiphasicShellTensionMatrix (SPH SPH)

Hyperelastic biphasic for thin shell.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellSpringN_T_ShellViscosityAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

HyperelasticBiphasicShellTensionMatrix (Sphere Sphere)

Hyperelastic biphasic for thin shell.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • E (kg . m^-1 . s^-2) — Young’s modulus of the elastic material from which the shell is composed
    • nu (1) — Poisson number of the elastic material from which the shell is composed. Warning: Currently only 1/3 is accepted as a valid value..
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • A (default value = 0) — constant that determines how fast the stiffness drops in function of the maximum historical stretch ratio
    • B (default value = 0) — constant that determines how much the stiffness drops at large strains (B=0 means pure hyperelastic behaviour)
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
    • s_max (default value = 1.7976931348623157e+308) — stretch at which spring will break, bringing forces to zero
  • Read only properties:
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)
    • k_compress — spring constant in compressive regime.
    • k_stretch — spring constant in extending regime.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellHyperelasticBiphasicShellSpringN_T_ShellViscosityAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

HyperelasticBiphasicSpringTensionMatrix

Description: Hyperelastic biphasic spring model, damping in friction matrix. Tension at the nodes is calculated in the array ‘tension’. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

HyperelasticBiphasicSpringTensionMatrix (SPH SPH)

Hyperelastic biphasic spring model, damping in friction matrix. Tension at the nodes is calculated in the array ‘tension’.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

HyperelasticBiphasicSpringTensionMatrix (Sphere Sphere)

Hyperelastic biphasic spring model, damping in friction matrix. Tension at the nodes is calculated in the array ‘tension’.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress — spring constant in compressive regime.
    • k_stretch — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • A (default value = 0) — constant that determines how fast the stiffness drops in function of the maximum historical stretch ratio
    • B (default value = 0) — constant that determines how much the stiffness drops at large strains (B=0 means pure hyperelastic behaviour)
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • s_max (default value = 1.7976931348623157e+308) — stretch at which spring will break, bringing forces to zero
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointHyperelasticBiphasicSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearGrowingSpringMatrix

Description: Node-node interaction model with growing linear springs. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

LinearGrowingSpringMatrix (SPH SPH)

Node-node interaction model with growing linear springs. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • f_max (kg . m . s^-2) (default value = -1) — Compressive spring force at which growth (optionally) vanishes.
    • growth_rate_array (default value = None) — optional array with growth rate per segment. Do not forget to set contact state variable ‘segment_index’ is you use this property.
    • growth_rate (m . s^-1) (default value = 1.7976931348623157e+308) — Base growth rate
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringGrowSpringN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearGrowingSpringMatrix (Sphere Sphere)

Node-node interaction model with growing linear springs. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • f_max (kg . m . s^-2) (default value = -1) — Compressive spring force at which growth (optionally) vanishes.
    • growth_rate_array (default value = None) — optional array with growth rate per segment. Do not forget to set contact state variable ‘segment_index’ is you use this property.
    • growth_rate (m . s^-1) (default value = 1.7976931348623157e+308) — Base growth rate
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringGrowSpringN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpring1DMatrix

Description: linear spring model with damping assembled to a friction matrix. Tension is computed for a 1D network and stored in a array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

LinearSpring1DMatrix (SPH SPH)

linear spring model with damping assembled to a friction matrix. Tension is computed for a 1D network and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_ConstantResistanceAssembleForcesAssemble_FrictionTension1DComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpring1DMatrix (Sphere Sphere)

linear spring model with damping assembled to a friction matrix. Tension is computed for a 1D network and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_ConstantResistanceAssembleForcesAssemble_FrictionTension1DComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpringMatrix

Description: Node-node interaction model with linear springs. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

LinearSpringMatrix (SPH SPH)

Node-node interaction model with linear springs. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpringMatrix (Sphere Sphere)

Node-node interaction model with linear springs. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpringMatrixCortexCurvature

Description: Linear spring model, damping in friction matrix. Cortex contractility based on local cortex curvature. Geometry combinations available:

PC2 | PC1 - SPH
SPH YES

LinearSpringMatrixCortexCurvature (SPH SPH)

Linear spring model, damping in friction matrix. Cortex contractility based on local cortex curvature.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • F_myo_max — maximal contractile force
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress — spring constant in compressive regime.
    • k_stretch — spring constant in extending regime.
    • max_curv — max angle for which actomyosin contraction is possible
    • mean_curv — angle at which maximal contraction is applied
    • min_dist — minimal segment length
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSPH_Cortex_ContractionSpring_CortexN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpringTensionMatrix

Description: Linear spring model, with damping forces assembled to a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is calculated in a ‘tension’ array of the nodes. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

LinearSpringTensionMatrix (SPH SPH)

Linear spring model, with damping forces assembled to a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is calculated in a ‘tension’ array of the nodes.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceSpringStiffnessAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearSpringTensionMatrix (Sphere Sphere)

Linear spring model, with damping forces assembled to a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is calculated in a ‘tension’ array of the nodes.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceSpringStiffnessAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

LinearVariableSpring1DMatrix

Description: linear spring model with damping assembled to a friction matrix. Tension is computed for a 1D network and stored in a array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

LinearVariableSpring1DMatrix (Sphere Sphere)

linear spring model with damping assembled to a friction matrix. Tension is computed for a 1D network and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • modifier1 — ScalarArray to modify spring constant for pc1.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • broken (default value = None) — If given, increment the node value of this array for each broken edge.
    • d0 (default value = -1) — optional spring equilibrium distance
    • d_max (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • d_min (default value = 0) — distance below which spring will break, bringing forces to zero
    • delete_broken (default value = 1) — If ‘true’, broken springs will be flagged to be removed from the contact detector, so they truly vanish. If you want to still compute additional stuff for broken springs, set this to ‘false’.
    • geometric_average (default value = 0) — If ‘true’, the spring stiffness will be computed using the geometric average instead of the arithmic average (with zero leading to zero stiffness).
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • k (default value = 1) — Optional unmodified spring constant. By default set to one, so that modifier arrays represent the spring constants
    • max_strain (default value = -1) — maximal strain (both in tension and compression) beyond which which spring will break. Will set and override d_max and d_min if given
    • modifier2 (default value = None) — ScalarArray to modify spring constant for pc2, if not set assumed to be the same as pc1.
    • rupture_force (default value = 1.7976931348623157e+308) — Force beyond which a spring connnection will break, regardless of d_max and max_strain

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpring_VariableStrengthN_T_ConstantResistanceAssembleForcesAssemble_FrictionTension1DComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

MaxwellFluidShellTensionMatrix

Description: Node-node interaction model for a meshed shell that represents a visco-elastic Maxwell fluid, specified by a Young’s modulus, a Poisson ratio, a viscosity, a Maxwell relaxation time and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and to give fluid-like behavior, the tension in each spring is relaxed by changing the spring reference length with a velocity that is inversely proportional to the Maxwell relaxation time. Two-dimensional tension is computed in a ‘tension’ array of the nodes. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

MaxwellFluidShellTensionMatrix (Sphere Sphere)

Node-node interaction model for a meshed shell that represents a visco-elastic Maxwell fluid, specified by a Young’s modulus, a Poisson ratio, a viscosity, a Maxwell relaxation time and a thickness which is kept per facet (triangle). Viscosity is added to contact matrix friction elements and to give fluid-like behavior, the tension in each spring is relaxed by changing the spring reference length with a velocity that is inversely proportional to the Maxwell relaxation time. Two-dimensional tension is computed in a ‘tension’ array of the nodes.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • E (kg . m^-1 . s^-2) — Young’s modulus of the elastic material from which the shell is composed
    • nu (1) — Poisson number of the elastic material from which the shell is composed. Warning: Currently only 1/3 is accepted as a valid value..
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • relaxation_time (s) — Stress relaxation time (Maxwell time) of the elastic material from which the shell is composed
    • triangles — Array manager of triangles
    • viscosity (kg . m^-1 . s^-1) — Viscosity of the thin shell (Pa*s)
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance of the spring connections. If not given, the ‘current’ distance when the model is first executed will be used.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • pre_factor (1) (default value = 0.57735026918962584) — Pre-factor to translate viscosity into a damping coefficient. For triangulated meshes, this should be 1./sqrt(3) (default). For quadrilateral meshes, this should be 1.
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).
  • Read only properties:
    • c — Current value of the dashpot coefficient (read-only)
    • creep_viscosity — Effective creep viscosity determined from relaxation time
    • gamma_normal — Viscous damping in the ‘in-plane’ direction (read-only)
    • gamma_tangential — Viscous damping in the ‘out-of-plane’ direction (read-only)
    • k — spring stiffness, computed from E, area and thickness (read-only).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataNodeShellDataNode_Node_ShellElasticShellSpringN_T_ShellViscositySpringStiffnessMaxwellFluidShellAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

SpringSerialDashpotMatrix

Description: Linear spring model, damping in friction matrix, serial dashpot causes plastic deformation. Tension is computed and stored in an array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

SpringSerialDashpotMatrix (SPH SPH)

Linear spring model, damping in friction matrix, serial dashpot causes plastic deformation. Tension is computed and stored in an array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • c (kg . s^-1) — Damping coefficient (kg/s)
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringSerialDashpotN_T_ConstantResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

SpringSerialDashpotMatrix (Sphere Sphere)

Linear spring model, damping in friction matrix, serial dashpot causes plastic deformation. Tension is computed and stored in an array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • c (kg . s^-1) — Damping coefficient (kg/s)
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringSerialDashpotN_T_ConstantResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

SpringSerialDashpotVirialEnergyMatrix

Description: Linear spring model, damping in friction matrix, serial dashpot causes plastic deformation. Tension is computed and stored in an array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

SpringSerialDashpotVirialEnergyMatrix (SPH SPH)

Linear spring model, damping in friction matrix, serial dashpot causes plastic deformation. Tension is computed and stored in an array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • c (kg . s^-1) — Damping coefficient (kg/s)
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringSerialDashpotN_T_ConstantResistanceAssemble_VirialEnergyAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

SpringSerialDashpotVirialEnergyMatrix (Sphere Sphere)

Linear spring model, damping in friction matrix, serial dashpot causes plastic deformation. Tension is computed and stored in an array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • c (kg . s^-1) — Damping coefficient (kg/s)
    • gamma_normal (kg . s^-1) — Normal friction coefficient (kg/s)
    • gamma_tangential (kg . s^-1) — Tangential friction coefficient (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringSerialDashpotN_T_ConstantResistanceAssemble_VirialEnergyAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

VariableLinearSpringTensionMatrix

Description: Node-node interaction model with linear springs with variable strength, specified by two user-given .’modifier’ arrays kept for each node, where the modification factor on the spring stiffness ‘k’ will be either m_{12} = (m_1 + m2_)/2 or m_{12} = 2 (m_1 m_2)/(m_1+m_2), depending on additional parameter ``harmonic_average`.Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

VariableLinearSpringTensionMatrix (Sphere Sphere)

Node-node interaction model with linear springs with variable strength, specified by two user-given .’modifier’ arrays kept for each node, where the modification factor on the spring stiffness ‘k’ will be either m_{12} = (m_1 + m2_)/2 or m_{12} = 2 (m_1 m_2)/(m_1+m_2), depending on additional parameter ``harmonic_average`.Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • modifier1 — ScalarArray to modify spring constant for pc1.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • broken (default value = None) — If given, increment the node value of this array for each broken edge.
    • d0 (default value = -1) — optional spring equilibrium distance
    • d_max (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • d_min (default value = 0) — distance below which spring will break, bringing forces to zero
    • delete_broken (default value = 1) — If ‘true’, broken springs will be flagged to be removed from the contact detector, so they truly vanish. If you want to still compute additional stuff for broken springs, set this to ‘false’.
    • geometric_average (default value = 0) — If ‘true’, the spring stiffness will be computed using the geometric average instead of the arithmic average (with zero leading to zero stiffness).
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • k (default value = 1) — Optional unmodified spring constant. By default set to one, so that modifier arrays represent the spring constants
    • max_strain (default value = -1) — maximal strain (both in tension and compression) beyond which which spring will break. Will set and override d_max and d_min if given
    • modifier2 (default value = None) — ScalarArray to modify spring constant for pc2, if not set assumed to be the same as pc1.
    • rupture_force (default value = 1.7976931348623157e+308) — Force beyond which a spring connnection will break, regardless of d_max and max_strain
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpring_VariableStrengthN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

ViscousLinearSpringTensionMatrix

Description: Node-node interaction model with linear springs and a serial dashpot (Maxwell model) that causes plastic deformation and fluid-like behavior. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).Tension is assembled in an array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

ViscousLinearSpringTensionMatrix (SPH SPH)

Node-node interaction model with linear springs and a serial dashpot (Maxwell model) that causes plastic deformation and fluid-like behavior. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).Tension is assembled in an array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • c (kg . s^-1) — Damping coefficient (kg/s)
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionSerialDashpotRecomputeRestingLengthDisplacedSpringComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

ViscousLinearSpringTensionMatrix (Sphere Sphere)

Node-node interaction model with linear springs and a serial dashpot (Maxwell model) that causes plastic deformation and fluid-like behavior. Viscous friction forces are computed as friction elements that are assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).Tension is assembled in an array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • c (kg . s^-1) — Damping coefficient (kg/s)
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • slip_threshold (1) (default value = 0) — Minimal stretch at which the viscous damper will be activated. Default: 0 (always).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesAssemble_SpringTensionSerialDashpotRecomputeRestingLengthDisplacedSpringComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

WLCMatrix

Description: Node-node interaction with Worm-Like Chain (WLC) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

WLCMatrix (SPH SPH)

Node-node interaction with Worm-Like Chain (WLC) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

WLCMatrix (Sphere Sphere)

Node-node interaction with Worm-Like Chain (WLC) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node).

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • max_stretch_safety — Safety fraction [0,1] of max_stretch at which F starts behaving linear with local F/d slope
    • max_stretch — Maximum extension of WLC spring.
    • p — WLC persistence length
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • temperature — temperature
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointWLCN_T_MeshWeightedResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

WLCTensionMatrix

Description: Node-node interaction with Worm-Like Chain (WLC) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is computed and stored in a array ‘tension’ kept for each node. Geometry combinations available:

PC2 | PC1 - Sphere SPH
Sphere YES  
SPH   YES

WLCTensionMatrix (SPH SPH)

Node-node interaction with Worm-Like Chain (WLC) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is computed and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • k_compress (kg . s^-2) — spring constant in compressive regime.
    • k_stretch (kg . s^-2) — spring constant in extending regime.
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (m) (default value = -1) — optional equilibrium distance
    • d_max (m) (default value = 1.7976931348623157e+308) — distance at which spring will break, bringing forces to zero
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointSpringN_T_MeshWeightedResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback

WLCTensionMatrix (Sphere Sphere)

Node-node interaction with Worm-Like Chain (WLC) springs and, viscous damping which is assembled in a contact matrix and weighted with a pre-factor according to the mesh connectivity (number of triangles connected to each node). Tension is computed and stored in a array ‘tension’ kept for each node.

Parallel Compatible: Yes

Properties:

  • Required keywords:
    • gamma_normal (kg . s^-1) — Viscous damping in the ‘in-plane’ direction (kg/s)
    • gamma_tangential (kg . s^-1) — Viscous damping in the ‘out-of-plane’ direction (kg/s)
    • max_stretch_safety — Safety fraction [0,1] of max_stretch at which F starts behaving linear with local F/d slope
    • max_stretch — Maximum extension of WLC spring.
    • p — WLC persistence length
    • pc1 — The first particle container in the binary contact detection.
    • pc2 — The second particle container in the binary contact detection. If contact detection within the same particle container is desired, and it is applicable for the contactmodel, pass the same pc to both pc1 and pc2.
    • temperature — temperature
  • Optional keywords:
    • _contactmatrixdatatype (default value = 1) — Identifier that signals that this chain element’s containing contact model is a friction matrix type. Only change this if you really know what you are doing!
    • d0 (default value = -1) — optional equilibrium distance
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • thickness (default value = -1) — Do not provide this parameter anymore.

This contact model is composed out of following pieces (click on the chain elements to get more information):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataPoint_1_DataPoint_PointWLCN_T_MeshWeightedResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixNoFeedback