egs_simple_application.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ simple 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:
#
###############################################################################
*/


#ifndef EGS_SIMPLE_APPLICATION_
#define EGS_SIMPLE_APPLICATION_

#include "egs_libconfig.h"
#include "egs_base_geometry.h"

class EGS_BaseSource;
class EGS_RandomGenerator;
class EGS_Input;

class APP_EXPORT EGS_SimpleApplication {

public:

    //
    // ******************* constructor and destructor *************************
    //
    EGS_SimpleApplication(int argc, char **argv);

    virtual ~EGS_SimpleApplication();

    //
    // ************************ geometry functions **********************
    //
    inline int howfar(int ireg, const EGS_Vector &x, const EGS_Vector &u,
                      EGS_Float &t, int *newmed) {
        return g->howfar(ireg,x,u,t,newmed);
    };
    inline EGS_Float hownear(int ireg,const EGS_Vector &x) {
        return g->hownear(ireg,x);
    };
    inline int getMedium(int ireg) {
        return g->medium(ireg);
    };

    //
    // ******************** ausgab ***************************************
    //
    virtual int ausgab(int) {
        return 0;
    };

    //
    // ********* finish the simulation
    //
    virtual void finish();

    //
    // ********* run a simulation
    //
    virtual int run();

    //
    // ********* how often to report the progress of the simulation
    //
    void setNProgress(int nprog) {
        nreport = nprog;
    };

    //
    // ********* functions to be executed before and after a shower.
    //
    virtual void startHistory(EGS_I64) {};

    virtual void endHistory() {};

    //
    // ******** fill an array with random numbers using the random
    //          number generator of this application.
    //
    void fillRandomArray(int n, EGS_Float *r);

    //
    // ******** get various directories and file names
    //
    const char *egsHome() const;
    const char *henHouse() const;
    const char *pegsFile() const;
    const char *inputFile() const;
    const char *outputFile() const;
    const char *userCode() const;
    const char *workDir() const;

    //
    // ******** the parallel run index and number of parallel jobs
    //
    int iParallel() const;
    int nParallel() const;

protected:

    EGS_I64             ncase;    
    int                 nreport;  
    EGS_BaseGeometry    *g;       
    EGS_BaseSource      *source;  
    EGS_RandomGenerator *rndm;    
    EGS_Input           *input;   
    double              sum_E,  
                        sum_E2, 
                        sum_w,  
                        sum_w2, 
                        Etot;   
    EGS_I64             last_case; 

};

#endif

#define APP_MAIN(app_name) \
    int main(int argc, char **argv) { \
        app_name app(argc,argv); \
        app.run(); \
        app.reportResults(); \
        app.finish(); \
        return 0; \
    }

#define APP_LIB(app_name) \
    extern "C" {\
        APP_EXPORT EGS_SimpleApplication* createApplication(int argc, char **argv) {\
            return new app_name(argc,argv);\
        }\
    }