A geometry repeated on a regular XYZ grid. More...

#include <egs_nd_geometry.h>

Inheritance diagram for EGS_XYZRepeater:

Public Member Functions
	EGS_XYZRepeater (EGS_Float Xmin, EGS_Float Xmax, EGS_Float Ymin, EGS_Float Ymax, EGS_Float Zmin, EGS_Float Zmax, int Nx, int Ny, int Nz, EGS_BaseGeometry *G, const string &Name="")

int	isWhere (const EGS_Vector &x)

bool	isInside (const EGS_Vector &x)

int	inside (const EGS_Vector &x)

int	medium (int ireg) const

EGS_Float	howfarToOutside (int ireg, const EGS_Vector &x, const EGS_Vector &u)

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)

int	getMaxStep () const

const string &	getType () const

void	printInfo () const

void	setXYZLabels (EGS_Input *input)

virtual void	getLabelRegions (const string &str, vector< int > &regs)

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	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	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 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
EGS_XYZGeometry *	xyz

EGS_BaseGeometry *	g

EGS_Vector *	translation

EGS_Float	dx

EGS_Float	dxi

EGS_Float	ax

EGS_Float	dy

EGS_Float	dyi

EGS_Float	ay

EGS_Float	dz

EGS_Float	dzi

EGS_Float	az

int	nx

int	ny

int	nz

int	nxy

int	nxyz

int	ng

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
static string	type = "EGS_XYZRepeater"

Static Protected Attributes inherited from EGS_BaseGeometry
static int	error_flag = 0
	Set to non-zero status if a geometry problem is encountered.

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...

Detailed Description

A geometry repeated on a regular XYZ grid.

The main reason for the introduction of the EGS_XYZRepeater geometry is convenience when defining this type of geometry in an input file, although some optimizations in the implementation of the various geometry methods has also been achieved. A EGS_XYZRepeater is a geometry where a base geometry is repeated $N_x \times N_y \times N_z$ times on a regular XYZ grid. It is defined using

:start geometry:
    library = egs_ndgeometry
    type = EGS_XYZRepeater
    repeated geometry = g_name
    repeat x = xmin xmax Nx
    repeat y = ymin ymax Ny
    repeat z = zmin zmax Nz
    medium = m_name
:stop geometry:

where g_name is the name of a pre-existing geometry. The medium input is optional. If present, the space within xmin...xmax,ymin...ymax,zmin...zmax is filled with the nedium named m_name, otherwise with vacuum. If the repeated geometry has $N_r$ regions, then there will be $N_x \times N_y \times N_z \times N_r + 1$ regions in the geometry, with the space surrounding the repeated geometry having region index $N_x \times N_y \times N_z \times N_r$ . The repeated geometry can be of any type and complexity, the only requirement is that it completely fits within the box $-Delta x/2 \cdots Delta x/2, -Delta y/2 \cdots Delta y/2,-Delta z/2 \cdots Delta z/2$ about the origin, where $\Delta x$ =(xmax-xmin)/Nx, etc.

See repeated_geometry.geom geometry file for an example of EGS_XYZRepeater use.

A simple example:

:start geometry definition:
    :start geometry:
        name        = my_sphere
        library     = egs_spheres
        midpoint = 0
        radii = 0.5
        :start media input:
            media = water
        :stop media input:
    :stop geometry:

    :start geometry:
        name            = my_xyz_repeater
        library         = egs_ndgeometry
        type            = EGS_XYZRepeater
        medium          = air

        repeated geometry = my_sphere

        # Format is: min, max, N
        repeat x = -1 4 3
        repeat y = -1 4 3
        repeat z = -1 4 3
    :stop geometry:

    simulation geometry = my_xyz_repeater

:stop geometry definition:

A simple example

Definition at line 1698 of file egs_nd_geometry.h.

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

/home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_nd_geometry/egs_nd_geometry.h
/home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_nd_geometry/egs_nd_geometry.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description