A template class for modeling pyramids. More...
#include <egs_pyramid.h>
Inheritance diagram for EGS_PyramidT< T >:
Public Member Functions | |
| EGS_PyramidT (T *P, const EGS_Vector &Xo, bool O=true, const string &N="") | |
| Construct a pyramid using P as the base polygon and Xo as the position of the tip. More... | |
| 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 > ®s) |
| Get a list of all the regions labeled with a number. | |
| virtual void | getLabelRegions (const string &str, vector< int > ®s) |
| 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 | xo |
| the tip of the pyramid | |
| EGS_2DVector | xop |
| the tip projection on the base polygon | |
| EGS_Vector | a |
| the base normal vector. | |
| EGS_Float | d |
| distance from tip to base polygon (always positive) | |
| int | n |
| number of sides | |
| EGS_Polygon ** | s |
| sides. | |
| bool | open |
| is the pyramid 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< label > | labels |
| Labels. More... | |
| EGS_Application * | app |
| 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_BaseGeometry * | createGeometry (EGS_Input *) |
| Create a geometry (or geometries) from a given input. More... | |
| static EGS_BaseGeometry * | createSingleGeometry (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_BaseGeometry * | getGeometry (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_PyramidT< T >
A template class for modeling pyramids.
This template class models pyramids with specializations for pyramids having their bases in the X-, Y-, Z- and any plane. The class can be used to model "open" pyramids (pyramids that extend to infinity in the direction pointing from the tip of the pyramid towards the plane used to define the pyramid base) or closed pyramids. The pyramid bases can be arbitrary closed polygons. Pyramid geometries have a single region (inside the pyramid). They are defined via the following set of keys:
library = egs_pyramid type = EGS_PyramidX or EGS_PyramidY or EGS_PyramidZ or EGS_Pyramid points = list of 2D or 3D positions tip = Ox, Oy, Oz # 3D position of the tip of the pyramid. closed = 0 or 1 # optional
As with prisms , when a X-, Y- or Z-pyramid 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_Pyramid 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_Pyramid is rejected. The tip key defines the 3D position of the tip of the pyramid. The closed key is optional. When missing or set to 0, the pyramid is open, otherwise it is closed by the plane in which the pyramid base is defined.
The pyramid.geom example geometry file demonstrate the use of a pyramid object.
A simple example:
:start geometry definition:
:start geometry:
name = my_pyramid
library = egs_pyramid
type = EGS_PyramidZ
points = 1 1 -1 1 -1 -1 4 -1
tip = 0 0 2
closed = 1
:start media input:
media = water
:stop media input:
:stop geometry:
simulation geometry = my_pyramid
:stop geometry definition:
A simple example
Definition at line 129 of file egs_pyramid.h.
Constructor & Destructor Documentation
template<class T >
| EGS_PyramidT< T >::EGS_PyramidT | ( | T * | P, |
| const EGS_Vector & | Xo, | ||
| bool | O = true, |
||
| const string & | N = "" |
||
| ) |
Construct a pyramid using P as the base polygon and Xo as the position of the tip.
If O is true, the pyramid is open (i.e. extends to infinity in the direction from the tip towards the pyramid base), otherwise it is closed by the base polygon.
Definition at line 50 of file egs_pyramid.cpp.
References EGS_PyramidT< T >::a, EGS_BaseGeometry::boundaryTolerance, EGS_PyramidT< T >::d, egsFatal, EGS_Projector::getProjection(), EGS_BaseGeometry::is_convex, EGS_PyramidT< T >::n, EGS_Projector::normal(), EGS_BaseGeometry::nreg, EGS_PyramidT< T >::open, EGS_PyramidT< T >::p, EGS_PyramidT< T >::s, EGS_PyramidT< T >::xo, and EGS_PyramidT< T >::xop.
The documentation for this class was generated from the following files:
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_pyramid/egs_pyramid.h
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_pyramid/egs_pyramid.cpp
