CbmRoot
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CbmVMCSettings Class Reference

User interface class to define the transport simulation settings which are common for both used transport engines. More...

#include <CbmVMCSettings.h>

Inheritance diagram for CbmVMCSettings:
[legend]
Collaboration diagram for CbmVMCSettings:
[legend]

Public Member Functions

 CbmVMCSettings ()=default
 
 ~CbmVMCSettings ()=default
 
 CbmVMCSettings (const CbmVMCSettings &)=delete
 
CbmVMCSettings & operator= (const CbmVMCSettings &)=delete
 
void Init (TVirtualMC *)
 Set all parameters defined in this class.
 
void SetProcessPairProduction (Int_t val)
 Control the pair production process.
 
void SetProcessComptonScattering (Int_t val)
 Control the Compton scattering process.
 
void SetProcessPhotoEffect (Int_t val)
 Control the photo-electric effect.
 
void SetProcessPhotoFission (Int_t val)
 Control the process of nuclear fission induced by a photon.
 
void SetProcessDeltaRay (Int_t val)
 Control the delta ray production.
 
void SetProcessAnnihilation (Int_t val)
 Control the positron annihilation process.
 
void SetProcessBremsstrahlung (Int_t val)
 Control the process of bremsstrahlung.
 
void SetProcessHadronicInteraction (Int_t val)
 Control the hadronic interactions.
 
void SetProcessMuonNuclearInteraction (Int_t val)
 Control the muon-nucleus interaction.
 
void SetProcessDecay (Int_t val)
 Control the decay of particles in flight.
 
void SetProcessEnergyLossModel (Int_t val)
 Control the continuous enery loss process.
 
void SetProcessMultipleScattering (Int_t val)
 Control the multiple scattering process.
 
void SetEnergyCutGammas (Double_t val)
 Set the energy threshold for the transport of gammas.
 
void SetEnergyCutElectrons (Double_t val)
 Set the energy threshold for the transport of electros and positrons.
 
void SetEnergyCutNeutralHadrons (Double_t val)
 Set the energy threshold for the transport of neutral hadrons.
 
void SetEnergyCutChargedHadrons (Double_t val)
 Set the energy threshold for the transport of charged hadrons and ions.
 
void SetEnergyCutMuons (Double_t val)
 Set the energy threshold for the transport of muons.
 
void SetEnergyCutElectronBremsstrahlung (Double_t val)
 Set the energy threshold for photons produced by electron bremsstrahlung.
 
void SetEnergyCutMuonHadronBremsstrahlung (Double_t val)
 Set the energy threshold for photons produced by muon bremsstrahlung.
 
void SetEnergyCutElectronDeltaRay (Double_t val)
 Set the energy threshold for electrons produced by electron delta-rays.
 
void SetEnergyCutMuonDeltaRay (Double_t val)
 Set the energy threshold for electrons produced by muon or hadron delta-rays.
 
void SetEnergyCutMuonPairProduction (Double_t val)
 Set the energy threshold for e+e- direct pair production by muons.
 
void SetTimeCutTof (Double_t val)
 Set the time of flight threshold from the primary interaction time.
 

Private Member Functions

 ClassDef (CbmVMCSettings, 1)
 

Private Attributes

Int_t fProcessPairProduction {1}
 
Int_t fProcessComptonScattering {1}
 
Int_t fProcessPhotoEffect {1}
 
Int_t fProcessPhotoFission {0}
 
Int_t fProcessDeltaRay {1}
 
Int_t fProcessAnnihilation {1}
 
Int_t fProcessBremsstrahlung {1}
 
Int_t fProcessHadronicInteraction {1}
 
Int_t fProcessMuonNuclearInteraction {1}
 
Int_t fProcessDecay {1}
 
Int_t fProcessEnergyLossModel {1}
 
Int_t fProcessMultipleScattering {1}
 
Double_t fEnergyCutGammas {1.e-3}
 
Double_t fEnergyCutElectrons {1.e-3}
 
Double_t fEnergyCutNeutralHadrons {1.e-3}
 
Double_t fEnergyCutChargedHadrons {1.e-3}
 
Double_t fEnergyCutMuons {1.e-3}
 
Double_t fEnergyCutElectronBremsstrahlung {1.e-3}
 
Double_t fEnergyCutMuonHadronBremsstrahlung {1.e-3}
 
Double_t fEnergyCutElectronDeltaRay {1.e-3}
 
Double_t fEnergyCutMuonDeltaRay {1.e-3}
 
Double_t fEnergyCutMuonPairProduction {1.e-3}
 
Double_t fTimeCutTof {1.0}
 

Detailed Description

User interface class to define the transport simulation settings which are common for both used transport engines.

