RadioBio::DoseAccumulable Class Reference

Accumulable of Dose-related data (that must be thread-local). More...

#include <Doxymodules_medical.h>

Inheritance diagram for RadioBio::DoseAccumulable:

Public Types
using	array_type = std::valarray< G4double >

Public Member Functions
	DoseAccumulable ()
	DoseAccumulable (const DoseAccumulable &other)=default
void	Merge (const G4VAccumulable &rhs) override
void	Reset () override
void	Accumulate (Hit *hit) override
const array_type	GetEnDeposit () const
G4int	GetVerboseLevel () const
Public Member Functions inherited from RadioBio::VRadiobiologicalAccumulable
	VRadiobiologicalAccumulable (G4String name)
virtual	~VRadiobiologicalAccumulable ()

Private Member Functions
void	Initialize ()

Private Attributes
G4bool	fInitialized = false
array_type	fEnDep

Detailed Description

Accumulable of Dose-related data (that must be thread-local).

It keeps the energy deposit data divided in voxels for dose calculation

This is implemented as a customized G4VAccumulable with non-scalar data.

Note

There are two levels of merging (accumulation): 1) From more threads in one run (G4VAccumulable merging is applied) 2) (Optional) inter-run merging of data (implemented in Dose).

std::valarray is used (instead of C arrays or std::vectors) to accumulate data for its logical simplicity.

Definition at line 130 of file Doxymodules_medical.h.

Member Typedef Documentation

array_type

using RadioBio::DoseAccumulable::array_type = std::valarray<G4double>

Definition at line 72 of file DoseAccumulable.hh.

Constructor & Destructor Documentation

DoseAccumulable() [1/2]

RadioBio::DoseAccumulable::DoseAccumulable

(

)

Definition at line 48 of file DoseAccumulable.cc.

: VRadiobiologicalAccumulable("Dose") {}

DoseAccumulable() [2/2]

RadioBio::DoseAccumulable::DoseAccumulable ( const DoseAccumulable &  other )

default

Member Function Documentation

Merge()

void RadioBio::DoseAccumulable::Merge ( const G4VAccumulable &  rhs )

override

Definition at line 52 of file DoseAccumulable.cc.

{
  if (GetVerboseLevel() > 1) {
    G4cout << "DoseAccumulable::Merge()" << G4endl;
  }
  const DoseAccumulable& other = dynamic_cast<const DoseAccumulable&>(rhs);
 
  // Merges the counter
  fEnDep += other.GetEnDeposit();
}

Reset()

void RadioBio::DoseAccumulable::Reset ( )

override

Definition at line 65 of file DoseAccumulable.cc.

{
  if (GetVerboseLevel() > 0) {
    G4cout << "DoseAccumulable::Reset()" << G4endl;
  }
  if (fInitialized) {
    fEnDep = 0.0;
  }
  else {
    Initialize();
  }
}

Accumulate()

void RadioBio::DoseAccumulable::Accumulate ( Hit *  hit )

overridevirtual

Implements RadioBio::VRadiobiologicalAccumulable.

Definition at line 81 of file DoseAccumulable.cc.

{
  // Calculation done only if energy is deposited
  if (hit->GetDeltaE() <= 0.) return;
 
  if (GetVerboseLevel() > 1) {
    G4cout << "DoseAccumulable::Accumulate()" << G4endl;
  }
 
  // Get voxel number
  G4int xIndex = hit->GetXindex();
  G4int yIndex = hit->GetYindex();
  G4int zIndex = hit->GetZindex();
 
  G4int voxel =
    VoxelizedSensitiveDetector::GetInstance()->GetThisVoxelNumber(xIndex, yIndex, zIndex);
 
  // Get deposited energy
  G4double DE = hit->GetDeltaE();
 
  // Update total dose
  fEnDep[voxel] += DE;
}

GetEnDeposit()

const array_type RadioBio::DoseAccumulable::GetEnDeposit ( ) const

inline

Definition at line 75 of file DoseAccumulable.hh.

{ return fEnDep; }

GetVerboseLevel()

G4int RadioBio::DoseAccumulable::GetVerboseLevel

(

)

const

Definition at line 107 of file DoseAccumulable.cc.

{
  // Returns same verbosity of Dose class
  return Manager::GetInstance()->GetQuantity("Dose")->GetVerboseLevel();
}

Initialize()

void RadioBio::DoseAccumulable::Initialize ( )

private

Definition at line 115 of file DoseAccumulable.cc.

{
  if (GetVerboseLevel() > 0) {
    G4cout << "DoseAccumulable::Initialize(): " << G4endl;
  }
 
  fEnDep = array_type(0.0, VoxelizedSensitiveDetector::GetInstance()->GetTotalVoxelNumber());
 
  fInitialized = true;
}

Member Data Documentation

fInitialized

G4bool RadioBio::DoseAccumulable::fInitialized = false

private

Definition at line 83 of file DoseAccumulable.hh.

fEnDep

array_type RadioBio::DoseAccumulable::fEnDep

private

Definition at line 85 of file DoseAccumulable.hh.

---

The documentation for this class was generated from the following files:

• .doxygen/Doxymodules_medical.h
• extended/medical/radiobiology/include/DoseAccumulable.hh
• extended/medical/radiobiology/src/DoseAccumulable.cc