GarfieldPhysics Class Reference

#include <GarfieldPhysics.hh>

Public Member Functions
void	InitializePhysics ()
void	DoIt (std::string particleName, double ekin_MeV, double time, double x_cm, double y_cm, double z_cm, double dx, double dy, double dz)
void	AddParticleName (const std::string particleName, double ekin_min_MeV, double ekin_max_MeV, std::string program)
bool	FindParticleName (const std::string name, std::string program="garfield")
bool	FindParticleNameEnergy (std::string name, double ekin_MeV, std::string program="garfield")
double	GetMinEnergyMeVParticle (std::string name, std::string program="garfield")
double	GetMaxEnergyMeVParticle (std::string name, std::string program="garfield")
void	SetIonizationModel (std::string model, bool useDefaults=true)
std::string	GetIonizationModel ()
std::vector< GarfieldParticle * > *	GetSecondaryParticles ()
void	DeleteSecondaryParticles ()
void	EnableCreateSecondariesInGeant4 (bool flag)
bool	GetCreateSecondariesInGeant4 ()
double	GetEnergyDeposit_MeV ()
double	GetAvalancheSize ()
double	GetGain ()
void	Clear ()

Static Public Member Functions
static GarfieldPhysics *	GetInstance ()
static void	Dispose ()

Detailed Description

Definition at line 76 of file GarfieldPhysics.hh.

Member Function Documentation

AddParticleName()

void GarfieldPhysics::AddParticleName	(	const std::string	particleName,
		double	ekin_min_MeV,
		double	ekin_max_MeV,
		std::string	program
	)

Definition at line 121 of file GarfieldPhysics.cc.

                                                         {
  if (ekin_min_MeV >= ekin_max_MeV) {
    std::cout << "Ekin_min=" << ekin_min_MeV
              << " keV is larger than Ekin_max=" << ekin_max_MeV << " keV"
              << std::endl;
    return;
  }
 
  if (program == "garfield") {
    std::cout << "Garfield model (Heed) is applicable for G4Particle "
              << particleName << " between " << ekin_min_MeV << " MeV and "
              << ekin_max_MeV << " MeV" << std::endl;
 
    fMapParticlesEnergyGarfield.insert(std::make_pair(
        particleName, std::make_pair(ekin_min_MeV, ekin_max_MeV)));
  } else {
    std::cout << fIonizationModel << " is applicable for G4Particle "
              << particleName << " between " << ekin_min_MeV << " MeV and "
              << ekin_max_MeV << " MeV" << std::endl;
    fMapParticlesEnergyGeant4.insert(std::make_pair(
        particleName, std::make_pair(ekin_min_MeV, ekin_max_MeV)));
  }
}

Referenced by SetIonizationModel(), and GarfieldMessenger::SetNewValue().

Clear()

void GarfieldPhysics::Clear ( )

inline

Definition at line 109 of file GarfieldPhysics.hh.

                      {
    fEnergyDeposit = 0;
    fAvalancheSize = 0;
    fGain = 0;
    nsum = 0;
  }

Referenced by GarfieldEventAction::BeginOfEventAction().

DeleteSecondaryParticles()

void GarfieldPhysics::DeleteSecondaryParticles

(

)

Definition at line 400 of file GarfieldPhysics.cc.

                                               {
  if (!fSecondaryParticles->empty()) {
    fSecondaryParticles->erase(fSecondaryParticles->begin(),
                               fSecondaryParticles->end());
  }
}

Referenced by DoIt().

Dispose()

void GarfieldPhysics::Dispose ( )

static

Definition at line 44 of file GarfieldPhysics.cc.

                              {
  delete fGarfieldPhysics;
  fGarfieldPhysics = 0;
}

Referenced by main().

DoIt()

void GarfieldPhysics::DoIt	(	std::string	particleName,
		double	ekin_MeV,
		double	time,
		double	x_cm,
		double	y_cm,
		double	z_cm,
		double	dx,
		double	dy,
		double	dz
	)

