GarfieldMessenger Class Reference

#include <GarfieldMessenger.h>

Inheritance diagram for GarfieldMessenger:

Public Member Functions
	GarfieldMessenger ()
	~GarfieldMessenger ()
virtual void	SetNewValue (G4UIcommand *, G4String)

Private Attributes
G4UIdirectory *	fExampleDir
G4UIdirectory *	fGarfieldPhysicsDir
G4UIcommand *	fIonizationModelCmd
G4UIcommand *	fGarfieldParticleCmd

Detailed Description

Definition at line 31 of file GarfieldMessenger.h.

Constructor & Destructor Documentation

GarfieldMessenger()

GarfieldMessenger::GarfieldMessenger

(

)

Definition at line 30 of file GarfieldMessenger.cxx.

  : G4UImessenger(),
    fExampleDir(0),
    fGarfieldPhysicsDir(0),
    fIonizationModelCmd(0),
    fGarfieldParticleCmd(0)
{
  fExampleDir = new G4UIdirectory("/exampleGarfield/");
  fExampleDir->SetGuidance("Commands specific to this example");
 
  G4bool broadcast = false;
  fGarfieldPhysicsDir =
    new G4UIdirectory("/exampleGarfield/physics/", broadcast);
  fGarfieldPhysicsDir->SetGuidance(
    "Particle and energy ranges for Garfield++ physics model");
 
  fIonizationModelCmd =
    new G4UIcommand("/exampleGarfield/physics/setIonizationModel", this);
  fIonizationModelCmd->SetGuidance("Select ionization model for Garfield++");
  fIonizationModelCmd->SetGuidance(
    "  and choose whether to use default particles");
  fIonizationModelCmd->SetGuidance("  and energy ranges for the chosen model");
  //
  G4UIparameter* ionizationModelPrm =
    new G4UIparameter("ionizationModel", 's', false);
  ionizationModelPrm->SetGuidance("ionization model (1. PAIPhot, 2. Heed)");
  ionizationModelPrm->SetGuidance(
    "  1. Geant4 model, delta electrons transported by Heed");
  ionizationModelPrm->SetGuidance("  2. Use directly Heed");
  fIonizationModelCmd->SetParameter(ionizationModelPrm);
  //
  G4UIparameter* useDefaultsPrm = new G4UIparameter("useDefaults", 'b', false);
  useDefaultsPrm->SetGuidance(
    "true to use default, false to manually choose particles and energies");
  fIonizationModelCmd->SetParameter(useDefaultsPrm);
  //
  fIonizationModelCmd->AvailableForStates(G4State_PreInit);
 
  fGarfieldParticleCmd = new G4UIcommand(
    "/exampleGarfield/physics/setGarfieldParticleTypeAndEnergy", this);
  fGarfieldParticleCmd->SetGuidance(
    "Select particle types and energies for Heed model.");
  fGarfieldParticleCmd->SetGuidance(
    " For PAI and PAIPhot model choose at which energy electrons are");
  fGarfieldParticleCmd->SetGuidance(
    " transported as delta electrons by Heed, and treatment of gammas");
  //
  G4UIparameter* particleGarfieldPrm =
    new G4UIparameter("particleName", 's', false);
  particleGarfieldPrm->SetGuidance(
    "Particle name (gamma, e-, e+, mu-, mu+, proton, anti_proton, pi-, pi+, "
    "kaon, kaon+, alpha, deuteron)");
  fGarfieldParticleCmd->SetParameter(particleGarfieldPrm);
  //
  G4UIparameter* minEnergyGarfieldPrm =
    new G4UIparameter("minimumEnergyGarfield", 'd', false);
  minEnergyGarfieldPrm->SetGuidance("minimum energy");
  minEnergyGarfieldPrm->SetParameterRange("minimumEnergyGarfield>=0");
  fGarfieldParticleCmd->SetParameter(minEnergyGarfieldPrm);
  //
  G4UIparameter* maxEnergyGarfieldPrm =
    new G4UIparameter("maximumEnergyGarfield", 'd', false);
  maxEnergyGarfieldPrm->SetGuidance("maximum energy");
  maxEnergyGarfieldPrm->SetParameterRange("maximumEnergyGarfield>=0");
  fGarfieldParticleCmd->SetParameter(maxEnergyGarfieldPrm);
  //
  G4UIparameter* unitGarfieldPrm = new G4UIparameter("unit", 's', false);
  unitGarfieldPrm->SetGuidance("unit of energy");
  G4String unitListGarfield =
    G4UIcommand::UnitsList(G4UIcommand::CategoryOf("MeV"));
  unitGarfieldPrm->SetParameterCandidates(unitListGarfield);
  fGarfieldParticleCmd->SetParameter(unitGarfieldPrm);
  //
  fGarfieldParticleCmd->AvailableForStates(G4State_PreInit);
}

~GarfieldMessenger()

GarfieldMessenger::~GarfieldMessenger

(

)

Definition at line 108 of file GarfieldMessenger.cxx.

{
  delete fExampleDir;
  delete fGarfieldPhysicsDir;
  delete fIonizationModelCmd;
  delete fGarfieldParticleCmd;
}

Member Function Documentation

SetNewValue()

void GarfieldMessenger::SetNewValue ( G4UIcommand * command, G4String newValue )

virtual

Definition at line 118 of file GarfieldMessenger.cxx.

{
  if (command == fIonizationModelCmd) {
    GarfieldPhysics* garfieldPhysics = GarfieldPhysics::GetInstance();
    G4String modelName;
    G4bool useDefaults;
    std::istringstream is(newValue);
    is >> modelName >> std::boolalpha >> useDefaults;
    garfieldPhysics->SetIonizationModel(modelName, useDefaults);
  }
  else if (command == fGarfieldParticleCmd) {
    GarfieldPhysics* garfieldPhysics = GarfieldPhysics::GetInstance();
    G4String particleName, unit, programName;
    G4double minEnergy;
    G4double maxEnergy;
    std::istringstream is(newValue);
    is >> particleName >> minEnergy >> maxEnergy >> unit;
    minEnergy *= G4UIcommand::ValueOf(unit);
    maxEnergy *= G4UIcommand::ValueOf(unit);
    garfieldPhysics->AddParticleName(particleName, minEnergy, maxEnergy);
  }
}

Member Data Documentation

fExampleDir

G4UIdirectory* GarfieldMessenger::fExampleDir

private

Definition at line 40 of file GarfieldMessenger.h.

fGarfieldPhysicsDir

G4UIdirectory* GarfieldMessenger::fGarfieldPhysicsDir

private

Definition at line 41 of file GarfieldMessenger.h.

fIonizationModelCmd

G4UIcommand* GarfieldMessenger::fIonizationModelCmd

private

Definition at line 42 of file GarfieldMessenger.h.

fGarfieldParticleCmd

G4UIcommand* GarfieldMessenger::fGarfieldParticleCmd

private

Definition at line 43 of file GarfieldMessenger.h.

---

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

• examples/ExGarfield/geant4/include/GarfieldMessenger.h
• examples/ExGarfield/geant4/src/GarfieldMessenger.cxx