Geant4 VMC Version 6.7
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TG4ModelConfiguration Class Reference
global

A helper class to hold a configuration of a special physics model. More...

#include <TG4ModelConfiguration.h>

Public Member Functions

 TG4ModelConfiguration (const G4String &modelName)
 
void Print () const
 
void SetParticles (const G4String &particles)
 
void SetExcludedParticles (const G4String &particles)
 
void SetRegionsMedia (const G4String &regionsMedia)
 
void SetOneRegionMedium (const G4String &regionMedium)
 
void SetOneRegion (const G4String &region)
 
void SetFastSimulationModel (G4VFastSimulationModel *fastSimulationModel)
 
const G4String & GetModelName () const
 
const G4String & GetParticles () const
 
const G4String & GetExcludedParticles () const
 
const std::vector< G4String > & GetRegionsMedia () const
 
const std::vector< G4String > & GetRegions () const
 
G4VFastSimulationModel * GetFastSimulationModel () const
 
G4bool HasParticle (const G4String &particleName)
 
G4bool HasRegion (const G4String &regionName)
 

Private Member Functions

 TG4ModelConfiguration (const TG4ModelConfiguration &right)
 not implemented
 
TG4ModelConfiguration & operator= (const TG4ModelConfiguration &right)
 not implemented
 

Private Attributes

G4String fModelName
 the EM model name
 
G4String fParticles
 the list of particle names
 
G4String fExcludedParticles
 the list of excluded particle names
 
std::vector< G4String > fRegionsMedia
 the vector of regions media
 
std::vector< G4String > fRegions
 the vector of created regions (per materials)
 
G4VFastSimulationModel * fFastSimulationModel
 fast simulation model
 

Detailed Description

A helper class to hold a configuration of a special physics model.

The class holds the information about the association of the special physics model (EM physics or fast simulation model) and the applicable regions (G4Region) defined via tracking media and particles.

Author
I. Hrivnacova; IPN Orsay

Definition at line 34 of file TG4ModelConfiguration.h.

Constructor & Destructor Documentation

◆ TG4ModelConfiguration() [1/2]

TG4ModelConfiguration::TG4ModelConfiguration ( const G4String & modelName)

Standard constructor

Definition at line 36 of file TG4ModelConfiguration.cxx.

Referenced by operator=(), and TG4ModelConfiguration().

◆ TG4ModelConfiguration() [2/2]

TG4ModelConfiguration::TG4ModelConfiguration ( const TG4ModelConfiguration & right)
private

not implemented

Member Function Documentation

◆ Print()

void TG4ModelConfiguration::Print ( ) const

Print all data

Definition at line 80 of file TG4ModelConfiguration.cxx.

◆ SetParticles()

void TG4ModelConfiguration::SetParticles ( const G4String & particles)
inline

Set the list of particles

Definition at line 79 of file TG4ModelConfiguration.h.

Referenced by TG4ModelConfigurationManager::SetModelParticles().

◆ SetExcludedParticles()

void TG4ModelConfiguration::SetExcludedParticles ( const G4String & particles)
inline

Set the list of particles

Definition at line 85 of file TG4ModelConfiguration.h.

Referenced by TG4ModelConfigurationManager::SetModelExcludedParticles().

◆ SetRegionsMedia()

void TG4ModelConfiguration::SetRegionsMedia ( const G4String & regionsMedia)

Set the list of regions. Can be used only for region names that do not contain spaces, the names with spaces must be added individually.

Definition at line 47 of file TG4ModelConfiguration.cxx.

Referenced by TG4ModelConfigurationManager::SetModelRegions().

◆ SetOneRegionMedium()

void TG4ModelConfiguration::SetOneRegionMedium ( const G4String & regionMedium)

Definition at line 66 of file TG4ModelConfiguration.cxx.

Referenced by TG4ModelConfigurationManager::SetOneModelRegion().

◆ SetOneRegion()

void TG4ModelConfiguration::SetOneRegion ( const G4String & region)

Definition at line 73 of file TG4ModelConfiguration.cxx.

◆ SetFastSimulationModel()

