Object belonging checkers

Object belonging checkers serve two purpooses:

  1. Split a ParticleVector into two disjointed parts (possibly forming a new Particle Vector): the particles that are inside any object of the given ObjectVector and the particles that are outside.
  2. Maintain the mentioned inside-outside property of the particles in the resulting ParticleVectors. Such maintenance is performed periodically, and the particles of, e.g. inner PV that appear to mistakingly be outside of the reference ObjectVector will be moved to the outer PV (and viceversa). If one of the PVs was specified as “none”, the erroneous particles will be deleted from the simulation.

See also Mirheo.registerObjectBelongingChecker and Mirheo.applyObjectBelongingChecker.

Summary

BelongingChecker() Base class for checking if particles belong to objects
Capsule() This checker will use the analytical representation of the capsule to detect inside-outside status.
Cylinder() This checker will use the analytical representation of the cylinder to detect inside-outside status.
Ellipsoid() This checker will use the analytical representation of the ellipsoid to detect inside-outside status.
Mesh() This checker will use the triangular mesh associated with objects to detect inside-outside status.
Rod() This checker will detect inside-outside status with respect to every segment of the rod, enlarged by a given radius.

Details

class BelongingChecker

Bases: object

Base class for checking if particles belong to objects

__init__()

Initialize self. See help(type(self)) for accurate signature.

class Capsule

Bases: mmirheo.BelongingCheckers.BelongingChecker

This checker will use the analytical representation of the capsule to detect inside-outside status.

__init__(name: str) → None
Parameters:name – name of the checker
class Cylinder

Bases: mmirheo.BelongingCheckers.BelongingChecker

This checker will use the analytical representation of the cylinder to detect inside-outside status.

__init__(name: str) → None
Parameters:name – name of the checker
class Ellipsoid

Bases: mmirheo.BelongingCheckers.BelongingChecker

This checker will use the analytical representation of the ellipsoid to detect inside-outside status.

__init__(name: str) → None
Parameters:name – name of the checker
class Mesh

Bases: mmirheo.BelongingCheckers.BelongingChecker

This checker will use the triangular mesh associated with objects to detect inside-outside status.

__init__(name: str) → None
Parameters:name – name of the checker
class Rod

Bases: mmirheo.BelongingCheckers.BelongingChecker

This checker will detect inside-outside status with respect to every segment of the rod, enlarged by a given radius.

__init__(name: str, radius: float) → None
Parameters:
  • name – name of the checker
  • radius – radius of the rod