G4SingleParticleSource Class Reference

#include <G4SingleParticleSource.hh>

Inheritance diagram for G4SingleParticleSource:

Public Member Functions
	G4SingleParticleSource ()
	~G4SingleParticleSource () override
void	GeneratePrimaryVertex (G4Event *evt) override
G4SPSPosDistribution *	GetPosDist () const
G4SPSAngDistribution *	GetAngDist () const
G4SPSEneDistribution *	GetEneDist () const
G4SPSRandomGenerator *	GetBiasRndm () const
void	SetVerbosity (G4int)
void	SetParticleDefinition (G4ParticleDefinition *aParticleDefinition)
G4ParticleDefinition *	GetParticleDefinition () const
void	SetParticleCharge (G4double aCharge)
void	SetParticlePolarization (const G4ThreeVector &aVal)
const 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
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 70 of file G4SingleParticleSource.hh.

Constructor & Destructor Documentation

G4SingleParticleSource()

G4SingleParticleSource::G4SingleParticleSource

(

)

Definition at line 57 of file G4SingleParticleSource.cc.

{
  // Initialise all variables
  // Position distribution Variables
 
  NumberOfParticlesToBeGenerated = 1;
  definition = G4Geantino::GeantinoDefinition();
 
  charge = 0.0;
  time = 0;
  polarization = G4ThreeVector();
 
  biasRndm = new G4SPSRandomGenerator();
  posGenerator = new G4SPSPosDistribution();
  posGenerator->SetBiasRndm(biasRndm);
  angGenerator = new G4SPSAngDistribution();
  angGenerator->SetPosDistribution(posGenerator);
  angGenerator->SetBiasRndm(biasRndm);
  eneGenerator = new G4SPSEneDistribution();
  eneGenerator->SetBiasRndm(biasRndm);
 
  verbosityLevel = 0;
    
  G4MUTEXINIT(mutex);
}

~G4SingleParticleSource()

G4SingleParticleSource::~G4SingleParticleSource ( )

override

Definition at line 83 of file G4SingleParticleSource.cc.

{
  delete biasRndm;
  delete posGenerator;
  delete angGenerator;
  delete eneGenerator;
 
  G4MUTEXDESTROY(mutex);
}

Member Function Documentation

GeneratePrimaryVertex()

void G4SingleParticleSource::GeneratePrimaryVertex ( G4Event * evt )

overridevirtual

Implements G4VPrimaryGenerator.

Definition at line 109 of file G4SingleParticleSource.cc.

{
  if (definition == nullptr)
  {
    // TODO: Should this rise an exception???
    return;
  }
 
  if (verbosityLevel > 1)
  {
    G4cout << " NumberOfParticlesToBeGenerated: "
           << NumberOfParticlesToBeGenerated << G4endl;
  }
 
  part_prop_t& pp = ParticleProperties.Get();
 
  // Position stuff
  pp.position = posGenerator->GenerateOne();
 
  // Create a new vertex
  auto* vertex = new G4PrimaryVertex(pp.position,time);
 
  for (G4int i=0; i<NumberOfParticlesToBeGenerated; ++i)
  {
    // Angular stuff
    pp.momentum_direction = angGenerator->GenerateOne();
 
    // Energy stuff
    pp.energy = eneGenerator->GenerateOne(definition);
 
    if (verbosityLevel >= 2)
    {
      G4cout << "Creating primaries and assigning to vertex" << G4endl;
    }
 
    // Create new primaries and set them to the vertex
    //
    G4double mass = definition->GetPDGMass();
    auto* particle = new G4PrimaryParticle(definition);
    particle->SetKineticEnergy(pp.energy );
    particle->SetMass( mass );
    particle->SetMomentumDirection( pp.momentum_direction );
    particle->SetCharge( charge );
    particle->SetPolarization(polarization.x(),
                              polarization.y(),
                              polarization.z());
    if (verbosityLevel > 1)
    {
      G4cout << "Particle name: " << definition->GetParticleName() << G4endl;
      G4cout << "       Energy: " << pp.energy << G4endl;
      G4cout << "     Position: " << pp.position << G4endl;
      G4cout << "    Direction: " << pp.momentum_direction << G4endl;
    }
 
    // Set bweight equal to the multiple of all non-zero weights
    //
    G4double weight = eneGenerator->GetWeight()*biasRndm->GetBiasWeight();
 
    if(eneGenerator->IfApplyEnergyWeight())
    {
      weight *= eneGenerator->GetArbEneWeight(pp.energy);
    }
 
    // Pass it to primary particle
    //
    particle->SetWeight(weight);
    vertex->SetPrimary(particle);
  }
 
  // Now pass the weight to the primary vertex. CANNOT be used here!
  //  vertex->SetWeight(particle_weight);
  evt->AddPrimaryVertex(vertex);
 
  if (verbosityLevel > 1)
  {
    G4cout << " Primary Vetex generated !" << G4endl;
  }
}

