#include <GarfieldPhysics.h>

Public Member Functions
void	InitializePhysics ()

void	CreateGeometry ()

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_keV, double ekin_max_keV)

bool	FindParticleName (const std::string name)

bool	FindParticleNameEnergy (std::string name, double ekin_keV)

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 ()

Private Member Functions
	GarfieldPhysics ()

	~GarfieldPhysics ()

Private Attributes
std::string	fIonizationModel

MapParticlesEnergy *	fMapParticlesEnergy

TGeoManager *	fGeoManager

Garfield::MediumMagboltz *	fMediumMagboltz

Garfield::Sensor *	fSensor

Garfield::AvalancheMC *	fDrift

Garfield::AvalancheMicroscopic *	fAvalanche

Garfield::TrackHeed *	fTrackHeed

Garfield::GeometryRoot *	fGeometryRoot

Garfield::GeometrySimple *	fGeometrySimple

Garfield::ComponentAnalyticField *	fComponentAnalyticField

Garfield::SolidTube *	fTube

std::vector< GarfieldParticle * > *	fSecondaryParticles

bool	createSecondariesInGeant4

double	fEnergyDeposit

double	fAvalancheSize

double	fGain

int	nsum

Static Private Attributes
static GarfieldPhysics *	fGarfieldPhysics = 0

Detailed Description

Definition at line 80 of file GarfieldPhysics.h.

Constructor & Destructor Documentation

◆ GarfieldPhysics()

GarfieldPhysics::GarfieldPhysics ( )

private

Definition at line 46 of file GarfieldPhysics.cxx.

{
  fMapParticlesEnergy = new MapParticlesEnergy();
  fSecondaryParticles = new std::vector<GarfieldParticle*>();
  fMediumMagboltz = 0;
  fSensor = 0;
  fAvalanche = 0;
  fDrift = 0;
  fComponentAnalyticField = 0;
  fTrackHeed = 0;
  fGeoManager = 0;
  fGeometryRoot = 0;
  fGeometrySimple = 0;
  fTube = 0;
  createSecondariesInGeant4 = false;
  fIonizationModel = "Geant4";
  Clear();
}

◆ ~GarfieldPhysics()

GarfieldPhysics::~GarfieldPhysics ( )

private

Definition at line 65 of file GarfieldPhysics.cxx.

{
  delete fMapParticlesEnergy;
  DeleteSecondaryParticles();
  delete fSecondaryParticles;
  delete fMediumMagboltz;
  delete fSensor;
  delete fAvalanche;
  delete fDrift;
  delete fComponentAnalyticField;
  delete fTrackHeed;
  delete fGeometryRoot;
  delete fGeometrySimple;
 
  std::cout << "Deconstructor GarfieldPhysics" << std::endl;
}

Member Function Documentation

◆ GetInstance()

GarfieldPhysics * GarfieldPhysics::GetInstance ( )

static

Definition at line 32 of file GarfieldPhysics.cxx.

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

◆ Dispose()

void GarfieldPhysics::Dispose ( )

static

Definition at line 40 of file GarfieldPhysics.cxx.

{
  delete fGarfieldPhysics;
  fGarfieldPhysics = 0;
}

◆ InitializePhysics()

void GarfieldPhysics::InitializePhysics ( )

Definition at line 162 of file GarfieldPhysics.cxx.

{
 
  fMediumMagboltz = new Garfield::MediumMagboltz();
 
  fMediumMagboltz->SetComposition("ar", 70., "co2", 30.);
  fMediumMagboltz->SetTemperature(293.15);
  fMediumMagboltz->SetPressure(760.);
  fMediumMagboltz->EnableDebugging();
  fMediumMagboltz->Initialise(true);
  fMediumMagboltz->DisableDebugging();
  // 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");
 
  fSensor = new Garfield::Sensor();
  fDrift = new Garfield::AvalancheMC();
  fAvalanche = new Garfield::AvalancheMicroscopic();
  fComponentAnalyticField = new Garfield::ComponentAnalyticField();
 
  CreateGeometry();
 
  fDrift->SetSensor(fSensor);
  fAvalanche->SetSensor(fSensor);
 
  fTrackHeed = new Garfield::TrackHeed();
  fTrackHeed->EnableDebugging();
  fTrackHeed->SetSensor(fSensor);
 
  fTrackHeed->EnableDeltaElectronTransport();
}

◆ CreateGeometry()

void GarfieldPhysics::CreateGeometry ( )

Definition at line 196 of file GarfieldPhysics.cxx.

{
  // Wire radius [cm]
  const double rWire = 25.e-4;
  // Outer radius of the tube [cm]
  const double rTube = 1.451;
  // Half-length of the tube [cm]
  const double lTube = 10.;
 
  fGeometrySimple = new Garfield::GeometrySimple();
  // Make a tube (centered at the origin, inner radius: 0, outer radius: rTube).
  fTube = new Garfield::SolidTube(0., 0., rWire, rTube, lTube);
  // Add the solid to the geometry, together with the medium inside.
  fGeometrySimple->AddSolid(fTube, fMediumMagboltz);
  fComponentAnalyticField->SetGeometry(fGeometrySimple);
 
  // 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->AddComponent(fComponentAnalyticField);
}

