EGSnrc C++ class library  Report PIRS-898 (2021)
Iwan Kawrakow, Ernesto Mainegra-Hing, Frederic Tessier, Reid Townson and Blake Walters
Public Member Functions | Protected Attributes | List of all members
EGS_PrismT< T > Class Template Reference

A class for modeling prisms. More...

#include <egs_prism.h>

Inheritance diagram for EGS_PrismT< T >:
EGS_BaseGeometry

Public Member Functions

 EGS_PrismT (T *P, const string &Name="")
 Construct an open prism using P as the base polygon. More...
 
 EGS_PrismT (T *P, EGS_Float D1, EGS_Float D2, const string &Name="")
 Construct a closed prism using P as the base polygon. More...
 
 ~EGS_PrismT ()
 Desctructor, deletes the base polygon.
 
bool isInside (const EGS_Vector &x)
 
int isWhere (const EGS_Vector &x)
 
int inside (const EGS_Vector &x)
 
int howfar (int ireg, const EGS_Vector &x, const EGS_Vector &u, EGS_Float &t, int *newmed=0, EGS_Vector *normal=0)
 
EGS_Float hownear (int ireg, const EGS_Vector &x)
 
const string & getType () const
 
void printInfo () const
 
- Public Member Functions inherited from EGS_BaseGeometry
 EGS_BaseGeometry (const string &Name)
 Construct a geometry named Name. More...
 
virtual ~EGS_BaseGeometry ()
 Destructor. More...
 
bool isConvex () const
 Is the geometry convex? More...
 
virtual EGS_Float howfarToOutside (int ireg, const EGS_Vector &x, const EGS_Vector &u)
 
virtual EGS_Float getVolume (int ireg)
 Calculates the volume of region ireg. More...
 
virtual EGS_Float getBound (int idir, int ind)
 Returns region boundaries in direction determined by idir. More...
 
virtual int getNRegDir (int idir)
 
int regions () const
 Returns the number of local regions in this geometry. More...
 
virtual bool isRealRegion (int ireg) const
 Returnes true if ireg is a real region, false otherwise. More...
 
virtual int medium (int ireg) const
 Returns the medium index in region ireg. More...
 
virtual int getMaxStep () const
 Returns the maximum number of steps through the geometry. More...
 
virtual int computeIntersections (int ireg, int n, const EGS_Vector &x, const EGS_Vector &u, EGS_GeometryIntersections *isections)
 Calculates intersection distances to region boundaries. More...
 
void setMedium (const string &Name)
 Set all regions to a medium with name Name. More...
 
void setMedium (int start, int end, const string &Name, int delta=1)
 Set every delta'th region between start and end to the medium named Name. More...
 
void setMedium (int imed)
 Set all regions to a medium with index imed. More...
 
void setMedium (int istart, int iend, int imed, int delta=1)
 Set every delta'th region between start and end (inclusive) to imed. More...
 
void setMedia (EGS_Input *inp)
 Set the media in the geometry from the input pointed to by inp. More...
 
bool hasRhoScaling () const
 Does this geometry object have a mass density scaling feature? More...
 
virtual EGS_Float getRelativeRho (int ireg) const
 Get the relative mass density in region ireg. More...
 
virtual void setRelativeRho (int start, int end, EGS_Float rho)
 Set the relative mass density in regions. More...
 
virtual void setRelativeRho (EGS_Input *)
 Set the relative mass density from an user input. More...
 
EGS_Float getMediumRho (int ind) const
 
virtual void setApplication (EGS_Application *app)
 
bool hasBScaling () const
 Does this geometry object have a B field scaling feature?
 
virtual EGS_Float getBScaling (int ireg) const
 Get the B field scaling factor in region ireg.
 
virtual void setBScaling (int start, int end, EGS_Float bf)
 Set the B field scaling factor in regions. More...
 
virtual void setBScaling (EGS_Input *)
 Set the B field scaling factor from an user input. More...
 