Author
Florian Uhlig f.uhl.nosp@m.ig@g.nosp@m.si.de
Since
21.01.2020

Definition at line 35 of file CbmVMCSettings.h.

Constructor & Destructor Documentation

◆ CbmVMCSettings() [1/2]

CbmVMCSettings::CbmVMCSettings ( )
default

◆ ~CbmVMCSettings()

CbmVMCSettings::~CbmVMCSettings ( )
default

◆ CbmVMCSettings() [2/2]

CbmVMCSettings::CbmVMCSettings ( const CbmVMCSettings & )
delete

Member Function Documentation

◆ ClassDef()

CbmVMCSettings::ClassDef ( CbmVMCSettings ,
1  )
private

◆ Init()

void CbmVMCSettings::Init ( TVirtualMC * vmc)

Set all parameters defined in this class.

Parameters
[in]vmcPointer to the VirtualMC class

Definition at line 11 of file CbmVMCSettings.cxx.

References fEnergyCutChargedHadrons, fEnergyCutElectronBremsstrahlung, fEnergyCutElectronDeltaRay, fEnergyCutElectrons, fEnergyCutGammas, fEnergyCutMuonDeltaRay, fEnergyCutMuonHadronBremsstrahlung, fEnergyCutMuonPairProduction, fEnergyCutMuons, fEnergyCutNeutralHadrons, fProcessAnnihilation, fProcessBremsstrahlung, fProcessComptonScattering, fProcessDecay, fProcessDeltaRay, fProcessEnergyLossModel, fProcessHadronicInteraction, fProcessMultipleScattering, fProcessMuonNuclearInteraction, fProcessPairProduction, fProcessPhotoEffect, fProcessPhotoFission, and fTimeCutTof.

Referenced by CbmGeant3Settings::Init(), and CbmGeant4Settings::Init().

◆ operator=()

CbmVMCSettings & CbmVMCSettings::operator= ( const CbmVMCSettings & )
delete

◆ SetEnergyCutChargedHadrons()

void CbmVMCSettings::SetEnergyCutChargedHadrons ( Double_t val)
inline

Set the energy threshold for the transport of charged hadrons and ions.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 276 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutChargedHadrons.

◆ SetEnergyCutElectronBremsstrahlung()

void CbmVMCSettings::SetEnergyCutElectronBremsstrahlung ( Double_t val)
inline

Set the energy threshold for photons produced by electron bremsstrahlung.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 298 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutElectronBremsstrahlung.

◆ SetEnergyCutElectronDeltaRay()

void CbmVMCSettings::SetEnergyCutElectronDeltaRay ( Double_t val)
inline

Set the energy threshold for electrons produced by electron delta-rays.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 320 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutElectronDeltaRay.

◆ SetEnergyCutElectrons()

void CbmVMCSettings::SetEnergyCutElectrons ( Double_t val)
inline

Set the energy threshold for the transport of electros and positrons.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 254 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutElectrons.

◆ SetEnergyCutGammas()

void CbmVMCSettings::SetEnergyCutGammas ( Double_t val)
inline

Set the energy threshold for the transport of gammas.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 243 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutGammas.

◆ SetEnergyCutMuonDeltaRay()

void CbmVMCSettings::SetEnergyCutMuonDeltaRay ( Double_t val)
inline

Set the energy threshold for electrons produced by muon or hadron delta-rays.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 331 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutMuonDeltaRay.

◆ SetEnergyCutMuonHadronBremsstrahlung()

void CbmVMCSettings::SetEnergyCutMuonHadronBremsstrahlung ( Double_t val)
inline

Set the energy threshold for photons produced by muon bremsstrahlung.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 309 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutMuonHadronBremsstrahlung.

◆ SetEnergyCutMuonPairProduction()

void CbmVMCSettings::SetEnergyCutMuonPairProduction ( Double_t val)
inline

Set the energy threshold for e+e- direct pair production by muons.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 342 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutMuonPairProduction.

◆ SetEnergyCutMuons()

void CbmVMCSettings::SetEnergyCutMuons ( Double_t val)
inline

Set the energy threshold for the transport of muons.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 287 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutMuons.

◆ SetEnergyCutNeutralHadrons()

void CbmVMCSettings::SetEnergyCutNeutralHadrons ( Double_t val)
inline

Set the energy threshold for the transport of neutral hadrons.

Parameters
[in]valValue to be set

The parameter is the kinetic energy in GeV

Definition at line 265 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutNeutralHadrons.

◆ SetProcessAnnihilation()

void CbmVMCSettings::SetProcessAnnihilation ( Int_t val)
inline

Control the positron annihilation process.