◆ 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 223 of file GarfieldPhysics.cxx.

{
 
  DeleteSecondaryParticles();
 
  // 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;
  // fAvalancheSize = 0;
  // fGain = 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();
        }
        // TO DO: add this histo in MCApplication
        // 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));
        }
 
        fDrift->DriftElectron(xe, ye, ze, te);
 
        double xe1, ye1, ze1, te1;
        double xe2, ye2, ze2, te2;
 
        int status;
        fDrift->GetElectronEndpoint(
          0, xe1, ye1, ze1, te1, xe2, ye2, ze2, te2, status);
 
        if (0 < xe2 && xe2 < rWire) {
          xe2 += 2 * rWire;
        }
        if (0 > xe2 && xe2 > -rWire) {
          xe2 += -2 * rWire;
        }
        if (0 < ye2 && ye2 < rWire) {
          ye2 += 2 * rWire;
        }
        if (0 > ye2 && ye2 > -rWire) {
          ye2 += -2 * rWire;
        }
 
        double e2 = 0.1;
        fAvalanche->AvalancheElectron(xe2, ye2, ze2, te2, e2, 0, 0, 0);
 
        int ne = 0, ni = 0;
        fAvalanche->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) {
            // TO DO: add this histo in MCApplication
            // 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));
            }
 
            fDrift->DriftElectron(xe, ye, ze, te);
 
            double xe1, ye1, ze1, te1;
            double xe2, ye2, ze2, te2;
 
            int status;
            fDrift->GetElectronEndpoint(
              0, xe1, ye1, ze1, te1, xe2, ye2, ze2, te2, status);
 
            if (0 < xe2 && xe2 < rWire) {
              xe2 += 2 * rWire;
            }
            if (0 > xe2 && xe2 > -rWire) {
              xe2 += -2 * rWire;
            }
            if (0 < ye2 && ye2 < rWire) {
              ye2 += 2 * rWire;
            }
            if (0 > ye2 && ye2 > -rWire) {
              ye2 += -2 * rWire;
            }
 
            double e2 = 0.1;
            fAvalanche->AvalancheElectron(xe2, ye2, ze2, te2, e2, 0, 0, 0);
 
            int ne = 0, ni = 0;
            fAvalanche->GetAvalancheSize(ne, ni);
            fAvalancheSize += ne;
          }
        }
      }
    }
  }
  if (nsum > 0) {
    fGain = fAvalancheSize / nsum;
  }
}

◆ AddParticleName()

void GarfieldPhysics::AddParticleName	(	const std::string	particleName,
		double	ekin_min_keV,
		double	ekin_max_keV )

Definition at line 123 of file GarfieldPhysics.cxx.

{
  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;
  }
  std::cout << "Garfield model is applicable for G4Particle " << particleName
            << " between " << ekin_min_MeV << " keV and " << ekin_max_MeV
            << " keV" << std::endl;
  fMapParticlesEnergy->insert(
    std::make_pair(particleName, std::make_pair(ekin_min_MeV, ekin_max_MeV)));
}

◆ FindParticleName()

bool GarfieldPhysics::FindParticleName ( const std::string name )

Definition at line 139 of file GarfieldPhysics.cxx.

{
  MapParticlesEnergy::iterator it;
  it = fMapParticlesEnergy->find(name);
  if (it != fMapParticlesEnergy->end()) {
    return true;
  }
  return false;
}

◆ FindParticleNameEnergy()

bool GarfieldPhysics::FindParticleNameEnergy	(	std::string	name,
		double	ekin_keV )

Definition at line 149 of file GarfieldPhysics.cxx.

{
  MapParticlesEnergy::iterator it;
  it = fMapParticlesEnergy->find(name);
  if (it != fMapParticlesEnergy->end()) {
    EnergyRange_MeV range = it->second;
    if (range.first <= ekin_MeV && range.second >= ekin_MeV) {
      return true;
    }
  }
  return false;
}

◆ SetIonizationModel()

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

Definition at line 84 of file GarfieldPhysics.cxx.

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

◆ GetIonizationModel()

std::string GarfieldPhysics::GetIonizationModel ( )

Definition at line 82 of file GarfieldPhysics.cxx.

82{ return fIonizationModel; }

◆ GetSecondaryParticles()

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

Definition at line 375 of file GarfieldPhysics.cxx.

{
  return fSecondaryParticles;
}

◆ DeleteSecondaryParticles()

void GarfieldPhysics::DeleteSecondaryParticles ( )

Definition at line 380 of file GarfieldPhysics.cxx.

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

◆ EnableCreateSecondariesInGeant4()

void GarfieldPhysics::EnableCreateSecondariesInGeant4 ( bool flag )

inline

Definition at line 100 of file GarfieldPhysics.h.

  {
    createSecondariesInGeant4 = flag;
  };

◆ GetCreateSecondariesInGeant4()

bool GarfieldPhysics::GetCreateSecondariesInGeant4 ( )

inline

Definition at line 104 of file GarfieldPhysics.h.

  {
    return createSecondariesInGeant4;
  };