const string & getName () const
 Get the name of this geometry. More...
 
void setDebug (bool deb)
 Turn debugging on. More...
 
void setName (EGS_Input *inp)
 Set the name of the geometry from the input inp. More...
 
void setBoundaryTolerance (EGS_Input *inp)
 Set the value of the boundary tolerance from the input inp. More...
 
void setBoundaryTolerance (EGS_Float tol)
 Set the value of the boundary tolerance from argument.
 
virtual bool hasBooleanProperty (int ireg, EGS_BPType prop) const
 Is the boolean property prop set for region ireg ?
 
virtual void setBooleanProperty (EGS_BPType prop)
 Set the boolean properties of the entire geometry to prop. More...
 
virtual void addBooleanProperty (int bit)
 Add a boolean property for the entire geometry by setting the bit'th bit. More...
 
virtual void setBooleanProperty (EGS_BPType prop, int start, int end, int step=1)
 Set the boolean properties of every step'th region between start and end (inclusive) to prop. More...
 
virtual void addBooleanProperty (int bit, int start, int end, int step=1)
 Add a boolean property to every step'th region between start and end (inclusive) by setting the bit'th bit. More...
 
int ref ()
 Increase the reference count to this geometry. More...
 
int deref ()
 Decrease the reference count to this geometry. More...
 
EGS_Float getBoundaryTolerance ()
 Get the value of the boundary tolerance.
 
virtual void getNumberRegions (const string &str, vector< int > &regs)
 Get a list of all the regions labeled with a number.
 
virtual void getLabelRegions (const string &str, vector< int > &regs)
 Get the list of all regions labeled with str.
 
virtual const string & getLabelName (const int i)
 Get the name of the i-th explicit label in the geometry.
 
virtual int getLabelCount ()
 Get the number of explicit labels in the geometry.
 
int setLabels (EGS_Input *input)
 Set the labels from an input block.
 
int setLabels (const string &inp)
 Set the labels from an input string.
 

Protected Attributes

T * p
 The base polygon.
 
EGS_Vector a
 The normal vector to the base plane.
 
EGS_Float d1
 Distance of the top plane to the base (for closed prisms)
 
EGS_Float d2
 Distance of the bottom plane to the base (for closed prisms)
 
bool open
 Is the prism open ?
 
- Protected Attributes inherited from EGS_BaseGeometry
int nreg
 Number of local regions in this geometry. More...
 
string name
 Name of this geometry. More...
 
short * region_media
 Array of media indeces. More...
 
int med
 Medium index. More...
 
bool has_rho_scaling
 Does this geometry have relative mass density scvaling? More...
 
EGS_Float * rhor
 Array with relative mass densities. More...
 
bool has_B_scaling
 Does this geometry has B field scaling factor? More...
 
bool has_Ref_rho
 
EGS_Float * bfactor
 Array with B field scaling factors. More...
 
EGS_Float rhoRef
 Reference density for B field scaling. More...
 
int nref
 Number of references to this geometry. More...
 
bool debug
 Debugging flag. More...
 
bool is_convex
 Is this geometry convex? More...
 
EGS_BPType bproperty
 A bit mask of boolean properties for the entire geometry. More...
 
EGS_BPType * bp_array
 An array of boolean properties on a region by region basis. More...
 
EGS_Float boundaryTolerance
 Boundary tolerance for geometries that need it.
 
EGS_Float halfBoundaryTolerance
 
vector< labellabels
 Labels. More...
 
EGS_Applicationapp
 The application this object belongs to.
 

Additional Inherited Members

- Static Public Member Functions inherited from EGS_BaseGeometry
static int findRegion (EGS_Float xp, int np, const EGS_Float *p)
 Find the bin to which xp belongs, given np bin edges p. More...
 
static int nMedia ()
 Get the number of media registered so far by all geometries. More...
 
static const char * getMediumName (int ind)
 Get the name of medium with index ind. More...
 
