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. More...

void	SetProcessPairProduction (Int_t val)
	Control the pair production process. More...

void	SetProcessComptonScattering (Int_t val)
	Control the Compton scattering process. More...

void	SetProcessPhotoEffect (Int_t val)
	Control the photo-electric effect. More...

void	SetProcessPhotoFission (Int_t val)
	Control the process of nuclear fission induced by a photon. More...

void	SetProcessDeltaRay (Int_t val)
	Control the delta ray production. More...

void	SetProcessAnnihilation (Int_t val)
	Control the positron annihilation process. More...

void	SetProcessBremsstrahlung (Int_t val)
	Control the process of bremsstrahlung. More...

void	SetProcessHadronicInteraction (Int_t val)
	Control the hadronic interactions. More...

void	SetProcessMuonNuclearInteraction (Int_t val)
	Control the muon-nucleus interaction. More...

void	SetProcessDecay (Int_t val)
	Control the decay of particles in flight. More...

void	SetProcessEnergyLossModel (Int_t val)
	Control the continuous enery loss process. More...

void	SetProcessMultipleScattering (Int_t val)
	Control the multiple scattering process. More...

void	SetEnergyCutGammas (Double_t val)
	Set the energy threshold for the transport of gammas. More...

void	SetEnergyCutElectrons (Double_t val)
	Set the energy threshold for the transport of electros and positrons. More...

void	SetEnergyCutNeutralHadrons (Double_t val)
	Set the energy threshold for the transport of neutral hadrons. More...

void	SetEnergyCutChargedHadrons (Double_t val)
	Set the energy threshold for the transport of charged hadrons and ions. More...

void	SetEnergyCutMuons (Double_t val)
	Set the energy threshold for the transport of muons. More...

void	SetEnergyCutElectronBremsstrahlung (Double_t val)
	Set the energy threshold for photons produced by electron bremsstrahlung. More...

void	SetEnergyCutMuonHadronBremsstrahlung (Double_t val)
	Set the energy threshold for photons produced by muon bremsstrahlung. More...

void	SetEnergyCutElectronDeltaRay (Double_t val)
	Set the energy threshold for electrons produced by electron delta-rays. More...

void	SetEnergyCutMuonDeltaRay (Double_t val)
	Set the energy threshold for electrons produced by muon or hadron delta-rays. More...

void	SetEnergyCutMuonPairProduction (Double_t val)
	Set the energy threshold for e+e- direct pair production by muons. More...

void	SetTimeCutTof (Double_t val)
	Set the time of flight threshold from the primary interaction time. More...

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 34 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] vmc Pointer to the VirtualMC class

Definition at line 7 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 260 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 280 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 300 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 240 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 230 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 310 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 290 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 320 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 270 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] val Value to be set

The parameter is the kinetic energy in GeV

Definition at line 250 of file CbmVMCSettings.h.

References CheckValueInRange(), and fEnergyCutNeutralHadrons.

◆ SetProcessAnnihilation()

void CbmVMCSettings::SetProcessAnnihilation ( Int_t val )

inline

Control the positron annihilation process.

Parameters

[in] val Value to be set

val = 0 no positron annihilation
    = 1 positron annihilation with generation of photons (Default)
    = 2 positron annihilation without generation of photons 

Definition at line 128 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessAnnihilation.

◆ SetProcessBremsstrahlung()

void CbmVMCSettings::SetProcessBremsstrahlung ( Int_t val )

inline

Control the process of bremsstrahlung.

Parameters

[in] val Value to be set

val = 0 no bremsstrahlung
    = 1 bremsstrahlung with generation of gammas (Default)
    = 2 bremsstrahlung without generation of gammas

Definition at line 142 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessBremsstrahlung.

◆ SetProcessComptonScattering()

void CbmVMCSettings::SetProcessComptonScattering ( Int_t val )

inline

Control the Compton scattering process.

Parameters

[in] val Value 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 72 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] val Value 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 186 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessDecay.

◆ SetProcessDeltaRay()

void CbmVMCSettings::SetProcessDeltaRay ( Int_t val )

inline

Control the delta ray production.

Parameters

[in] val Value 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 114 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessDeltaRay.

◆ SetProcessEnergyLossModel()

void CbmVMCSettings::SetProcessEnergyLossModel ( Int_t val )

inline

Control the continuous enery loss process.

Parameters

[in] val Value 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 205 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessEnergyLossModel.

◆ SetProcessHadronicInteraction()

void CbmVMCSettings::SetProcessHadronicInteraction ( Int_t val )

inline

Control the hadronic interactions.

Parameters

[in] val Value 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 158 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessHadronicInteraction.

◆ SetProcessMultipleScattering()

void CbmVMCSettings::SetProcessMultipleScattering ( Int_t val )

inline

Control the multiple scattering process.

Parameters

[in] val Value 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 220 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessMultipleScattering.

◆ SetProcessMuonNuclearInteraction()

void CbmVMCSettings::SetProcessMuonNuclearInteraction ( Int_t val )

inline

Control the muon-nucleus interaction.

Parameters

[in] val Value 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 172 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessMuonNuclearInteraction.

◆ SetProcessPairProduction()

void CbmVMCSettings::SetProcessPairProduction ( Int_t val )

inline

Control the pair production process.

Parameters

[in] val Value 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 58 of file CbmVMCSettings.h.

References CheckValueInRange(), and fProcessPairProduction.

◆ SetProcessPhotoEffect()

void CbmVMCSettings::SetProcessPhotoEffect ( Int_t val )

inline

Control the photo-electric effect.

Parameters

[in] val Value 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 86 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] val Value 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 100 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] val Value to be set

The parameter is the time in s

