G4GeneralParticleSource Class Reference

#include <G4GeneralParticleSource.hh>

Inheritance diagram for G4GeneralParticleSource:

Public Member Functions
	G4GeneralParticleSource ()
	~G4GeneralParticleSource () override
void	GeneratePrimaryVertex (G4Event *) override
G4int	GetNumberofSource ()
void	ListSource ()
void	SetCurrentSourceto (G4int)
void	SetCurrentSourceIntensity (G4double)
G4SingleParticleSource *	GetCurrentSource () const
G4int	GetCurrentSourceIndex () const
G4double	GetCurrentSourceIntensity () const
void	ClearAll ()
void	AddaSource (G4double)
void	DeleteaSource (G4int)
void	SetVerbosity (G4int i)
void	SetMultipleVertex (G4bool av)
void	SetFlatSampling (G4bool av)
void	SetParticleDefinition (G4ParticleDefinition *aPDef)
G4ParticleDefinition *	GetParticleDefinition () const
void	SetParticleCharge (G4double aCharge)
void	SetParticlePolarization (G4ThreeVector aVal)
G4ThreeVector	GetParticlePolarization () const
void	SetParticleTime (G4double aTime)
G4double	GetParticleTime () const
void	SetNumberOfParticles (G4int i)
G4int	GetNumberOfParticles () const
G4ThreeVector	GetParticlePosition () const
G4ThreeVector	GetParticleMomentumDirection () const
G4double	GetParticleEnergy () const
Public Member Functions inherited from G4VPrimaryGenerator
	G4VPrimaryGenerator ()=default
virtual	~G4VPrimaryGenerator ()=default
virtual void	GeneratePrimaryVertex (G4Event *evt)=0
G4ThreeVector	GetParticlePosition ()
G4double	GetParticleTime ()
void	SetParticlePosition (G4ThreeVector aPosition)
void	SetParticleTime (G4double aTime)

Additional Inherited Members
Static Public Member Functions inherited from G4VPrimaryGenerator
static G4bool	CheckVertexInsideWorld (const G4ThreeVector &pos)
Protected Attributes inherited from G4VPrimaryGenerator
G4ThreeVector	particle_position
G4double	particle_time = 0.0

Detailed Description

Definition at line 58 of file G4GeneralParticleSource.hh.

Constructor & Destructor Documentation

G4GeneralParticleSource()

G4GeneralParticleSource::G4GeneralParticleSource

(

)

Definition at line 49 of file G4GeneralParticleSource.cc.

{
  GPSData = G4GeneralParticleSourceData::Instance();
  // currentSource = GPSData->GetCurrentSource();
  // currentSourceIdx = G4int(GPSData->GetSourceVectorSize() - 1);
 
  // Messenger is special, only a worker should instantiate it.
  // Singleton pattern
  //
  theMessenger = G4GeneralParticleSourceMessenger::GetInstance(this);
 
  // Some initialization should be done only once
  //
  G4AutoLock l(&messangerInit);
  static G4bool onlyOnce = false;
  if ( !onlyOnce )
  {
    theMessenger->SetParticleGun(GPSData->GetCurrentSource());
    IntensityNormalization();
    onlyOnce = true;
  }
}

~G4GeneralParticleSource()

G4GeneralParticleSource::~G4GeneralParticleSource ( )

override

Definition at line 72 of file G4GeneralParticleSource.cc.

{
  theMessenger->Destroy();
}

Member Function Documentation

AddaSource()

void G4GeneralParticleSource::AddaSource

(

G4double

aV

)

Definition at line 77 of file G4GeneralParticleSource.cc.

{
  GPSData->Lock();
 
  GPSData->AddASource(aV);
  theMessenger->SetParticleGun(GPSData->GetCurrentSource());
 
  // TODO: But do we really normalize here after each source?
  IntensityNormalization();
 
  GPSData->Unlock();
}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

ClearAll()

void G4GeneralParticleSource::ClearAll

(

)

Definition at line 158 of file G4GeneralParticleSource.cc.

{
  GPSData->ClearSources();
  normalised=GPSData->Normalised();
}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

DeleteaSource()

void G4GeneralParticleSource::DeleteaSource

(

G4int

aV

)

Definition at line 164 of file G4GeneralParticleSource.cc.

{
  G4int id = aV;
  if ( id <= GPSData->GetIntensityVectorSize() )
  {
    GPSData->DeleteASource(aV);
    normalised=GPSData->Normalised();
  }
  else
  {
    G4cout << " source index is invalid " << G4endl;
    G4cout << "    it shall be <= "
           << GPSData->GetIntensityVectorSize() << G4endl;
  }
}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

