G4GeneralParticleSourceData Class Reference

#include <G4GeneralParticleSourceData.hh>

Public Member Functions
void	AddASource (G4double intensity)
void	ClearSources ()
void	DeleteASource (G4int idx)
G4SingleParticleSource *	GetCurrentSource () const
G4SingleParticleSource *	GetCurrentSource (G4int idx)
G4int	GetCurrentSourceIdx () const
G4bool	GetFlatSampling () const
G4double	GetIntensity (G4int idx) const
G4int	GetIntensityVectorSize () const
G4bool	GetMultipleVertex () const
G4double	GetSourceProbability (G4int idx) const
G4int	GetSourceVectorSize () const
void	IntensityNormalise ()
void	Lock ()
G4bool	Normalised () const
void	SetCurrentSourceIntensity (G4double)
void	SetFlatSampling (G4bool fSamp)
void	SetMultipleVertex (G4bool flag)
void	SetVerbosityAllSources (G4int vl)
void	Unlock ()

Static Public Member Functions
static G4GeneralParticleSourceData *	Instance ()

Private Member Functions
	G4GeneralParticleSourceData ()
	~G4GeneralParticleSourceData ()

Private Attributes
G4SingleParticleSource *	currentSource = nullptr
G4int	currentSourceIdx = 0
G4bool	flat_sampling = false
G4bool	multiple_vertex = false
G4Mutex	mutex
G4bool	normalised = false
std::vector< G4double >	sourceIntensity
std::vector< G4double >	sourceProbability
std::vector< G4SingleParticleSource * >	sourceVector

Detailed Description

Definition at line 56 of file G4GeneralParticleSourceData.hh.

Constructor & Destructor Documentation

G4GeneralParticleSourceData()

G4GeneralParticleSourceData::G4GeneralParticleSourceData ( )

private

Definition at line 40 of file G4GeneralParticleSourceData.cc.

{
  G4MUTEXINIT(mutex);
    
  sourceVector.clear();
  sourceIntensity.clear();
  sourceProbability.clear();
    
  currentSource = new G4SingleParticleSource();
  sourceVector.push_back(currentSource);
  sourceIntensity.push_back(1.);
}

References currentSource, G4MUTEXINIT, sourceIntensity, sourceProbability, and sourceVector.

~G4GeneralParticleSourceData()

G4GeneralParticleSourceData::~G4GeneralParticleSourceData ( )

private

Definition at line 53 of file G4GeneralParticleSourceData.cc.

{
  G4MUTEXDESTROY(mutex);
  for ( auto it = sourceVector.cbegin(); it != sourceVector.cend(); ++it )
  {
    delete *it;
  }
  sourceVector.clear();
}

References G4MUTEXDESTROY, and sourceVector.

Member Function Documentation

AddASource()

void G4GeneralParticleSourceData::AddASource

(

G4double

intensity

)

Definition at line 115 of file G4GeneralParticleSourceData.cc.

{
  currentSource = new G4SingleParticleSource();
  sourceVector.push_back(currentSource);
  sourceIntensity.push_back(intensity);
  currentSourceIdx = sourceVector.size() - 1;
  normalised = false;
}

References currentSource, currentSourceIdx, normalised, sourceIntensity, and sourceVector.

Referenced by G4GeneralParticleSource::AddaSource().

ClearSources()

void G4GeneralParticleSourceData::ClearSources

(

)

Definition at line 145 of file G4GeneralParticleSourceData.cc.

{
  currentSourceIdx = -1;
  currentSource = nullptr;
  for ( auto it = sourceVector.cbegin(); it != sourceVector.cend(); ++it )
  {
    delete *it;
  }
  sourceVector.clear();
  sourceIntensity.clear();
  normalised = false;
}

References currentSource, currentSourceIdx, normalised, sourceIntensity, and sourceVector.

Referenced by G4GeneralParticleSource::ClearAll().

DeleteASource()

void G4GeneralParticleSourceData::DeleteASource

(

G4int

idx

)

Definition at line 124 of file G4GeneralParticleSourceData.cc.

{
  delete sourceVector[idx];
  sourceVector.erase(sourceVector.begin() + idx);
  sourceIntensity.erase(sourceIntensity.begin()+idx);
  normalised = false ;
  if (currentSourceIdx == idx )
  {
    if ( GetIntensityVectorSize() > 0 )
    {
      currentSource = GetCurrentSource(0);
      currentSourceIdx = 0;
    }
    else
    {
      currentSource = nullptr;
      currentSourceIdx = -1;
    }
  }
}

