A set of planes intersecting in the same axis. More...
#include <egs_iplanes.h>
Inheritance diagram for EGS_IPlanes:
Public Member Functions | |
| EGS_IPlanes (const EGS_Vector &Xo, const EGS_Vector &A, int np, const EGS_Float *angles, const string &Name="", bool degree=true) | |
| Construct a set of intersecting planes (iplanes) More... | |
| EGS_IPlanes (const EGS_Vector &Xo, const EGS_Vector &A, int np, const EGS_Vector *aj, const EGS_Float *dj, const string &Name="") | |
| Construct a set of intersecting planes (iplanes) More... | |
| EGS_IPlanes (const EGS_Vector &Xo, const EGS_Vector &A, int np, EGS_Float first=0, const string &Name="") | |
| Construct a set of intersecting planes (iplanes) 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 |
| EGS_Vector | getAxisXo () const |
| EGS_Vector | getAxisDirection () const |
| EGS_Vector | getPlaneNormal (int j) const |
| EGS_Float | getPlanePosition (int j) 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. | |
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... | |
| 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. | |
| 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
A set of planes intersecting in the same axis.
The EGS_IPlanes class implements the geometry methods for a set of 
planes intersecting in the same axis that divides the entire space into 
regions (i.e. any point in space is inside an EGS_IPlanes geometry). This type of geometry is useful, for instance, for defining azimuthal segments in cylinders as a component of a composite geometry. It is defined using the following set of keys:
library = egs_iplanes axis = Px, Py, Pz, ax, ay, az angles = list of angles of rotation around the axis for the planes in degrees or angles in radian = same as above but in radians
Note that the axis key requires 6 inputs: the three coordinates of a point on the axis and 3 direction cosines defining the axis direction. Also note that angles must be given in increasing order and that they must be between 0 and 180 degrees.
An example demonstrating the use of I-planes is found in rz_phi.geom.
A simple example:
:start geometry definition:
# The cylinder
:start geometry:
library = egs_cylinders
type = EGS_ZCylinders
name = rho_coordinates
radii = 2
:stop geometry:
# The planes
:start geometry:
library = egs_planes
type = EGS_Zplanes
positions = -2 2
name = z_coordinates
:stop geometry:
# The I-planes
:start geometry:
library = egs_iplanes
axis = 0 0 0 0 0 1
angles = 0 30 60 90 120 150
# above angles are in degrees, you can use
# 'angles in radian' to define angles in radians
name = phi_coordinates
:stop geometry:
# The final geometry is a N-dimensional geometry
# made from the cylinder, the planes and the I-planes
:start geometry:
library = egs_ndgeometry
name = rho_z_phi
dimensions = rho_coordinates z_coordinates phi_coordinates
:start media input:
media = carbon air water
set medium = 0 0
set medium = 1 1
set medium = 2 2
set medium = 3 0
set medium = 4 1
set medium = 5 2
set medium = 6 0
set medium = 7 1
set medium = 8 2
set medium = 9 0
set medium = 10 1
set medium = 11 2
:stop media input:
:stop geometry:
simulation geometry = rho_z_phi
:stop geometry definition:
A simple example
Definition at line 150 of file egs_iplanes.h.
Constructor & Destructor Documentation
| EGS_IPlanes::EGS_IPlanes | ( | const EGS_Vector & | Xo, |
| const EGS_Vector & | A, | ||
| int | np, | ||
| const EGS_Float * | angles, | ||
| const string & | Name = "", |
||
| bool | degree = true |
||
| ) |
Construct a set of intersecting planes (iplanes)
The common axis is defined by the direction A and point on the axis Xo, with np denoting the number of angles in the array angles. If degree is true, all angles are assumed to be in degree, otherwise all angles are considered to be in radian.
Definition at line 50 of file egs_iplanes.cpp.
References EGS_BaseGeometry::nreg.
| EGS_IPlanes::EGS_IPlanes | ( | const EGS_Vector & | Xo, |
| const EGS_Vector & | A, | ||
| int | np, | ||
| const EGS_Vector * | aj, | ||
| const EGS_Float * | dj, | ||
| const string & | Name = "" |
||
| ) |
Construct a set of intersecting planes (iplanes)
The common axis is defined by the direction A and point on the axis Xo. The arrays aj and dj are of size np and define the np planes directly via the equation aj[j]*x = dj[j] for a position x.
Definition at line 79 of file egs_iplanes.cpp.
References EGS_BaseGeometry::nreg.
| EGS_IPlanes::EGS_IPlanes | ( | const EGS_Vector & | Xo, |
| const EGS_Vector & | A, | ||
| int | np, | ||
| EGS_Float | first = 0, |
||
| const string & | Name = "" |
||
| ) |
Construct a set of intersecting planes (iplanes)
The common axis is defined by the direction A and point on the axis Xo. It is assumed that space is divided uniformely into np segments, with first defining the angle of the first plane in radians.
Definition at line 92 of file egs_iplanes.cpp.
References EGS_BaseGeometry::nreg.
The documentation for this class was generated from the following files:
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_iplanes/egs_iplanes.h
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_iplanes/egs_iplanes.cpp