GeneratePrimaryVertex()

void G4GeneralParticleSource::GeneratePrimaryVertex ( G4Event *  evt )

overridevirtual

Implements G4VPrimaryGenerator.

Definition at line 180 of file G4GeneralParticleSource.cc.

{
  if (!GPSData->GetMultipleVertex())
  {
    G4SingleParticleSource* currentSource = GPSData->GetCurrentSource();
    if (GPSData->GetIntensityVectorSize() > 1)
    {
      // Try to minimize locks
      if (! normalised )
      {
        // According to local variable, normalization is needed
        // Check with underlying shared resource, another
        // thread could have already normalized this
        GPSData->Lock();
        G4bool norm = GPSData->Normalised();
        if (!norm)
        {
          IntensityNormalization();
        }
        // This takes care of the case in which the local variable
        // is False and the underlying resource is true.
        normalised = GPSData->Normalised();
        GPSData->Unlock();
      }
      G4double rndm = G4UniformRand();
      G4int i = 0 ;
      if (! GPSData->GetFlatSampling() )
      {
        while ( rndm > GPSData->GetSourceProbability(i) ) ++i;
          currentSource = GPSData->GetCurrentSource(i);
      }
      else
      {
        i = G4int (GPSData->GetIntensityVectorSize()*rndm);
        currentSource = GPSData->GetCurrentSource(i);
      }
    }
    currentSource->GeneratePrimaryVertex(evt);
  } 
  else
  {
    for (G4int i = 0; i <  GPSData->GetIntensityVectorSize(); ++i)
    {
      GPSData->GetCurrentSource(i)->GeneratePrimaryVertex(evt);
    }
  }
}

GetCurrentSource()

G4SingleParticleSource * G4GeneralParticleSource::GetCurrentSource ( ) const

inline

Definition at line 84 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource(); }

GetCurrentSourceIndex()

G4int G4GeneralParticleSource::GetCurrentSourceIndex ( ) const

inline

Definition at line 87 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSourceIdx(); }

Referenced by GetCurrentSourceIntensity(), and G4GeneralParticleSourceMessenger::SetNewValue().

GetCurrentSourceIntensity()

G4double G4GeneralParticleSource::GetCurrentSourceIntensity ( ) const

inline

Definition at line 90 of file G4GeneralParticleSource.hh.

      { return GPSData->GetIntensity(GetCurrentSourceIndex()); }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

GetNumberOfParticles()

G4int G4GeneralParticleSource::GetNumberOfParticles ( ) const

inline

Definition at line 135 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetNumberOfParticles(); }

GetNumberofSource()

G4int G4GeneralParticleSource::GetNumberofSource ( )

inline

Definition at line 71 of file G4GeneralParticleSource.hh.

{ return GPSData->GetSourceVectorSize(); }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

GetParticleDefinition()

G4ParticleDefinition * G4GeneralParticleSource::GetParticleDefinition ( ) const

inline

Definition at line 113 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetParticleDefinition(); }

GetParticleEnergy()

G4double G4GeneralParticleSource::GetParticleEnergy ( ) const

inline

Definition at line 143 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetParticleEnergy(); }

GetParticleMomentumDirection()

G4ThreeVector G4GeneralParticleSource::GetParticleMomentumDirection ( ) const

inline

Definition at line 141 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetParticleMomentumDirection(); }

GetParticlePolarization()

G4ThreeVector G4GeneralParticleSource::GetParticlePolarization ( ) const

inline

Definition at line 123 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetParticlePolarization(); }

GetParticlePosition()

G4ThreeVector G4GeneralParticleSource::GetParticlePosition ( ) const

inline

Definition at line 139 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetParticlePosition(); }

GetParticleTime()

G4double G4GeneralParticleSource::GetParticleTime ( ) const

inline

Definition at line 129 of file G4GeneralParticleSource.hh.

      { return GPSData->GetCurrentSource()->GetParticleTime(); }

ListSource()

void G4GeneralParticleSource::ListSource

(

)

Definition at line 96 of file G4GeneralParticleSource.cc.