References currentSource, currentSourceIdx, GetCurrentSource(), GetIntensityVectorSize(), normalised, sourceIntensity, and sourceVector.

Referenced by G4GeneralParticleSource::DeleteaSource().

GetCurrentSource() [1/2]

G4SingleParticleSource * G4GeneralParticleSourceData::GetCurrentSource ( ) const

inline

Definition at line 72 of file G4GeneralParticleSourceData.hh.

      { return currentSource; }

References currentSource.

Referenced by DeleteASource(), and IntensityNormalise().

GetCurrentSource() [2/2]

G4SingleParticleSource * G4GeneralParticleSourceData::GetCurrentSource

(

G4int

idx

)

Definition at line 166 of file G4GeneralParticleSourceData.cc.

{
  currentSource = sourceVector[idx];
  currentSourceIdx = idx;
  return sourceVector[idx];
}

References currentSource, currentSourceIdx, and sourceVector.

Referenced by G4GeneralParticleSource::AddaSource(), G4GPSModel::DescribeYourselfTo(), G4GeneralParticleSource::G4GeneralParticleSource(), G4GeneralParticleSource::GeneratePrimaryVertex(), G4GeneralParticleSource::GetCurrentSource(), G4GeneralParticleSource::GetNumberOfParticles(), G4GeneralParticleSource::GetParticleDefinition(), G4GeneralParticleSource::GetParticleEnergy(), G4GeneralParticleSource::GetParticleMomentumDirection(), G4GeneralParticleSource::GetParticlePolarization(), G4GeneralParticleSource::GetParticlePosition(), G4GeneralParticleSource::GetParticleTime(), G4GeneralParticleSource::ListSource(), G4GeneralParticleSource::SetCurrentSourceto(), G4GeneralParticleSource::SetNumberOfParticles(), G4GeneralParticleSource::SetParticleCharge(), G4GeneralParticleSource::SetParticleDefinition(), G4GeneralParticleSource::SetParticlePolarization(), and G4GeneralParticleSource::SetParticleTime().

GetCurrentSourceIdx()

G4int G4GeneralParticleSourceData::GetCurrentSourceIdx ( ) const

inline

Definition at line 96 of file G4GeneralParticleSourceData.hh.

      { return currentSourceIdx; }

References currentSourceIdx.

Referenced by G4GeneralParticleSource::GetCurrentSourceIndex(), and G4GeneralParticleSource::ListSource().

GetFlatSampling()

G4bool G4GeneralParticleSourceData::GetFlatSampling ( ) const

inline

Definition at line 88 of file G4GeneralParticleSourceData.hh.

      { return flat_sampling; }

References flat_sampling.

Referenced by G4GeneralParticleSource::GeneratePrimaryVertex(), and G4GeneralParticleSource::ListSource().

GetIntensity()

G4double G4GeneralParticleSourceData::GetIntensity ( G4int  idx ) const

inline

Definition at line 79 of file G4GeneralParticleSourceData.hh.

      { return sourceIntensity.at(idx); }

References sourceIntensity.

Referenced by G4GeneralParticleSource::GetCurrentSourceIntensity(), and G4GeneralParticleSource::ListSource().

GetIntensityVectorSize()

G4int G4GeneralParticleSourceData::GetIntensityVectorSize ( ) const

inline

Definition at line 77 of file G4GeneralParticleSourceData.hh.

      { return G4int(sourceIntensity.size()); }

References sourceIntensity.

Referenced by DeleteASource(), G4GeneralParticleSource::DeleteaSource(), G4GeneralParticleSource::GeneratePrimaryVertex(), G4GeneralParticleSource::ListSource(), and G4GeneralParticleSource::SetCurrentSourceto().

GetMultipleVertex()

G4bool G4GeneralParticleSourceData::GetMultipleVertex ( ) const

inline

Definition at line 93 of file G4GeneralParticleSourceData.hh.

      { return multiple_vertex; }

References multiple_vertex.

Referenced by G4GeneralParticleSource::GeneratePrimaryVertex(), and G4GeneralParticleSource::ListSource().

GetSourceProbability()