◆ GetEnergyDeposit_MeV()

double GarfieldPhysics::GetEnergyDeposit_MeV ( )

inline

Definition at line 108 of file GarfieldPhysics.h.

108{ return fEnergyDeposit / 1000000; };

◆ GetAvalancheSize()

double GarfieldPhysics::GetAvalancheSize ( )

inline

Definition at line 109 of file GarfieldPhysics.h.

109{ return fAvalancheSize; };

◆ GetGain()

double GarfieldPhysics::GetGain ( )

inline

Definition at line 110 of file GarfieldPhysics.h.

110{ return fGain; };

◆ Clear()

void GarfieldPhysics::Clear ( )

inline

Definition at line 111 of file GarfieldPhysics.h.

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

Member Data Documentation

◆ fIonizationModel

std::string GarfieldPhysics::fIonizationModel

private

Definition at line 123 of file GarfieldPhysics.h.

◆ fGarfieldPhysics

GarfieldPhysics * GarfieldPhysics::fGarfieldPhysics = 0

staticprivate

Definition at line 125 of file GarfieldPhysics.h.

◆ fMapParticlesEnergy

MapParticlesEnergy* GarfieldPhysics::fMapParticlesEnergy

private

Definition at line 126 of file GarfieldPhysics.h.

◆ fGeoManager

TGeoManager* GarfieldPhysics::fGeoManager

private

Definition at line 127 of file GarfieldPhysics.h.

◆ fMediumMagboltz

Garfield::MediumMagboltz* GarfieldPhysics::fMediumMagboltz

private

Definition at line 128 of file GarfieldPhysics.h.

◆ fSensor

Garfield::Sensor* GarfieldPhysics::fSensor

private

Definition at line 129 of file GarfieldPhysics.h.

◆ fDrift

Garfield::AvalancheMC* GarfieldPhysics::fDrift

private

Definition at line 130 of file GarfieldPhysics.h.

◆ fAvalanche

Garfield::AvalancheMicroscopic* GarfieldPhysics::fAvalanche

private

Definition at line 131 of file GarfieldPhysics.h.

◆ fTrackHeed

Garfield::TrackHeed* GarfieldPhysics::fTrackHeed

private

Definition at line 132 of file GarfieldPhysics.h.

◆ fGeometryRoot

Garfield::GeometryRoot* GarfieldPhysics::fGeometryRoot

private

Definition at line 133 of file GarfieldPhysics.h.

◆ fGeometrySimple

Garfield::GeometrySimple* GarfieldPhysics::fGeometrySimple

private

Definition at line 134 of file GarfieldPhysics.h.

◆ fComponentAnalyticField

Garfield::ComponentAnalyticField* GarfieldPhysics::fComponentAnalyticField

private

Definition at line 135 of file GarfieldPhysics.h.

◆ fTube

Garfield::SolidTube* GarfieldPhysics::fTube

private

Definition at line 136 of file GarfieldPhysics.h.

◆ fSecondaryParticles

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

private

Definition at line 138 of file GarfieldPhysics.h.

◆ createSecondariesInGeant4

bool GarfieldPhysics::createSecondariesInGeant4

private

Definition at line 140 of file GarfieldPhysics.h.

◆ fEnergyDeposit

double GarfieldPhysics::fEnergyDeposit

private

Definition at line 141 of file GarfieldPhysics.h.

◆ fAvalancheSize

double GarfieldPhysics::fAvalancheSize

private

Definition at line 142 of file GarfieldPhysics.h.

◆ fGain

double GarfieldPhysics::fGain

private

Definition at line 143 of file GarfieldPhysics.h.

◆ nsum

int GarfieldPhysics::nsum

private

Definition at line 144 of file GarfieldPhysics.h.

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

examples/ExGarfield/include/GarfieldPhysics.h
examples/ExGarfield/src/GarfieldPhysics.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GarfieldPhysics()

◆ ~GarfieldPhysics()

Member Function Documentation

◆ GetInstance()

◆ Dispose()

◆ InitializePhysics()

◆ CreateGeometry()

◆ DoIt()

◆ AddParticleName()

◆ FindParticleName()

◆ FindParticleNameEnergy()

◆ SetIonizationModel()

◆ GetIonizationModel()

◆ GetSecondaryParticles()

◆ DeleteSecondaryParticles()

◆ EnableCreateSecondariesInGeant4()

◆ GetCreateSecondariesInGeant4()

◆ GetEnergyDeposit_MeV()

◆ GetAvalancheSize()

◆ GetGain()

◆ Clear()

Member Data Documentation

◆ fIonizationModel

◆ fGarfieldPhysics

◆ fMapParticlesEnergy

◆ fGeoManager

◆ fMediumMagboltz

◆ fSensor

◆ fDrift

◆ fAvalanche

◆ fTrackHeed

◆ fGeometryRoot

◆ fGeometrySimple

◆ fComponentAnalyticField

◆ fTube

◆ fSecondaryParticles

◆ createSecondariesInGeant4

◆ fEnergyDeposit

◆ fAvalancheSize

◆ fGain

◆ nsum