{
  G4cout << "The number of particle sources is: "
         << GPSData->GetIntensityVectorSize() << G4endl;
  G4cout << " Multiple Vertex sources: " << GPSData->GetMultipleVertex();
  G4cout << " Flat Sampling flag: " << GPSData->GetFlatSampling() << G4endl;
  const G4int currentIdx = GPSData->GetCurrentSourceIdx();
  for(G4int i=0; i<GPSData->GetIntensityVectorSize(); ++i)
  {
    G4cout << "\tsource " << i << " with intensity: "
           << GPSData->GetIntensity(i) << G4endl;
    const G4SingleParticleSource* thisSrc = GPSData->GetCurrentSource(i);
    G4cout << " \t\tNum Particles: "<<thisSrc->GetNumberOfParticles()
           << "; Particle type: "
           << thisSrc->GetParticleDefinition()->GetParticleName() << G4endl;
    G4cout << " \t\tEnergy: "
           << G4BestUnit(thisSrc->GetParticleEnergy(),"Energy") << G4endl;
    G4cout << " \t\tDirection: "
           << thisSrc->GetAngDist()->GetDirection() << "; Position: ";
    G4cout << G4BestUnit(thisSrc->GetPosDist()->GetCentreCoords(),"Length")
           << G4endl;
    G4cout << " \t\tAngular Distribution: "
           << thisSrc->GetAngDist()->GetDistType() << G4endl;
    G4cout << " \t\tEnergy Distribution: "
           << thisSrc->GetEneDist()->GetEnergyDisType() << G4endl;
    G4cout << " \t\tPosition Distribution Type: "
           << thisSrc->GetPosDist()->GetPosDisType();
    G4cout << "; Position Shape: "
           << thisSrc->GetPosDist()->GetPosDisShape() << G4endl;
  }
 
  // Set back previous source
  GPSData->GetCurrentSource(currentIdx);
}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

SetCurrentSourceIntensity()

void G4GeneralParticleSource::SetCurrentSourceIntensity

(

G4double

aV

)

Definition at line 150 of file G4GeneralParticleSource.cc.

{
  GPSData->Lock();
  GPSData->SetCurrentSourceIntensity(aV);
  GPSData->Unlock();
  normalised = GPSData->Normalised();
}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

SetCurrentSourceto()

void G4GeneralParticleSource::SetCurrentSourceto

(

G4int

aV

)

Definition at line 131 of file G4GeneralParticleSource.cc.

{
  G4int id = aV;
  if ( id < GPSData->GetIntensityVectorSize() )
  {
    // currentSourceIdx = aV;
    // currentSource = GPSData->GetCurrentSource(id);
    theMessenger->SetParticleGun(GPSData->GetCurrentSource(id));
  }
  else
  {
    G4ExceptionDescription msg;
    msg << "Trying to set source to index " << aV << " but only "
        << GPSData->GetIntensityVectorSize() << " sources are defined.";
    G4Exception("G4GeneralParticleSoruce::SetCurrentSourceto", "G4GPS004",
                FatalException, msg);
  }
}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

SetFlatSampling()

void G4GeneralParticleSource::SetFlatSampling ( G4bool  av )

inline

Definition at line 107 of file G4GeneralParticleSource.hh.

      { GPSData->SetFlatSampling(av); normalised = false;}

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

SetMultipleVertex()

void G4GeneralParticleSource::SetMultipleVertex ( G4bool  av )

inline

Definition at line 104 of file G4GeneralParticleSource.hh.

{ GPSData->SetMultipleVertex(av); }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

SetNumberOfParticles()

void G4GeneralParticleSource::SetNumberOfParticles ( G4int  i )

inline

Definition at line 133 of file G4GeneralParticleSource.hh.

      { GPSData->GetCurrentSource()->SetNumberOfParticles(i); }

SetParticleCharge()

void G4GeneralParticleSource::SetParticleCharge ( G4double  aCharge )

inline

Definition at line 117 of file G4GeneralParticleSource.hh.

      { GPSData->GetCurrentSource()->SetParticleCharge(aCharge); }

SetParticleDefinition()

void G4GeneralParticleSource::SetParticleDefinition ( G4ParticleDefinition *  aPDef )

inline

Definition at line 111 of file G4GeneralParticleSource.hh.

      { GPSData->GetCurrentSource()->SetParticleDefinition(aPDef); }

SetParticlePolarization()

void G4GeneralParticleSource::SetParticlePolarization ( G4ThreeVector  aVal )

inline

Definition at line 121 of file G4GeneralParticleSource.hh.

      { GPSData->GetCurrentSource()->SetParticlePolarization(aVal); }

SetParticleTime()

void G4GeneralParticleSource::SetParticleTime ( G4double  aTime )

inline

Definition at line 127 of file G4GeneralParticleSource.hh.

      { GPSData->GetCurrentSource()->SetParticleTime(aTime); }

SetVerbosity()

void G4GeneralParticleSource::SetVerbosity ( G4int  i )

inline

Definition at line 101 of file G4GeneralParticleSource.hh.

{ GPSData->SetVerbosityAllSources(i); }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue().

---

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

• G4GeneralParticleSource.hh
• G4GeneralParticleSource.cc