G4double G4GeneralParticleSourceData::GetSourceProbability ( G4int  idx ) const

inline

Definition at line 81 of file G4GeneralParticleSourceData.hh.

      { return sourceProbability.at(idx); }

References sourceProbability.

Referenced by G4GeneralParticleSource::GeneratePrimaryVertex().

GetSourceVectorSize()

G4int G4GeneralParticleSourceData::GetSourceVectorSize ( ) const

inline

Definition at line 75 of file G4GeneralParticleSourceData.hh.

      { return G4int(sourceVector.size()); }

References sourceVector.

Referenced by G4GPSModel::DescribeYourselfTo(), and G4GeneralParticleSource::GetNumberofSource().

Instance()

G4GeneralParticleSourceData * G4GeneralParticleSourceData::Instance ( )

static

Definition at line 63 of file G4GeneralParticleSourceData.cc.

{
  G4AutoLock lock(&singMutex);
  static G4GeneralParticleSourceData instance;
  return &instance;
}

References anonymous_namespace{G4GeneralParticleSourceData.cc}::singMutex.

Referenced by G4GPSModel::DescribeYourselfTo(), and G4GeneralParticleSource::G4GeneralParticleSource().

IntensityNormalise()

void G4GeneralParticleSourceData::IntensityNormalise

(

)

Definition at line 70 of file G4GeneralParticleSourceData.cc.

{
  G4double total  = 0.;
  std::size_t i = 0 ;
  for (i = 0; i < sourceIntensity.size(); ++i)
  {
    total += sourceIntensity[i] ;
  }
  sourceProbability.clear();
  std::vector <G4double> sourceNormalizedIntensity;
  sourceNormalizedIntensity.clear();
    
  sourceNormalizedIntensity.push_back(sourceIntensity[0]/total);
  sourceProbability.push_back(sourceNormalizedIntensity[0]);
 
  for (i = 1 ;  i < sourceIntensity.size(); ++i)
  {
    sourceNormalizedIntensity.push_back(sourceIntensity[i]/total);
    sourceProbability.push_back(sourceNormalizedIntensity[i]+sourceProbability[i-1]);
  }
 
  // set source weights here based on sampling scheme (analog/flat)
  // and intensities
  //
  for (i = 0 ;  i < sourceIntensity.size(); ++i)
  {
    if (!flat_sampling)
    {
      GetCurrentSource(i)->GetBiasRndm()->SetIntensityWeight(1.);
    }
    else
    {
      GetCurrentSource(i)->GetBiasRndm()
      ->SetIntensityWeight(sourceNormalizedIntensity[i]*sourceIntensity.size());
    }
  }
  normalised = true;
}

References flat_sampling, G4SingleParticleSource::GetBiasRndm(), GetCurrentSource(), normalised, G4SPSRandomGenerator::SetIntensityWeight(), sourceIntensity, sourceProbability, and G4INCL::CrossSections::total().

Referenced by G4GeneralParticleSource::IntensityNormalization().

Lock()

void G4GeneralParticleSourceData::Lock

(

)

Definition at line 173 of file G4GeneralParticleSourceData.cc.

{
  G4MUTEXLOCK(&mutex);
}

References G4MUTEXLOCK.

Referenced by G4GeneralParticleSource::AddaSource(), G4GeneralParticleSource::GeneratePrimaryVertex(), and G4GeneralParticleSource::SetCurrentSourceIntensity().

Normalised()

G4bool G4GeneralParticleSourceData::Normalised ( ) const

inline

Definition at line 68 of file G4GeneralParticleSourceData.hh.

      { return normalised; }

References normalised.

Referenced by G4GeneralParticleSource::ClearAll(), G4GeneralParticleSource::DeleteaSource(), G4GeneralParticleSource::GeneratePrimaryVertex(), G4GeneralParticleSource::IntensityNormalization(), and G4GeneralParticleSource::SetCurrentSourceIntensity().

SetCurrentSourceIntensity()

void G4GeneralParticleSourceData::SetCurrentSourceIntensity

(

G4double

intensity

)

Definition at line 109 of file G4GeneralParticleSourceData.cc.

{
  sourceIntensity.at(currentSourceIdx) = intensity;
  normalised = false;
}

References currentSourceIdx, normalised, and sourceIntensity.

Referenced by G4GeneralParticleSource::SetCurrentSourceIntensity().

SetFlatSampling()

