mpacts.contact.models.collision.linearforce. linearforce_matrix

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

import mpacts.contact.models.collision.linearforce.linearforce_matrix
#or assign it to a shorter name
import mpacts.contact.models.collision.linearforce.linearforce_matrix as lin

LinearForceDisplacedMatrix

Description: Linear Force - stiffness k - between spheres with normals in an overdamped system with a parallel and normal friction constant. This model is aimed for nodes of the mesh, where the position of the sphere is displaced along the normal inside a mesh, which guarantees that the surface of the mesh and sphere coincide at the node, or in other words the sphere is approximately inscribed in mesh. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

LinearForceDisplacedMatrix (Sphere Sphere)

Linear Force - stiffness k - between spheres with normals in an overdamped system with a parallel and normal friction constant. This model is aimed for nodes of the mesh, where the position of the sphere is displaced along the normal inside a mesh, which guarantees that the surface of the mesh and sphere coincide at the node, or in other words the sphere is approximately inscribed in mesh.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataSphere0_1_DataSphere_Sphere_DisplacedN_LinearForceN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixAbortIfSameParentFeedback

LinearForceMatrix

Description: Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant Geometry combinations available:

PC2 | PC1 - Sphere Rigid_Triangle Rigid_Sphere Rigid_RoundedTriangle Rigid_Quad Rigid_CylinderTop Rigid_CylinderBottom Rigid_Cylinder Rigid_Cone Rigid_Capsule Deformable_Triangle Deformable_RoundedTriangle Deformable_Capsule
Sphere YES YES YES YES YES YES YES YES YES YES YES YES YES
Rigid_Capsule                   YES     YES
Deformable_Capsule                         YES

LinearForceMatrix (Deformable_Capsule Deformable_Capsule)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_data_storage_factory (default value = None) — The contact data storage factory to make contact data. Do not change! Especially vector in parallel is not a safe choice here.
    • contact_data (default value = None) — The contact data belonging to the DoF (parents) made by this model.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • transpose (default value = 0) — switches around pc1 and pc2 for the ContactMatrix.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepDeformable_Cylinder_2_DataDeformable_Cylinder_1_DataCapsule_CapsuleN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForces_DeformableCylinder_2AssembleForces_DeformableCylinder_1ComputeContactMatrixElementOverdampedDeformableCapsuleDof_1DeformableCapsuleDof_2AssembleContactMatrix_ComposedParticleAbortIfSameParentFeedback

LinearForceMatrix (Deformable_Capsule Rigid_Capsule)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepRigid_Cylinder_2_DataDeformable_Cylinder_1_DataCapsule_CapsuleN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessFeedback

LinearForceMatrix (Deformable_Capsule Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_data_storage_factory (default value = None) — The contact data storage factory to make contact data. Do not change! Especially vector in parallel is not a safe choice here.
    • contact_data (default value = None) — The contact data belonging to the DoF (parents) made by this model.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • transpose (default value = 0) — switches around pc1 and pc2 for the ContactMatrix.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataDeformable_Cylinder_1_DataCapsule_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForces_2AssembleForces_DeformableCylinder_1ComputeContactMatrixElementOverdampedDeformableCapsuleDof_1SphereDof_2AssembleContactMatrix_ComposedParticleFeedback

LinearForceMatrix (Deformable_RoundedTriangle Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_data_storage_factory (default value = None) — The contact data storage factory to make contact data. Do not change! Especially vector in parallel is not a safe choice here.
    • contact_data (default value = None) — The contact data belonging to the DoF (parents) made by this model.
    • disable_warning_fake_rounded_triangle (default value = 0) — Disables the printing of the specified warning message.
    • flip_normals (default value = 0) — Optionally flip normals if sphere is more than its radius submerged. In most cases, we recommend that you leave this option to its default ‘false’.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • reject_large_overlap (default value = 1) — Optionally reject overlaps reject_overlap_r times larger than the radius. Unless you have a fully concave ‘container’ geometry, we recommend that you leave this value to its default ‘true’.
    • reject_overlap_r (default value = 1) — If reject_large_overlap is True, this specifies the number of sphere radii of overlap that should be rejected (Default=1).
    • transpose (default value = 0) — switches around pc1 and pc2 for the ContactMatrix.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataDeformable_NGon_1_Data  <3 >
  ↓
NGon_SphereWarningMessage  <WARN::FakeRoundedTriangle >
  ↓
N_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForces_DeformableTriangleBarycentric_1AssembleForces_2ComputeContactMatrixElementOverdampedDeformableTriangleBarycentricDof_1SphereDof_2AssembleContactMatrix_ComposedParticleFeedback

LinearForceMatrix (Deformable_Triangle Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_data_storage_factory (default value = None) — The contact data storage factory to make contact data. Do not change! Especially vector in parallel is not a safe choice here.
    • contact_data (default value = None) — The contact data belonging to the DoF (parents) made by this model.
    • flip_normals (default value = 0) — Optionally flip normals if sphere is more than its radius submerged. In most cases, we recommend that you leave this option to its default ‘false’.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • reject_large_overlap (default value = 1) — Optionally reject overlaps reject_overlap_r times larger than the radius. Unless you have a fully concave ‘container’ geometry, we recommend that you leave this value to its default ‘true’.
    • reject_overlap_r (default value = 1) — If reject_large_overlap is True, this specifies the number of sphere radii of overlap that should be rejected (Default=1).
    • transpose (default value = 0) — switches around pc1 and pc2 for the ContactMatrix.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataDeformable_NGon_1_Data  <3 >
  ↓
NGon_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForces_DeformableTriangleBarycentric_1AssembleForces_2ComputeContactMatrixElementOverdampedDeformableTriangleBarycentricDof_1SphereDof_2AssembleContactMatrix_ComposedParticleFeedback

LinearForceMatrix (Rigid_Capsule Rigid_Capsule)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepRigid_Cylinder_2_DataRigid_Cylinder_1_DataCapsule_CapsuleN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAbortIfSameParentFeedback

LinearForceMatrix (Rigid_Capsule Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_Cylinder_1_DataCylinder_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_Cone Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_Cone_1_DataCone_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_Cylinder Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_Cylinder_1_DataCylinder_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_CylinderBottom Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_Cylinder_1_DataDisk_Sphere  <Bottom_Selector >
  ↓
N_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_CylinderTop Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_Cylinder_1_DataDisk_Sphere  <Top_Selector >
  ↓
N_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_Quad Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • flip_normals (default value = 0) — Optionally flip normals if sphere is more than its radius submerged. In most cases, we recommend that you leave this option to its default ‘false’.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • reject_large_overlap (default value = 1) — Optionally reject overlaps reject_overlap_r times larger than the radius. Unless you have a fully concave ‘container’ geometry, we recommend that you leave this value to its default ‘true’.
    • reject_overlap_r (default value = 1) — If reject_large_overlap is True, this specifies the number of sphere radii of overlap that should be rejected (Default=1).

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_NGon_1_Data  <4 >
  ↓
NGon_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_RoundedTriangle Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • disable_warning_fake_rounded_triangle (default value = 0) — Disables the printing of the specified warning message.
    • flip_normals (default value = 0) — Optionally flip normals if sphere is more than its radius submerged. In most cases, we recommend that you leave this option to its default ‘false’.
    • reject_large_overlap (default value = 1) — Optionally reject overlaps reject_overlap_r times larger than the radius. Unless you have a fully concave ‘container’ geometry, we recommend that you leave this value to its default ‘true’.
    • reject_overlap_r (default value = 1) — If reject_large_overlap is True, this specifies the number of sphere radii of overlap that should be rejected (Default=1).

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_NGon_1_Data  <3 >
  ↓
NGon_SphereWarningMessage  <WARN::FakeRoundedTriangle >
  ↓
N_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesFeedback

LinearForceMatrix (Rigid_Sphere Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigidSphere_1_DataSphere_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Rigid_Triangle Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • flip_normals (default value = 0) — Optionally flip normals if sphere is more than its radius submerged. In most cases, we recommend that you leave this option to its default ‘false’.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • reject_large_overlap (default value = 1) — Optionally reject overlaps reject_overlap_r times larger than the radius. Unless you have a fully concave ‘container’ geometry, we recommend that you leave this value to its default ‘true’.
    • reject_overlap_r (default value = 1) — If reject_large_overlap is True, this specifies the number of sphere radii of overlap that should be rejected (Default=1).

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataRigid_NGon_1_Data  <3 >
  ↓
NGon_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2Feedback

LinearForceMatrix (Sphere Sphere)

Linear Force - stiffness k - between particles in an overdamped system with a parallel and normal friction constant

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 (kg . s^-2) — effective spring constant.
    • 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!
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_radius1 (default value = None) — Radius to be used for determining whether the particle is in contact for particle container 1.
    • contact_radius2 (default value = None) — Radius to be used for determining whether the particle is in contact for particle container 2.
    • 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):

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepSphere0_2_DataSphere0_1_DataRadius_2_SwapperRadius_1_SwapperSphere_SphereN_LinearForceN_T_ConstantResistanceN_ConstantStiffnessAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixFeedback

LinearRepulsionInternalNodes

Description: Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant. Geometry combinations available:

PC2 | PC1 - Sphere Rigid_Triangle Rigid_Quad Rigid_Cylinder Rigid_Capsule Deformable_Triangle Deformable_RoundedTriangle
Sphere YES YES YES YES YES YES YES

LinearRepulsionInternalNodes (Deformable_RoundedTriangle Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_data_storage_factory (default value = None) — The contact data storage factory to make contact data. Do not change! Especially vector in parallel is not a safe choice here.
    • contact_data (default value = None) — The contact data belonging to the DoF (parents) made by this model.
    • disable_warning_fake_rounded_triangle (default value = 0) — Disables the printing of the specified warning message.
    • flip_normals (default value = 0) — If ‘True’, the normals of the N-Gon will be flipped.In most cases, we recommend that you leave this option to its default ‘false’. Contrary to the option ‘flip_normals’ in e.g. Ngon-Sphere contact, this option will always flip the normals, if enables, since points do not have any radius.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • transpose (default value = 0) — switches around pc1 and pc2 for the ContactMatrix.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataDeformable_NGon_1_Data  <3 >
  ↓
NGon_PointWarningMessage  <WARN::FakeRoundedTriangle >
  ↓
N_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForces_DeformableTriangleBarycentric_1AssembleForces_2ComputeContactMatrixElementOverdampedDeformableTriangleBarycentricDof_1SphereDof_2AssembleContactMatrix_ComposedParticleAbortIfSameParentFeedback

LinearRepulsionInternalNodes (Deformable_Triangle Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • contact_data_storage_factory (default value = None) — The contact data storage factory to make contact data. Do not change! Especially vector in parallel is not a safe choice here.
    • contact_data (default value = None) — The contact data belonging to the DoF (parents) made by this model.
    • flip_normals (default value = 0) — If ‘True’, the normals of the N-Gon will be flipped.In most cases, we recommend that you leave this option to its default ‘false’. Contrary to the option ‘flip_normals’ in e.g. Ngon-Sphere contact, this option will always flip the normals, if enables, since points do not have any radius.
    • implicitness (default value = 0) — Choose the semi-implicit integration method. (0 for explicit Euler, 1 for implicit Euler, 0.5 for Cranck-Nicholson).
    • transpose (default value = 0) — switches around pc1 and pc2 for the ContactMatrix.

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

DefaultBoilerPlateContactMatrixDataBoilerPlateContactMatrixContactStateKeepTimeStepPoint_2_DataDeformable_NGon_1_Data  <3 >
  ↓
NGon_PointN_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForces_DeformableTriangleBarycentric_1AssembleForces_2ComputeContactMatrixElementOverdampedDeformableTriangleBarycentricDof_1SphereDof_2AssembleContactMatrix_ComposedParticleAbortIfSameParentFeedback

LinearRepulsionInternalNodes (Rigid_Capsule Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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_DataRigid_Cylinder_1_DataCylinder_PointN_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2AbortIfSameParentFeedback

LinearRepulsionInternalNodes (Rigid_Cylinder Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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_DataRigid_Cylinder_1_DataCylinder_PointN_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2AbortIfSameParentFeedback

LinearRepulsionInternalNodes (Rigid_Quad Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • flip_normals (default value = 0) — If ‘True’, the normals of the N-Gon will be flipped.In most cases, we recommend that you leave this option to its default ‘false’. Contrary to the option ‘flip_normals’ in e.g. Ngon-Sphere contact, this option will always flip the normals, if enables, since points do not have any radius.
    • 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_DataRigid_NGon_1_Data  <4 >
  ↓
NGon_PointN_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2AbortIfSameParentFeedback

LinearRepulsionInternalNodes (Rigid_Triangle Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • flip_normals (default value = 0) — If ‘True’, the normals of the N-Gon will be flipped.In most cases, we recommend that you leave this option to its default ‘false’. Contrary to the option ‘flip_normals’ in e.g. Ngon-Sphere contact, this option will always flip the normals, if enables, since points do not have any radius.
    • 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_DataRigid_NGon_1_Data  <3 >
  ↓
NGon_PointN_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedRigidBodyDof_1SphereDof_2AssembleContactMatrixToDiagonal_2FrictionMatrixForce_2AbortIfSameParentFeedback

LinearRepulsionInternalNodes (Sphere Sphere)

Linear Force - stiffness k - between ‘internal’ nodes and a bounding geometry (e.g. deformable cell) in an overdamped system with a parallel and normal friction constant.

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 (kg . s^-2) — effective spring constant.
    • 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!
    • abort_if_different (default value = 0) — If ‘True’, inverts the regular function of ‘AbortIfSameParent’, and makes the contact model early abort if the particles’ parents are different. Please do not change this ‘Property’ if you are not sure what you are doing.
    • c (kg . s^-1) (default value = 0) — damping coefficient.
    • 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_DataSphere0_1_DataSphere_PointN_LinearForceN_ConstantStiffnessN_T_ConstantResistanceAssembleForcesComputeContactMatrixElementOverdampedAssembleContactMatrixAbortIfSameParentFeedback