void TG4ModelConfiguration::SetFastSimulationModel ( G4VFastSimulationModel * fastSimulationModel)
inline

Set fast simulation model

Definition at line 91 of file TG4ModelConfiguration.h.

Referenced by TG4VUserFastSimulation::Register().

◆ GetModelName()

const G4String & TG4ModelConfiguration::GetModelName ( ) const
inline

Return the energy loss model name

Definition at line 98 of file TG4ModelConfiguration.h.

◆ GetParticles()

const G4String & TG4ModelConfiguration::GetParticles ( ) const
inline

Return the list of particles

Definition at line 104 of file TG4ModelConfiguration.h.

Referenced by TG4BiasingManager::CreateBiasingOperator().

◆ GetExcludedParticles()

const G4String & TG4ModelConfiguration::GetExcludedParticles ( ) const
inline

Return the list of particles

Definition at line 110 of file TG4ModelConfiguration.h.

◆ GetRegionsMedia()

const std::vector< G4String > & TG4ModelConfiguration::GetRegionsMedia ( ) const
inline

Return the list of regions

Definition at line 117 of file TG4ModelConfiguration.h.

◆ GetRegions()

const std::vector< G4String > & TG4ModelConfiguration::GetRegions ( ) const
inline

Return the list of regions

Definition at line 123 of file TG4ModelConfiguration.h.

◆ GetFastSimulationModel()

G4VFastSimulationModel * TG4ModelConfiguration::GetFastSimulationModel ( ) const
inline

Return fast simulation model

Definition at line 130 of file TG4ModelConfiguration.h.

◆ HasParticle()

G4bool TG4ModelConfiguration::HasParticle ( const G4String & particleName)

Return true if given particle is in the particles list and is not in the excluded list

Definition at line 95 of file TG4ModelConfiguration.cxx.

◆ HasRegion()

G4bool TG4ModelConfiguration::HasRegion ( const G4String & regionName)

Return true if given regionName is in the regions list

Definition at line 106 of file TG4ModelConfiguration.cxx.

Referenced by TG4BiasingManager::CreateBiasingOperator().

◆ operator=()

TG4ModelConfiguration & TG4ModelConfiguration::operator= ( const TG4ModelConfiguration & right)
private

not implemented

Member Data Documentation

◆ fModelName

G4String TG4ModelConfiguration::fModelName
private

the EM model name

Definition at line 68 of file TG4ModelConfiguration.h.

Referenced by GetModelName(), Print(), and TG4ModelConfiguration().

◆ fParticles

G4String TG4ModelConfiguration::fParticles
private

the list of particle names

Definition at line 69 of file TG4ModelConfiguration.h.

Referenced by GetParticles(), HasParticle(), Print(), SetParticles(), and TG4ModelConfiguration().

◆ fExcludedParticles

G4String TG4ModelConfiguration::fExcludedParticles
private

the list of excluded particle names

Definition at line 70 of file TG4ModelConfiguration.h.

Referenced by GetExcludedParticles(), HasParticle(), and SetExcludedParticles().

◆ fRegionsMedia

std::vector<G4String> TG4ModelConfiguration::fRegionsMedia
private

the vector of regions media

Definition at line 71 of file TG4ModelConfiguration.h.

Referenced by GetRegionsMedia(), Print(), SetOneRegionMedium(), SetRegionsMedia(), and TG4ModelConfiguration().

◆ fRegions

std::vector<G4String> TG4ModelConfiguration::fRegions
private

the vector of created regions (per materials)

Definition at line 73 of file TG4ModelConfiguration.h.

Referenced by GetRegions(), HasRegion(), Print(), SetOneRegion(), and TG4ModelConfiguration().

◆ fFastSimulationModel

G4VFastSimulationModel* TG4ModelConfiguration::fFastSimulationModel
private

fast simulation model

Definition at line 74 of file TG4ModelConfiguration.h.

Referenced by GetFastSimulationModel(), SetFastSimulationModel(), and TG4ModelConfiguration().

The documentation for this class was generated from the following files:
Generated on Tue Apr 1 2025 13:04:47 for Geant4 VMC by doxygen 1.13.2