ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
PairCriteria::PairCriterion Class Referenceabstract

Criterion which returns a true/false value for a pair of particles. More...

#include <PairCriterion.hpp>

+ Inheritance diagram for PairCriteria::PairCriterion:

Public Member Functions

virtual bool decide (Particle const &p1, Particle const &p2) const =0
 Make a decision based on two particles.
 
bool decide (int id1, int id2) const
 Make a decision based on particle ids.
 
virtual ~PairCriterion ()=default
 

Detailed Description

Criterion which returns a true/false value for a pair of particles.

Definition at line 29 of file core/pair_criteria/PairCriterion.hpp.

Constructor & Destructor Documentation

◆ ~PairCriterion()

virtual PairCriteria::PairCriterion::~PairCriterion ( )
virtualdefault

Member Function Documentation

◆ decide() [1/2]

bool PairCriteria::PairCriterion::decide ( int  id1,
int  id2 
) const
inline

Make a decision based on particle ids.

This can only run on the head node outside of the integration loop.

Definition at line 37 of file core/pair_criteria/PairCriterion.hpp.

References decide(), and get_particle_data().

◆ decide() [2/2]

virtual bool PairCriteria::PairCriterion::decide ( Particle const &  p1,
Particle const &  p2 
) const
pure virtual

Make a decision based on two particles.

Implemented in PairCriteria::DistanceCriterion, PairCriteria::BondCriterion, and PairCriteria::EnergyCriterion.

Referenced by decide().


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