#include <G4SingleParticleSource.hh>

Inheritance diagram for G4SingleParticleSource:

Data Structures
struct	part_prop_t

Public Member Functions
	G4SingleParticleSource ()

void	GeneratePrimaryVertex (G4Event *evt)

G4SPSAngDistribution *	GetAngDist () const

G4SPSRandomGenerator *	GetBiasRndm () const

G4SPSEneDistribution *	GetEneDist () const

G4int	GetNumberOfParticles () const

G4ParticleDefinition *	GetParticleDefinition () const

G4double	GetParticleEnergy () const

G4ThreeVector	GetParticleMomentumDirection () const

const G4ThreeVector &	GetParticlePolarization () const

G4ThreeVector	GetParticlePosition ()

G4ThreeVector	GetParticlePosition () const

G4double	GetParticleTime ()

G4double	GetParticleTime () const

G4SPSPosDistribution *	GetPosDist () const

void	SetNumberOfParticles (G4int i)

void	SetParticleCharge (G4double aCharge)

void	SetParticleDefinition (G4ParticleDefinition *aParticleDefinition)

void	SetParticlePolarization (const G4ThreeVector &aVal)

void	SetParticlePosition (G4ThreeVector aPosition)

void	SetParticleTime (G4double aTime)

void	SetVerbosity (G4int)

	~G4SingleParticleSource ()

Static Public Member Functions
static G4bool	CheckVertexInsideWorld (const G4ThreeVector &pos)

Protected Attributes
G4ThreeVector	particle_position

G4double	particle_time = 0.0

Private Attributes
G4SPSAngDistribution *	angGenerator = nullptr

G4SPSRandomGenerator *	biasRndm = nullptr

G4double	charge

G4ParticleDefinition *	definition = nullptr

G4SPSEneDistribution *	eneGenerator = nullptr

G4Mutex	mutex

G4int	NumberOfParticlesToBeGenerated

G4Cache< part_prop_t >	ParticleProperties

G4ThreeVector	polarization

G4SPSPosDistribution *	posGenerator = nullptr

G4double	time

G4int	verbosityLevel

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);
}

References angGenerator, biasRndm, charge, definition, eneGenerator, G4MUTEXINIT, G4Geantino::GeantinoDefinition(), NumberOfParticlesToBeGenerated, polarization, posGenerator, G4SPSAngDistribution::SetBiasRndm(), G4SPSEneDistribution::SetBiasRndm(), G4SPSPosDistribution::SetBiasRndm(), G4SPSAngDistribution::SetPosDistribution(), time, and verbosityLevel.

◆ ~G4SingleParticleSource()

G4SingleParticleSource::~G4SingleParticleSource ( )

Definition at line 83 of file G4SingleParticleSource.cc.

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

References angGenerator, biasRndm, eneGenerator, G4MUTEXDESTROY, and posGenerator.

Member Function Documentation

◆ CheckVertexInsideWorld()

G4bool G4VPrimaryGenerator::CheckVertexInsideWorld ( const G4ThreeVector & pos )

staticinherited

Definition at line 43 of file G4VPrimaryGenerator.cc.

{
  G4Navigator* navigator= G4TransportationManager::GetTransportationManager()
                                                 -> GetNavigatorForTracking();
  
  G4VPhysicalVolume* world= navigator-> GetWorldVolume();
  G4VSolid* solid = world-> GetLogicalVolume()-> GetSolid();
  EInside qinside = solid-> Inside(pos);
  
  return (qinside != kInside) ? false : true;
}

References G4TransportationManager::GetTransportationManager(), kInside, write_gdml::navigator, and pos.

◆ GeneratePrimaryVertex()

void G4SingleParticleSource::GeneratePrimaryVertex ( G4Event * evt )

virtual

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
  G4PrimaryVertex* 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();
    G4PrimaryParticle* 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;
  }
}

References G4Event::AddPrimaryVertex(), angGenerator, biasRndm, charge, definition, eneGenerator, G4cout, G4endl, G4SPSAngDistribution::GenerateOne(), G4SPSPosDistribution::GenerateOne(), G4SPSEneDistribution::GenerateOne(), G4SPSEneDistribution::GetArbEneWeight(), G4SPSRandomGenerator::GetBiasWeight(), G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetPDGMass(), G4SPSEneDistribution::GetWeight(), G4SPSEneDistribution::IfApplyEnergyWeight(), NumberOfParticlesToBeGenerated, ParticleProperties, polarization, posGenerator, G4InuclParticleNames::pp, G4PrimaryParticle::SetCharge(), G4PrimaryParticle::SetKineticEnergy(), G4PrimaryParticle::SetMass(), G4PrimaryParticle::SetMomentumDirection(), G4PrimaryParticle::SetPolarization(), G4PrimaryVertex::SetPrimary(), G4PrimaryParticle::SetWeight(), time, verbosityLevel, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

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

◆ GetAngDist()

G4SPSAngDistribution * G4SingleParticleSource::GetAngDist ( ) const

inline

