egs_radionuclide_source.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ radionuclide 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:          Reid Townson, 2016
#
#  Contributors:    Martin Martinov
#
###############################################################################
*/


#ifndef EGS_RADIONUCLIDE_SOURCE_
#define EGS_RADIONUCLIDE_SOURCE_

#include "egs_vector.h"
#include "egs_base_source.h"
#include "egs_rndm.h"
#include "egs_shapes.h"
#include "egs_base_geometry.h"
#include "egs_math.h"
#include "egs_application.h"
#include "egs_spectra.cpp"

#include <algorithm>


#ifdef WIN32

    #ifdef BUILD_RADIONUCLIDE_SOURCE_DLL
        #define EGS_RADIONUCLIDE_SOURCE_EXPORT __declspec(dllexport)
    #else
        #define EGS_RADIONUCLIDE_SOURCE_EXPORT __declspec(dllimport)
    #endif
    #define EGS_RADIONUCLIDE_SOURCE_LOCAL

#else

    #ifdef HAVE_VISIBILITY
        #define EGS_RADIONUCLIDE_SOURCE_EXPORT __attribute__ ((visibility ("default")))
        #define EGS_RADIONUCLIDE_SOURCE_LOCAL  __attribute__ ((visibility ("hidden")))
    #else
        #define EGS_RADIONUCLIDE_SOURCE_EXPORT
        #define EGS_RADIONUCLIDE_SOURCE_LOCAL
    #endif

#endif

class EGS_RADIONUCLIDE_SOURCE_EXPORT EGS_RadionuclideSource :
    public EGS_BaseSource {

public:

    EGS_RadionuclideSource(EGS_Input *, EGS_ObjectFactory *f=0);

    ~EGS_RadionuclideSource() {
        if (baseSource)
            if (!baseSource->deref()) {
                delete baseSource;
            }

        for (vector<EGS_RadionuclideSpectrum * >::iterator it =
                    decays.begin();
                it!=decays.end(); it++) {
            delete *it;
            *it=0;
        }
        decays.clear();
    };

    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 (ishower+1)*(baseSource->getFluence()/sCount); 
    };

    double getTime() const {
        return time;
    };

    double getExperimentTime() const {
        return experimentTime;
    };

    EGS_I64 getShowerIndex() const {
        return ishower;
    };

    unsigned int getEmissionType() const {
        return emissionType;
    }

    void printSampledEmissions() {
        egsInformation("\n======================================================\n");
        egsInformation("Start of source emissions statistics:\n");
        for (unsigned int i=0; i<decays.size(); ++i) {
            decays[i]->printSampledEmissions();
        }
        egsInformation("End of source emissions statistics\n");
        egsInformation("======================================================\n\n");
    };

    bool isValid() const {
        return baseSource;
    };

    bool storeState(ostream &data_out) const;

    bool addState(istream &data);

    void resetCounter();

    bool setState(istream &data);

private:
    EGS_Application *app;

    EGS_I64             count; 
    EGS_Float           Emax; 

    void setUp();

    string sName; 
    EGS_I64 sCount; 
    EGS_BaseSource *baseSource; 

    vector<int>         q_allowed; 
    vector<EGS_RadionuclideSpectrum *> decays; 
    EGS_Float           activity; 

    bool                q_allowAll; 
    bool                disintegrationOccurred; 
    EGS_Float           time, 
                        experimentTime, 
                        lastDisintTime; 
    EGS_I64             ishower; 
    EGS_Vector          xOfDisintegration; 

    unsigned int emissionType;
};

#endif