VRadiobiologicalQuantity.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
/// \file radiobiology/include/VRadiobiologicalQuantity.hh
/// \brief Definition of the RadioBio::VRadiobiologicalQuantity class
 
// This is a purely virtual class giving the framework for the
// calculation of a radiobiological quantity.
// Default quantities (inheriting from this class) are Dose,
// LET and RBE.
 
#ifndef RadiobiologyVRadiobiologicalQuantity_H
#define RadiobiologyVRadiobiologicalQuantity_H 1
 
#include "VoxelizedSensitiveDetector.hh"
 
#include <valarray>
 
class G4VAccumulable;
class G4UImessenger;
 
namespace RadioBio
{
 
class VRadiobiologicalQuantity
{
  public:
    VRadiobiologicalQuantity()
    {
      if (VoxelizedSensitiveDetector::GetInstance() == 0)
        G4Exception("VRadiobiologicalQuantity::VRadiobiologicalQuantity", "NotVoxelized",
                    FatalException,
                    "Trying to create a radiobiological quantity before voxelizing the detector!");
 
    }
 
    virtual ~VRadiobiologicalQuantity()
    {
      ;
    }
 
    // If this is false (set with macro), nothing happens
    G4bool IsCalculationEnabled() const
    {
      return fCalculationEnabled;
    }
 
    // If this is true, calculation is over and values are updated
    G4bool HasBeenCalculated() const
    {
      return fCalculated;
    }
 
    // Parameter setting
    void SetCalculationEnabled(G4bool enabled)
    {
      fCalculationEnabled = enabled;
    }
 
    // Verbosity for output
    void SetVerboseLevel(G4int level)
    {
      fVerboseLevel = level;
    }
    G4int GetVerboseLevel() const
    {
      return fVerboseLevel;
    }
 
    // Set path for output file
    void SetPath(G4String fN)
    {
      fPath = fN;
    }
 
    // Alias for matrix type
    using array_type = std::valarray<G4double>;
 
    // Update data from the accumulable
    void virtual AddFromAccumulable(G4VAccumulable*) = 0;
 
    // Initialization
    void virtual Initialize() = 0;
 
    // Calculation
    void virtual Compute() = 0;
 
    // Clear accumulated data
    void virtual Reset() = 0;
 
    // Output to text files (called at the end of run)
    void virtual Store() = 0;
 
    // Some basic output to the screen
    void PrintVirtualParameters()
    {
      G4cout << "** Verbose level = " << fVerboseLevel << " **********************" << G4endl
             << "** Initialized = " << (fInitialized ? "true *" : "false ")
             << "********************" << G4endl << "** Saved = " << (fSaved ? "true *" : "false ")
             << "**************************" << G4endl
             << "** Calculation enabled = " << (fCalculationEnabled ? "true *" : "false ")
             << "************" << G4endl << "*******************************************" << G4endl;
    }
    void virtual PrintParameters()
    {
      PrintVirtualParameters();
    }
 
  protected:
    // Proper messenger
    G4UImessenger* fMessenger = nullptr;
 
    // Verbose Level
    G4int fVerboseLevel = 1;
 
    // Bool to see if class has been initialized
    G4bool fInitialized = false;
 
    // Bool to see if output has already been saved
    G4bool fSaved = false;
 
    // Bool to see if quantity has been calculated
    G4bool fCalculated = false;
 
    // Output paths
    G4String fPath ;
 
    // Boolean for calculation
    G4bool fCalculationEnabled = false;
};
 
}  // namespace RadioBio
 
#endif