mpacts.contact.models.misc. submerged_volume

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

import mpacts.contact.models.misc.submerged_volume
#or assign it to a shorter name
import mpacts.contact.models.misc.submerged_volume as sub

ComputeSubmergedVolume

Description: Computes the submerged volume of P1 with respect to a surface represented by P2 Geometry combinations available:

PC2 | PC1 - Rigid_Triangle
Rigid_Triangle YES

ComputeSubmergedVolume (Rigid_Triangle Rigid_Triangle)

Computes the submerged volume of P1 with respect to a surface represented by P2

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.
  • Optional keywords:
    • surface_normal (default value = 0 1 0) — Unit normal vector of the liquid-void interface, pointing towards the void phase. Default = (0,1,0)

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

DefaultBoilerPlateRigid_NGon_2_Data  <3 >
  ↓
Rigid_NGon_1_Data  <3 >
  ↓
ComputeSubmergedVolumePolyhedronChainFeedback