Class CylindricalBoundary

Defined in File Boundary.h

Inheritance Relationships

Base Type

public AbstractCondition (Class AbstractCondition)

Class Documentation

class CylindricalBoundary : public AbstractCondition 

Flags a particle when leaving the cylinder whose axis is along the z-axis. 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(): Default constructor

CylindricalBoundary(Vector3d origin, double height, double radius)

Constructor

Parameters:

origin – vector corresponding to the lower part of the cylinder axis
height – height of the cylinder
radius – radius of the cylinder

virtual void process(Candidate *candidate) const

Process function This is the main function to work with, it is called during every ModuleList::run step. Derived functions need to override this overload of process!

Parameters:: candidate – Candidate raw pointer

void setOrigin(Vector3d origin)

void setHeight(double height)

void setRadius(double radius)

void setMargin(double margin)

void setLimitStep(bool limitStep)

virtual std::string getDescription() const: Returns description, can be overriden by derived class.

void onReject(Module *rejectAction)

Sets the module that should be invoked on rejection

Parameters:: rejectAction – Module that should be called on rejection

void onAccept(Module *acceptAction)

Sets the module that should be invoked on acception

Parameters:: rejectAction – Module that should be called on acception

void setMakeRejectedInactive(bool makeInactive): Whether to make Candidate inactive on rejection

void setMakeAcceptedInactive(bool makeInactive): Whether to make Candidate inactive on acception

void setRejectFlag(std::string key, std::string value)

sets Rejection flag Sets the key and value that should be set when the Candidate is rejected

Parameters:

key – property key
value – property value

void setAcceptFlag(std::string key, std::string value)

sets the Acception flag Sets the key and value that should be set when the Candidate is accepted

Parameters:

key – property key
value – property value

std::string getRejectFlag()

std::string getAcceptFlag()

void setDescription(const std::string &description)

Sets description, can be used instead of getDescription in derived class

Parameters:: description – Description string

inline void process(ref_ptr<Candidate> candidate) const: Process function Overload for process function to explicitly make a conversion from ref_ptr to a raw pointer

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

Function to reject particle This function rejects the particle, what that means is determined by the rejectAction and makeRejectedInactive variable.

Parameters:: candidate – Candidate raw pointer to reject

inline void reject(ref_ptr<Candidate> candidate) const: Overload for reject(Candidate *candidate) This function wraps reject(Candidate *candidate) so a reference pointer can be conversed explicitly

void accept(Candidate *candidate) const

Function to accepts particle This function accepts the particle, what that means is determined by the acceptAction and makeAcceptedInactive variable.

Parameters:: candidate – Candidate to reject

inline void accept(ref_ptr<Candidate> candidate) const: Overload for accept(Candidate *candidate) This function wraps accept(Candidate *candidate) so a reference pointer can be conversed explicitly

Protected Attributes

ref_ptr<Module> rejectAction: Module to call when Candidate is rejected

ref_ptr<Module> acceptAction: Module to call when Candidate is accepted

bool makeRejectedInactive: If to make Candidate inactive on rejection

bool makeAcceptedInactive: If to make Candidate inactive on acception

std::string rejectFlagKey: key for the Candidate property that should be set on rejection

std::string rejectFlagValue: value for the Candidate property that should be set on rejection

std::string acceptFlagKey: key for the Candidate property that should be set on acception

std::string acceptFlagValue: value for the Candidate property that should be set on acception

mutable size_t _referenceCount