radiobiology/include/Dose.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 /// \file radiobiology/include/Dose.hh
0027 /// \brief Definition of the RadioBio::Dose class
0028
0029 #ifndef RadiobiologyDose_h
0030 #define RadiobiologyDose_h 1
0031
0032 #include "globals.hh"
0033
0034 #include "VRadiobiologicalQuantity.hh"
0035
0036 #include <valarray>
0037
0038 namespace RadioBio
0039 {
0040
0041 // Forward declariation of other radiobiology classes
0042 class DetectorConstruction;
0043 class DoseAccumulable;
0044 class DoseMessenger;
0045
0046 class Dose : public VRadiobiologicalQuantity
0047 {
0048   private:
0049     // RBE should be a friend to be able to see the dose
0050     // and use it for its calculations
0051     friend class RBE;
0052
0053   public:
0054     Dose();
0055     ~Dose() override;
0056
0057     // Virtual methods to override
0058     void AddFromAccumulable(G4VAccumulable*) override;
0059     void Initialize() override;
0060     void Compute() override;
0061     void Reset() override;
0062     void Store() override;
0063     void PrintParameters() override;
0064
0065     // Get a copy of the dose object
0066     inline array_type GetDose() const { return fDose; }
0067
0068   private:
0069     // Deposited energy and dose array
0070     array_type fEnDep = {};
0071     array_type fDose = {};
0072
0073     // To be used for accumulation
0074     void SetEnergyDeposit(const array_type Dep) { fEnDep = Dep; }
0075     void AddEnergyDeposit(const array_type Dep) { fEnDep += Dep; }
0076 };
0077
0078 }  // namespace RadioBio
0079
0080 #endif  // Dose_h