Definition at line 251 of file GarfieldPhysics.cc.

                                                            {
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  fEnergyDeposit = 0;
  DeleteSecondaryParticles();
 
  Garfield::AvalancheMC drift;
  drift.SetSensor(fSensor);
  drift.SetDistanceSteps(1.e-4);
  Garfield::AvalancheMicroscopic avalanche;
  avalanche.SetSensor(fSensor);
 
  // Wire radius [cm]
  const double rWire = 25.e-4;
  // Outer radius of the tube [cm]
  const double rTube = 1.45;
  // Half-length of the tube [cm]
  const double lTube = 10.;
 
  double eKin_eV = ekin_MeV * 1e+6;
 
  double xc = 0., yc = 0., zc = 0., tc = 0.;
  // Number of electrons produced in a collision
  int nc = 0;
  // Energy loss in a collision
  double ec = 0.;
  // Dummy variable (not used at present)
  double extra = 0.;
  fEnergyDeposit = 0;
  if (fIonizationModel != "Heed" || particleName == "gamma") {
    if (particleName == "gamma") {
      fTrackHeed->TransportPhoton(x_cm, y_cm, z_cm, time, eKin_eV, dx, dy, dz,
                                  nc);
    } else {
      fTrackHeed->TransportDeltaElectron(x_cm, y_cm, z_cm, time, eKin_eV, dx,
                                         dy, dz, nc);
      fEnergyDeposit = eKin_eV;
    }
 
    for (int cl = 0; cl < nc; cl++) {
      double xe, ye, ze, te;
      double ee, dxe, dye, dze;
      fTrackHeed->GetElectron(cl, xe, ye, ze, te, ee, dxe, dye, dze);
      if (ze < lTube && ze > -lTube && sqrt(xe * xe + ye * ye) < rTube) {
        nsum++;
        if (particleName == "gamma") {
          fEnergyDeposit += fTrackHeed->GetW();
        }
        analysisManager->FillH3(1, ze * 10, xe * 10, ye * 10);
        if (createSecondariesInGeant4) {
          double newTime = te;
          if (newTime < time) {
            newTime += time;
          }
          fSecondaryParticles->push_back(new GarfieldParticle(
              "e-", ee, newTime, xe, ye, ze, dxe, dye, dze));
        }
 
        drift.DriftElectron(xe, ye, ze, te);
 
        double xe1, ye1, ze1, te1;
        double xe2, ye2, ze2, te2;
 
        int status;
        drift.GetElectronEndpoint(0, xe1, ye1, ze1, te1, xe2, ye2, ze2, te2,
                                  status);
 
        if (0 < xe2 && xe2 < rWire) {
          xe2 += 2 * rWire;
        } else if (0 > xe2 && xe2 > -rWire) {
          xe2 += -2 * rWire;
        } 
        if (0 < ye2 && ye2 < rWire) {
          ye2 += 2 * rWire;
        } else if (0 > ye2 && ye2 > -rWire) {
          ye2 += -2 * rWire;
        }
 
        double e2 = 0.1;
        avalanche.AvalancheElectron(xe2, ye2, ze2, te2, e2, 0, 0, 0);
 
        int ne = 0, ni = 0;
        avalanche.GetAvalancheSize(ne, ni);
        fAvalancheSize += ne;
      }
    }
  } else {
    fTrackHeed->SetParticle(particleName);
    fTrackHeed->SetKineticEnergy(eKin_eV);
    fTrackHeed->NewTrack(x_cm, y_cm, z_cm, time, dx, dy, dz);
 
    while (fTrackHeed->GetCluster(xc, yc, zc, tc, nc, ec, extra)) {
      if (zc < lTube && zc > -lTube && sqrt(xc * xc + yc * yc) < rTube) {
        nsum += nc;
        fEnergyDeposit += ec;
        for (int cl = 0; cl < nc; cl++) {
          double xe, ye, ze, te;
          double ee, dxe, dye, dze;
          fTrackHeed->GetElectron(cl, xe, ye, ze, te, ee, dxe, dye, dze);
          if (ze < lTube && ze > -lTube && sqrt(xe * xe + ye * ye) < rTube) {
            analysisManager->FillH3(1, ze * 10, xe * 10, ye * 10);
            if (createSecondariesInGeant4) {
              double newTime = te;
              if (newTime < time) {
                newTime += time;
              }
              fSecondaryParticles->push_back(new GarfieldParticle(
                  "e-", ee, newTime, xe, ye, ze, dxe, dye, dze));
            }
 
            drift.DriftElectron(xe, ye, ze, te);
 
            double xe1, ye1, ze1, te1;
            double xe2, ye2, ze2, te2;
 
            int status;
            drift.GetElectronEndpoint(0, xe1, ye1, ze1, te1, xe2, ye2, ze2,
                                      te2, status);
 
            if (0 < xe2 && xe2 < rWire) {
              xe2 += 2 * rWire;
            } else if (0 > xe2 && xe2 > -rWire) {
              xe2 += -2 * rWire;
            }
            if (0 < ye2 && ye2 < rWire) {
              ye2 += 2 * rWire;
            } else if (0 > ye2 && ye2 > -rWire) {
              ye2 += -2 * rWire;
            }
 
            double e2 = 0.1;
            avalanche.AvalancheElectron(xe2, ye2, ze2, te2, e2, 0, 0, 0);
 
            int ne = 0, ni = 0;
            avalanche.GetAvalancheSize(ne, ni);
            fAvalancheSize += ne;
          }
        }
      }
    }
  }
  fGain = fAvalancheSize / nsum;
}

