Add sources, ausgab, other egs_view editor support

nrc-cnrc · Xuan-Zheng05 · Aug 3, 2019 · Dec 13, 2019 · Aug 3, 2019 · Dec 13, 2019
commit 1d65c15357a1ea840613a383d58a00cc1628ad6d
@@ -29,6 +29,7 @@
 #                   Blake Walters
 #                   Max Orok
 #                   Martin Martinov
+#                   Hannah Gallop
 #
 ###############################################################################
 #
@@ -98,6 +99,8 @@
 #include "egs_input.h"
 #include "egs_functions.h"
 
+static bool EGS_DOSE_SCORING_LOCAL inputSet = false;
+
 EGS_DoseScoring::EGS_DoseScoring(const string &Name,
                                  EGS_ObjectFactory *f) :
     EGS_AusgabObject(Name,f), dose(0), doseM(0), doseF(0),
@@ -591,6 +594,39 @@ void EGS_DoseScoring::resetCounter() {
 //**********************************************************************
 extern "C" {
 
+    static void setInputs() {
+        inputSet = true;
+
+        setBaseAusgabObjectInputs();
+
+        ausBlockInput->getSingleInput("library")->setValues({"EGS_Dose_Scoring"});
+
+        // Format: name, isRequired, description, vector string of allowed values
+        ausBlockInput->addSingleInput("medium dose", false, "Requests the dose deposited in each medium to be scored, default is no", {"yes", "no"});
+        ausBlockInput->addSingleInput("region dose", false, "Requests the dose deposited in each region to be scored, default is yes", {"yes", "no"});
+        ausBlockInput->addSingleInput("volume", false, "Either a unique volume, which will be the same for all regions or a list of individual volumes for each region, default is 1g/cm3");
+        auto dosePtr = ausBlockInput->addSingleInput("dose regions", false, "A list of individual regions");
+        auto startPtr = ausBlockInput->addSingleInput("dose start region", false, "A list of starts for regions");
+        auto stopPtr = ausBlockInput->addSingleInput("dose stop region", false, "A list of stops for regions");
+
+        dosePtr->addDependency(startPtr, "", true);
+        dosePtr->addDependency(stopPtr, "", true);
+        startPtr->addDependency(dosePtr, "", true);
+        stopPtr->addDependency(dosePtr, "", true);
+
+        // This can only be used if one of the geometries is an EGS_XYZGeometry
+        auto blockPtr = ausBlockInput->addBlockInput("output dose file");
+        blockPtr->addSingleInput("geometry name", true, "The name of a predefined EGS_XYZGeometry");
+        blockPtr->addSingleInput("file type", true, "The type of file", {"3ddose"});
+    }
+
+    EGS_DOSE_SCORING_EXPORT shared_ptr<EGS_BlockInput> getInputs() {
+        if(!inputSet) {
+            setInputs();
+        }
+        return ausBlockInput;
+    }
+
     EGS_DOSE_SCORING_EXPORT EGS_AusgabObject *createAusgabObject(EGS_Input *input,
             EGS_ObjectFactory *f) {
         const static char *func = "createAusgabObject(dose_scoring)";

@@ -24,6 +24,7 @@
 #  Author:          Blake Walters, 2018
 #
 #  Contributors:    Reid Townson
+#                   Hannah Gallop
 #
 ###############################################################################
 */
@@ -44,6 +45,8 @@
 #include "egs_functions.h"
 #include "iaea_phsp.h"
 
+static bool EGS_PHSP_SCORING_LOCAL inputSet = false;
+
 EGS_PhspScoring::EGS_PhspScoring(const string &Name,
                                  EGS_ObjectFactory *f) :
     EGS_AusgabObject(Name,f), phsp_index(0), store_max(1000), phsp_file(),
@@ -519,6 +522,86 @@ bool  EGS_PhspScoring::addState(istream &data) {
 //**********************************************************************
 extern "C" {
 
+    static void setInputs() {
+        inputSet = true;
+
+        setBaseAusgabObjectInputs();
+
+        ausBlockInput->getSingleInput("library")->setValues({"EGS_Phsp_Scoring"});
+
+        // Format: name, isRequired, description, vector string of allowed values
+        auto formatPtr = ausBlockInput->addSingleInput("output format", false, "The type of file the data is output to", {"EGSnrc", "IAEA"});
+
+        auto xPtr = ausBlockInput->addSingleInput("constant X", false, "X values(cm) at which all particles are scored.");
+        xPtr->addDependency(formatPtr, "IAEA");
+        auto yPtr = ausBlockInput->addSingleInput("constant Y", false, "Y values(cm) at which all particles are scored.");
+        yPtr->addDependency(formatPtr, "IAEA");
+        auto zPtr = ausBlockInput->addSingleInput("constant Z", false, "Z values(cm) at which all particles are scored.");
+        zPtr->addDependency(formatPtr, "IAEA");
+        auto muPtr = ausBlockInput->addSingleInput("score mu", false, "Default is no", {"yes", "no"});
+        muPtr->addDependency(formatPtr, "IAEA");
+
+        auto multiPtr = ausBlockInput->addSingleInput("score multiple crossers", false, "Default is no", {"yes", "no"});
+        multiPtr->addDependency(formatPtr, "EGSnrc");
+
+        ausBlockInput->addSingleInput("particle type", true, "The type of particle", {"all", "photons", "charged"});
+        ausBlockInput->addSingleInput("output directory", true, "The name of output directory");
+
+        // Method 1: Score particles on entry to/exit from a predefined geometry
+        auto spacePtr = ausBlockInput->addSingleInput("phase space geometry", true, "The name of a previously defined geometry");
+        auto scorePtr = ausBlockInput->addSingleInput("score particles on", false, "entry, exit, entry and exit", {"entry", "exit", "entry and exit"});
+
+        // Method 2: Score particles on exiting one region and entering another
+        auto fromPtr = ausBlockInput->addSingleInput("from regions", true, "A list of exit region numbers");
+        auto toPtr = ausBlockInput->addSingleInput("to regions", true, "A list of entry region numbers");
+
+        // Can only use one method
+        spacePtr->addDependency(fromPtr, "", true);
+        spacePtr->addDependency(toPtr, "", true);
+        scorePtr->addDependency(fromPtr, "", true);
+        scorePtr->addDependency(toPtr, "", true);
+        fromPtr->addDependency(spacePtr, "", true);
+        fromPtr->addDependency(scorePtr, "", true);
+        toPtr->addDependency(spacePtr, "", true);
+        toPtr->addDependency(scorePtr, "", true);
+    }
+
+    EGS_PHSP_SCORING_EXPORT string getExample() {
+        string example;
+        example =
+{R"(
+    # Example of egs_phsp_scoring
+    #:start ausgab object:
+        library = egs_phsp_scoring
+        name = test
+        from regions = 0 2
+        to regions = 3 5
+        output format = IAEA
+        constant Z = 10.0
+        particle type = all
+        score mu = no
+    :stop ausgab object:
+
+    #:start ausgab object:
+        library = egs_phsp_scoring
+        name = test2
+        phase space geometry = scoreplane
+        output format = EGSnrc
+        particle type = all
+        score particles on = entry
+        score multiple crossers = yes
+    :stop ausgab object:
+)"};
+        return example;
+    }
+
+    EGS_PHSP_SCORING_EXPORT shared_ptr<EGS_BlockInput> getInputs() {
+        if(!inputSet) {
+            setInputs();
+        }
+        return ausBlockInput;
+    }
+
     EGS_PHSP_SCORING_EXPORT EGS_AusgabObject *createAusgabObject(EGS_Input *input,
             EGS_ObjectFactory *f) {
         const static char *func = "createAusgabObject(phsp_scoring)";

@@ -23,7 +23,7 @@
 #
 #  Author:          Ernesto Mainegra-Hing, 2018
 #
-#  Contributors:
+#  Contributors:    Hannah Gallop
 #
 ###############################################################################
 #
@@ -50,6 +50,8 @@
 #include "egs_input.h"
 #include "egs_functions.h"
 
+static bool EGS_RADIATIVE_SPLITTING_LOCAL inputSet = false;
+
 EGS_RadiativeSplitting::EGS_RadiativeSplitting(const string &Name,
         EGS_ObjectFactory *f) :
     nsplit(1) {
@@ -111,6 +113,24 @@ void EGS_RadiativeSplitting::setApplication(EGS_Application *App) {
 //**********************************************************************
 extern "C" {
 
+    static void setInputs() {
+        inputSet = true;
+
+        setBaseAusgabObjectInputs();
+
+        ausBlockInput->getSingleInput("library")->setValues({"EGS_Radiative_Splitting"});
+
+        // Format: name, isRequired, description, vector string of allowed values
+        ausBlockInput->addSingleInput("splitting", false, "N-split");
+    }
+
+    EGS_RADIATIVE_SPLITTING_EXPORT shared_ptr<EGS_BlockInput> getInputs() {
+        if(!inputSet) {
+            setInputs();
+        }
+        return ausBlockInput;
+    }
+
     EGS_RADIATIVE_SPLITTING_EXPORT EGS_AusgabObject *createAusgabObject(EGS_Input *input,
             EGS_ObjectFactory *f) {
         const static char *func = "createAusgabObject(radiative_splitting)";

@@ -24,6 +24,7 @@
 #  Author:          Iwan Kawrakow, 2009
 #
 #  Contributors:    Georgi Gerganov
+#                   Hannah Gallop
 #
 ###############################################################################
 */
@@ -38,6 +39,8 @@
 #include "egs_input.h"
 #include "egs_functions.h"
 
+static bool EGS_TRACK_SCORING_LOCAL inputSet = false;
+
 EGS_TrackScoring::EGS_TrackScoring(const string &Name, EGS_ObjectFactory *f) :
     EGS_AusgabObject(Name,f), m_pts(0), m_start(0), m_stop(1024), m_lastCase(-1),
     m_nScore(0), m_bufSize(16), m_score(false), m_didScore(false),
@@ -117,6 +120,48 @@ void EGS_TrackScoring::reportResults() {
 
 extern "C" {
 
+    static void setInputs() {
+        inputSet = true;
+
+        setBaseAusgabObjectInputs();
+
+        ausBlockInput->getSingleInput("library")->setValues({"EGS_Track_Scoring"});
+
+        // Format: name, isRequired, description, vector string of allowed values
+        ausBlockInput->addSingleInput("score photons", false, "Score photons? Default is yes.", {"yes", "no"});
+        ausBlockInput->addSingleInput("score electrons", false, "Score the elctrons? Default is yes.", {"yes", "no"});
+        ausBlockInput->addSingleInput("score positrons", false, "Score positrons? Default is yes.", {"yes", "no"});
+        ausBlockInput->addSingleInput("start scoring", false, "Event_number, default is 0.");
+        ausBlockInput->addSingleInput("stop scoring", false, "Event_number, default is 1024.");
+        ausBlockInput->addSingleInput("buffer size", false, "Size, default is 1024.");
+        ausBlockInput->addSingleInput("file name addition", false, "A string that constructs the output file name");
+    }
+
+    EGS_TRACK_SCORING_EXPORT string getExample() {
+        string example;
+        example =
+{R"(
+    # Example of egs_track_scoring
+    #:start ausgab object:
+        library = egs_track_scoring
+        name = my_score
+        score photons = yes
+        score electrons = yes
+        score positrons = yes
+        start scoring = 0
+        stop scoring = 1024
+    :stop ausgab object:
+)"};
+        return example;
+    }
+
+    EGS_TRACK_SCORING_EXPORT shared_ptr<EGS_BlockInput> getInputs() {
+        if(!inputSet) {
+            setInputs();
+        }
+        return ausBlockInput;
+    }
+
     EGS_TRACK_SCORING_EXPORT EGS_AusgabObject *createAusgabObject(EGS_Input *input,
             EGS_ObjectFactory *f) {
         const static char *func = "createAusgabObject(track_scoring)";

@@ -39,6 +39,7 @@
 
 #include "egs_application.h"
 #include "egs_object_factory.h"
+#include "egs_input_struct.h"
 
 #include <string>
 #include <iostream>
@@ -61,6 +62,12 @@ using namespace std;
 class EGS_Input;
 class EGS_Application;
 
+static shared_ptr<EGS_BlockInput> ausBlockInput = make_shared<EGS_BlockInput>("ausgab object");
+static void setBaseAusgabObjectInputs() {
+    ausBlockInput->addSingleInput("library", true, "The type of ausgab object, loaded by shared library in egs++/dso.");
+    ausBlockInput->addSingleInput("name", true, "The user-declared unique name of this ausgab object. This is the name you may refer to elsewhere in the input file.");
+}
+
 class EGS_EXPORT EGS_AusgabObject : public EGS_Object {
 
 public:

@@ -63,7 +63,7 @@ static void setBaseSourceInputs(bool isSimpleSource = true, bool includeSpectrum
 
     if(isSimpleSource) {
         includeSpectrumBlock = true;
-        srcBlockInput->addSingleInput("charge", true, "The type of particle to emit from the source, as defined by the charge. Use 0 for photons, -1 for electrons and 1 for positrons.");
+        srcBlockInput->addSingleInput("charge", true, "The type of particle to emit from the source, as defined by the charge. Use 0 for photons, -1 for electrons and 1 for positrons.", {"0", "1", "-1"});
     }
     if(includeSpectrumBlock) {
         shared_ptr<EGS_BlockInput> specBlock = srcBlockInput->addBlockInput("spectrum");

@@ -28,6 +28,7 @@
 #                   Rowan Thomson
 #                   Dave Rogers
 #                   Martin Martinov
+#                   Hannah Gallop
 #
 ###############################################################################
 #

@@ -47,7 +47,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_Cylinders"});
 

@@ -52,7 +52,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_EllipticCylinders"});
 

@@ -1089,7 +1089,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_NDGeometry"});
 

@@ -55,7 +55,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_Prism"});
 

@@ -102,7 +102,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_Pyramid"});
 

@@ -47,7 +47,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_RoundRect_Cylinders"});
 

@@ -26,6 +26,7 @@
 #  Contributors:    Frederic Tessier
 #                   Ernesto Mainegra-Hing
 #                   Marc Chamberland
+#                   Hannah Gallop
 #
 ###############################################################################
 #

@@ -687,7 +687,7 @@ extern "C" {
     static void setInputs() {
         inputSet = true;
 
-        setBaseGeometryInputs(false);
+        setBaseGeometryInputs();
 
         geomBlockInput->getSingleInput("library")->setValues({"EGS_Spheres"});