Class CubicBoundary

Inheritance Relationships

Base Type

Class Documentation

class CubicBoundary : public AbstractCondition

Flags a particle when exiting the cube.

The particle is made inactive and flagged as “Rejected”. By default the module prevents overshooting the boundary by more than a margin of 0.1 kpc. This corresponds to the default minimum step size of the propagation modules (PropagationCK and SimplePropagation).

Public Functions

CubicBoundary()

Default constructor

CubicBoundary(Vector3d origin, double size)

Constructor

Parameters
  • origin – vector corresponding to the lower box corner

  • size – vector corresponding to the box sizes along each direction

virtual void process(Candidate *candidate) const
void setOrigin(Vector3d origin)
void setSize(double size)
void setMargin(double margin)
void setLimitStep(bool limitStep)
virtual 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)
inline void process(ref_ptr<Candidate> candidate) const
inline size_t addReference() const
inline size_t removeReference() const
inline int removeReferenceNoDelete() const
inline size_t getReferenceCount() const

Protected Functions

void reject(Candidate *candidate) const
inline void reject(ref_ptr<Candidate> candidate) const
void accept(Candidate *candidate) const
inline 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
mutable size_t _referenceCount