mrmd::analysis::CountingPlane Class Reference

Counts particles that cross a defined plane between two time steps. More...

#include <analysis/CountingPlane.hpp>

Public Member Functions
	CountingPlane (const Point3D &pointOnPlane, const Vector3D &planeNormal)
void	startCounting (data::Atoms &atoms)
	Records the current positions of all particles relative to the plane.
int64_t	stopCounting (data::Atoms &atoms)
	Counts how many particles have crossed the plane since startCounting() was called.

Detailed Description

Counts particles that cross a defined plane between two time steps.

Constructor & Destructor Documentation

CountingPlane()

mrmd::analysis::CountingPlane::CountingPlane	(	const Point3D &	pointOnPlane,
		const Vector3D &	planeNormal
	)

Member Function Documentation

startCounting()

void mrmd::analysis::CountingPlane::startCounting

(

data::Atoms &

atoms

)

Records the current positions of all particles relative to the plane.

This method should be called before tracking particle crossings.

stopCounting()

int64_t mrmd::analysis::CountingPlane::stopCounting

(

data::Atoms &

atoms

)

Counts how many particles have crossed the plane since startCounting() was called.

This method compares the current positions of the particles to their positions recorded by startCounting() and determines how many have crossed the plane.

---

The documentation for this class was generated from the following files:

• mrmd/analysis/CountingPlane.hpp
• mrmd/analysis/CountingPlane.cpp