Add EGS_DynamicSource class #308
Conversation
|
@blakewalters this branch does not pass the travis compilation test, it fails while building the egs++ library. Can you take a look at that? |
|
Okay, @ftessier, I'll take a look! |
|
|
||
| /*! \file egs_dynamic_source.cpp | ||
| * \brief A dynamic source | ||
| * \IK |
There was a problem hiding this comment.
Typo here, should be \BW.
| } | ||
| } | ||
|
|
||
| //actually select the rotation coordinats for the incident particle |
| /* | ||
| ############################################################################### | ||
| # | ||
| # EGSnrc egs++ transformed source headers |
There was a problem hiding this comment.
File title and authors are wrong.
| const string &Name="", EGS_ObjectFactory *f=0) : | ||
| EGS_BaseSource(Name,f), source(Source) { | ||
| }; | ||
| /*! \brief Construct a dynamic source from the input \a inp */ |
There was a problem hiding this comment.
Okay, let me clean these up before this gets merged....
There was a problem hiding this comment.
PS. What's an astyle run and can I do it in the safety and comfort of my own home?
There was a problem hiding this comment.
Why yes, you can! Check out the handy-dandy wiki docs on coding style:
There was a problem hiding this comment.
Eeehaa! Thanks!
ftessier
force-pushed
the
feature-dynamic_source
branch
from
725fa5f
to
655bc7f
Compare
|
Cleaned up this branch, put everything in a single commit and rebased on develop. @blakewalters this is awesome! Is it ready for merging into develop? |
|
Should be ready to merge, @ftessier. It's all part of the effort of stealthily supplanting dosxyznrc. |
|
Updated the Makefile which still referred to the transformed source. |
blakewalters
force-pushed
the
feature-dynamic_source
branch
from
8f7508d
to
aa894eb
Compare
ftessier
force-pushed
the
feature-dynamic_source
branch
2 times, most recently
from
a163c3c
to
ca22273
Compare
|
Rebased on develop tip and applied astyle. |
|
The setSimulationChunk method--essential if you're going to use a dynamic phase space source in parallel runs--was omitted from this source and from EGS_TransformedSource. I've implemented this method in both sources in the latest commit. Thanks @vahx129 for doing all the heavy debugging! |
ftessier
force-pushed
the
feature-dynamic_source
branch
from
64f22b7
to
a8dbe2b
Compare
Add an EGS_DynamicSource class to allow simulation of dynamic (time-varying) motion of any source during a single calculation. Continuous motion of the source is simulated between user-defined control points, where each control point defines a set of incident polar coordinates and an associated fractional monitor unit (mu) index. If the source is an IAEA format phase space file or a BEAMnrc simulation source which stores the value of mu for each particle, this mu value can be used to set incident source coordinates, thus synchronizing the motion of EGS_DynamicSource with jaw and MLC opening coordinates in the upstream BEAMnrc simulation. For phase space and BEAMnrc simulation sources, EGS_DynamicSource essentially provides the same functionality as sources 20 and 21 in DOSXYZnrc, as documented by Lobo & Popescu, Phys. Med. Biol., 55:4431-4443 (2010). Note that implementation of this source requires the implementation of a new method, EGS_Float getMu(), in egs_base_source. As reimplemented in iaea_phsp_source and egs_beam_source, getMu returns the value of mu associated with a particle. See the source documentation for more info and sample input. Note: replaced to_string(), which is not a member of std on all g++ compilers, with another method of converting integers to strings during the source input loop.
Implement a getMu method so that egs_dynamic_source can pass on the dynamic indexing parameter mu (monitor unit). Also, fix a bug in the iaea_phsp_source when determining whether mu is stored in the phase space source or not.
Add setSimulationChunk method to dynamic and transformed sources in order to set the portion of the phase space source to use during parallel runs.
ftessier
force-pushed
the
feature-dynamic_source
branch
from
a8dbe2b
to
fa382d7
Compare
An EGS_DynamicSource allows the user to simulate dynamic (time-varying)
motion of any source during a single calculation. Continuous motion
of the source is simulated between user-defined control points, where
each control point defines a set of incident polar coordinates and an
associated fractional monitor unit (mu) index.
If the source is an IAEA-format phase space file or a BEAM simulation
source, then, provided the source stores the value of mu for each
particle, the user has the option to use these when setting incident
source coordinates, thus synchronizing the motion of EGS_DynamicSource
with jaw and MLC opening coordinates in the upstream BEAM simulation.
For phase space and BEAM simulation sources, EGS_DynamicSource
essentially provides the same functionality as sources 20 and 21
in DOSXYZnrc, as documented by Lobo & Popescu, Phys. Med. Biol.,
55:4431-4443 (2010).
Note that implementation of this source required the implementation
of a new method, EGS_Float getMu(), in egs_base_source. As
reimplemented in iaea_phsp_source and egs_beam_source, getMu returns
the value of mu associated with a particle.
See the source documentation for more info and an example input.