Definition at line 87 of file G4SingleParticleSource.hh.

87{ return angGenerator; }

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

93{ return biasRndm; }

References biasRndm.

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

◆ GetEneDist()

G4SPSEneDistribution * G4SingleParticleSource::GetEneDist ( ) const

inline

Definition at line 90 of file G4SingleParticleSource.hh.

90{ return eneGenerator; }

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

120 { return NumberOfParticlesToBeGenerated; }

References NumberOfParticlesToBeGenerated.

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

◆ GetParticleDefinition()

G4ParticleDefinition * G4SingleParticleSource::GetParticleDefinition ( ) const

inline

Definition at line 100 of file G4SingleParticleSource.hh.

101 { return definition; }

References definition.

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

◆ GetParticleEnergy()

G4double G4SingleParticleSource::GetParticleEnergy ( ) const

inline

Definition at line 127 of file G4SingleParticleSource.hh.

128 { return ParticleProperties.Get().energy; }

References ParticleProperties.

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

◆ GetParticleMomentumDirection()

G4ThreeVector G4SingleParticleSource::GetParticleMomentumDirection ( ) const

inline

Definition at line 125 of file G4SingleParticleSource.hh.

126 { return ParticleProperties.Get().momentum_direction; }

References ParticleProperties.

Referenced by G4GeneralParticleSource::GetParticleMomentumDirection().

◆ GetParticlePolarization()

const G4ThreeVector & G4SingleParticleSource::GetParticlePolarization ( ) const

inline

Definition at line 109 of file G4SingleParticleSource.hh.

110 { return polarization; }

References polarization.

Referenced by G4GeneralParticleSource::GetParticlePolarization().

◆ GetParticlePosition() [1/2]

G4ThreeVector G4VPrimaryGenerator::GetParticlePosition ( )

inlineinherited

Definition at line 60 of file G4VPrimaryGenerator.hh.

60{ return particle_position; }

G4VPrimaryGenerator::particle_position

G4ThreeVector particle_position

Definition: G4VPrimaryGenerator.hh:70

References G4VPrimaryGenerator::particle_position.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticlePosition() [2/2]

G4ThreeVector G4SingleParticleSource::GetParticlePosition ( ) const

inline

Definition at line 123 of file G4SingleParticleSource.hh.

124 { return ParticleProperties.Get().position; }

References ParticleProperties.

Referenced by G4GeneralParticleSource::GetParticlePosition().

◆ GetParticleTime() [1/2]

G4double G4VPrimaryGenerator::GetParticleTime ( )

inlineinherited

Definition at line 61 of file G4VPrimaryGenerator.hh.

61{ return particle_time; }

G4VPrimaryGenerator::particle_time

G4double particle_time

Definition: G4VPrimaryGenerator.hh:71

References G4VPrimaryGenerator::particle_time.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticleTime() [2/2]

G4double G4SingleParticleSource::GetParticleTime ( ) const

inline

Definition at line 114 of file G4SingleParticleSource.hh.

114{ return time; }

References time.

Referenced by G4GeneralParticleSource::GetParticleTime().

◆ GetPosDist()

G4SPSPosDistribution * G4SingleParticleSource::GetPosDist ( ) const

inline

Definition at line 84 of file G4SingleParticleSource.hh.

84{ return posGenerator; }

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

118 { NumberOfParticlesToBeGenerated = i; }

References NumberOfParticlesToBeGenerated.

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

◆ SetParticleCharge()

void G4SingleParticleSource::SetParticleCharge ( G4double aCharge )

inline

Definition at line 104 of file G4SingleParticleSource.hh.

104{ charge = aCharge; }

References charge.

Referenced by G4GeneralParticleSourceMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), and G4GeneralParticleSource::SetParticleCharge().

◆ SetParticleDefinition()

void G4SingleParticleSource::SetParticleDefinition ( G4ParticleDefinition * aParticleDefinition )

Definition at line 102 of file G4SingleParticleSource.cc.

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

References charge, definition, and G4ParticleDefinition::GetPDGCharge().

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

◆ SetParticlePolarization()

void G4SingleParticleSource::SetParticlePolarization ( const G4ThreeVector & aVal )

inline

Definition at line 107 of file G4SingleParticleSource.hh.

108 { polarization = aVal; }

References polarization.

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

◆ SetParticlePosition()

void G4VPrimaryGenerator::SetParticlePosition ( G4ThreeVector aPosition )

inlineinherited

Definition at line 63 of file G4VPrimaryGenerator.hh.

64 { particle_position = aPosition; }

References G4VPrimaryGenerator::particle_position.

Referenced by export_G4ParticleGun(), G4ParticleGunMessenger::G4ParticleGunMessenger(), PrimaryGeneratorAction::SetDefaultKinematic(), and G4ParticleGunMessenger::SetNewValue().

◆ SetParticleTime()

void G4SingleParticleSource::SetParticleTime ( G4double aTime )

inline

Definition at line 113 of file G4SingleParticleSource.hh.

113{ time = aTime; }

References time.

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);
}

