G4ParticleGunMessenger Class Reference

#include <G4ParticleGunMessenger.hh>

Inheritance diagram for G4ParticleGunMessenger:

Collaboration diagram for G4ParticleGunMessenger:

Public Member Functions
	G4ParticleGunMessenger (G4ParticleGun *fPtclGun)
	~G4ParticleGunMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValues)
G4String	GetCurrentValue (G4UIcommand *command)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Member Functions
void	IonCommand (G4String newValues)
void	IonLevelCommand (G4String newValues)

Private Attributes
G4ParticleGun *	fParticleGun
G4ParticleTable *	particleTable
G4UIdirectory *	gunDirectory
G4UIcmdWithoutParameter *	listCmd
G4UIcmdWithAString *	particleCmd
G4UIcmdWith3Vector *	directionCmd
G4UIcmdWithADoubleAndUnit *	energyCmd
G4UIcmdWithADoubleAndUnit *	momAmpCmd
G4UIcmdWith3VectorAndUnit *	momCmd
G4UIcmdWith3VectorAndUnit *	positionCmd
G4UIcmdWithADoubleAndUnit *	timeCmd
G4UIcmdWith3Vector *	polCmd
G4UIcmdWithAnInteger *	numberCmd
G4UIcommand *	ionCmd
G4UIcommand *	ionLvlCmd
G4bool	fShootIon
G4int	fAtomicNumber
G4int	fAtomicMass
G4int	fIonCharge
G4double	fIonExciteEnergy
G4int	fIonEnergyLevel

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (G4String s)
G4bool	StoB (G4String s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 54 of file G4ParticleGunMessenger.hh.

Constructor & Destructor Documentation

G4ParticleGunMessenger()

G4ParticleGunMessenger::G4ParticleGunMessenger

(

G4ParticleGun *

fPtclGun

)

Definition at line 47 of file G4ParticleGunMessenger.cc.

  :fParticleGun(fPtclGun),fShootIon(false),
   fAtomicNumber(0),fAtomicMass(0),fIonCharge(0),fIonExciteEnergy(0.0),fIonEnergyLevel(0)
{
  particleTable = G4ParticleTable::GetParticleTable();

  gunDirectory = new G4UIdirectory("/gun/");
  gunDirectory->SetGuidance("Particle Gun control commands.");

  listCmd = new G4UIcmdWithoutParameter("/gun/List",this);
  listCmd->SetGuidance("List available particles.");
  listCmd->SetGuidance(" Invoke G4ParticleTable.");

  particleCmd = new G4UIcmdWithAString("/gun/particle",this);
  particleCmd->SetGuidance("Set particle to be generated.");
  particleCmd->SetGuidance(" (geantino is default)");
  particleCmd->SetGuidance(" (ion can be specified for shooting ions)");
  particleCmd->SetParameterName("particleName",true);
  particleCmd->SetDefaultValue("geantino");
  G4String candidateList; 
  G4ParticleTable::G4PTblDicIterator* itr = particleTable->GetIterator();
  itr->reset();
  while( (*itr)() )
  {
    G4ParticleDefinition* pd = itr->value();
    if( !(pd->IsShortLived()) || pd->GetDecayTable() )
    {
      candidateList += pd->GetParticleName();
      candidateList += " ";
    }
  }
  candidateList += "ion ";
  particleCmd->SetCandidates(candidateList);

  directionCmd = new G4UIcmdWith3Vector("/gun/direction",this);
  directionCmd->SetGuidance("Set momentum direction.");
  directionCmd->SetGuidance("Direction needs not to be a unit vector.");
  directionCmd->SetParameterName("ex","ey","ez",true,true); 
  directionCmd->SetRange("ex != 0 || ey != 0 || ez != 0");
  
  energyCmd = new G4UIcmdWithADoubleAndUnit("/gun/energy",this);
  energyCmd->SetGuidance("Set kinetic energy.");
  energyCmd->SetParameterName("Energy",true,true);
  energyCmd->SetDefaultUnit("GeV");
  //energyCmd->SetUnitCategory("Energy");
  //energyCmd->SetUnitCandidates("eV keV MeV GeV TeV");

  momCmd = new G4UIcmdWith3VectorAndUnit("/gun/momentum",this);
  momCmd->SetGuidance("Set momentum. This command is equivalent to two commands /gun/direction and /gun/momentumAmp");
  momCmd->SetParameterName("px","py","pz",true,true); 
  momCmd->SetRange("px != 0 || py != 0 || pz != 0");
  momCmd->SetDefaultUnit("GeV");

  momAmpCmd = new G4UIcmdWithADoubleAndUnit("/gun/momentumAmp",this);
  momAmpCmd->SetGuidance("Set absolute value of momentum.");
  momAmpCmd->SetGuidance("Direction should be set by /gun/direction command.");
  momAmpCmd->SetGuidance("This command should be used alternatively with /gun/energy.");
  momAmpCmd->SetParameterName("Momentum",true,true);
  momAmpCmd->SetDefaultUnit("GeV");

  positionCmd = new G4UIcmdWith3VectorAndUnit("/gun/position",this);
  positionCmd->SetGuidance("Set starting position of the particle.");
  positionCmd->SetParameterName("X","Y","Z",true,true);
  positionCmd->SetDefaultUnit("cm");
  //positionCmd->SetUnitCategory("Length");
  //positionCmd->SetUnitCandidates("microm mm cm m km");

  timeCmd = new G4UIcmdWithADoubleAndUnit("/gun/time",this);
  timeCmd->SetGuidance("Set initial time of the particle.");
  timeCmd->SetParameterName("t0",true,true);
  timeCmd->SetDefaultUnit("ns");
  //timeCmd->SetUnitCategory("Time");
  //timeCmd->SetUnitCandidates("ns ms s");
  
  polCmd = new G4UIcmdWith3Vector("/gun/polarization",this);
  polCmd->SetGuidance("Set polarization.");
  polCmd->SetParameterName("Px","Py","Pz",true,true); 
  polCmd->SetRange("Px>=-1.&&Px<=1.&&Py>=-1.&&Py<=1.&&Pz>=-1.&&Pz<=1.");

  numberCmd = new G4UIcmdWithAnInteger("/gun/number",this);
  numberCmd->SetGuidance("Set number of particles to be generated.");
  numberCmd->SetParameterName("N",true,true);
  numberCmd->SetRange("N>0");

  ionCmd = new G4UIcommand("/gun/ion",this);
  ionCmd->SetGuidance("Set properties of ion to be generated.");
  ionCmd->SetGuidance("[usage] /gun/ion Z A Q");
  ionCmd->SetGuidance("        Z:(int) AtomicNumber");
  ionCmd->SetGuidance("        A:(int) AtomicMass");
  ionCmd->SetGuidance("        Q:(int) Charge of Ion (in unit of e)");
  ionCmd->SetGuidance("        E:(double) Excitation energy (in keV)");
  
  G4UIparameter* param;
  param = new G4UIparameter("Z",'i',false);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("A",'i',false);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("Q",'i',true);
  param->SetDefaultValue(-1);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("E",'d',true);
  param->SetDefaultValue(0.0);
  ionCmd->SetParameter(param);

  ionLvlCmd = new G4UIcommand("/gun/ionL",this);
  ionLvlCmd->SetGuidance("Set properties of ion to be generated.");
  ionLvlCmd->SetGuidance("[usage] /gun/ion Z A Q I");
  ionLvlCmd->SetGuidance("        Z:(int) AtomicNumber");
  ionLvlCmd->SetGuidance("        A:(int) AtomicMass");
  ionLvlCmd->SetGuidance("        Q:(int) Charge of Ion (in unit of e)");
  ionLvlCmd->SetGuidance("        I:(int) Level number of metastable state (0 = ground)");

  G4UIparameter* paraml;
  paraml = new G4UIparameter("Z",'i',false);
  ionLvlCmd->SetParameter(paraml);
  paraml = new G4UIparameter("A",'i',false);
  ionLvlCmd->SetParameter(paraml);
  paraml = new G4UIparameter("Q",'i',true);
  paraml->SetDefaultValue(-1);
  ionLvlCmd->SetParameter(paraml);
  paraml = new G4UIparameter("I",'i',true);
  paraml->SetDefaultValue("0");
  ionLvlCmd->SetParameter(paraml);

  // set initial value to G4ParticleGun
  fParticleGun->SetParticleDefinition( G4Geantino::Geantino() );
  fParticleGun->SetParticleMomentumDirection( G4ThreeVector(1.0,0.0,0.0) );
  fParticleGun->SetParticleEnergy( 1.0*GeV );
  fParticleGun->SetParticlePosition(G4ThreeVector(0.0*cm, 0.0*cm, 0.0*cm));
  fParticleGun->SetParticleTime( 0.0*ns );
}

Here is the call graph for this function:

~G4ParticleGunMessenger()

G4ParticleGunMessenger::~G4ParticleGunMessenger

(

)

Definition at line 179 of file G4ParticleGunMessenger.cc.

{
  delete listCmd;
  delete particleCmd;
  delete directionCmd;
  delete energyCmd;
  delete momCmd;
  delete momAmpCmd;
  delete positionCmd;
  delete timeCmd;
  delete polCmd;
  delete numberCmd;
  delete ionCmd;
  delete ionLvlCmd;
  delete gunDirectory;
}

Member Function Documentation

GetCurrentValue()

G4String G4ParticleGunMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 232 of file G4ParticleGunMessenger.cc.

{
  G4String cv;
  
  if( command==directionCmd )
  { cv = directionCmd->ConvertToString(fParticleGun->GetParticleMomentumDirection()); }
  else if( command==particleCmd )
  { cv = fParticleGun->GetParticleDefinition()->GetParticleName(); }
  else if( command==energyCmd )
  {
    G4double ene = fParticleGun->GetParticleEnergy();
    if(ene == 0.)
    { G4cerr << " G4ParticleGun:  was defined in terms of momentum." << G4endl; }
    else
    { cv = energyCmd->ConvertToString(ene,"GeV"); }
  }
  else if( command==momCmd || command==momAmpCmd )
  {
    G4double mom = fParticleGun->GetParticleMomentum();
    if(mom == 0.)
    { G4cerr << " G4ParticleGun:  was defined in terms of kinetic energy." << G4endl; }
    else
    {
      if( command==momCmd )
      { cv = momCmd->ConvertToString(mom*(fParticleGun->GetParticleMomentumDirection()),"GeV"); }
      else
      { cv = momAmpCmd->ConvertToString(mom,"GeV"); }
    }
  }
  else if( command==positionCmd )
  { cv = positionCmd->ConvertToString(fParticleGun->GetParticlePosition(),"cm"); }
  else if( command==timeCmd )
  { cv = timeCmd->ConvertToString(fParticleGun->GetParticleTime(),"ns"); }
  else if( command==polCmd )
  { cv = polCmd->ConvertToString(fParticleGun->GetParticlePolarization()); }
  else if( command==numberCmd )
  { cv = numberCmd->ConvertToString(fParticleGun->GetNumberOfParticles()); }
  else if( command==ionCmd )
  { 
    if (fShootIon) {
      cv = ItoS(fAtomicNumber) + " " + ItoS(fAtomicMass) + " ";
      cv += ItoS(fIonCharge);
    } else {
      cv = "";
    }  
  }    
  return cv;
}

Here is the call graph for this function:

IonCommand()

void G4ParticleGunMessenger::IonCommand ( G4String  newValues )

private

Definition at line 317 of file G4ParticleGunMessenger.cc.

{
  if (fShootIon) {
    G4Tokenizer next( newValues );
    // check argument
    fAtomicNumber = StoI(next());
    fAtomicMass = StoI(next());
    G4String sQ = next();
    if (sQ.isNull() || StoI(sQ)<0) {
      fIonCharge = fAtomicNumber;
    } else {
    fIonCharge = StoI(sQ);
      sQ = next();
      if (sQ.isNull()) {
        fIonExciteEnergy = 0.0;
      } else {
        fIonExciteEnergy = StoD(sQ) * keV;
      }
    }
    G4ParticleDefinition* ion = 0;
    ion =  G4IonTable::GetIonTable()->GetIon( fAtomicNumber, fAtomicMass, fIonExciteEnergy);
    if (ion==0) {
    G4cout << "Ion with Z=" << fAtomicNumber;
    G4cout << " A=" << fAtomicMass << "is not defined" << G4endl;    
    } else {
      fParticleGun->SetParticleDefinition(ion);
      fParticleGun->SetParticleCharge(fIonCharge*eplus);
    }
  } else {
    G4cout << "Set /gun/particle to ion before using /gun/ion command";
    G4cout << G4endl; 
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

IonLevelCommand()

void G4ParticleGunMessenger::IonLevelCommand ( G4String  newValues )

private

Definition at line 283 of file G4ParticleGunMessenger.cc.

{
  if (fShootIon) {
    G4Tokenizer next( newValues );
    // check argument
    fAtomicNumber = StoI(next());
    fAtomicMass = StoI(next());
    G4String sQ = next();
    if (sQ.isNull() || StoI(sQ)<0) {
      fIonCharge = fAtomicNumber;
    } else {
      fIonCharge = StoI(sQ);
    }
    sQ = next();
    if (sQ.isNull()) {
      fIonEnergyLevel = 0;
    } else {
      fIonEnergyLevel = StoI(sQ);
    }
    G4ParticleDefinition* ion = 0;
    ion =  G4IonTable::GetIonTable()->GetIon(fAtomicNumber,fAtomicMass,fIonEnergyLevel);
    if (ion == 0) {
      G4cout << "Ion with Z = " << fAtomicNumber << ", A = " << fAtomicMass
             << ", I = " << fIonEnergyLevel << " is not defined " << G4endl;
    } else {
      fParticleGun->SetParticleDefinition(ion);
      fParticleGun->SetParticleCharge(fIonCharge*eplus);
    }
  } else {
    G4cout << "Set /gun/particle to ion before using /gun/ion command";
    G4cout << G4endl;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetNewValue()

void G4ParticleGunMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValues  )

virtual

Reimplemented from G4UImessenger.

Definition at line 196 of file G4ParticleGunMessenger.cc.

{
  if (command==listCmd) {
    particleTable->DumpTable();
  } else if (command==particleCmd) {
    if (newValues =="ion") {
      fShootIon = true;
    } else {
      fShootIon = false;
      G4ParticleDefinition* pd = particleTable->FindParticle(newValues);
      if(pd != 0)
      { fParticleGun->SetParticleDefinition( pd ); }
    }

  } else if( command==directionCmd )
  { fParticleGun->SetParticleMomentumDirection(directionCmd->GetNew3VectorValue(newValues)); }
  else if( command==energyCmd )
  { fParticleGun->SetParticleEnergy(energyCmd->GetNewDoubleValue(newValues)); }
  else if( command==momCmd )
  { fParticleGun->SetParticleMomentum(momCmd->GetNew3VectorValue(newValues)); }
  else if( command==momAmpCmd )
  { fParticleGun->SetParticleMomentum(momAmpCmd->GetNewDoubleValue(newValues)); }
  else if( command==positionCmd )
  { fParticleGun->SetParticlePosition(positionCmd->GetNew3VectorValue(newValues)); }
  else if( command==timeCmd )
  { fParticleGun->SetParticleTime(timeCmd->GetNewDoubleValue(newValues)); }
  else if( command==polCmd )
  { fParticleGun->SetParticlePolarization(polCmd->GetNew3VectorValue(newValues)); }
  else if( command==numberCmd )
  { fParticleGun->SetNumberOfParticles(numberCmd->GetNewIntValue(newValues)); }
  else if( command==ionCmd ) 
  { IonCommand(newValues); }
  else if( command==ionLvlCmd ) 
  { IonLevelCommand(newValues); }
}

Here is the call graph for this function:

Member Data Documentation

directionCmd

G4UIcmdWith3Vector* G4ParticleGunMessenger::directionCmd

private

Definition at line 76 of file G4ParticleGunMessenger.hh.

energyCmd

G4UIcmdWithADoubleAndUnit* G4ParticleGunMessenger::energyCmd

private

Definition at line 77 of file G4ParticleGunMessenger.hh.

fAtomicMass

G4int G4ParticleGunMessenger::fAtomicMass

private

Definition at line 91 of file G4ParticleGunMessenger.hh.

fAtomicNumber

G4int G4ParticleGunMessenger::fAtomicNumber

private

Definition at line 90 of file G4ParticleGunMessenger.hh.

fIonCharge

G4int G4ParticleGunMessenger::fIonCharge

private

Definition at line 92 of file G4ParticleGunMessenger.hh.

fIonEnergyLevel

G4int G4ParticleGunMessenger::fIonEnergyLevel

private

Definition at line 94 of file G4ParticleGunMessenger.hh.

fIonExciteEnergy

G4double G4ParticleGunMessenger::fIonExciteEnergy

private

Definition at line 93 of file G4ParticleGunMessenger.hh.

fParticleGun

G4ParticleGun* G4ParticleGunMessenger::fParticleGun

private

Definition at line 69 of file G4ParticleGunMessenger.hh.

fShootIon

G4bool G4ParticleGunMessenger::fShootIon

private

Definition at line 89 of file G4ParticleGunMessenger.hh.

gunDirectory

G4UIdirectory* G4ParticleGunMessenger::gunDirectory

private

Definition at line 73 of file G4ParticleGunMessenger.hh.

ionCmd

G4UIcommand* G4ParticleGunMessenger::ionCmd

private

Definition at line 85 of file G4ParticleGunMessenger.hh.

ionLvlCmd

G4UIcommand* G4ParticleGunMessenger::ionLvlCmd

private

Definition at line 86 of file G4ParticleGunMessenger.hh.

listCmd

G4UIcmdWithoutParameter* G4ParticleGunMessenger::listCmd

private

Definition at line 74 of file G4ParticleGunMessenger.hh.

momAmpCmd

G4UIcmdWithADoubleAndUnit* G4ParticleGunMessenger::momAmpCmd

private

Definition at line 78 of file G4ParticleGunMessenger.hh.

momCmd

G4UIcmdWith3VectorAndUnit* G4ParticleGunMessenger::momCmd

private

Definition at line 79 of file G4ParticleGunMessenger.hh.

numberCmd

G4UIcmdWithAnInteger* G4ParticleGunMessenger::numberCmd

private

Definition at line 83 of file G4ParticleGunMessenger.hh.

particleCmd

G4UIcmdWithAString* G4ParticleGunMessenger::particleCmd

private

Definition at line 75 of file G4ParticleGunMessenger.hh.

particleTable

G4ParticleTable* G4ParticleGunMessenger::particleTable

private

Definition at line 70 of file G4ParticleGunMessenger.hh.

polCmd

G4UIcmdWith3Vector* G4ParticleGunMessenger::polCmd

private

Definition at line 82 of file G4ParticleGunMessenger.hh.

positionCmd

G4UIcmdWith3VectorAndUnit* G4ParticleGunMessenger::positionCmd

private

Definition at line 80 of file G4ParticleGunMessenger.hh.

timeCmd

G4UIcmdWithADoubleAndUnit* G4ParticleGunMessenger::timeCmd

private

Definition at line 81 of file G4ParticleGunMessenger.hh.

---

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

• G4ParticleGunMessenger.hh
• G4ParticleGunMessenger.cc