Referenced by G4AdjointPrimaryGenerator::GenerateAdjointPrimaryVertex(), G4AdjointPrimaryGenerator::GenerateFwdPrimaryVertex(), and G4GeneralParticleSource::GeneratePrimaryVertex().

GetAngDist()

G4SPSAngDistribution * G4SingleParticleSource::GetAngDist ( ) const

inline

Definition at line 87 of file G4SingleParticleSource.hh.

{ return angGenerator; }

Referenced by G4AdjointPrimaryGenerator::G4AdjointPrimaryGenerator(), G4AdjointPrimaryGenerator::GenerateAdjointPrimaryVertex(), G4AdjointPrimaryGenerator::GenerateFwdPrimaryVertex(), G4GeneralParticleSource::ListSource(), G4AdjointPrimaryGenerator::SetAdjointPrimarySourceOnAnExtSurfaceOfAVolume(), G4GeneralParticleSourceMessenger::SetNewValue(), and G4AdjointPrimaryGenerator::SetSphericalAdjointPrimarySource().

GetBiasRndm()

G4SPSRandomGenerator * G4SingleParticleSource::GetBiasRndm ( ) const

inline

Definition at line 93 of file G4SingleParticleSource.hh.

{ return biasRndm; }

Referenced by G4GeneralParticleSourceData::IntensityNormalise(), and G4GeneralParticleSourceMessenger::SetNewValue().

GetEneDist()

G4SPSEneDistribution * G4SingleParticleSource::GetEneDist ( ) const

inline

Definition at line 90 of file G4SingleParticleSource.hh.

{ return eneGenerator; }

Referenced by G4AdjointPrimaryGenerator::G4AdjointPrimaryGenerator(), G4AdjointPrimaryGenerator::GenerateAdjointPrimaryVertex(), G4AdjointPrimaryGenerator::GenerateFwdPrimaryVertex(), G4GeneralParticleSource::ListSource(), and G4GeneralParticleSourceMessenger::SetNewValue().

GetNumberOfParticles()

G4int G4SingleParticleSource::GetNumberOfParticles ( ) const

inline

Definition at line 119 of file G4SingleParticleSource.hh.

           { return NumberOfParticlesToBeGenerated; }

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

GetParticleDefinition()

G4ParticleDefinition * G4SingleParticleSource::GetParticleDefinition ( ) const

inline

Definition at line 100 of file G4SingleParticleSource.hh.

           { return definition; }

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

GetParticleEnergy()

G4double G4SingleParticleSource::GetParticleEnergy ( ) const

inline

Definition at line 127 of file G4SingleParticleSource.hh.

           { return ParticleProperties.Get().energy; }

Referenced by G4GeneralParticleSource::GetParticleEnergy().

GetParticleMomentumDirection()

G4ThreeVector G4SingleParticleSource::GetParticleMomentumDirection ( ) const

inline

Definition at line 125 of file G4SingleParticleSource.hh.

           { return ParticleProperties.Get().momentum_direction; }

Referenced by G4GeneralParticleSource::GetParticleMomentumDirection().

