DMXParticleSourceMessenger Class Reference

#include <DMXParticleSourceMessenger.hh>

Inheritance diagram for DMXParticleSourceMessenger:

Collaboration diagram for DMXParticleSourceMessenger:

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

Private Attributes
DMXParticleSource *	fParticleGun
G4ParticleTable *	particleTable
G4UIdirectory *	gunDirectory
G4UIcmdWithAString *	typeCmd
G4UIcmdWithAString *	shapeCmd
G4UIcmdWith3VectorAndUnit *	centreCmd
G4UIcmdWithADoubleAndUnit *	halfzCmd
G4UIcmdWithADoubleAndUnit *	radiusCmd
G4UIcmdWithAString *	confineCmd
G4UIcmdWithAString *	angtypeCmd
G4UIcmdWithAString *	energytypeCmd
G4UIcmdWithAnInteger *	verbosityCmd
G4UIcommand *	ionCmd
G4UIcmdWithAString *	particleCmd
G4UIcmdWith3VectorAndUnit *	positionCmd
G4UIcmdWith3Vector *	directionCmd
G4UIcmdWithADoubleAndUnit *	energyCmd
G4UIcmdWithoutParameter *	listCmd
G4bool	fShootIon
G4int	fAtomicNumber
G4int	fAtomicMass
G4int	fIonCharge
G4double	fIonExciteEnergy

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 69 of file DMXParticleSourceMessenger.hh.

Constructor & Destructor Documentation

DMXParticleSourceMessenger()

DMXParticleSourceMessenger::DMXParticleSourceMessenger

(

DMXParticleSource *

fPtclGun

)

Definition at line 72 of file DMXParticleSourceMessenger.cc.

                              : fParticleGun(fPtclGun),fShootIon(false) {

  particleTable = G4ParticleTable::GetParticleTable();

  // create directory
  gunDirectory = new G4UIdirectory("/dmx/gun/");
  gunDirectory->SetGuidance("Particle Source control commands.");

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

  // set particle  
  particleCmd = new G4UIcmdWithAString("/dmx/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; 
  G4int nPtcl = particleTable->entries();
  for(G4int i=0;i<nPtcl;i++)
    {
      candidateList += particleTable->GetParticleName(i);
      candidateList += " ";
    }
  candidateList += "ion ";
  particleCmd->SetCandidates(candidateList);
  

  // particle direction
  directionCmd = new G4UIcmdWith3Vector("/dmx/gun/direction",this);
  directionCmd->SetGuidance("Set momentum direction.");
  directionCmd->SetGuidance("Direction needs not to be a unit vector.");
  directionCmd->SetParameterName("Px","Py","Pz",true,true); 
  directionCmd->SetRange("Px != 0 || Py != 0 || Pz != 0");
  
  // particle energy
  energyCmd = new G4UIcmdWithADoubleAndUnit("/dmx/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");

  positionCmd = new G4UIcmdWith3VectorAndUnit("/dmx/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");

 
  // ion 
  ionCmd = new G4UIcommand("/dmx/gun/ion",this);
  ionCmd->SetGuidance("Set properties of ion to be generated.");
  ionCmd->SetGuidance("[usage] /gun/ion Z A Q E");
  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);
  param->SetDefaultValue("1");
  ionCmd->SetParameter(param);
  param = new G4UIparameter("A",'i',false);
  param->SetDefaultValue("1");
  ionCmd->SetParameter(param);
  param = new G4UIparameter("Q",'i',true);
  param->SetDefaultValue("0");
  ionCmd->SetParameter(param);
  param = new G4UIparameter("E",'d',true);
  param->SetDefaultValue("0.0");
  ionCmd->SetParameter(param);
  

  // source distribution type
  typeCmd = new G4UIcmdWithAString("/dmx/gun/type",this);
  typeCmd->SetGuidance("Sets source distribution type.");
  typeCmd->SetGuidance("Either Point or Volume");
  typeCmd->SetParameterName("DisType",true,true);
  typeCmd->SetDefaultValue("Point");
  typeCmd->SetCandidates("Point Volume");
  
  // source shape
  shapeCmd = new G4UIcmdWithAString("/dmx/gun/shape",this);
  shapeCmd->SetGuidance("Sets source shape type.");
  shapeCmd->SetParameterName("Shape",true,true);
  shapeCmd->SetDefaultValue("NULL");
  shapeCmd->SetCandidates("Sphere Cylinder");
  
  // centre coordinates
  centreCmd = new G4UIcmdWith3VectorAndUnit("/dmx/gun/centre",this);
  centreCmd->SetGuidance("Set centre coordinates of source.");
  centreCmd->SetParameterName("X","Y","Z",true,true);
  centreCmd->SetDefaultUnit("cm");
  centreCmd->SetUnitCandidates("nm um mm cm m km");

  // half height of source
  halfzCmd = new G4UIcmdWithADoubleAndUnit("/dmx/gun/halfz",this);
  halfzCmd->SetGuidance("Set z half length of source.");
  halfzCmd->SetParameterName("Halfz",true,true);
  halfzCmd->SetDefaultUnit("cm");
  halfzCmd->SetUnitCandidates("nm um mm cm m km");

  // radius of source  
  radiusCmd = new G4UIcmdWithADoubleAndUnit("/dmx/gun/radius",this);
  radiusCmd->SetGuidance("Set radius of source.");
  radiusCmd->SetParameterName("Radius",true,true);
  radiusCmd->SetDefaultUnit("cm");
  radiusCmd->SetUnitCandidates("nm um mm cm m km");
  
  // confine to volume
  confineCmd = new G4UIcmdWithAString("/dmx/gun/confine",this);
  confineCmd->SetGuidance("Confine source to volume (NULL to unset).");
  confineCmd->SetGuidance("usage: confine VolName");
  confineCmd->SetParameterName("VolName",true,true);
  confineCmd->SetDefaultValue("NULL");
  
  // angular distribution
  angtypeCmd = new G4UIcmdWithAString("/dmx/gun/angtype",this);
  angtypeCmd->SetGuidance("Sets angular source distribution type");
  angtypeCmd->SetGuidance("Possible variables are: iso direction");
  angtypeCmd->SetParameterName("AngDis",true,true);
  angtypeCmd->SetDefaultValue("iso");
  angtypeCmd->SetCandidates("iso direction");
  
  // energy distribution
  energytypeCmd = new G4UIcmdWithAString("/dmx/gun/energytype",this);
  energytypeCmd->SetGuidance("Sets energy distribution type");
  energytypeCmd->SetGuidance("Possible variables are: Mono");
  energytypeCmd->SetParameterName("EnergyDis",true,true);
  energytypeCmd->SetDefaultValue("Mono");
  energytypeCmd->SetCandidates("Mono");

  // verbosity
  verbosityCmd = new G4UIcmdWithAnInteger("/dmx/gun/verbose",this);
  verbosityCmd->SetGuidance("Set Verbose level for gun");
  verbosityCmd->SetGuidance(" 0 : Silent");
  verbosityCmd->SetGuidance(" 1 : Limited information");
  verbosityCmd->SetGuidance(" 2 : Detailed information");
  verbosityCmd->SetParameterName("level",false);
  verbosityCmd->SetRange("level>=0 && level <=2");
  
}

