mpacts.contact.models.misc. coulomb

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

import mpacts.contact.models.misc.coulomb
#or assign it to a shorter name
import mpacts.contact.models.misc.coulomb as cou

ScreenedCoulomb

Description: Screened Coulomb force between two charged points. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

ScreenedCoulomb (Sphere Sphere)

Screened Coulomb force between two charged points.

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.
    • permittivity (s^4 . A^2 . kg^-1 . m^-3) — Permittivity
    • screening_length (m) — Screening length.
  • Optional keywords:
    • 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.

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

DefaultBoilerPlateSphere0_2_DataSphere0_1_DataCharge_2_DataCharge_1_DataRadius_2_SwapperRadius_1_SwapperSphere_SphereScreened_CoulombAssembleForcesFeedback

ScreenedCoulombWithPlane

Description: Screened Coulomb force for a charged particle in a uniformly charged environment close to an uncharged obstacle. Geometry combinations available:

PC2 | PC1 - Rigid_Triangle Rigid_Quad Deformable_Triangle
Sphere YES YES YES

ScreenedCoulombWithPlane (Deformable_Triangle Sphere)

Screened Coulomb force for a charged particle in a uniformly charged environment close to an uncharged obstacle.

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.
    • permittivity (s^4 . A^2 . kg^-1 . m^-3) — Permittivity
    • rho (s . A . m^-3) — Corresponds to the homogeneous charge density in the medium.
    • screening_length (m) — Screening length.
  • Optional keywords:
    • contact_radius2 (default value = None) — Radius to be used for determining whether the particle is in contact for particle container 2.
    • 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 >
  ↓
Charge_2_DataRadius_2_SwapperNGon_SphereScreened_Coulomb_WithPlaneAssembleForces_DeformableTriangleBarycentric_1AssembleForces_2Feedback

ScreenedCoulombWithPlane (Rigid_Quad Sphere)

Screened Coulomb force for a charged particle in a uniformly charged environment close to an uncharged obstacle.

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.
    • permittivity (s^4 . A^2 . kg^-1 . m^-3) — Permittivity
    • rho (s . A . m^-3) — Corresponds to the homogeneous charge density in the medium.
    • screening_length (m) — Screening length.
  • Optional keywords:
    • contact_radius2 (default value = None) — Radius to be used for determining whether the particle is in contact for particle container 2.
    • 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 >
  ↓
Charge_2_DataRadius_2_SwapperNGon_SphereScreened_Coulomb_WithPlaneAssembleForcesFeedback

ScreenedCoulombWithPlane (Rigid_Triangle Sphere)

Screened Coulomb force for a charged particle in a uniformly charged environment close to an uncharged obstacle.

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.
    • permittivity (s^4 . A^2 . kg^-1 . m^-3) — Permittivity
    • rho (s . A . m^-3) — Corresponds to the homogeneous charge density in the medium.
    • screening_length (m) — Screening length.
  • Optional keywords:
    • contact_radius2 (default value = None) — Radius to be used for determining whether the particle is in contact for particle container 2.
    • 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 >
  ↓
Charge_2_DataRadius_2_SwapperNGon_SphereScreened_Coulomb_WithPlaneAssembleForcesFeedback

ScreenedCoulombWithPotential

Description: Screened Coulomb force between two charged spheres, calculated with a given surface potential. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

ScreenedCoulombWithPotential (Sphere Sphere)

Screened Coulomb force between two charged spheres, calculated with a given surface potential.

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.
    • permittivity (s^4 . A^2 . kg^-1 . m^-3) — Permittivity of the medium.
    • screening_length (m) — Screening length of the medium.
  • Optional keywords:
    • 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.
    • cutoff (default value = 0.10000000000000001) — Cutoff factor. When the surface-to-surface distance is smaller than product of the cutoff factor with the screening length, the force will be set to a constant value.

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

DefaultBoilerPlateSphere0_2_DataSphere0_1_DataZetaPotential_2_DataZetaPotential_1_DataRadius_2_SwapperRadius_1_SwapperSphere_SphereScreened_Coulomb_With_PotentialAssembleForcesFeedback

Yukawa

Description: Yukawa force between two points. Geometry combinations available:

PC2 | PC1 - Sphere
Sphere YES

Yukawa (Sphere Sphere)

Yukawa force between two points.

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.
    • screening_length (m) — Screening length of the medium.
    • well_depth (m^2 . kg . s^-2) — Potential well depth
  • Optional keywords:
    • 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.

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

DefaultBoilerPlateSphere0_2_DataSphere0_1_DataZetaPotential_2_DataZetaPotential_1_DataRadius_2_SwapperRadius_1_SwapperSphere_SphereYukawaAssembleForcesFeedback