void G4GeneralParticleSourceData::SetFlatSampling ( G4bool  fSamp )

inline

Definition at line 86 of file G4GeneralParticleSourceData.hh.

      { flat_sampling = fSamp; }

References flat_sampling.

Referenced by G4GeneralParticleSource::SetFlatSampling().

SetMultipleVertex()

void G4GeneralParticleSourceData::SetMultipleVertex ( G4bool  flag )

inline

Definition at line 91 of file G4GeneralParticleSourceData.hh.

      { multiple_vertex = flag; }

References multiple_vertex.

Referenced by G4GeneralParticleSource::SetMultipleVertex().

SetVerbosityAllSources()

void G4GeneralParticleSourceData::SetVerbosityAllSources

(

G4int

vl

)

Definition at line 158 of file G4GeneralParticleSourceData.cc.

{
  for ( auto it = sourceVector.cbegin(); it != sourceVector.cend(); ++it )
  {
    (*it)->SetVerbosity(vl);
  }
}

References sourceVector.

Referenced by G4GeneralParticleSource::SetVerbosity().

Unlock()

void G4GeneralParticleSourceData::Unlock

(

)

Definition at line 178 of file G4GeneralParticleSourceData.cc.

{
  G4MUTEXUNLOCK(&mutex);
}

References G4MUTEXUNLOCK.

Referenced by G4GeneralParticleSource::AddaSource(), G4GeneralParticleSource::GeneratePrimaryVertex(), and G4GeneralParticleSource::SetCurrentSourceIntensity().

Field Documentation

currentSource

G4SingleParticleSource* G4GeneralParticleSourceData::currentSource = nullptr

private

Definition at line 121 of file G4GeneralParticleSourceData.hh.

Referenced by AddASource(), ClearSources(), DeleteASource(), G4GeneralParticleSourceData(), and GetCurrentSource().

currentSourceIdx

G4int G4GeneralParticleSourceData::currentSourceIdx = 0

private

Definition at line 120 of file G4GeneralParticleSourceData.hh.

Referenced by AddASource(), ClearSources(), DeleteASource(), GetCurrentSource(), GetCurrentSourceIdx(), and SetCurrentSourceIntensity().

flat_sampling

G4bool G4GeneralParticleSourceData::flat_sampling = false

private

Definition at line 117 of file G4GeneralParticleSourceData.hh.

Referenced by GetFlatSampling(), IntensityNormalise(), and SetFlatSampling().

multiple_vertex

G4bool G4GeneralParticleSourceData::multiple_vertex = false

private

Definition at line 116 of file G4GeneralParticleSourceData.hh.

Referenced by GetMultipleVertex(), and SetMultipleVertex().

mutex

G4Mutex G4GeneralParticleSourceData::mutex

private

Definition at line 122 of file G4GeneralParticleSourceData.hh.

normalised

G4bool G4GeneralParticleSourceData::normalised = false

private

Definition at line 118 of file G4GeneralParticleSourceData.hh.

Referenced by AddASource(), ClearSources(), DeleteASource(), IntensityNormalise(), Normalised(), and SetCurrentSourceIntensity().

sourceIntensity

std::vector<G4double> G4GeneralParticleSourceData::sourceIntensity

private

Definition at line 113 of file G4GeneralParticleSourceData.hh.

Referenced by AddASource(), ClearSources(), DeleteASource(), G4GeneralParticleSourceData(), GetIntensity(), GetIntensityVectorSize(), IntensityNormalise(), and SetCurrentSourceIntensity().

sourceProbability

std::vector<G4double> G4GeneralParticleSourceData::sourceProbability

private

Definition at line 114 of file G4GeneralParticleSourceData.hh.

Referenced by G4GeneralParticleSourceData(), GetSourceProbability(), and IntensityNormalise().

sourceVector

std::vector<G4SingleParticleSource*> G4GeneralParticleSourceData::sourceVector

private

Definition at line 112 of file G4GeneralParticleSourceData.hh.

Referenced by AddASource(), ClearSources(), DeleteASource(), G4GeneralParticleSourceData(), GetCurrentSource(), GetSourceVectorSize(), SetVerbosityAllSources(), and ~G4GeneralParticleSourceData().

---

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

• source/event/include/G4GeneralParticleSourceData.hh
• source/event/src/G4GeneralParticleSourceData.cc