Parameters
[in]valValue to be set
val = 0 no positron annihilation
= 1 positron annihilation with generation of photons (Default)
= 2 positron annihilation without generation of photons
Default
@ Default
Definition CbmMvdGeoHandler.h:36

Definition at line 134 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessAnnihilation.

◆ SetProcessBremsstrahlung()

void CbmVMCSettings::SetProcessBremsstrahlung ( Int_t val)
inline

Control the process of bremsstrahlung.

Parameters
[in]valValue to be set
val = 0 no bremsstrahlung
= 1 bremsstrahlung with generation of gammas (Default)
= 2 bremsstrahlung without generation of gammas

Definition at line 149 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessBremsstrahlung.

◆ SetProcessComptonScattering()

void CbmVMCSettings::SetProcessComptonScattering ( Int_t val)
inline

Control the Compton scattering process.

Parameters
[in]valValue to be set
val = 0 no Compton scattering
= 1 Compton scattering with production of e- (Default)
= 2 Compton scattering without production of e-

Definition at line 74 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessComptonScattering.

◆ SetProcessDecay()

void CbmVMCSettings::SetProcessDecay ( Int_t val)
inline

Control the decay of particles in flight.

Parameters
[in]valValue to be set
val = 0 no decay in flight
= 1 decay in flight with generation of secondaries (Default)
= 2 decay in flight without generation of secondaries

Definition at line 196 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessDecay.

◆ SetProcessDeltaRay()

void CbmVMCSettings::SetProcessDeltaRay ( Int_t val)
inline

Control the delta ray production.

Parameters
[in]valValue to be set
val = 0 no delta ray production
= 1 delta ray production with generation of e- (Default)
= 2 delta ray production without generation of e-

Definition at line 119 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessDeltaRay.

◆ SetProcessEnergyLossModel()

void CbmVMCSettings::SetProcessEnergyLossModel ( Int_t val)
inline

Control the continuous enery loss process.

Parameters
[in]valValue to be set
val = 0 no continuous energy loss
= 1 continuous energy loss with generation of delta-rays above the value defined for
the DCUTE cut and restricted Landau fluctuations below DCUTE (Default)
= 2 continuous energy loss without generation of delta-rays and full
Landau-Vavilov-Gauss fluctuations. In This case the delta-ray production process
is switched of to avoid double counting
= 3 Same as 1, kept for backward compatibility
= 4 Energy loss without fluctuations. The value obtained from the tables is used directly

Definition at line 216 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessEnergyLossModel.

◆ SetProcessHadronicInteraction()

void CbmVMCSettings::SetProcessHadronicInteraction ( Int_t val)
inline

Control the hadronic interactions.

Parameters
[in]valValue to be set
val = 0 no hadronic interaction
= 1 hadronic interaction with generation of secondaries (Default)
= 2 hadronic interaction without generation of secondaries
> 2 Can be used in user code to choose a hadronic package
= 5 hadronic interactions using the gcalor package

Definition at line 166 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessHadronicInteraction.

◆ SetProcessMultipleScattering()

void CbmVMCSettings::SetProcessMultipleScattering ( Int_t val)
inline

Control the multiple scattering process.

Parameters
[in]valValue to be set
val = 0 no multiple scattering
= 1 multiple scattering according to Moliere theory (Default)
= 2 same as 1, kept for backward compatibility
= 3 pure gaussian scattering according to the Rossi formula

Definition at line 232 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessMultipleScattering.

◆ SetProcessMuonNuclearInteraction()

void CbmVMCSettings::SetProcessMuonNuclearInteraction ( Int_t val)
inline

Control the muon-nucleus interaction.

Parameters
[in]valValue to be set
val = 0 no muon-nucleus interaction
= 1 muon-nucleus interactions with generation of secondaries (Default)
= 2 muon-nucleus interactions without generation of secondaries

Definition at line 181 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessMuonNuclearInteraction.

◆ SetProcessPairProduction()

void CbmVMCSettings::SetProcessPairProduction ( Int_t val)
inline

Control the pair production process.

Parameters
[in]valValue to be set
val = 0 no pair production
= 1 Pair production with generation of secondary e+/e- (Default)
= 2 Pair production without generation of secondary e+/e-

Definition at line 59 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessPairProduction.

◆ SetProcessPhotoEffect()

void CbmVMCSettings::SetProcessPhotoEffect ( Int_t val)
inline

Control the photo-electric effect.

Parameters
[in]valValue to be set
val = 0 no photo-electric effect
= 1 photo-electric effect with production of e- (Default)
= 2 photo-electric effect without production of e-

Definition at line 89 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessPhotoEffect.

◆ SetProcessPhotoFission()

void CbmVMCSettings::SetProcessPhotoFission ( Int_t val)
inline