GetParticlePolarization()

const G4ThreeVector & G4SingleParticleSource::GetParticlePolarization ( ) const

inline

Definition at line 109 of file G4SingleParticleSource.hh.

           { return polarization; }

Referenced by G4GeneralParticleSource::GetParticlePolarization().

GetParticlePosition()

G4ThreeVector G4SingleParticleSource::GetParticlePosition ( ) const

inline

Definition at line 123 of file G4SingleParticleSource.hh.

           { return ParticleProperties.Get().position; }

Referenced by G4GeneralParticleSource::GetParticlePosition().

GetParticleTime()

G4double G4SingleParticleSource::GetParticleTime ( ) const

inline

Definition at line 114 of file G4SingleParticleSource.hh.

{ return time; }

Referenced by G4GeneralParticleSource::GetParticleTime().

GetPosDist()

G4SPSPosDistribution * G4SingleParticleSource::GetPosDist ( ) const

inline

Definition at line 84 of file G4SingleParticleSource.hh.

{ return posGenerator; }

Referenced by G4GPSModel::DescribeYourselfTo(), G4AdjointPrimaryGenerator::G4AdjointPrimaryGenerator(), G4AdjointPrimaryGenerator::GenerateAdjointPrimaryVertex(), G4AdjointPrimaryGenerator::GenerateFwdPrimaryVertex(), G4GeneralParticleSource::ListSource(), G4AdjointPrimaryGenerator::SetAdjointPrimarySourceOnAnExtSurfaceOfAVolume(), G4GeneralParticleSourceMessenger::SetNewValue(), and G4AdjointPrimaryGenerator::SetSphericalAdjointPrimarySource().

SetNumberOfParticles()

void G4SingleParticleSource::SetNumberOfParticles ( G4int i )

inline

Definition at line 117 of file G4SingleParticleSource.hh.

           { NumberOfParticlesToBeGenerated = i; }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue(), and G4GeneralParticleSource::SetNumberOfParticles().

SetParticleCharge()

void G4SingleParticleSource::SetParticleCharge ( G4double aCharge )

inline

Definition at line 104 of file G4SingleParticleSource.hh.

{ charge = aCharge; }

Referenced by G4GeneralParticleSource::SetParticleCharge().

SetParticleDefinition()

void G4SingleParticleSource::SetParticleDefinition

(

G4ParticleDefinition *

aParticleDefinition

)

Definition at line 102 of file G4SingleParticleSource.cc.

{
  definition = aParticleDefinition;
  charge = aParticleDefinition->GetPDGCharge();
}

Referenced by G4AdjointPrimaryGenerator::GenerateAdjointPrimaryVertex(), G4AdjointPrimaryGenerator::GenerateFwdPrimaryVertex(), G4GeneralParticleSourceMessenger::SetNewValue(), and G4GeneralParticleSource::SetParticleDefinition().

SetParticlePolarization()

void G4SingleParticleSource::SetParticlePolarization ( const G4ThreeVector & aVal )

inline

Definition at line 107 of file G4SingleParticleSource.hh.

           { polarization = aVal; }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue(), and G4GeneralParticleSource::SetParticlePolarization().

SetParticleTime()

void G4SingleParticleSource::SetParticleTime ( G4double aTime )

inline

Definition at line 113 of file G4SingleParticleSource.hh.

{ time = aTime; }

Referenced by G4GeneralParticleSourceMessenger::SetNewValue(), and G4GeneralParticleSource::SetParticleTime().

SetVerbosity()

void G4SingleParticleSource::SetVerbosity

(

G4int

vL

)

Definition at line 93 of file G4SingleParticleSource.cc.

{
  G4AutoLock l(&mutex);
  verbosityLevel = vL;
  posGenerator->SetVerbosity(vL);
  angGenerator->SetVerbosity(vL);
  eneGenerator->SetVerbosity(vL);
}

---

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

• G4SingleParticleSource.hh
• G4SingleParticleSource.cc