Referenced by GarfieldG4FastSimulationModel::DoIt().

EnableCreateSecondariesInGeant4()

void GarfieldPhysics::EnableCreateSecondariesInGeant4 ( bool  flag )

inline

Definition at line 100 of file GarfieldPhysics.hh.

                                                         {
    createSecondariesInGeant4 = flag;
  }

FindParticleName()

bool GarfieldPhysics::FindParticleName	(	const std::string	name,
		std::string	program = "garfield"
	)

Definition at line 147 of file GarfieldPhysics.cc.

                                                                        {
  if (program == "garfield") {
    auto it = fMapParticlesEnergyGarfield.find(name);
    if (it != fMapParticlesEnergyGarfield.end()) return true;
  } else {
    auto it = fMapParticlesEnergyGeant4.find(name);
    if (it != fMapParticlesEnergyGeant4.end()) return true;
  }
  return false;
}

Referenced by GarfieldPhysicsList::AddParameterisation(), and GarfieldG4FastSimulationModel::IsApplicable().

FindParticleNameEnergy()

bool GarfieldPhysics::FindParticleNameEnergy	(	std::string	name,
		double	ekin_MeV,
		std::string	program = "garfield"
	)

Definition at line 158 of file GarfieldPhysics.cc.

                                                                {
  if (program == "garfield") {
    auto it = fMapParticlesEnergyGarfield.find(name);
    if (it != fMapParticlesEnergyGarfield.end()) {
      EnergyRange_MeV range = it->second;
      if (range.first <= ekin_MeV && range.second >= ekin_MeV) {
        return true;
      }
    }
  } else {
    auto it = fMapParticlesEnergyGeant4.find(name);
    if (it != fMapParticlesEnergyGeant4.end()) {
      EnergyRange_MeV range = it->second;
      if (range.first <= ekin_MeV && range.second >= ekin_MeV) {
        return true;
      }
    }
  }
  return false;
}

Referenced by GarfieldG4FastSimulationModel::ModelTrigger().

GetAvalancheSize()

double GarfieldPhysics::GetAvalancheSize ( )

inline

Definition at line 107 of file GarfieldPhysics.hh.

{ return fAvalancheSize; }

Referenced by GarfieldEventAction::EndOfEventAction().

GetCreateSecondariesInGeant4()

bool GarfieldPhysics::GetCreateSecondariesInGeant4 ( )

inline

Definition at line 103 of file GarfieldPhysics.hh.

                                             {
    return createSecondariesInGeant4;
  }

Referenced by GarfieldG4FastSimulationModel::DoIt().

GetEnergyDeposit_MeV()

double GarfieldPhysics::GetEnergyDeposit_MeV ( )

inline

Definition at line 106 of file GarfieldPhysics.hh.

{ return fEnergyDeposit / 1000000; }

Referenced by GarfieldG4FastSimulationModel::DoIt().

GetGain()

double GarfieldPhysics::GetGain ( )

inline

Definition at line 108 of file GarfieldPhysics.hh.

{ return fGain; }

Referenced by GarfieldEventAction::EndOfEventAction().

GetInstance()

GarfieldPhysics * GarfieldPhysics::GetInstance ( )

static

Definition at line 37 of file GarfieldPhysics.cc.

                                              {
  if (!fGarfieldPhysics) {
    fGarfieldPhysics = new GarfieldPhysics();
  }
  return fGarfieldPhysics;
}

Referenced by GarfieldPhysicsList::AddParameterisation(), GarfieldEventAction::BeginOfEventAction(), GarfieldEventAction::EndOfEventAction(), GarfieldG4FastSimulationModel::GarfieldG4FastSimulationModel(), and GarfieldMessenger::SetNewValue().

GetIonizationModel()

std::string GarfieldPhysics::GetIonizationModel

(

)

Definition at line 70 of file GarfieldPhysics.cc.

{ return fIonizationModel; }

Referenced by GarfieldPhysicsList::AddParameterisation().

GetMaxEnergyMeVParticle()

double GarfieldPhysics::GetMaxEnergyMeVParticle	(	std::string	name,
		std::string	program = "garfield"
	)

Definition at line 198 of file GarfieldPhysics.cc.

                                                                   {
  if (program == "garfield") {
    auto it = fMapParticlesEnergyGarfield.find(name);
    if (it != fMapParticlesEnergyGarfield.end()) {
      EnergyRange_MeV range = it->second;
      return range.second;
    }
  } else {
    auto it = fMapParticlesEnergyGeant4.find(name);
    if (it != fMapParticlesEnergyGeant4.end()) {
      EnergyRange_MeV range = it->second;
      return range.second;
    }
  }
  return -1;
}

Referenced by GarfieldPhysicsList::AddParameterisation().

GetMinEnergyMeVParticle()

double GarfieldPhysics::GetMinEnergyMeVParticle	(	std::string	name,
		std::string	program = "garfield"
	)

Definition at line 180 of file GarfieldPhysics.cc.

                                                                   {
  if (program == "garfield") {
    auto it = fMapParticlesEnergyGarfield.find(name);
    if (it != fMapParticlesEnergyGarfield.end()) {
      EnergyRange_MeV range = it->second;
      return range.first;
    }
  } else {
    auto it = fMapParticlesEnergyGeant4.find(name);
    if (it != fMapParticlesEnergyGeant4.end()) {
      EnergyRange_MeV range = it->second;
      return range.first;
    }
  }
  return -1;
}

Referenced by GarfieldPhysicsList::AddParameterisation().

GetSecondaryParticles()

std::vector< GarfieldParticle * > * GarfieldPhysics::GetSecondaryParticles

(

)

Definition at line 396 of file GarfieldPhysics.cc.

                                                                     {
  return fSecondaryParticles;
}

Referenced by GarfieldG4FastSimulationModel::DoIt().

InitializePhysics()

void GarfieldPhysics::InitializePhysics

(

)

