A geometry constructed as the union of other geometries. More...

#include <egs_union_geometry.h>

Inheritance diagram for EGS_UnionGeometry:

Public Member Functions
	EGS_UnionGeometry (const vector< EGS_BaseGeometry * > &geoms, const int *priorities=0, const string &Name="")
	Construct a geometry union from the vector of geometries geom.

bool	isRealRegion (int ireg) const

bool	isInside (const EGS_Vector &x)

int	isWhere (const EGS_Vector &x)

int	inside (const EGS_Vector &x)

int	medium (int ireg) const

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

EGS_Float	getRelativeRho (int ireg) const

void	setRelativeRho (int start, int end, EGS_Float rho)

void	setRelativeRho (EGS_Input *)

void	setBScaling (int start, int end, EGS_Float rho)

void	setBScaling (EGS_Input *)

EGS_Float	getBScaling (int ireg) const

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

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?

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 Member Functions
void	setMedia (EGS_Input , int, const int )
	Don't set media when defining the union. More...

Protected Attributes
EGS_BaseGeometry **	g
	the geometries that form the union.

int	ng
	number of geometries.

int	nmax
	max. number of regions in all of the geoms.

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_UnionGeometry"
	the geometry type

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 ()

Detailed Description

A geometry constructed as the union of other geometries.

A geometry union is a geometry constructed from geometries $G_1, G_2,..., G_N$ so that a point is inside the union if it is inside any of the constituent geometries. If two or more of the geometries in the union overlap, the regions and media of the geometry with the highest priority win. As an example consider two intersecting spheres forming an union. For the region occupied simultaneously by both spheres the material in the sphere with the higher priority will be used. A geometry union is defined as follows:

library = egs_gunion
geometries = list of names of previously defined geometries
priorities = list of integers defining the geometry priorities (optional)

The priorities key is optional. If it is missing, the priority decreases when moving from the front to the back of the list (i.e. the priority of $G_i$ is higher than the priority of $G_j$ , if $i < j$ ). If the priorities of the geometries are explicitely defined via the priorities key and $G_i$ and $G_j$ have the same priority defined, $G_i$ is still considered to have a higher priority if $i < j$ . A geometry union is used in the car.geom example geometry file.

A simple example:

:start geometry definition:
    :start geometry:
        name        = my_box
        library     = egs_box
        box size    = 1 2 3
        :start media input:
            media = water
        :stop media input:
    :stop geometry:

    :start geometry:
        name        = my_sphere
        library     = egs_spheres
        midpoint = 0
        radii = 1
        :start media input:
            media = air
        :stop media input:
    :stop geometry:

    :start geometry:
        name        = my_union
        library     = egs_gunion
        # Geometry priority follows order in list
        geometries = my_box my_sphere
    :stop geometry:

    simulation geometry = my_union

:stop geometry definition:

A simple example

Definition at line 133 of file egs_union_geometry.h.

Member Function Documentation

void EGS_UnionGeometry::setMedia	(	EGS_Input *	,
		int	,
		const int *
	)

protectedvirtual

Don't set media when defining the union.

This function is re-implemented to warn the user that media should be defined for each individual geometry participating in the union, not in the union itself.

Reimplemented from EGS_BaseGeometry.

Definition at line 47 of file egs_union_geometry.cpp.

References egsWarning.

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

/home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_union/egs_union_geometry.h
/home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_union/egs_union_geometry.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation