DMXParticleSource Class Reference

#include <DMXParticleSource.hh>

Inheritance diagram for DMXParticleSource:

Public Member Functions
	DMXParticleSource ()
	~DMXParticleSource ()
void	GeneratePrimaryVertex (G4Event *evt)
void	SetPosDisType (G4String)
void	SetPosDisShape (G4String)
void	SetCentreCoords (G4ThreeVector)
void	SetHalfZ (G4double)
void	SetRadius (G4double)
void	GeneratePointSource ()
void	GeneratePointsInVolume ()
G4bool	IsSourceConfined ()
void	ConfineSourceToVolume (G4String)
void	SetAngDistType (G4String)
void	SetParticleMomentumDirection (G4ParticleMomentum)
void	GenerateIsotropicFlux ()
void	SetEnergyDisType (G4String)
void	SetMonoEnergy (G4double)
void	GenerateMonoEnergetic ()
G4double	GetParticleEnergy ()
void	SetVerbosity (G4int)
void	SetParticleDefinition (G4ParticleDefinition *aParticleDefinition)
void	SetParticleCharge (G4double aCharge)
Public Member Functions inherited from G4VPrimaryGenerator
	G4VPrimaryGenerator ()
virtual	~G4VPrimaryGenerator ()
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

Detailed Description

Definition at line 58 of file DMXParticleSource.hh.

Constructor & Destructor Documentation

DMXParticleSource::DMXParticleSource

(

)

Definition at line 68 of file DMXParticleSource.cc.

References G4TransportationManager::GetNavigatorForTracking(), G4TransportationManager::GetTransportationManager(), python.hepunit::MeV, python.hepunit::pi, and python.hepunit::twopi.

                                     {

  NumberOfParticlesToBeGenerated = 1;
  particle_definition = NULL;
  G4ThreeVector zero(0., 0., 0.);
  particle_momentum_direction = G4ParticleMomentum(1., 0., 0.);
  particle_energy = 1.0*MeV;
  particle_position = zero;
  particle_time = 0.0;
  particle_polarization = zero;
  particle_charge = 0.0;

  SourcePosType = "Volume";
  Shape = "NULL";
  halfz = 0.;
  Radius = 0.;
  CentreCoords = zero;
  Confine = false;
  VolName = "NULL";

  AngDistType = "iso"; 
  MinTheta = 0.;
  MaxTheta = pi;
  MinPhi = 0.;
  MaxPhi = twopi;

  EnergyDisType = "Mono";
  MonoEnergy = 1*MeV;

  verbosityLevel = 0;

  theMessenger = new DMXParticleSourceMessenger(this);
  gNavigator = G4TransportationManager::GetTransportationManager()
    ->GetNavigatorForTracking();
}

DMXParticleSource::~DMXParticleSource

(

)

Definition at line 104 of file DMXParticleSource.cc.

{
  delete theMessenger;
}

Member Function Documentation

void DMXParticleSource::ConfineSourceToVolume

(

G4String

Vname

)

Definition at line 134 of file DMXParticleSource.cc.

References G4cout, G4endl, G4PhysicalVolumeStore::GetInstance(), and G4VPhysicalVolume::GetName().

{
  VolName = Vname;
  if(verbosityLevel == 2) G4cout << VolName << G4endl;

  // checks if selected volume exists
  G4VPhysicalVolume *tempPV      = NULL;
  G4PhysicalVolumeStore *PVStore = 0;
  G4String theRequiredVolumeName = VolName;
  PVStore = G4PhysicalVolumeStore::GetInstance();
  G4int i = 0;
  G4bool found = false;
  if(verbosityLevel == 2) G4cout << PVStore->size() << G4endl;

  // recasting required since PVStore->size() is actually a signed int...
  while (!found && i<(G4int)PVStore->size())
    {
      tempPV = (*PVStore)[i];
      found  = tempPV->GetName() == theRequiredVolumeName;
      if(verbosityLevel == 2)
    G4cout << i << " " << " " << tempPV->GetName() 
           << " " << theRequiredVolumeName << " " << found << G4endl;
      if (!found)
    {i++;}
    }

  // found = true then the volume exists else it doesnt.
  if(found == true) {
    if(verbosityLevel >= 1)
      G4cout << "Volume " << VolName << " exists" << G4endl;
    Confine = true;
  }
  else if(VolName=="NULL")
    Confine = false;
  else {
    G4cout << " **** Error: Volume does not exist **** " << G4endl;
    G4cout << " Ignoring confine condition" << G4endl;
    VolName = "NULL";
    Confine = false;
  }

}

