egs_beam_source.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ beam source 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
#
###############################################################################
*/


#ifndef EGS_BEAM_SOURCE_
#define EGS_BEAM_SOURCE_

#include "egs_vector.h"
#include "egs_base_source.h"
#include "egs_rndm.h"
#include "egs_functions.h"

#include <fstream>
using namespace std;

#ifdef WIN32

    #ifdef BUILD_BEAM_SOURCE_DLL
        #define EGS_BEAM_SOURCE_EXPORT __declspec(dllexport)
    #else
        #define EGS_BEAM_SOURCE_EXPORT __declspec(dllimport)
    #endif
    #define EGS_BEAM_SOURCE_LOCAL

#else

    #ifdef HAVE_VISIBILITY
        #define EGS_BEAM_SOURCE_EXPORT __attribute__ ((visibility ("default")))
        #define EGS_BEAM_SOURCE_LOCAL  __attribute__ ((visibility ("hidden")))
    #else
        #define EGS_BEAM_SOURCE_EXPORT
        #define EGS_BEAM_SOURCE_LOCAL
    #endif

#endif

class EGS_Library;
typedef void (*InitFunction)(const int *, const int *, const int *,
                             const char *, const char *, const char *,
                             const char *, const char *, int,int,int,int,int);
typedef void (*FinishFunction)();
typedef void (*SampleFunction)(EGS_Float *, EGS_Float *, EGS_Float *,
                               EGS_Float *, EGS_Float *, EGS_Float *, EGS_Float *, EGS_Float *,
                               EGS_I32 *, EGS_I32 *, EGS_I64 *, EGS_I32 *);
typedef void (*MotionSampleFunction)(EGS_Float *, EGS_Float *, EGS_Float *,
                                     EGS_Float *, EGS_Float *, EGS_Float *, EGS_Float *, EGS_Float *,
                                     EGS_I32 *, EGS_I32 *, EGS_I64 *, EGS_I32 *, EGS_Float *);
typedef void (*MaxEnergyFunction)(EGS_Float *);

class EGS_BEAM_SOURCE_EXPORT EGS_BeamSource : public EGS_BaseSource {

public:

    EGS_BeamSource(EGS_Input *, EGS_ObjectFactory *f=0);
    ~EGS_BeamSource();

    EGS_I64 getNextParticle(EGS_RandomGenerator *rndm,
                            int &q, int &latch, EGS_Float &E, EGS_Float &wt,
                            EGS_Vector &x, EGS_Vector &u);
    EGS_Float getEmax() const {
        return Emax;
    };
    EGS_Float getFluence() const {
        return count;
    };
    EGS_Float getMu() {
        if (mu_stored) {
            return mu;
        }
        else {
            return -1.0;
        }
    };
    bool storeState(ostream &data) const {
        return egsStoreI64(data,count);
    };
    bool setState(istream &data) {
        return egsGetI64(data,count);
    };
    bool addState(istream &data) {
        EGS_I64 tmp;
        bool res = egsGetI64(data,tmp);
        count += tmp;
        return res;
    };
    void resetCounter() {
        count = 0;
    };

    bool isValid() const {
        return is_valid;
    };

    void setCutout(EGS_Float xmin, EGS_Float xmax, EGS_Float ymin,
                   EGS_Float ymax) {
        Xmin = xmin;
        Xmax = xmax;
        Ymin = ymin;
        Ymax = ymax;
    };

protected:

    EGS_Library    *lib;    
    FinishFunction finish;  
    SampleFunction sample;  
    MotionSampleFunction motionsample; //< Use this instead because we may want
    //< to synchronize dynamic source with this

    bool        is_valid;
    bool        mu_stored;  
    string      the_file_name;
    ifstream    the_file;
    EGS_Float   Emax;
    EGS_Float   mu;
    EGS_I64     count;

    // filters
    int         particle_type;
    EGS_Float   Xmin, Xmax, Ymin, Ymax;
    EGS_Float   wmin, wmax;

    // temporary particle storage
    int         q_save, latch_save;
    EGS_Float   E_save, wt_save, mu_save;
    EGS_Vector  x_save, u_save;

    // reusing particles
    int         n_reuse_photon, n_reuse_electron;
    int         i_reuse_photon, i_reuse_electron;

    // stored info for first particle read in
    // need this because we now query the data to see
    // if mu index is passed by the source
    EGS_Float tei,txi,tyi,tzi,tui,tvi,twi,twti,tmui;
    int tqi,tlatchi,tiphati;
    EGS_I64     counti;
    bool  use_iparticle; // true if we want to use the above data instead
    // of calling motionsample

};

#endif