Here is the call graph for this function:

~DMXParticleSourceMessenger()

DMXParticleSourceMessenger::~DMXParticleSourceMessenger

(

)

Definition at line 221 of file DMXParticleSourceMessenger.cc.

                                                        {

  delete typeCmd;
  delete shapeCmd;
  delete centreCmd;
  delete halfzCmd;
  delete radiusCmd;
  delete confineCmd;
  delete angtypeCmd;
  delete energytypeCmd;
  delete verbosityCmd;
  delete ionCmd;
  delete particleCmd;
  delete positionCmd;
  delete directionCmd;
  delete energyCmd;
  delete listCmd;

  delete gunDirectory;
}

Here is the call graph for this function:

Member Function Documentation

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 243 of file DMXParticleSourceMessenger.cc.

                                              {

  if(command == typeCmd)
    fParticleGun->SetPosDisType(newValues);

  else if(command == shapeCmd)
    fParticleGun->SetPosDisShape(newValues);

  else if(command == centreCmd)
    fParticleGun->SetCentreCoords(centreCmd->GetNew3VectorValue(newValues));

  else if(command == halfzCmd)
    fParticleGun->SetHalfZ(halfzCmd->GetNewDoubleValue(newValues));

  else if(command == radiusCmd)
    fParticleGun->SetRadius(radiusCmd->GetNewDoubleValue(newValues));

  else if(command == angtypeCmd)
      fParticleGun->SetAngDistType(newValues);

  else if(command == confineCmd)
    fParticleGun->ConfineSourceToVolume(newValues);

  else if(command == energytypeCmd)
    fParticleGun->SetEnergyDisType(newValues);
  
  else if(command == verbosityCmd)
    fParticleGun->SetVerbosity(verbosityCmd->GetNewIntValue(newValues));

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

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

  else if( command==listCmd )
    particleTable->DumpTable();

  else if( command==directionCmd ) { 
    fParticleGun->SetAngDistType("direction");
    fParticleGun->SetParticleMomentumDirection
      (directionCmd->GetNew3VectorValue(newValues));
  }

  else if( command==energyCmd ) {
    fParticleGun->SetEnergyDisType("Mono");
    fParticleGun->SetMonoEnergy(energyCmd->GetNewDoubleValue(newValues));
  }  

  else if( command==positionCmd ) { 
    fParticleGun->SetPosDisType("Point");    
    fParticleGun->SetCentreCoords(positionCmd->GetNew3VectorValue(newValues));
  }
  else
    G4cout << "Error entering command" << G4endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

angtypeCmd

G4UIcmdWithAString* DMXParticleSourceMessenger::angtypeCmd

private

Definition at line 91 of file DMXParticleSourceMessenger.hh.

centreCmd

G4UIcmdWith3VectorAndUnit* DMXParticleSourceMessenger::centreCmd

private

Definition at line 87 of file DMXParticleSourceMessenger.hh.

confineCmd

G4UIcmdWithAString* DMXParticleSourceMessenger::confineCmd

private

Definition at line 90 of file DMXParticleSourceMessenger.hh.

directionCmd

G4UIcmdWith3Vector* DMXParticleSourceMessenger::directionCmd

private

Definition at line 97 of file DMXParticleSourceMessenger.hh.

energyCmd

G4UIcmdWithADoubleAndUnit* DMXParticleSourceMessenger::energyCmd

private

Definition at line 98 of file DMXParticleSourceMessenger.hh.

energytypeCmd

G4UIcmdWithAString* DMXParticleSourceMessenger::energytypeCmd

private

Definition at line 92 of file DMXParticleSourceMessenger.hh.

fAtomicMass

G4int DMXParticleSourceMessenger::fAtomicMass

private

Definition at line 105 of file DMXParticleSourceMessenger.hh.

fAtomicNumber

G4int DMXParticleSourceMessenger::fAtomicNumber

private

Definition at line 104 of file DMXParticleSourceMessenger.hh.

fIonCharge

G4int DMXParticleSourceMessenger::fIonCharge

private

Definition at line 106 of file DMXParticleSourceMessenger.hh.

fIonExciteEnergy

G4double DMXParticleSourceMessenger::fIonExciteEnergy

private

Definition at line 107 of file DMXParticleSourceMessenger.hh.

fParticleGun

DMXParticleSource* DMXParticleSourceMessenger::fParticleGun

private

Definition at line 79 of file DMXParticleSourceMessenger.hh.

fShootIon

G4bool DMXParticleSourceMessenger::fShootIon

private

Definition at line 103 of file DMXParticleSourceMessenger.hh.

gunDirectory

G4UIdirectory* DMXParticleSourceMessenger::gunDirectory

private

Definition at line 83 of file DMXParticleSourceMessenger.hh.

halfzCmd

G4UIcmdWithADoubleAndUnit* DMXParticleSourceMessenger::halfzCmd

private

Definition at line 88 of file DMXParticleSourceMessenger.hh.

ionCmd

G4UIcommand* DMXParticleSourceMessenger::ionCmd

private

Definition at line 94 of file DMXParticleSourceMessenger.hh.

listCmd

G4UIcmdWithoutParameter* DMXParticleSourceMessenger::listCmd

private

Definition at line 99 of file DMXParticleSourceMessenger.hh.

particleCmd

G4UIcmdWithAString* DMXParticleSourceMessenger::particleCmd

private

Definition at line 95 of file DMXParticleSourceMessenger.hh.

particleTable

G4ParticleTable* DMXParticleSourceMessenger::particleTable

private

Definition at line 80 of file DMXParticleSourceMessenger.hh.

positionCmd

G4UIcmdWith3VectorAndUnit* DMXParticleSourceMessenger::positionCmd

private

Definition at line 96 of file DMXParticleSourceMessenger.hh.

radiusCmd

G4UIcmdWithADoubleAndUnit* DMXParticleSourceMessenger::radiusCmd

private

Definition at line 89 of file DMXParticleSourceMessenger.hh.

shapeCmd

G4UIcmdWithAString* DMXParticleSourceMessenger::shapeCmd

private

Definition at line 86 of file DMXParticleSourceMessenger.hh.

typeCmd

G4UIcmdWithAString* DMXParticleSourceMessenger::typeCmd

private

Definition at line 85 of file DMXParticleSourceMessenger.hh.

verbosityCmd

G4UIcmdWithAnInteger* DMXParticleSourceMessenger::verbosityCmd

private

Definition at line 93 of file DMXParticleSourceMessenger.hh.

---

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

• DMXParticleSourceMessenger.hh
• DMXParticleSourceMessenger.cc