Object belonging checkers

Object belonging checkers serve two purpooses. Firstly, they are used to split a ParticleVector into two disjointed parts (probably forming a new Particle Vector): the particles that are inside any object of the given ObjectVector and the particles that are outside. See also ymero.registerObjectBelongingChecker and ymero.registerObjectBelongingChecker. Secondly, they are used to 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 apper 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.

Summary

BelongingChecker Base class for checking if particles belong to objects
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.

Details

class BelongingChecker

Bases: object

Base class for checking if particles belong to objects

class Ellipsoid

Bases: _ymero.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: _ymero.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