Class CylindricalBoundary

Inheritance Relationships

Base Type

Class Documentation

class CylindricalBoundary : public AbstractCondition

Flags a particle when leaving the cylinder. This module flags particles when outside of the cylinder, defined by a radius and a height. The particle is made inactive and by default is flagged “OutOfBounds”. Optionally the module can ensure the candidate does not overshoot the boundary by more than a set margin.

Public Functions

CylindricalBoundary()
CylindricalBoundary(Vector3d origin, double height, double radius)
void process(Candidate *candidate) const
void setOrigin(Vector3d origin)
void setHeight(double height)
void setRadius(double radius)
void setMargin(double margin)
void setLimitStep(bool limitStep)
std::string getDescription() const
void onReject(Module *rejectAction)
void onAccept(Module *acceptAction)
void setMakeRejectedInactive(bool makeInactive)
void setMakeAcceptedInactive(bool makeInactive)
void setRejectFlag(std::string key, std::string value)
void setAcceptFlag(std::string key, std::string value)
void setDescription(const std::string &description)
void process(ref_ptr<Candidate> candidate) const
size_t addReference() const
size_t removeReference() const
int removeReferenceNoDelete() const
size_t getReferenceCount() const

Protected Functions

void reject(Candidate *candidate) const
void reject(ref_ptr<Candidate> candidate) const
void accept(Candidate *candidate) const
void accept(ref_ptr<Candidate> candidate) const

Protected Attributes

ref_ptr<Module> rejectAction
ref_ptr<Module> acceptAction
bool makeRejectedInactive
bool makeAcceptedInactive
std::string rejectFlagKey
std::string rejectFlagValue
std::string acceptFlagKey
std::string acceptFlagValue
size_t _referenceCount