egs_advanced_application.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ advanced application headers
#  Copyright (C) 2015 National Research Council Canada
#
#  This file is part of EGSnrc.
#
#  EGSnrc is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the
#  Free Software Foundation, either version 3 of the License, or (at your
#  option) any later version.
#
#  EGSnrc is distributed in the hope that it will be useful, but WITHOUT ANY
#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
#  FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
#  more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with EGSnrc. If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################
#
#  Author:          Iwan Kawrakow, 2005
#
#  Contributors:    Ernesto Mainegra-Hing
#                   Frederic Tessier
#                   Reid Townson
#                   Blake Walters
#
###############################################################################
*/
 
 
#ifndef EGS_ADVANCED_APPLICATION_
#define EGS_ADVANCED_APPLICATION_
 
#include "egs_libconfig.h"
#include "egs_application.h"
#include <vector>
 
class EGS_Input;
class EGS_Interpolator;
 
class APP_EXPORT EGS_AdvancedApplication : public EGS_Application {
 
public:
 
    //
    // ********* constructor and destructor
    //
    EGS_AdvancedApplication(int argc, char **argv);
 
    virtual ~EGS_AdvancedApplication();
 
    void setAusgabCall(AusgabCall call, bool on_or_off);
 
    virtual void finishRun();
 
 
    int outputData();
 
    int readData();
 
    int addState(istream &);
 
    void resetCounter();
 
    int finishSimulation();
 
    void describeSimulation();
 
    EGS_I64 randomNumbersUsed() const;
 
    void getElectronSteps(double &ch_steps, double &all_steps) const;
 
    virtual void saveRNGState();
 
    virtual void resetRNGState();
 
    void appInformation(const char *msg);
    void appWarning(const char *msg);
    void appFatal(const char *msg);
 
    void startNewParticle();
    void enterNewRegion();
 
    void setRayleighData(const vector<string> &str_medium,
                         const vector<string> &str_file);
    void setEIIData(EGS_I32 len);
 
    //************************************************************
    // Utility functions for use with ausgab dose scoring objects
    //************************************************************
    EGS_Float getMediumRho(int ind);
    EGS_Float getEdep();
    void setEdep(EGS_Float edep);
    EGS_Float getEcut();
    EGS_Float getPcut();
 
    //************************************************************
    // Utility function for ausgab phase space scoring objects
    //************************************************************
    void setLatch(int latch);
 
    //************************************************************
    // Utility functions for fluence scoring objects
    //************************************************************
    EGS_Float getTVSTEP();
    EGS_Interpolator *getDEDX(const int &imed, const int &iq);
    void setLatch(const int &ip, const int &latch);
    void incLatch(const int &ip, const int &increment);
    int getNp();
    int getNpOld();
 
    /* Needed by some sources */
    EGS_Float getRM();
 
    //************************************************
    // For use with ausgab radiative splitting objects
    //************************************************
 
    /* Turn ON/OFF EGSnrc internal radiative splitting (UBS) */
    void setRadiativeSplitting(const EGS_Float &nsplit);
    /* Turn ON/OFF EGSnrc internal Russian Roultette + UBS */
    void setRussianRoulette(const EGS_Float &iSwitchRR);
    void splitTopParticleIsotropically(const EGS_Float &fsplit);
 
protected:
 
    int              nmed;      
    EGS_Interpolator *i_ededx;  
    EGS_Interpolator *i_pdedx;  
    EGS_Interpolator *i_esig;   
    EGS_Interpolator *i_psig;   
    EGS_Interpolator *i_ebr1;   
    EGS_Interpolator *i_pbr1;   
    EGS_Interpolator *i_pbr2;   
 
    EGS_Interpolator *i_gmfp;   
    EGS_Interpolator *i_gbr1;   
    EGS_Interpolator *i_gbr2;   
    EGS_Interpolator *i_cohe;   
    EGS_Interpolator *i_photonuc;   
 
    int n_rng_buffer;           
    int i_rng_buffer;           
    EGS_Float *rng_buffer;      
 
    int initEGSnrcBackEnd();
 
    int initCrossSections();
 
    int shower();
 
    bool final_job;  
 
    int  helpInit(EGS_Input *, bool do_hatch);
 
    static string base_revision;
 
    int    io_flag; 
 
};
 
#endif