References angGenerator, eneGenerator, posGenerator, G4SPSAngDistribution::SetVerbosity(), G4SPSEneDistribution::SetVerbosity(), G4SPSPosDistribution::SetVerbosity(), and verbosityLevel.

Field Documentation

◆ angGenerator

G4SPSAngDistribution* G4SingleParticleSource::angGenerator = nullptr

private

Definition at line 134 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetAngDist(), SetVerbosity(), and ~G4SingleParticleSource().

◆ biasRndm

G4SPSRandomGenerator* G4SingleParticleSource::biasRndm = nullptr

private

Definition at line 136 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetBiasRndm(), and ~G4SingleParticleSource().

◆ charge

G4double G4SingleParticleSource::charge

private

Definition at line 152 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), SetParticleCharge(), and SetParticleDefinition().

◆ definition

G4ParticleDefinition* G4SingleParticleSource::definition = nullptr

private

Definition at line 151 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetParticleDefinition(), and SetParticleDefinition().

◆ eneGenerator

G4SPSEneDistribution* G4SingleParticleSource::eneGenerator = nullptr

private

Definition at line 135 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetEneDist(), SetVerbosity(), and ~G4SingleParticleSource().

◆ mutex

G4Mutex G4SingleParticleSource::mutex

private

Definition at line 159 of file G4SingleParticleSource.hh.

◆ NumberOfParticlesToBeGenerated

G4int G4SingleParticleSource::NumberOfParticlesToBeGenerated

private

Definition at line 150 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetNumberOfParticles(), and SetNumberOfParticles().

◆ particle_position

G4ThreeVector G4VPrimaryGenerator::particle_position

protectedinherited

Definition at line 70 of file G4VPrimaryGenerator.hh.

Referenced by G4HEPEvtInterface::G4HEPEvtInterface(), G4HEPEvtInterface::GeneratePrimaryVertex(), G4ParticleGun::GeneratePrimaryVertex(), G4VPrimaryGenerator::GetParticlePosition(), G4ParticleGun::SetInitialValues(), and G4VPrimaryGenerator::SetParticlePosition().

◆ particle_time

G4double G4VPrimaryGenerator::particle_time = 0.0

protectedinherited

Definition at line 71 of file G4VPrimaryGenerator.hh.

Referenced by G4HEPEvtInterface::G4HEPEvtInterface(), G4HEPEvtInterface::GeneratePrimaryVertex(), G4ParticleGun::GeneratePrimaryVertex(), G4VPrimaryGenerator::GetParticleTime(), G4ParticleGun::SetInitialValues(), and G4VPrimaryGenerator::SetParticleTime().

◆ ParticleProperties

G4Cache<part_prop_t> G4SingleParticleSource::ParticleProperties

private

Definition at line 149 of file G4SingleParticleSource.hh.

Referenced by GeneratePrimaryVertex(), GetParticleEnergy(), GetParticleMomentumDirection(), and GetParticlePosition().

◆ polarization

G4ThreeVector G4SingleParticleSource::polarization

private

Definition at line 154 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetParticlePolarization(), and SetParticlePolarization().

◆ posGenerator

G4SPSPosDistribution* G4SingleParticleSource::posGenerator = nullptr

private

Definition at line 133 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetPosDist(), SetVerbosity(), and ~G4SingleParticleSource().

◆ time

G4double G4SingleParticleSource::time

private

Definition at line 153 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), GetParticleTime(), and SetParticleTime().

◆ verbosityLevel

G4int G4SingleParticleSource::verbosityLevel

private

Definition at line 156 of file G4SingleParticleSource.hh.

Referenced by G4SingleParticleSource(), GeneratePrimaryVertex(), and SetVerbosity().

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

source/event/include/G4SingleParticleSource.hh
source/event/src/G4SingleParticleSource.cc

Data Structures

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4SingleParticleSource()

◆ ~G4SingleParticleSource()

Member Function Documentation

◆ CheckVertexInsideWorld()

◆ GeneratePrimaryVertex()

◆ GetAngDist()

◆ GetBiasRndm()

◆ GetEneDist()

◆ GetNumberOfParticles()

◆ GetParticleDefinition()

◆ GetParticleEnergy()

◆ GetParticleMomentumDirection()

◆ GetParticlePolarization()

◆ GetParticlePosition() [1/2]

◆ GetParticlePosition() [2/2]

◆ GetParticleTime() [1/2]

◆ GetParticleTime() [2/2]

◆ GetPosDist()

◆ SetNumberOfParticles()

◆ SetParticleCharge()

◆ SetParticleDefinition()

◆ SetParticlePolarization()

◆ SetParticlePosition()

◆ SetParticleTime()

◆ SetVerbosity()

Field Documentation

◆ angGenerator

◆ biasRndm

◆ charge

◆ definition

◆ eneGenerator

◆ mutex

◆ NumberOfParticlesToBeGenerated

◆ particle_position

◆ particle_time

◆ ParticleProperties

◆ polarization

◆ posGenerator

◆ time

◆ verbosityLevel