RadioBio::RBEAccumulable Class Reference

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

#include <Doxymodules_medical.h>

Inheritance diagram for RadioBio::RBEAccumulable:

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

Public Member Functions
	RBEAccumulable ()
	RBEAccumulable (const RBEAccumulable &other)=default
void	Merge (const G4VAccumulable &rhs) override
void	Reset () override
void	Accumulate (G4double E, G4double energyDeposit, G4double dX, G4int Z, G4int i, G4int j, G4int k)
void	Accumulate (Hit *hit) override
const array_type	GetAlphaNumerator () const
const array_type	GetBetaNumerator () const
const array_type	GetDenominator () 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	fAlphaNumerator = {}
array_type	fBetaNumerator = {}
array_type	fDenominator = {}
size_t	fVoxelsAlongX = -1
size_t	fVoxelsAlongY = -1
size_t	fVoxelsAlongZ = -1
size_t	fVoxels = -1

Detailed Description

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

It keeps the sum of alpha and beta numerators/denominator, as well as energy deposits. The class is closely tied with the singleton RBE that is used both to calculate alphas and betas, and also to store results.

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 RBE).

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

Definition at line 142 of file Doxymodules_medical.h.

Member Typedef Documentation

array_type

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

Definition at line 75 of file RBEAccumulable.hh.

Constructor & Destructor Documentation

RBEAccumulable() [1/2]

RadioBio::RBEAccumulable::RBEAccumulable

(

)

Definition at line 47 of file RBEAccumulable.cc.

: VRadiobiologicalAccumulable("RBE") {}

RBEAccumulable() [2/2]

RadioBio::RBEAccumulable::RBEAccumulable ( const RBEAccumulable &  other )

default

Member Function Documentation

Merge()

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

override

Definition at line 51 of file RBEAccumulable.cc.

{
  if (GetVerboseLevel() > 1) {
    G4cout << "RBEAccumulable::Merge()" << G4endl;
  }
  const RBEAccumulable& other = dynamic_cast<const RBEAccumulable&>(rhs);
  fAlphaNumerator += other.fAlphaNumerator;
  fDenominator += other.fDenominator;
  fBetaNumerator += other.fBetaNumerator;
}

Reset()

void RadioBio::RBEAccumulable::Reset ( )

override

Definition at line 64 of file RBEAccumulable.cc.

{
  if (GetVerboseLevel() > 0) {
    G4cout << "RBEAccumulable::Reset()" << G4endl;
  }
  if (fInitialized) {
    fAlphaNumerator = 0.0;
    fBetaNumerator = 0.0;
    fDenominator = 0.0;
  }
  else {
    Initialize();
  }
}

Accumulate() [1/2]

void RadioBio::RBEAccumulable::Accumulate	(	G4double	E,
		G4double	energyDeposit,
		G4double	dX,
		G4int	Z,
		G4int	i,
		G4int	j,
		G4int	k
	)

Definition at line 101 of file RBEAccumulable.cc.

{
  if (!fInitialized) {
    G4Exception("RBEAccumulable::Accumulate", "NotInitialized", FatalException,
                "Accumulable not initialized. Must be a programming error.");
  }
  if (GetVerboseLevel() > 2) {
    G4cout << "RBEAccumulable::Accumulate() in " << i << ", " << j << ", " << k << G4endl;
  }
  if (energyDeposit <= 0) {
    return;
  }
 
  // Get the global voxel number for the given indexes
  size_t n = VoxelizedSensitiveDetector::GetInstance()->GetThisVoxelNumber(i, j, k);
 
  // Calculate only for hadrons that traveled finite range and released finite energy.
  if ((Z >= 1) && (dX > 0) && (E > 0)) {
    RBE* rbe = dynamic_cast<RBE*>(Manager::GetInstance()->GetQuantity("RBE"));
    std::tuple<G4double, G4double> alpha_beta = rbe->GetHitAlphaAndBeta(E, Z);
    fDenominator[n] += energyDeposit;
    fAlphaNumerator[n] += std::get<0>(alpha_beta) * energyDeposit;
    fBetaNumerator[n] += std::sqrt(std::get<1>(alpha_beta)) * energyDeposit;
  }
}