Control the process of nuclear fission induced by a photon.

Parameters
[in]valValue to be set
val = 0 no photo-fission (Default)
= 1 photo-fission with generation of secondaries
= 2 photo-fission without generation of secondaries

Definition at line 104 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessPhotoFission.

◆ SetTimeCutTof()

void CbmVMCSettings::SetTimeCutTof ( Double_t val)
inline

Set the time of flight threshold from the primary interaction time.

Parameters
[in]valValue to be set

The parameter is the time in s

Definition at line 353 of file CbmVMCSettings.h.

References CheckValueInRange(), and fTimeCutTof.

Member Data Documentation

◆ fEnergyCutChargedHadrons

Double_t CbmVMCSettings::fEnergyCutChargedHadrons {1.e-3}
private

Definition at line 376 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutChargedHadrons().

◆ fEnergyCutElectronBremsstrahlung

Double_t CbmVMCSettings::fEnergyCutElectronBremsstrahlung {1.e-3}
private

Definition at line 378 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutElectronBremsstrahlung().

◆ fEnergyCutElectronDeltaRay

Double_t CbmVMCSettings::fEnergyCutElectronDeltaRay {1.e-3}
private

Definition at line 380 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutElectronDeltaRay().

◆ fEnergyCutElectrons

Double_t CbmVMCSettings::fEnergyCutElectrons {1.e-3}
private

Definition at line 374 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutElectrons().

◆ fEnergyCutGammas

Double_t CbmVMCSettings::fEnergyCutGammas {1.e-3}
private

Definition at line 373 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutGammas().

◆ fEnergyCutMuonDeltaRay

Double_t CbmVMCSettings::fEnergyCutMuonDeltaRay {1.e-3}
private

Definition at line 381 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuonDeltaRay().

◆ fEnergyCutMuonHadronBremsstrahlung

Double_t CbmVMCSettings::fEnergyCutMuonHadronBremsstrahlung {1.e-3}
private

Definition at line 379 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuonHadronBremsstrahlung().

◆ fEnergyCutMuonPairProduction

Double_t CbmVMCSettings::fEnergyCutMuonPairProduction {1.e-3}
private

Definition at line 382 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuonPairProduction().

◆ fEnergyCutMuons

Double_t CbmVMCSettings::fEnergyCutMuons {1.e-3}
private

Definition at line 377 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuons().

◆ fEnergyCutNeutralHadrons

Double_t CbmVMCSettings::fEnergyCutNeutralHadrons {1.e-3}
private

Definition at line 375 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutNeutralHadrons().

◆ fProcessAnnihilation

Int_t CbmVMCSettings::fProcessAnnihilation {1}
private

Definition at line 365 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessAnnihilation().

◆ fProcessBremsstrahlung

Int_t CbmVMCSettings::fProcessBremsstrahlung {1}
private

Definition at line 366 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessBremsstrahlung().

◆ fProcessComptonScattering

Int_t CbmVMCSettings::fProcessComptonScattering {1}
private

Definition at line 361 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessComptonScattering().

◆ fProcessDecay

Int_t CbmVMCSettings::fProcessDecay {1}
private

Definition at line 369 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessDecay().

◆ fProcessDeltaRay

Int_t CbmVMCSettings::fProcessDeltaRay {1}
private

Definition at line 364 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessDeltaRay().

◆ fProcessEnergyLossModel

Int_t CbmVMCSettings::fProcessEnergyLossModel {1}
private

Definition at line 370 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessEnergyLossModel().

◆ fProcessHadronicInteraction

Int_t CbmVMCSettings::fProcessHadronicInteraction {1}
private

Definition at line 367 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessHadronicInteraction().

◆ fProcessMultipleScattering

Int_t CbmVMCSettings::fProcessMultipleScattering {1}
private

Definition at line 371 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessMultipleScattering().

◆ fProcessMuonNuclearInteraction

Int_t CbmVMCSettings::fProcessMuonNuclearInteraction {1}
private

Definition at line 368 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessMuonNuclearInteraction().

◆ fProcessPairProduction

Int_t CbmVMCSettings::fProcessPairProduction {1}
private

Definition at line 360 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessPairProduction().

◆ fProcessPhotoEffect

Int_t CbmVMCSettings::fProcessPhotoEffect {1}
private

Definition at line 362 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessPhotoEffect().

◆ fProcessPhotoFission

Int_t CbmVMCSettings::fProcessPhotoFission {0}
private

Definition at line 363 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessPhotoFission().

◆ fTimeCutTof

Double_t CbmVMCSettings::fTimeCutTof {1.0}
private

Definition at line 384 of file CbmVMCSettings.h.

Referenced by Init(), and SetTimeCutTof().

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