void DMXParticleSource::GenerateIsotropicFlux

(

)

Definition at line 273 of file DMXParticleSource.cc.

References G4cout, G4endl, G4UniformRand, rndm(), CLHEP::Hep3Vector::setX(), CLHEP::Hep3Vector::setY(), and CLHEP::Hep3Vector::setZ().

Referenced by GeneratePrimaryVertex().

{

  G4double rndm, rndm2;
  G4double px, py, pz;

  G4double sintheta, sinphi, costheta, cosphi;
  rndm = G4UniformRand();
  costheta = std::cos(MinTheta) - rndm * (std::cos(MinTheta) - std::cos(MaxTheta));
  sintheta = std::sqrt(1. - costheta*costheta);
  
  rndm2 = G4UniformRand();
  Phi = MinPhi + (MaxPhi - MinPhi) * rndm2; 
  sinphi = std::sin(Phi);
  cosphi = std::cos(Phi);

  px = -sintheta * cosphi;
  py = -sintheta * sinphi;
  pz = -costheta;

  G4double ResMag = std::sqrt((px*px) + (py*py) + (pz*pz));
  px = px/ResMag;
  py = py/ResMag;
  pz = pz/ResMag;

  particle_momentum_direction.setX(px);
  particle_momentum_direction.setY(py);
  particle_momentum_direction.setZ(pz);

  // particle_momentum_direction now holds unit momentum vector.
  if(verbosityLevel >= 2)
    G4cout << "Generating isotropic vector: " << particle_momentum_direction << G4endl;
}

void DMXParticleSource::GenerateMonoEnergetic

(

)

Definition at line 318 of file DMXParticleSource.cc.

Referenced by GeneratePrimaryVertex().

{
  particle_energy = MonoEnergy;
}

void DMXParticleSource::GeneratePointsInVolume

(

)

Definition at line 195 of file DMXParticleSource.cc.

References G4cout, G4endl, G4UniformRand, CLHEP::Hep3Vector::setX(), CLHEP::Hep3Vector::setY(), CLHEP::Hep3Vector::setZ(), test::x, and z.

Referenced by GeneratePrimaryVertex().

{
  G4ThreeVector RandPos;
  G4double x=0., y=0., z=0.;
  
  if(SourcePosType != "Volume" && verbosityLevel >= 1)
    G4cout << "Error SourcePosType not Volume" << G4endl;
  
  if(Shape == "Sphere") {
    x = Radius*2.;
    y = Radius*2.;
    z = Radius*2.;
    while(((x*x)+(y*y)+(z*z)) > (Radius*Radius)) {
      x = G4UniformRand();
      y = G4UniformRand();
      z = G4UniformRand();
      
      x = (x*2.*Radius) - Radius;
      y = (y*2.*Radius) - Radius;
      z = (z*2.*Radius) - Radius;
    }
  }

  else if(Shape == "Cylinder") {
    x = Radius*2.;
    y = Radius*2.;
    while(((x*x)+(y*y)) > (Radius*Radius)) {
      x = G4UniformRand();
      y = G4UniformRand();
      z = G4UniformRand();
      x = (x*2.*Radius) - Radius;
      y = (y*2.*Radius) - Radius;
      z = (z*2.*halfz) - halfz;
    }
  }
  
  else
    G4cout << "Error: Volume Shape Does Not Exist" << G4endl;

  RandPos.setX(x);
  RandPos.setY(y);
  RandPos.setZ(z);
  particle_position = CentreCoords + RandPos;

}

void DMXParticleSource::GeneratePointSource

(

)

Definition at line 184 of file DMXParticleSource.cc.

References G4cout, and G4endl.

Referenced by GeneratePrimaryVertex().