Definition at line 330 of file CbmVMCSettings.h.

References CheckValueInRange(), and fTimeCutTof.

Member Data Documentation

◆ fEnergyCutChargedHadrons

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

private

Definition at line 352 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutChargedHadrons().

◆ fEnergyCutElectronBremsstrahlung

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

private

Definition at line 354 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutElectronBremsstrahlung().

◆ fEnergyCutElectronDeltaRay

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

private

Definition at line 356 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutElectronDeltaRay().

◆ fEnergyCutElectrons

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

private

Definition at line 350 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutElectrons().

◆ fEnergyCutGammas

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

private

Definition at line 349 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutGammas().

◆ fEnergyCutMuonDeltaRay

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

private

Definition at line 357 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuonDeltaRay().

◆ fEnergyCutMuonHadronBremsstrahlung

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

private

Definition at line 355 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuonHadronBremsstrahlung().

◆ fEnergyCutMuonPairProduction

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

private

Definition at line 358 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuonPairProduction().

◆ fEnergyCutMuons

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

private

Definition at line 353 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutMuons().

◆ fEnergyCutNeutralHadrons

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

private

Definition at line 351 of file CbmVMCSettings.h.

Referenced by Init(), and SetEnergyCutNeutralHadrons().

◆ fProcessAnnihilation

Int_t CbmVMCSettings::fProcessAnnihilation {1}

private

Definition at line 341 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessAnnihilation().

◆ fProcessBremsstrahlung

Int_t CbmVMCSettings::fProcessBremsstrahlung {1}

private

Definition at line 342 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessBremsstrahlung().

◆ fProcessComptonScattering

Int_t CbmVMCSettings::fProcessComptonScattering {1}

private

Definition at line 337 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessComptonScattering().

◆ fProcessDecay

Int_t CbmVMCSettings::fProcessDecay {1}

private

Definition at line 345 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessDecay().

◆ fProcessDeltaRay

Int_t CbmVMCSettings::fProcessDeltaRay {1}

private

Definition at line 340 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessDeltaRay().

◆ fProcessEnergyLossModel

Int_t CbmVMCSettings::fProcessEnergyLossModel {1}

private

Definition at line 346 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessEnergyLossModel().

◆ fProcessHadronicInteraction

Int_t CbmVMCSettings::fProcessHadronicInteraction {1}

private

Definition at line 343 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessHadronicInteraction().

◆ fProcessMultipleScattering

Int_t CbmVMCSettings::fProcessMultipleScattering {1}

private

Definition at line 347 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessMultipleScattering().

◆ fProcessMuonNuclearInteraction

Int_t CbmVMCSettings::fProcessMuonNuclearInteraction {1}

private

Definition at line 344 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessMuonNuclearInteraction().

◆ fProcessPairProduction

Int_t CbmVMCSettings::fProcessPairProduction {1}

private

Definition at line 336 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessPairProduction().

◆ fProcessPhotoEffect

Int_t CbmVMCSettings::fProcessPhotoEffect {1}

private

Definition at line 338 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessPhotoEffect().

◆ fProcessPhotoFission

Int_t CbmVMCSettings::fProcessPhotoFission {0}

private

Definition at line 339 of file CbmVMCSettings.h.

Referenced by Init(), and SetProcessPhotoFission().

◆ fTimeCutTof

Double_t CbmVMCSettings::fTimeCutTof {1.0}

private

Definition at line 360 of file CbmVMCSettings.h.

Referenced by Init(), and SetTimeCutTof().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmVMCSettings() [1/2]

◆ ~CbmVMCSettings()

◆ CbmVMCSettings() [2/2]

Member Function Documentation

◆ ClassDef()

◆ Init()

◆ operator=()

◆ SetEnergyCutChargedHadrons()

◆ SetEnergyCutElectronBremsstrahlung()

◆ SetEnergyCutElectronDeltaRay()

◆ SetEnergyCutElectrons()

◆ SetEnergyCutGammas()

◆ SetEnergyCutMuonDeltaRay()

◆ SetEnergyCutMuonHadronBremsstrahlung()

◆ SetEnergyCutMuonPairProduction()

◆ SetEnergyCutMuons()

◆ SetEnergyCutNeutralHadrons()

◆ SetProcessAnnihilation()

◆ SetProcessBremsstrahlung()

◆ SetProcessComptonScattering()

◆ SetProcessDecay()

◆ SetProcessDeltaRay()

◆ SetProcessEnergyLossModel()

◆ SetProcessHadronicInteraction()

◆ SetProcessMultipleScattering()

◆ SetProcessMuonNuclearInteraction()

◆ SetProcessPairProduction()

◆ SetProcessPhotoEffect()

◆ SetProcessPhotoFission()

◆ SetTimeCutTof()

Member Data Documentation

◆ fEnergyCutChargedHadrons

◆ fEnergyCutElectronBremsstrahlung

◆ fEnergyCutElectronDeltaRay

◆ fEnergyCutElectrons

◆ fEnergyCutGammas

◆ fEnergyCutMuonDeltaRay

◆ fEnergyCutMuonHadronBremsstrahlung

◆ fEnergyCutMuonPairProduction

◆ fEnergyCutMuons

◆ fEnergyCutNeutralHadrons

◆ fProcessAnnihilation

◆ fProcessBremsstrahlung

◆ fProcessComptonScattering

◆ fProcessDecay

◆ fProcessDeltaRay

◆ fProcessEnergyLossModel

◆ fProcessHadronicInteraction

◆ fProcessMultipleScattering

◆ fProcessMuonNuclearInteraction

◆ fProcessPairProduction

◆ fProcessPhotoEffect

◆ fProcessPhotoFission

◆ fTimeCutTof