Definition at line 216 of file GarfieldPhysics.cc.

                                        {
  // Define the gas mixture.
  fMediumMagboltz = new Garfield::MediumMagboltz();
  fMediumMagboltz->SetComposition("ar", 70., "co2", 30.);
  fMediumMagboltz->SetTemperature(293.15);
  fMediumMagboltz->SetPressure(760.);
  fMediumMagboltz->Initialise(true);
  // Set the Penning transfer efficiency.
  const double rPenning = 0.57;
  const double lambdaPenning = 0.;
  fMediumMagboltz->EnablePenningTransfer(rPenning, lambdaPenning, "ar");
  fMediumMagboltz->LoadGasFile("ar_70_co2_30_1000mbar.gas");
 
  fComponentAnalyticField = new Garfield::ComponentAnalyticField();
  fComponentAnalyticField->SetMedium(fMediumMagboltz);
  // Wire radius [cm]
  const double rWire = 25.e-4;
  // Tube radius [cm]
  const double rTube = 1.451;
  // Voltages
  const double vWire = 1000.;
  const double vTube = 0.;
  // Add the wire in the center.
  fComponentAnalyticField->AddWire(0., 0., 2 * rWire, vWire, "w");
  // Add the tube.
  fComponentAnalyticField->AddTube(rTube, vTube, 0, "t");
 
  fSensor = new Garfield::Sensor();
  fSensor->AddComponent(fComponentAnalyticField);
 
  fTrackHeed = new Garfield::TrackHeed();
  fTrackHeed->SetSensor(fSensor);
  fTrackHeed->EnableDeltaElectronTransport();
}

Referenced by GarfieldG4FastSimulationModel::GarfieldG4FastSimulationModel().

SetIonizationModel()

void GarfieldPhysics::SetIonizationModel	(	std::string	model,
		bool	useDefaults = true
	)

Definition at line 72 of file GarfieldPhysics.cc.

                                                                          {
  if (model != "PAIPhot" && model != "PAI" && model != "Heed") {
    std::cout << "Unknown ionization model " << model << std::endl;
    std::cout << "Using PAIPhot as default model!" << std::endl;
    model = "PAIPhot";
  }
  fIonizationModel = model;
 
  if (fIonizationModel == "PAIPhot" || fIonizationModel == "PAI") {
    if (useDefaults == true) {
      // Particle types and energies for which the G4FastSimulationModel with
      // Garfield++ is valid
      this->AddParticleName("e-", 1e-6, 1e-3, "garfield");
      this->AddParticleName("gamma", 1e-6, 1e+8, "garfield");
 
      // Particle types and energies for which the PAI or PAIPhot model is valid
      this->AddParticleName("e-", 0, 1e+8, "geant4");
      this->AddParticleName("e+", 0, 1e+8, "geant4");
      this->AddParticleName("mu-", 0, 1e+8, "geant4");
      this->AddParticleName("mu+", 0, 1e+8, "geant4");
      this->AddParticleName("proton", 0, 1e+8, "geant4");
      this->AddParticleName("pi+", 0, 1e+8, "geant4");
      this->AddParticleName("pi-", 0, 1e+8, "geant4");
      this->AddParticleName("alpha", 0, 1e+8, "geant4");
      this->AddParticleName("He3", 0, 1e+8, "geant4");
      this->AddParticleName("GenericIon", 0, 1e+8, "geant4");
    }
 
  } else if (fIonizationModel == "Heed") {
    if (useDefaults == true) {
      // Particle types and energies for which the G4FastSimulationModel with
      // Garfield++ is valid
      this->AddParticleName("gamma", 1e-6, 1e+8, "garfield");
      this->AddParticleName("e-", 6e-2, 1e+7, "garfield");
      this->AddParticleName("e+", 6e-2, 1e+7, "garfield");
      this->AddParticleName("mu-", 1e+1, 1e+8, "garfield");
      this->AddParticleName("mu+", 1e+1, 1e+8, "garfield");
      this->AddParticleName("pi-", 2e+1, 1e+8, "garfield");
      this->AddParticleName("pi+", 2e+1, 1e+8, "garfield");
      this->AddParticleName("kaon-", 1e+1, 1e+8, "garfield");
      this->AddParticleName("kaon+", 1e+1, 1e+8, "garfield");
      this->AddParticleName("proton", 9.e+1, 1e+8, "garfield");
      this->AddParticleName("anti_proton", 9.e+1, 1e+8, "garfield");
      this->AddParticleName("deuteron", 2.e+2, 1e+8, "garfield");
      this->AddParticleName("alpha", 4.e+2, 1e+8, "garfield");
    }
  }
}

Referenced by GarfieldMessenger::SetNewValue().

---

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

• GarfieldPhysics.hh
• GarfieldPhysics.cc