mpacts.contact.models.misc. infection

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

import mpacts.contact.models.misc.infection
#or assign it to a shorter name
import mpacts.contact.models.misc.infection as inf

ContactInfection

Description: Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles. 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_Line Deformable_Capsule
Sphere YES YES YES YES YES YES YES YES YES YES YES YES YES YES

ContactInfection (Deformable_Capsule Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataDeformable_Cylinder_1_DataCapsule_SphereInfectFeedback

ContactInfection (Deformable_Line Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.
  • Optional keywords:
    • orthogonal_to (default value = 0 0 1) — Direction ‘out of plane’ for the 2D system. Default = (0,0,1).
    • reject_larger_radius (default value = 1) — If true, overlaps larger than the sphere’s radius will be rejected’

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

DefaultBoilerPlateSphere0_2_DataDeformable_Line_1_DataLine_SphereInfectFeedback

ContactInfection (Deformable_RoundedTriangle Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.
  • Optional keywords:
    • 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.
    • 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):

DefaultBoilerPlateSphere0_2_DataDeformable_NGon_1_Data  <3 >
  ↓
NGon_SphereWarningMessage  <WARN::FakeRoundedTriangle >
  ↓
InfectAbortIfSameParentFeedback

ContactInfection (Deformable_Triangle Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.
  • Optional keywords:
    • 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.
    • 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):

DefaultBoilerPlateSphere0_2_DataDeformable_NGon_1_Data  <3 >
  ↓
NGon_SphereInfectAbortIfSameParentFeedback

ContactInfection (Rigid_Capsule Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataRigid_Cylinder_1_DataCylinder_SphereInfectFeedback

ContactInfection (Rigid_Cone Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataRigid_Cone_1_DataCone_SphereInfectFeedback

ContactInfection (Rigid_Cylinder Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataRigid_Cylinder_1_DataCylinder_SphereInfectFeedback

ContactInfection (Rigid_CylinderBottom Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataRigid_Cylinder_1_DataDisk_Sphere  <Bottom_Selector >
  ↓
InfectFeedback

ContactInfection (Rigid_CylinderTop Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataRigid_Cylinder_1_DataDisk_Sphere  <Top_Selector >
  ↓
InfectFeedback

ContactInfection (Rigid_Quad Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.
  • Optional keywords:
    • 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):

DefaultBoilerPlateSphere0_2_DataRigid_NGon_1_Data  <4 >
  ↓
NGon_SphereInfectFeedback

ContactInfection (Rigid_RoundedTriangle Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.
  • Optional keywords:
    • 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):

DefaultBoilerPlateSphere0_2_DataRigid_NGon_1_Data  <3 >
  ↓
NGon_SphereWarningMessage  <WARN::FakeRoundedTriangle >
  ↓
InfectFeedback

ContactInfection (Rigid_Sphere Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataRigidSphere_1_DataSphere_SphereInfectFeedback

ContactInfection (Rigid_Triangle Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.
  • Optional keywords:
    • 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):

DefaultBoilerPlateSphere0_2_DataRigid_NGon_1_Data  <3 >
  ↓
NGon_SphereInfectFeedback

ContactInfection (Sphere Sphere)

Propagate an ‘infection’ through contacts between particles. Useful for efficiently quantifying clusters of particles.

Parallel Compatible: No

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.

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

DefaultBoilerPlateSphere0_2_DataSphere0_1_DataSphere_SphereInfectFeedback