Accumulate() [2/2]

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

overridevirtual

Implements RadioBio::VRadiobiologicalAccumulable.

Definition at line 82 of file RBEAccumulable.cc.

{
  G4double kineticEnergy = hit->GetEkinMean();
  G4int A = hit->GetPartType()->GetAtomicMass();
  G4double energyDeposit = hit->GetDeltaE();
  G4double DX = hit->GetTrackLength();
  G4int Z = hit->GetPartType()->GetAtomicNumber();
  G4int i = hit->GetXindex();
  G4int j = hit->GetYindex();
  G4int k = hit->GetZindex();
 
  // If A is zero, return immediately to avoid division by zero
  if (!A) return;
 
  Accumulate(kineticEnergy / A, energyDeposit, DX, Z, i, j, k);
}

GetAlphaNumerator()

const array_type RadioBio::RBEAccumulable::GetAlphaNumerator ( ) const

inline

Definition at line 78 of file RBEAccumulable.hh.

    {
      return fAlphaNumerator;
    }

GetBetaNumerator()

const array_type RadioBio::RBEAccumulable::GetBetaNumerator ( ) const

inline

Definition at line 82 of file RBEAccumulable.hh.

    {
      return fBetaNumerator;
    }

GetDenominator()

const array_type RadioBio::RBEAccumulable::GetDenominator ( ) const

inline

Definition at line 86 of file RBEAccumulable.hh.

    {
      return fDenominator;
    }

GetVerboseLevel()

G4int RadioBio::RBEAccumulable::GetVerboseLevel

(

)

const

Definition at line 130 of file RBEAccumulable.cc.

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

Initialize()

void RadioBio::RBEAccumulable::Initialize ( )

private

Definition at line 138 of file RBEAccumulable.cc.

{
  if (GetVerboseLevel() > 0) {
    G4cout << "RBEAccumulable::Initialize(): " << G4endl;
  }
 
  auto voxSensDet = VoxelizedSensitiveDetector::GetInstance();
 
  fVoxelsAlongX = voxSensDet->GetVoxelNumberAlongX();
  fVoxelsAlongY = voxSensDet->GetVoxelNumberAlongY();
  fVoxelsAlongZ = voxSensDet->GetVoxelNumberAlongZ();
  fVoxels = fVoxelsAlongX * fVoxelsAlongY * fVoxelsAlongZ;
 
  if (GetVerboseLevel() > 1) {
    G4cout << fVoxels << " voxels." << G4endl;
  }
 
  fAlphaNumerator = array_type(0.0, fVoxels);
  fBetaNumerator = array_type(0.0, fVoxels);
  fDenominator = array_type(0.0, fVoxels);
  fInitialized = true;
}

Member Data Documentation

fInitialized

G4bool RadioBio::RBEAccumulable::fInitialized = false

private

Definition at line 97 of file RBEAccumulable.hh.

fAlphaNumerator

array_type RadioBio::RBEAccumulable::fAlphaNumerator = {}

private

Definition at line 99 of file RBEAccumulable.hh.

{};

fBetaNumerator

array_type RadioBio::RBEAccumulable::fBetaNumerator = {}

private

Definition at line 100 of file RBEAccumulable.hh.

{};

fDenominator

array_type RadioBio::RBEAccumulable::fDenominator = {}

private

Definition at line 101 of file RBEAccumulable.hh.

{};

fVoxelsAlongX

size_t RadioBio::RBEAccumulable::fVoxelsAlongX = -1

private

Definition at line 105 of file RBEAccumulable.hh.

fVoxelsAlongY

size_t RadioBio::RBEAccumulable::fVoxelsAlongY = -1

private

Definition at line 106 of file RBEAccumulable.hh.

fVoxelsAlongZ

size_t RadioBio::RBEAccumulable::fVoxelsAlongZ = -1

private

Definition at line 107 of file RBEAccumulable.hh.

fVoxels

size_t RadioBio::RBEAccumulable::fVoxels = -1

private

Definition at line 109 of file RBEAccumulable.hh.

---

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

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