static int addMedium (const string &medname)
 Add a medium or get the index of an existing medium. More...
 
static int getMediumIndex (const string &medname)
 Get the index of a medium named medname. More...
 
static EGS_BaseGeometrycreateGeometry (EGS_Input *)
 Create a geometry (or geometries) from a given input. More...
 
static EGS_BaseGeometrycreateSingleGeometry (EGS_Input *inp)
 Create a single geometry from the input inp. More...
 
static void clearGeometries ()
 Clears (deletes) all geometries in the currently active geometry list. More...
 
static EGS_BaseGeometrygetGeometry (const string &Name)
 Get a pointer to the geometry named Name. More...
 
static EGS_BaseGeometry ** getGeometries ()
 
static int getNGeometries ()
 
static string getUniqueName ()
 Get a unique geometry name. More...
 
static void describeGeometries ()
 Describes all existing geometries. More...
 
static void setActiveGeometryList (int list)
 Set the currently active geometry list. More...
 
static int getLastError ()
 
static void resetErrorFlag ()
 
- Protected Member Functions inherited from EGS_BaseGeometry
virtual void setMedia (EGS_Input *inp, int nmed, const int *med_ind)
 Set media. More...
 
- Static Protected Attributes inherited from EGS_BaseGeometry
static int error_flag = 0
 Set to non-zero status if a geometry problem is encountered.
 

Detailed Description

template<class T>
class EGS_PrismT< T >

A class for modeling prisms.

This template class is used to model prisms with specializations for prisms having their bases in the X-, Y-, Z- and any plane. It can be used to model "open" prisms (prisms that extend to infinity along the axis perpendicular to the prism base) or closed prisms. The prism bases can be arbitrary closed polygons. Prism geometries have a single region (inside the prism). They are defined via the following set of keys:

library = egs_prism
type = EGS_PrismX or EGS_PrismY or EGS_PrismZ or EGS_Prism
points = list of 2D or 3D positions
closed = two inputs

When a X-, Y- or Z-prism is being constructed the list of inputs for the points key is considered to be a list of 2D positions in the X-, Y- or Z-planes through the origin (and therefore the number of floating point numbers input must be even). When a EGS_Prism object is constructed, the list of inputs for the points key is considered to be a list of 3D positions (and therefore, the number of floating point numbers input must be divisible by 3). In this case, all points must be on a single plane, otherwise the construction of an EGS_Prism is rejected. The closed key is optional and if missing, the prism becomes "open". If present, the two inputs define the distance from the top and bottom prism plane to the plane used to define the polygon. Note that at least 3 different 2D or 3D positions are required for the points key in order to construct a prism. Also note that if the last point of the polygon is not the same as the first point, the polygon is automatically closed.

A simple example:

:start geometry definition:
    :start geometry:
        name        = my_prism
        library     = egs_prism
        type        = EGS_PrismZ
        points      = 1 1  -1 1  -1 -1  4 -1
        closed      = 1 4
        :start media input:
            media = water
        :stop media input:
    :stop geometry:

    simulation geometry = my_prism

:stop geometry definition:
egs_prism.png
A simple example

Definition at line 124 of file egs_prism.h.

Constructor & Destructor Documentation

template<class T >
EGS_PrismT< T >::EGS_PrismT ( T *  P,
const string &  Name = "" 
)

Construct an open prism using P as the base polygon.

The object takes ownership of the polygon pointed to by P (i.e. no copy is made).

Definition at line 143 of file egs_prism.h.

References EGS_BaseGeometry::isConvex().

template<class T >
EGS_PrismT< T >::EGS_PrismT ( T *  P,
EGS_Float  D1,
EGS_Float  D2,
const string &  Name = "" 
)

Construct a closed prism using P as the base polygon.

The object takes ownership of the polygon pointed to by P (i.e. no copy is made). The distances of the yop and bottom planes from the base are given by D1 and D2.

Definition at line 155 of file egs_prism.h.

References EGS_BaseGeometry::isConvex().


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