{
  // Generates Points given the point source.
  if(SourcePosType == "Point")
    particle_position = CentreCoords;
  else
    if(verbosityLevel >= 1)
      G4cout << "Error SourcePosType is not set to Point" << G4endl;
}

void DMXParticleSource::GeneratePrimaryVertex ( G4Event *  evt )

virtual

Implements G4VPrimaryGenerator.

Definition at line 338 of file DMXParticleSource.cc.

References G4Event::AddPrimaryVertex(), energy(), G4cout, G4endl, GenerateIsotropicFlux(), GenerateMonoEnergetic(), GeneratePointsInVolume(), GeneratePointSource(), G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetPDGMass(), IsSourceConfined(), G4PrimaryParticle::SetCharge(), G4PrimaryParticle::SetMass(), SetParticleMomentumDirection(), G4PrimaryParticle::SetPolarization(), G4PrimaryVertex::SetPrimary(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by DMXPrimaryGeneratorAction::GeneratePrimaries().

{

  if(particle_definition==NULL) {
    G4cout << "No particle has been defined!" << G4endl;
    return;
  }
  
  // Position
  G4bool srcconf = false;
  G4int LoopCount = 0;
  
  while(srcconf == false)  {
    if(SourcePosType == "Point")
      GeneratePointSource();
    else if(SourcePosType == "Volume")
      GeneratePointsInVolume();
    else {
      G4cout << "Error: SourcePosType undefined" << G4endl;
      G4cout << "Generating point source" << G4endl;
      GeneratePointSource();
    }
    if(Confine == true) {
      srcconf = IsSourceConfined();
      // if source in confined srcconf = true terminating the loop
      // if source isnt confined srcconf = false and loop continues
    }
    else if(Confine == false)
      srcconf = true; // terminate loop
    
    LoopCount++;
    if(LoopCount == 100000) {
      G4cout << "*************************************" << G4endl;
        G4cout << "LoopCount = 100000" << G4endl;
        G4cout << "Either the source distribution >> confinement" << G4endl;
        G4cout << "or any confining volume may not overlap with" << G4endl;
        G4cout << "the source distribution or any confining volumes" << G4endl;
        G4cout << "may not exist"<< G4endl;
        G4cout << "If you have set confine then this will be ignored" <<G4endl;
        G4cout << "for this event." << G4endl;
        G4cout << "*************************************" << G4endl;
        srcconf = true; //Avoids an infinite loop
      }
  }

  // Angular stuff
  if(AngDistType == "iso")
    GenerateIsotropicFlux();
  else if(AngDistType == "direction")
    SetParticleMomentumDirection(particle_momentum_direction);
  else
    G4cout << "Error: AngDistType has unusual value" << G4endl;
  // Energy stuff
  if(EnergyDisType == "Mono")
    GenerateMonoEnergetic();
  else
    G4cout << "Error: EnergyDisType has unusual value" << G4endl;
  
  // create a new vertex
  G4PrimaryVertex* vertex = 
    new G4PrimaryVertex(particle_position,particle_time);

  if(verbosityLevel >= 2)
    G4cout << "Creating primaries and assigning to vertex" << G4endl;
  // create new primaries and set them to the vertex
  G4double mass =  particle_definition->GetPDGMass();
  G4double energy = particle_energy + mass;
  G4double pmom = std::sqrt(energy*energy-mass*mass);
  G4double px = pmom*particle_momentum_direction.x();
  G4double py = pmom*particle_momentum_direction.y();
  G4double pz = pmom*particle_momentum_direction.z();
  
  if(verbosityLevel >= 1){
    G4cout << "Particle name: " 
       << particle_definition->GetParticleName() << G4endl; 
    G4cout << "       Energy: "<<particle_energy << G4endl;
    G4cout << "     Position: "<<particle_position<< G4endl; 
    G4cout << "    Direction: "<<particle_momentum_direction << G4endl;
    G4cout << " NumberOfParticlesToBeGenerated: "
       << NumberOfParticlesToBeGenerated << G4endl;
  }


  for( G4int i=0; i<NumberOfParticlesToBeGenerated; i++ ) {
    G4PrimaryParticle* particle =
      new G4PrimaryParticle(particle_definition,px,py,pz);
    particle->SetMass( mass );
    particle->SetCharge( particle_charge );
    particle->SetPolarization(particle_polarization.x(),
                  particle_polarization.y(),
                  particle_polarization.z());
    vertex->SetPrimary( particle );
  }
  evt->AddPrimaryVertex( vertex );
  if(verbosityLevel > 1)
    G4cout << " Primary Vetex generated "<< G4endl;   
}

G4double DMXParticleSource::GetParticleEnergy ( )

inline

Definition at line 87 of file DMXParticleSource.hh.

Referenced by DMXPrimaryGeneratorAction::GeneratePrimaries().

{return particle_energy;}

G4bool DMXParticleSource::IsSourceConfined

(

)

Definition at line 242 of file DMXParticleSource.cc.

References G4cout, G4endl, G4VPhysicalVolume::GetName(), and G4Navigator::LocateGlobalPointAndSetup().

Referenced by GeneratePrimaryVertex().

{

  // Method to check point is within the volume specified
  if(Confine == false)
    G4cout << "Error: Confine is false" << G4endl;
  G4ThreeVector null(0.,0.,0.);
  G4ThreeVector *ptr;
  ptr = &null;

  // Check particle_position is within VolName
  G4VPhysicalVolume *theVolume;
  theVolume=gNavigator->LocateGlobalPointAndSetup(particle_position,ptr,true);
  G4String theVolName = theVolume->GetName();
  if(theVolName == VolName) {
    if(verbosityLevel >= 1)
      G4cout << "Particle is in volume " << VolName << G4endl;
    return(true);
  }
  else
    return(false);
}

void DMXParticleSource::SetAngDistType

(

G4String

atype

)

Definition at line 178 of file DMXParticleSource.cc.

{
  AngDistType = atype;
}

void DMXParticleSource::SetCentreCoords

(

G4ThreeVector

coordsOfCentre

)

Definition at line 119 of file DMXParticleSource.cc.

{
  CentreCoords = coordsOfCentre;
}

void DMXParticleSource::SetEnergyDisType

(

G4String

DisType

)

Definition at line 308 of file DMXParticleSource.cc.

{
  EnergyDisType = DisType;
}

void DMXParticleSource::SetHalfZ

(

G4double

zhalf

)

Definition at line 124 of file DMXParticleSource.cc.

{
  halfz = zhalf;
}

void DMXParticleSource::SetMonoEnergy

(

G4double

menergy

)

Definition at line 313 of file DMXParticleSource.cc.

{
  MonoEnergy = menergy;
}

void DMXParticleSource::SetParticleCharge ( G4double  aCharge )

inline

Definition at line 94 of file DMXParticleSource.hh.

        { particle_charge = aCharge; }

void DMXParticleSource::SetParticleDefinition

(

G4ParticleDefinition *

aParticleDefinition

)

Definition at line 331 of file DMXParticleSource.cc.

References G4ParticleDefinition::GetPDGCharge().

{
  particle_definition = aParticleDefinition;
  particle_charge = particle_definition->GetPDGCharge();
}

void DMXParticleSource::SetParticleMomentumDirection

(

G4ParticleMomentum

aDirection

)

Definition at line 267 of file DMXParticleSource.cc.

References CLHEP::Hep3Vector::unit().

Referenced by GeneratePrimaryVertex().

                                   {

  particle_momentum_direction =  aDirection.unit();
}

void DMXParticleSource::SetPosDisShape

(

G4String

shapeType

)

Definition at line 114 of file DMXParticleSource.cc.

{
  Shape = shapeType;
}

void DMXParticleSource::SetPosDisType

(

G4String

PosType

)

Definition at line 109 of file DMXParticleSource.cc.

{
  SourcePosType = PosType;
}

void DMXParticleSource::SetRadius

(

G4double

radius

)

Definition at line 129 of file DMXParticleSource.cc.

{
  Radius = radius;
}

void DMXParticleSource::SetVerbosity

(

G4int

vL

)

Definition at line 324 of file DMXParticleSource.cc.

References G4cout, and G4endl.

{
  verbosityLevel = vL;
  G4cout << "Verbosity Set to: " << verbosityLevel << G4endl;
}

---

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

• DMXParticleSource.hh
• DMXParticleSource.cc