#include <MediumMagboltz.hh>

Inheritance diagram for Garfield::MediumMagboltz:

Public Member Functions
	MediumMagboltz ()

	~MediumMagboltz ()

bool	SetMaxElectronEnergy (const double e)

double	GetMaxElectronEnergy () const

bool	SetMaxPhotonEnergy (const double e)

double	GetMaxPhotonEnergy () const

void	EnableEnergyRangeAdjustment ()

void	DisableEnergyRangeAdjustment ()

void	EnableAnisotropicScattering ()

void	DisableAnisotropicScattering ()

void	SetSplittingFunctionOpalBeaty ()

void	SetSplittingFunctionGreenSawada ()

void	SetSplittingFunctionFlat ()

void	EnableDeexcitation ()

void	DisableDeexcitation ()

void	EnableRadiationTrapping ()

void	DisableRadiationTrapping ()

void	EnablePenningTransfer (const double r, const double lambda)

void	EnablePenningTransfer (const double r, const double lambda, std::string gasname)

void	DisablePenningTransfer ()

void	DisablePenningTransfer (std::string gasname)

void	EnableCrossSectionOutput ()

void	DisableCrossSectionOutput ()

void	SetExcitationScalingFactor (const double r, std::string gasname)

bool	Initialise (const bool verbose=false)

void	PrintGas ()

double	GetElectronNullCollisionRate (const int band)

double	GetElectronCollisionRate (const double e, const int band)

double	GetElectronCollisionRate (const double e, const int level, const int band)

bool	GetElectronCollision (const double e, int &type, int &level, double &e1, double &dx, double &dy, double &dz, int &nion, int &ndxc, int &band)

int	GetNumberOfIonisationProducts ()

bool	GetIonisationProduct (const int i, int &type, double &energy)

void	ComputeDeexcitation (int iLevel, int &fLevel)

int	GetNumberOfDeexcitationProducts ()

bool	GetDeexcitationProduct (const int i, double &t, double &s, int &type, double &energy)

double	GetPhotonCollisionRate (const double &e)

bool	GetPhotonCollision (const double e, int &type, int &level, double &e1, double &ctheta, int &nsec, double &esec)

void	ResetCollisionCounters ()

int	GetNumberOfElectronCollisions () const

int	GetNumberOfElectronCollisions (int &nElastic, int &nIonising, int &nAttachment, int &nInelastic, int &nExcitation, int &nSuperelastic) const

int	GetNumberOfLevels ()

bool	GetLevel (const int i, int &ngas, int &type, std::string &descr, double &e)

int	GetNumberOfElectronCollisions (const int level) const

int	GetNumberOfPenningTransfers () const

int	GetNumberOfPhotonCollisions () const

int	GetNumberOfPhotonCollisions (int &nElastic, int &nIonising, int &nInelastic) const

void	RunMagboltz (const double e, const double b, const double btheta, const int ncoll, bool verbose, double &vx, double &vy, double &vz, double &dl, double &dt, double &alpha, double &eta, double &vxerr, double &vyerr, double &vzerr, double &dlerr, double &dterr, double &alphaerr, double &etaerr, double &alphatof)

void	GenerateGasTable (const int numCollisions=10, const bool verbose=true)

Public Member Functions inherited from Garfield::MediumGas
	MediumGas ()

	~MediumGas ()

bool	IsGas () const

bool	SetComposition (const std::string gas1, const double f1=1., const std::string gas2="", const double f2=0., const std::string gas3="", const double f3=0., const std::string gas4="", const double f4=0., const std::string gas5="", const double f5=0., const std::string gas6="", const double f6=0.)

void	GetComposition (std::string &gas1, double &f1, std::string &gas2, double &f2, std::string &gas3, double &f3, std::string &gas4, double &f4, std::string &gas5, double &f5, std::string &gas6, double &f6)

void	GetComponent (const unsigned int &i, std::string &label, double &f)

void	SetAtomicNumber (const double &z)

double	GetAtomicNumber () const

void	SetAtomicWeight (const double &a)

double	GetAtomicWeight () const

void	SetNumberDensity (const double &n)

double	GetNumberDensity () const

void	SetMassDensity (const double &rho)

double	GetMassDensity () const

bool	LoadGasFile (const std::string &filename)

bool	WriteGasFile (const std::string &filename)

void	PrintGas ()

bool	LoadIonMobility (const std::string &filename)

void	SetExtrapolationMethodExcitationRates (const std::string extrLow, const std::string extrHigh)

void	SetExtrapolationMethodIonisationRates (const std::string extrLow, const std::string extrHigh)

void	SetInterpolationMethodExcitationRates (const int intrp)

void	SetInterpolationMethodIonisationRates (const int intrp)

double	ScaleElectricField (const double &e) const

double	UnScaleElectricField (const double &e) const

double	ScaleDiffusion (const double &d) const

double	ScaleDiffusionTensor (const double &d) const

double	ScaleTownsend (const double &alpha) const

double	ScaleAttachment (const double &eta) const

bool	GetPhotoabsorptionCrossSection (const double &e, double &sigma, const unsigned int &i)

Public Member Functions inherited from Garfield::Medium
	Medium ()

virtual	~Medium ()

int	GetId () const

std::string	GetName () const

virtual bool	IsGas () const

virtual bool	IsSemiconductor () const

void	SetTemperature (const double &t)

double	GetTemperature () const

void	SetPressure (const double &p)

double	GetPressure () const

void	SetDielectricConstant (const double &eps)

double	GetDielectricConstant () const

unsigned int	GetNumberOfComponents () const

virtual void	GetComponent (const unsigned int &i, std::string &label, double &f)

virtual void	SetAtomicNumber (const double &z)

virtual double	GetAtomicNumber () const

virtual void	SetAtomicWeight (const double &a)

virtual double	GetAtomicWeight () const

virtual void	SetNumberDensity (const double &n)

virtual double	GetNumberDensity () const

virtual void	SetMassDensity (const double &rho)

virtual double	GetMassDensity () const

virtual void	EnableDrift ()

void	DisableDrift ()

virtual void	EnablePrimaryIonisation ()

void	DisablePrimaryIonisation ()

bool	IsDriftable () const

bool	IsMicroscopic () const

bool	IsIonisable () const

void	SetW (const double &w)

double	GetW ()

void	SetFanoFactor (const double &f)

double	GetFanoFactor ()

virtual bool	ElectronVelocity (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &vx, double &vy, double &vz)

virtual bool	ElectronDiffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &dl, double &dt)

virtual bool	ElectronDiffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double cov[3][3])

virtual bool	ElectronTownsend (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &alpha)

virtual bool	ElectronAttachment (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &eta)

virtual double	GetElectronEnergy (const double px, const double py, const double pz, double &vx, double &vy, double &vz, const int band=0)

virtual void	GetElectronMomentum (const double e, double &px, double &py, double &pz, int &band)

virtual double	GetElectronNullCollisionRate (const int band=0)

virtual double	GetElectronCollisionRate (const double e, const int band=0)

virtual bool	GetElectronCollision (const double e, int &type, int &level, double &e1, double &dx, double &dy, double &dz, int &nion, int &ndxc, int &band)

virtual int	GetNumberOfIonisationProducts ()

virtual bool	GetIonisationProduct (const int i, int &type, double &energy)

virtual int	GetNumberOfDeexcitationProducts ()

virtual bool	GetDeexcitationProduct (const int i, double &t, double &s, int &type, double &energy)

virtual bool	HoleVelocity (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &vx, double &vy, double &vz)

virtual bool	HoleDiffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &dl, double &dt)

virtual bool	HoleDiffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double cov[3][3])

virtual bool	HoleTownsend (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &alpha)

virtual bool	HoleAttachment (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &eta)

virtual bool	IonVelocity (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &vx, double &vy, double &vz)

virtual bool	IonDiffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &dl, double &dt)

virtual bool	IonDissociation (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &diss)

void	SetFieldGrid (double emin, double emax, int ne, bool logE, double bmin=0., double bmax=0., int nb=1, double amin=0., double amax=0., int na=1)

void	SetFieldGrid (const std::vector< double > &efields, const std::vector< double > &bfields, const std::vector< double > &angles)

void	GetFieldGrid (std::vector< double > &efields, std::vector< double > &bfields, std::vector< double > &angles)

bool	GetElectronVelocityE (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &v)

bool	GetElectronVelocityExB (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &v)

bool	GetElectronVelocityB (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &v)

bool	GetElectronLongitudinalDiffusion (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &dl)

bool	GetElectronTransverseDiffusion (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &dt)

bool	GetElectronTownsend (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &alpha)

bool	GetElectronAttachment (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &eta)

bool	GetHoleVelocityE (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &v)

bool	GetHoleVelocityExB (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &v)

bool	GetHoleVelocityB (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &v)

bool	GetHoleLongitudinalDiffusion (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &dl)

bool	GetHoleTransverseDiffusion (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &dt)

bool	GetHoleTownsend (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &alpha)

bool	GetHoleAttachment (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &eta)

bool	GetIonMobility (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &mu)

bool	GetIonLongitudinalDiffusion (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &dl)

bool	GetIonTransverseDiffusion (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &dt)

bool	GetIonDissociation (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, double &diss)

void	ResetElectronVelocity ()

void	ResetElectronDiffusion ()

void	ResetElectronTownsend ()

void	ResetElectronAttachment ()

void	ResetHoleVelocity ()

void	ResetHoleDiffusion ()

void	ResetHoleTownsend ()

void	ResetHoleAttachment ()

void	ResetIonMobility ()

void	ResetIonDiffusion ()

void	ResetIonDissociation ()

bool	SetIonMobility (const unsigned int &ie, const unsigned int &ib, const unsigned int &ia, const double &mu)

bool	SetIonMobility (const std::vector< double > &fields, const std::vector< double > &mobilities)

void	SetExtrapolationMethodVelocity (const std::string &extrLow, const std::string &extrHigh)

void	SetExtrapolationMethodDiffusion (const std::string &extrLow, const std::string &extrHigh)

void	SetExtrapolationMethodTownsend (const std::string &extrLow, const std::string &extrHigh)

void	SetExtrapolationMethodAttachment (const std::string &extrLow, const std::string &extrHigh)

void	SetExtrapolationMethodIonMobility (const std::string &extrLow, const std::string &extrHigh)

void	SetExtrapolationMethodIonDissociation (const std::string &extrLow, const std::string &extrHigh)

void	SetInterpolationMethodVelocity (const unsigned int &intrp)

void	SetInterpolationMethodDiffusion (const unsigned int &intrp)

void	SetInterpolationMethodTownsend (const unsigned int &intrp)

void	SetInterpolationMethodAttachment (const unsigned int &intrp)

void	SetInterpolationMethodIonMobility (const unsigned int &intrp)

void	SetInterpolationMethodIonDissociation (const unsigned int &intrp)

virtual double	ScaleElectricField (const double &e) const

virtual double	UnScaleElectricField (const double &e) const

virtual double	ScaleVelocity (const double &v) const

virtual double	ScaleDiffusion (const double &d) const

virtual double	ScaleDiffusionTensor (const double &d) const

virtual double	ScaleTownsend (const double &alpha) const

virtual double	ScaleAttachment (const double &eta) const

virtual double	ScaleDissociation (const double &diss) const

virtual bool	GetOpticalDataRange (double &emin, double &emax, const unsigned int &i=0)

virtual bool	GetDielectricFunction (const double &e, double &eps1, double &eps2, const unsigned int &i=0)

virtual bool	GetPhotoAbsorptionCrossSection (const double &e, double &sigma, const unsigned int &i=0)

virtual double	GetPhotonCollisionRate (const double &e)

virtual bool	GetPhotonCollision (const double e, int &type, int &level, double &e1, double &ctheta, int &nsec, double &esec)

void	EnableDebugging ()

void	DisableDebugging ()

Public Attributes
double	fit3d4p

double	fitHigh4p

double	fit3dQCO2

double	fit3dEtaCO2

double	fit3dQCH4

double	fit3dEtaCH4

double	fit3dQC2H6

double	fit3dEtaC2H6

double	fit4pEtaCH4

double	fit4pEtaC2H6

double	fit4sEtaC2H6

double	fitLineCut

Additional Inherited Members
Protected Member Functions inherited from Garfield::MediumGas
bool	GetGasInfo (const std::string gasname, double &a, double &z) const

bool	GetGasName (const int gasnumber, const int version, std::string &gasname)

bool	GetGasName (std::string input, std::string &gasname) const

bool	GetGasNumberGasFile (const std::string input, int &number) const

Protected Member Functions inherited from Garfield::Medium
double	Interpolate1D (const double &e, const std::vector< double > &table, const std::vector< double > &fields, const unsigned int &intpMeth, const int &jExtr, const int &iExtr)

bool	GetExtrapolationIndex (std::string extrStr, unsigned int &extrNb)

void	CloneTable (std::vector< std::vector< std::vector< double > > > &tab, const std::vector< double > &efields, const std::vector< double > &bfields, const std::vector< double > &angles, const unsigned int &intp, const unsigned int &extrLow, const unsigned int &extrHigh, const double init, const std::string label)

void	CloneTensor (std::vector< std::vector< std::vector< std::vector< double > > > > &tab, const unsigned int &n, const std::vector< double > &efields, const std::vector< double > &bfields, const std::vector< double > &angles, const unsigned int &intp, const unsigned int &extrLow, const unsigned int &extrHigh, const double &init, const std::string &label)

void	InitParamArrays (const unsigned int &eRes, const unsigned int &bRes, const unsigned int &aRes, std::vector< std::vector< std::vector< double > > > &tab, const double &val)

void	InitParamTensor (const unsigned int &eRes, const unsigned int &bRes, const unsigned int &aRes, const unsigned int &tRes, std::vector< std::vector< std::vector< std::vector< double > > > > &tab, const double &val)

Protected Attributes inherited from Garfield::MediumGas
std::string	gas [m_nMaxGases]

double	fraction [m_nMaxGases]

double	atWeight [m_nMaxGases]

double	atNum [m_nMaxGases]

bool	usePenning

double	rPenningGlobal

double	rPenningGas [m_nMaxGases]

double	lambdaPenningGlobal

double	lambdaPenningGas [m_nMaxGases]

double	pressureTable

double	temperatureTable

std::vector< std::vector< std::vector< double > > >	tabTownsendNoPenning

bool	m_hasExcRates

bool	m_hasIonRates

std::vector< std::vector< std::vector< std::vector< double > > > >	tabExcRates

std::vector< std::vector< std::vector< std::vector< double > > > >	tabIonRates

int	nExcListElements

std::vector< excListElement >	excitationList

int	nIonListElements

std::vector< ionListElement >	ionisationList

unsigned int	m_extrLowExcRates

unsigned int	m_extrHighExcRates

unsigned int	m_extrLowIonRates

unsigned int	m_extrHighIonRates

unsigned int	m_intpExcRates

unsigned int	m_intpIonRates

Protected Attributes inherited from Garfield::Medium
std::string	m_className

int	m_id

std::string	m_name

double	m_temperature

double	m_pressure

double	m_epsilon

unsigned int	m_nComponents

double	m_z

double	m_a

double	m_density

bool	m_driftable

bool	m_microscopic

bool	m_ionisable

double	m_w

double	m_fano

bool	m_isChanged

bool	m_debug

unsigned int	m_nEfields

unsigned int	m_nBfields

unsigned int	m_nAngles

std::vector< double >	eFields

std::vector< double >	bFields

std::vector< double >	bAngles

bool	m_map2d

bool	m_hasElectronVelocityE

bool	m_hasElectronVelocityB

bool	m_hasElectronVelocityExB

bool	m_hasElectronDiffLong

bool	m_hasElectronDiffTrans

bool	m_hasElectronDiffTens

bool	m_hasElectronTownsend

bool	m_hasElectronAttachment

std::vector< std::vector< std::vector< double > > >	tabElectronVelocityE

std::vector< std::vector< std::vector< double > > >	tabElectronVelocityExB

std::vector< std::vector< std::vector< double > > >	tabElectronVelocityB

std::vector< std::vector< std::vector< double > > >	tabElectronDiffLong

std::vector< std::vector< std::vector< double > > >	tabElectronDiffTrans

std::vector< std::vector< std::vector< double > > >	tabElectronTownsend

std::vector< std::vector< std::vector< double > > >	tabElectronAttachment

std::vector< std::vector< std::vector< std::vector< double > > > >	tabElectronDiffTens

bool	m_hasHoleVelocityE

bool	m_hasHoleVelocityB

bool	m_hasHoleVelocityExB

bool	m_hasHoleDiffLong

bool	m_hasHoleDiffTrans

bool	m_hasHoleDiffTens

bool	m_hasHoleTownsend

bool	m_hasHoleAttachment

std::vector< std::vector< std::vector< double > > >	tabHoleVelocityE

std::vector< std::vector< std::vector< double > > >	tabHoleVelocityExB

std::vector< std::vector< std::vector< double > > >	tabHoleVelocityB

std::vector< std::vector< std::vector< double > > >	tabHoleDiffLong

std::vector< std::vector< std::vector< double > > >	tabHoleDiffTrans

std::vector< std::vector< std::vector< double > > >	tabHoleTownsend

std::vector< std::vector< std::vector< double > > >	tabHoleAttachment

std::vector< std::vector< std::vector< std::vector< double > > > >	tabHoleDiffTens

bool	m_hasIonMobility

bool	m_hasIonDiffLong

bool	m_hasIonDiffTrans

bool	m_hasIonDissociation

std::vector< std::vector< std::vector< double > > >	tabIonMobility

std::vector< std::vector< std::vector< double > > >	tabIonDiffLong

std::vector< std::vector< std::vector< double > > >	tabIonDiffTrans

std::vector< std::vector< std::vector< double > > >	tabIonDissociation

int	thrElectronTownsend

int	thrElectronAttachment

int	thrHoleTownsend

int	thrHoleAttachment

int	thrIonDissociation

unsigned int	m_extrLowVelocity

unsigned int	m_extrHighVelocity

unsigned int	m_extrLowDiffusion

unsigned int	m_extrHighDiffusion

unsigned int	m_extrLowTownsend

unsigned int	m_extrHighTownsend

unsigned int	m_extrLowAttachment

unsigned int	m_extrHighAttachment

unsigned int	m_extrLowMobility

unsigned int	m_extrHighMobility

unsigned int	m_extrLowDissociation

unsigned int	m_extrHighDissociation

unsigned int	m_intpVelocity

unsigned int	m_intpDiffusion

unsigned int	m_intpTownsend

unsigned int	m_intpAttachment

unsigned int	m_intpMobility

unsigned int	m_intpDissociation

Static Protected Attributes inherited from Garfield::MediumGas
static const unsigned int	m_nMaxGases = 6

Static Protected Attributes inherited from Garfield::Medium
static int	m_idCounter = -1

Detailed Description

Definition at line 10 of file MediumMagboltz.hh.

Constructor & Destructor Documentation

◆ MediumMagboltz()

Garfield::MediumMagboltz::MediumMagboltz ( )

Definition at line 23 of file MediumMagboltz.cc.

    : MediumGas(),
      eFinal(40.),
      eStep(eFinal / nEnergySteps),
      eHigh(1.e4),
      eHighLog(log(eHigh)),
      lnStep(1.),
      useAutoAdjust(true),
      useCsOutput(false),
      nTerms(0),
      useAnisotropic(true),
      nPenning(0),
      useDeexcitation(false),
      useRadTrap(true),
      nDeexcitations(0),
      nIonisationProducts(0),
      nDeexcitationProducts(0),
      useOpalBeaty(true),
      useGreenSawada(false),
      eFinalGamma(20.),
      eStepGamma(eFinalGamma / nEnergyStepsGamma) {
 
  fit3d4p = fitHigh4p = 1.;
  fit3dQCO2 = fit3dQCH4 = fit3dQC2H6 = 1.;
  fit3dEtaCO2 = fit3dEtaCH4 = fit3dEtaC2H6 = 0.5;
  fit4pEtaCH4 = fit4pEtaC2H6 = 0.5;
  fit4sEtaC2H6 = 0.5;
  fitLineCut = 1000;
 
  m_className = "MediumMagboltz";
 
  // Set physical constants in Magboltz common blocks.
  Magboltz::cnsts_.echarg = ElementaryCharge * 1.e-15;
  Magboltz::cnsts_.emass = ElectronMassGramme;
  Magboltz::cnsts_.amu = AtomicMassUnit;
  Magboltz::cnsts_.pir2 = BohrRadius * BohrRadius * Pi;
  Magboltz::inpt_.ary = RydbergEnergy;
 
  // Set parameters in Magboltz common blocks.
  Magboltz::inpt_.nGas = m_nComponents;
  Magboltz::inpt_.nStep = nEnergySteps;
  // Select the scattering model.
  Magboltz::inpt_.nAniso = 2;
  // Max. energy [eV]
  Magboltz::inpt_.efinal = eFinal;
  // Energy step size [eV]
  Magboltz::inpt_.estep = eStep;
  // Temperature and pressure
  Magboltz::inpt_.akt = BoltzmannConstant * m_temperature;
  Magboltz::inpt_.tempc = m_temperature - ZeroCelsius;
  Magboltz::inpt_.torr = m_pressure;
  // Disable Penning transfer.
  Magboltz::inpt_.ipen = 0;
 
  // Initialise Penning parameters
  for (int i = nMaxLevels; i--;) {
    rPenning[i] = 0.;
    lambdaPenning[i] = 0.;
  }
 
  m_isChanged = true;
 
  EnableDrift();
  EnablePrimaryIonisation();
  m_microscopic = true;
 
  // Initialize the collision counters.
  nCollisionsDetailed.clear();
  for (int i = nCsTypes; i--;) nCollisions[i] = 0;
  for (int i = nCsTypesGamma; i--;) nPhotonCollisions[i] = 0;
 
  ionProducts.clear();
  dxcProducts.clear();
 
  for (unsigned int i = 0; i < m_nMaxGases; ++i) scaleExc[i] = 1.;
}

◆ ~MediumMagboltz()

Garfield::MediumMagboltz::~MediumMagboltz ( )

inline

Definition at line 16 of file MediumMagboltz.hh.

16{}

Member Function Documentation

◆ ComputeDeexcitation()

void Garfield::MediumMagboltz::ComputeDeexcitation	(	int	iLevel,
		int &	fLevel
	)

Definition at line 5095 of file MediumMagboltz.cc.

                                                                {
 
  if (!useDeexcitation) {
    std::cerr << m_className << "::ComputeDeexcitation:\n";
    std::cerr << "    Deexcitation is disabled.\n";
    return;
  }
 
  // Make sure that the tables are updated.
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::ComputeDeexcitation:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return;
    }
    m_isChanged = false;
  }
 
  if (iLevel < 0 || iLevel >= nTerms) {
    std::cerr << m_className << "::ComputeDeexcitation:\n";
    std::cerr << "    Level index is out of range.\n";
    return;
  }
 
  iLevel = iDeexcitation[iLevel];
  if (iLevel < 0 || iLevel >= nDeexcitations) {
    std::cerr << m_className << "::ComputeDeexcitation:\n";
    std::cerr << "    Level is not deexcitable.\n";
    return;
  }
 
  ComputeDeexcitationInternal(iLevel, fLevel);
  if (fLevel >= 0 && fLevel < nDeexcitations) {
    fLevel = deexcitations[fLevel].level;
  }
}

◆ DisableAnisotropicScattering()

void Garfield::MediumMagboltz::DisableAnisotropicScattering ( )

inline

Definition at line 38 of file MediumMagboltz.hh.

                                      {
    useAnisotropic = false;
    m_isChanged = true;
  }

◆ DisableCrossSectionOutput()

void Garfield::MediumMagboltz::DisableCrossSectionOutput ( )

inline

Definition at line 66 of file MediumMagboltz.hh.

66{ useCsOutput = false; }

◆ DisableDeexcitation()

void Garfield::MediumMagboltz::DisableDeexcitation ( )

inline

Definition at line 50 of file MediumMagboltz.hh.

50{ useDeexcitation = false; }

◆ DisableEnergyRangeAdjustment()

void Garfield::MediumMagboltz::DisableEnergyRangeAdjustment ( )

inline

Definition at line 31 of file MediumMagboltz.hh.

31{ useAutoAdjust = false; }

◆ DisablePenningTransfer() [1/2]

void Garfield::MediumMagboltz::DisablePenningTransfer ( )

Definition at line 317 of file MediumMagboltz.cc.

                                            {
 
  for (int i = nTerms; i--;) {
    rPenning[i] = 0.;
    lambdaPenning[i] = 0.;
  }
  rPenningGlobal = 0.;
  lambdaPenningGlobal = 0.;
 
  for (unsigned int i = 0; i < m_nMaxGases; ++i) {
    rPenningGas[i] = 0.;
    lambdaPenningGas[i] = 0.;
  }
 
  usePenning = false;
}

◆ DisablePenningTransfer() [2/2]

void Garfield::MediumMagboltz::DisablePenningTransfer ( std::string gasname )

Definition at line 334 of file MediumMagboltz.cc.

                                                             {
 
  // Get the "standard" name of this gas.
  if (!GetGasName(gasname, gasname)) {
    std::cerr << m_className << "::DisablePenningTransfer:\n";
    std::cerr << "    Gas " << gasname << " is not defined.\n";
    return;
  }
 
  // Look for this gas in the present gas mixture.
  bool found = false;
  int iGas = -1;
  for (unsigned int i = 0; i < m_nComponents; ++i) {
    if (gas[i] == gasname) {
      rPenningGas[i] = 0.;
      lambdaPenningGas[i] = 0.;
      found = true;
      iGas = i;
      break;
    }
  }
 
  if (!found) {
    std::cerr << m_className << "::DisablePenningTransfer:\n";
    std::cerr << "    Specified gas (" << gasname
              << ") is not part of the present gas mixture.\n";
    return;
  }
 
  int nLevelsFound = 0;
  for (int i = nTerms; i--;) {
    if (int(csType[i] / nCsTypes) == iGas) {
      rPenning[i] = 0.;
      lambdaPenning[i] = 0.;
    } else {
      if (csType[i] % nCsTypes == ElectronCollisionTypeExcitation &&
          rPenning[i] > Small) {
        ++nLevelsFound;
      }
    }
  }
 
  if (nLevelsFound <= 0) {
    // There are no more excitation levels with r > 0.
    std::cout << m_className << "::DisablePenningTransfer:\n";
    std::cout << "    Penning transfer globally switched off.\n";
    usePenning = false;
  }
}

◆ DisableRadiationTrapping()

void Garfield::MediumMagboltz::DisableRadiationTrapping ( )

inline

Definition at line 53 of file MediumMagboltz.hh.

53{ useRadTrap = false; }

◆ EnableAnisotropicScattering()

void Garfield::MediumMagboltz::EnableAnisotropicScattering ( )

inline

Definition at line 34 of file MediumMagboltz.hh.

                                     {
    useAnisotropic = true;
    m_isChanged = true;
  }

◆ EnableCrossSectionOutput()

void Garfield::MediumMagboltz::EnableCrossSectionOutput ( )

inline

Definition at line 65 of file MediumMagboltz.hh.

65{ useCsOutput = true; }

◆ EnableDeexcitation()

void Garfield::MediumMagboltz::EnableDeexcitation ( )

Definition at line 177 of file MediumMagboltz.cc.

                                        {
 
  if (usePenning) {
    std::cout << m_className << "::EnableDeexcitation:\n";
    std::cout << "    Penning transfer will be switched off.\n";
  }
  // if (useRadTrap) {
  //   std::cout << "    Radiation trapping is switched on.\n";
  // } else {
  //   std::cout << "    Radiation trapping is switched off.\n";
  // }
  usePenning = false;
  useDeexcitation = true;
  m_isChanged = true;
  nDeexcitationProducts = 0;
}

◆ EnableEnergyRangeAdjustment()

void Garfield::MediumMagboltz::EnableEnergyRangeAdjustment ( )

inline

Definition at line 30 of file MediumMagboltz.hh.

30{ useAutoAdjust = true; }

◆ EnablePenningTransfer() [1/2]

void Garfield::MediumMagboltz::EnablePenningTransfer	(	const double	r,
		const double	lambda
	)

Definition at line 206 of file MediumMagboltz.cc.

                                                                {
 
  if (r < 0. || r > 1.) {
    std::cerr << m_className << "::EnablePenningTransfer:\n";
    std::cerr << "    Penning transfer probability must be "
              << " in the range [0, 1].\n";
    return;
  }
 
  rPenningGlobal = r;
  if (lambda < Small) {
    lambdaPenningGlobal = 0.;
  } else {
    lambdaPenningGlobal = lambda;
  }
 
  std::cout << m_className << "::EnablePenningTransfer:\n";
  std::cout << "    Global Penning transfer parameters set to: \n";
  std::cout << "    r      = " << rPenningGlobal << "\n";
  std::cout << "    lambda = " << lambdaPenningGlobal << " cm\n";
 
  for (int i = nTerms; i--;) {
    rPenning[i] = rPenningGlobal;
    lambdaPenning[i] = lambdaPenningGlobal;
  }
 
  if (useDeexcitation) {
    std::cout << m_className << "::EnablePenningTransfer:\n";
    std::cout << "    Deexcitation handling will be switched off.\n";
  }
  usePenning = true;
}

Referenced by GarfieldPhysics::InitializePhysics().

◆ EnablePenningTransfer() [2/2]

void Garfield::MediumMagboltz::EnablePenningTransfer	(	const double	r,
		const double	lambda,
		std::string	gasname
	)

Definition at line 240 of file MediumMagboltz.cc.

                                                              {
 
  if (r < 0. || r > 1.) {
    std::cerr << m_className << "::EnablePenningTransfer:\n";
    std::cerr << "    Penning transfer probability must be "
              << " in the range [0, 1].\n";
    return;
  }
 
  // Get the "standard" name of this gas.
  if (!GetGasName(gasname, gasname)) {
    std::cerr << m_className << "::EnablePenningTransfer:\n";
    std::cerr << "    Unknown gas name.\n";
    return;
  }
 
  // Look for this gas in the present gas mixture.
  bool found = false;
  int iGas = -1;
  for (unsigned int i = 0; i < m_nComponents; ++i) {
    if (gas[i] == gasname) {
      rPenningGas[i] = r;
      if (lambda < Small) {
        lambdaPenningGas[i] = 0.;
      } else {
        lambdaPenningGas[i] = lambda;
      }
      found = true;
      iGas = i;
      break;
    }
  }
 
  if (!found) {
    std::cerr << m_className << "::EnablePenningTransfer:\n";
    std::cerr << "    Specified gas (" << gasname
              << ") is not part of the present gas mixture.\n";
    return;
  }
 
  // Make sure that the collision rate table is updated.
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::EnablePenningTransfer:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return;
    }
    m_isChanged = false;
  }
 
  int nLevelsFound = 0;
  for (int i = nTerms; i--;) {
    if (int(csType[i] / nCsTypes) == iGas) {
      if (csType[i] % nCsTypes == ElectronCollisionTypeExcitation) {
        ++nLevelsFound;
      }
      rPenning[i] = rPenningGas[iGas];
      lambdaPenning[i] = lambdaPenningGas[iGas];
    }
  }
 
  if (nLevelsFound > 0) {
    std::cout << m_className << "::EnablePenningTransfer:\n";
    std::cout << "    Penning transfer parameters for " << nLevelsFound
              << " excitation levels set to:\n";
    std::cout << "      r      = " << rPenningGas[iGas] << "\n";
    std::cout << "      lambda = " << lambdaPenningGas[iGas] << " cm\n";
  } else {
    std::cerr << m_className << "::EnablePenningTransfer:\n";
    std::cerr << "    Specified gas (" << gasname
              << ") has no excitation levels in the present energy range.\n";
  }
 
  usePenning = true;
}

◆ EnableRadiationTrapping()

void Garfield::MediumMagboltz::EnableRadiationTrapping ( )

Definition at line 194 of file MediumMagboltz.cc.

                                             {
 
  useRadTrap = true;
  if (!useDeexcitation) {
    std::cout << m_className << "::EnableRadiationTrapping:\n";
    std::cout << "    Radiation trapping is enabled"
              << " but de-excitation is not.\n";
  } else {
    m_isChanged = true;
  }
}

◆ GenerateGasTable()

void Garfield::MediumMagboltz::GenerateGasTable	(	const int	numCollisions = `10`,
		const bool	verbose = `true`
	)

Definition at line 5565 of file MediumMagboltz.cc.

                                                                           {
 
  // Set the reference pressure and temperature.
  pressureTable = m_pressure;
  temperatureTable = m_temperature;
 
  // Initialize the parameter arrays.
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronVelocityE, 0.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronVelocityB, 0.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronVelocityExB, 0.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronDiffLong, 0.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronDiffTrans, 0.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronTownsend, -30.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabTownsendNoPenning, -30.);
  InitParamArrays(m_nEfields, m_nBfields, m_nAngles, tabElectronAttachment, -30.);
 
  m_hasElectronVelocityE = true;
  m_hasElectronVelocityB = true;
  m_hasElectronVelocityExB = true;
  m_hasElectronDiffLong = true;
  m_hasElectronDiffTrans = true;
  m_hasElectronTownsend = true;
  m_hasElectronAttachment = true;
 
  m_hasExcRates = false;
  tabExcRates.clear();
  excitationList.clear();
  nExcListElements = 0;
  m_hasIonRates = false;
  tabIonRates.clear();
  ionisationList.clear();
  nIonListElements = 0;
 
  m_hasIonMobility = false;
  m_hasIonDissociation = false;
  m_hasIonDiffLong = false;
  m_hasIonDiffTrans = false;
 
  // gasBits = "TFTTFTFTTTFFFFFF";
  // The version number is 11 because there are slight
  // differences between the way these gas files are written
  // and the ones from Garfield. This is mainly in the way
  // the gas tables are stored.
  // versionNumber = 11;
 
  double vx = 0., vy = 0., vz = 0.;
  double difl = 0., dift = 0.;
  double alpha = 0., eta = 0.;
  double vxerr = 0., vyerr = 0., vzerr = 0.;
  double diflerr = 0., difterr = 0.;
  double alphaerr = 0., etaerr = 0.;
  double alphatof = 0.;
 
  // Run through the grid of E- and B-fields and angles.
  for (unsigned int i = 0; i < m_nEfields; ++i) {
    for (unsigned int j = 0; j < m_nAngles; ++j) {
      for (unsigned int k = 0; k < m_nBfields; ++k) {
        if (m_debug) {
          std::cout << m_className << "::GenerateGasTable:\n";
          std::cout << "    E = " << eFields[i] << " V/cm, B = " << bFields[k]
                    << " T, angle: " << bAngles[j] << " rad\n";
        }
        RunMagboltz(eFields[i], bFields[k], bAngles[j], numColl, verbose, vx,
                    vy, vz, difl, dift, alpha, eta, vxerr, vyerr, vzerr,
                    diflerr, difterr, alphaerr, etaerr, alphatof);
        tabElectronVelocityE[j][k][i] = vz;
        tabElectronVelocityExB[j][k][i] = vy;
        tabElectronVelocityB[j][k][i] = vx;
        tabElectronDiffLong[j][k][i] = difl;
        tabElectronDiffTrans[j][k][i] = dift;
        if (alpha > 0.) {
          tabElectronTownsend[j][k][i] = log(alpha);
          tabTownsendNoPenning[j][k][i] = log(alpha);
        } else {
          tabElectronTownsend[j][k][i] = -30.;
          tabTownsendNoPenning[j][k][i] = -30.;
        }
        if (eta > 0.) {
          tabElectronAttachment[j][k][i] = log(eta);
        } else {
          tabElectronAttachment[j][k][i] = -30.;
        }
      }
    }
  }
}

◆ GetDeexcitationProduct()

bool Garfield::MediumMagboltz::GetDeexcitationProduct	(	const int	i,
		double &	t,
		double &	s,
		int &	type,
		double &	energy
	)

virtual

Reimplemented from Garfield::Medium.

Definition at line 903 of file MediumMagboltz.cc.

                                                                       {
 
  if (i < 0 || i >= nDeexcitationProducts || !(useDeexcitation || usePenning))
    return false;
  t = dxcProducts[i].t;
  s = dxcProducts[i].s;
  type = dxcProducts[i].type;
  energy = dxcProducts[i].energy;
  return true;
}

◆ GetElectronCollision()

bool Garfield::MediumMagboltz::GetElectronCollision	(	const double	e,
		int &	type,
		int &	level,
		double &	e1,
		double &	dx,
		double &	dy,
		double &	dz,
		int &	nion,
		int &	ndxc,
		int &	band
	)

virtual

Reimplemented from Garfield::Medium.

Definition at line 651 of file MediumMagboltz.cc.

                                                     {
 
  // Check if the electron energy is within the currently set range.
  if (e > eFinal && useAutoAdjust) {
    std::cerr << m_className << "::GetElectronCollision:\n";
    std::cerr << "    Provided electron energy  (" << e
              << " eV) exceeds current energy range  (" << eFinal << " eV).\n";
    std::cerr << "    Increasing energy range to " << 1.05 * e << " eV.\n";
    SetMaxElectronEnergy(1.05 * e);
  } else if (e <= 0.) {
    std::cerr << m_className << "::GetElectronCollision:\n";
    std::cerr << "    Electron energy must be greater than zero.\n";
    return false;
  }
 
  // If necessary, update the collision rates table.
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetElectronCollision:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return false;
    }
    m_isChanged = false;
  }
 
  if (m_debug && band > 0) {
    std::cerr << m_className << "::GetElectronCollision:\n";
    std::cerr << "    Warning: unexpected band index.\n";
  }
 
  double angCut = 1.;
  double angPar = 0.5;
 
  if (e <= eHigh) {
    // Linear binning
    // Get the energy interval.
    int iE = int(e / eStep);
    if (iE >= nEnergySteps) iE = nEnergySteps - 1;
    if (iE < 0) iE = 0;
 
    // Sample the scattering process.
    const double r = RndmUniform();
    int iLow = 0;
    int iUp = nTerms - 1;
    if (r <= cf[iE][iLow]) {
      level = iLow;
    } else if (r >= cf[iE][iUp]) {
      level = iUp;
    } else {
      int iMid;
      while (iUp - iLow > 1) {
        iMid = (iLow + iUp) >> 1;
        if (r < cf[iE][iMid]) {
          iUp = iMid;
        } else {
          iLow = iMid;
        }
      }
      level = iUp;
    }
    // Get the angular distribution parameters.
    angCut = scatCut[iE][level];
    angPar = scatParameter[iE][level];
  } else {
    // Logarithmic binning
    // Get the energy interval.
    int iE = int(log(e / eHigh) / lnStep);
    if (iE < 0) iE = 0;
    if (iE >= nEnergyStepsLog) iE = nEnergyStepsLog - 1;
    // Sample the scattering process.
    const double r = RndmUniform();
    int iLow = 0;
    int iUp = nTerms - 1;
    if (r <= cfLog[iE][iLow]) {
      level = iLow;
    } else if (r >= cfLog[iE][iUp]) {
      level = iUp;
    } else {
      int iMid;
      while (iUp - iLow > 1) {
        iMid = (iLow + iUp) >> 1;
        if (r < cfLog[iE][iMid]) {
          iUp = iMid;
        } else {
          iLow = iMid;
        }
      }
      level = iUp;
    }
    // Get the angular distribution parameters.
    angCut = scatCutLog[iE][level];
    angPar = scatParameterLog[iE][level];
  }
 
  // Extract the collision type.
  type = csType[level] % nCsTypes;
  const int igas = int(csType[level] / nCsTypes);
  // Increase the collision counters.
  ++nCollisions[type];
  ++nCollisionsDetailed[level];
 
  // Get the energy loss for this process.
  double loss = energyLoss[level];
  nion = ndxc = 0;
 
  if (type == ElectronCollisionTypeIonisation) {
    // Sample the secondary electron energy according to
    // the Opal-Beaty-Peterson parameterisation.
    double esec = 0.;
    if (useOpalBeaty) {
      // Get the splitting parameter.
      const double w = wOpalBeaty[level];
      esec = w * tan(RndmUniform() * atan(0.5 * (e - loss) / w));
      // Rescaling (SST)
      // esec = w * pow(esec / w, 0.9524);
    } else if (useGreenSawada) {
      const double w = gsGreenSawada[igas] * e / (e + gbGreenSawada[igas]);
      const double esec0 =
          tsGreenSawada[igas] - taGreenSawada[igas] / (e + tbGreenSawada[igas]);
      const double r = RndmUniform();
      esec = esec0 + w * tan((r - 1.) * atan(esec0 / w) +
                             r * atan((0.5 * (e - loss) - esec0) / w));
    } else {
      esec = RndmUniform() * (e - loss);
    }
    if (esec <= 0) esec = Small;
    loss += esec;
    ionProducts.clear();
    // Add the secondary electron.
    ionProd newIonProd;
    newIonProd.type = IonProdTypeElectron;
    newIonProd.energy = esec;
    ionProducts.push_back(newIonProd);
    // Add the ion.
    newIonProd.type = IonProdTypeIon;
    newIonProd.energy = 0.;
    ionProducts.push_back(newIonProd);
    nIonisationProducts = nion = 2;
  } else if (type == ElectronCollisionTypeExcitation) {
    // if (gas[igas] == "CH4" && loss * rgas[igas] < 13.35 && e > 12.65) {
    //   if (RndmUniform() < 0.5) {
    //     loss = 8.55 + RndmUniform() * (13.3 - 8.55);
    //     loss /= rgas[igas];
    //   } else {
    //     loss = std::max(Small, RndmGaussian(loss * rgas[igas], 1.));
    //     loss /= rgas[igas];
    //   }
    // }
    // Follow the de-excitation cascade (if switched on).
    if (useDeexcitation && iDeexcitation[level] >= 0) {
      int fLevel = 0;
      ComputeDeexcitationInternal(iDeexcitation[level], fLevel);
      ndxc = nDeexcitationProducts;
    } else if (usePenning) {
      nDeexcitationProducts = 0;
      dxcProducts.clear();
      // Simplified treatment of Penning ionisation.
      // If the energy threshold of this level exceeds the
      // ionisation potential of one of the gases,
      // create a new electron (with probability rPenning).
      if (energyLoss[level] * rgas[igas] > minIonPot &&
          RndmUniform() < rPenning[level]) {
        // The energy of the secondary electron is assumed to be given by
        // the difference of excitation and ionisation threshold.
        double esec = energyLoss[level] * rgas[igas] - minIonPot;
        if (esec <= 0) esec = Small;
        // Add the secondary electron to the list.
        dxcProd newDxcProd;
        newDxcProd.t = 0.;
        newDxcProd.s = 0.;
        if (lambdaPenning[level] > Small) {
          // Uniform distribution within a sphere of radius lambda
          newDxcProd.s = lambdaPenning[level] * pow(RndmUniformPos(), 1. / 3.);
        }
        newDxcProd.energy = esec;
        newDxcProd.type = DxcProdTypeElectron;
        dxcProducts.push_back(newDxcProd);
        nDeexcitationProducts = ndxc = 1;
        ++nPenning;
      }
    }
  }
 
  // Make sure the energy loss is smaller than the energy.
  if (e < loss) loss = e - 0.0001;
 
  // Determine the scattering angle.
  double ctheta0 = 1. - 2. * RndmUniform();
  if (useAnisotropic) {
    switch (scatModel[level]) {
      case 0:
        break;
      case 1:
        ctheta0 = 1. - RndmUniform() * angCut;
        if (RndmUniform() > angPar) ctheta0 = -ctheta0;
        break;
      case 2:
        ctheta0 = (ctheta0 + angPar) / (1. + angPar * ctheta0);
        break;
      default:
        std::cerr << m_className << "::GetElectronCollision:\n";
        std::cerr << "    Unknown scattering model. \n";
        std::cerr << "    Using isotropic distribution.\n";
        break;
    }
  }
 
  const double s1 = rgas[igas];
  const double s2 = (s1 * s1) / (s1 - 1.);
  const double theta0 = acos(ctheta0);
  const double arg = std::max(1. - s1 * loss / e, Small);
  const double d = 1. - ctheta0 * sqrt(arg);
 
  // Update the energy.
  e1 = std::max(e * (1. - loss / (s1 * e) - 2. * d / s2), Small);
  double q = std::min(sqrt((e / e1) * arg) / s1, 1.);
  const double theta = asin(q * sin(theta0));
  double ctheta = cos(theta);
  if (ctheta0 < 0.) {
    const double u = (s1 - 1.) * (s1 - 1.) / arg;
    if (ctheta0 * ctheta0 > u) ctheta = -ctheta;
  }
  const double stheta = sin(theta);
  // Calculate the direction after the collision.
  dz = std::min(dz, 1.);
  const double argZ = sqrt(dx * dx + dy * dy);
 
  // Azimuth is chosen at random.
  const double phi = TwoPi * RndmUniform();
  const double cphi = cos(phi);
  const double sphi = sin(phi);
 
  if (argZ == 0.) {
    dz = ctheta;
    dx = cphi * stheta;
    dy = sphi * stheta;
  } else {
    const double a = stheta / argZ;
    const double dz1 = dz * ctheta + argZ * stheta * sphi;
    const double dy1 = dy * ctheta + a * (dx * cphi - dy * dz * sphi);
    const double dx1 = dx * ctheta - a * (dy * cphi + dx * dz * sphi);
    dz = dz1;
    dy = dy1;
    dx = dx1;
  }
 
  return true;
}

◆ GetElectronCollisionRate() [1/2]

double Garfield::MediumMagboltz::GetElectronCollisionRate	(	const double	e,
		const int	band
	)

virtual

Reimplemented from Garfield::Medium.

Definition at line 550 of file MediumMagboltz.cc.

                                                                {
 
  // Check if the electron energy is within the currently set range.
  if (e <= 0.) {
    std::cerr << m_className << "::GetElectronCollisionRate:\n";
    std::cerr << "    Electron energy must be greater than zero.\n";
    return cfTot[0];
  }
  if (e > eFinal && useAutoAdjust) {
    std::cerr << m_className << "::GetElectronCollisionRate:\n";
    std::cerr << "    Collision rate at " << e
              << " eV is not included in the current table.\n";
    std::cerr << "    Increasing energy range to " << 1.05 * e << " eV.\n";
    SetMaxElectronEnergy(1.05 * e);
  }
 
  // If necessary, update the collision rates table.
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetElectronCollisionRate:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return 0.;
    }
    m_isChanged = false;
  }
 
  if (m_debug && band > 0) {
    std::cerr << m_className << "::GetElectronCollisionRate:\n";
    std::cerr << "    Warning: unexpected band index.\n";
  }
 
  // Get the energy interval.
  int iE = 0;
  if (e <= eHigh) {
    // Linear binning
    iE = int(e / eStep);
    if (iE >= nEnergySteps) return cfTot[nEnergySteps - 1];
    if (iE < 0) return cfTot[0];
    return cfTot[iE];
  }
 
  // Logarithmic binning
  const double eLog = log(e);
  iE = int((eLog - eHighLog) / lnStep);
  // Calculate the collision rate by log-log interpolation.
  const double fmax = cfTotLog[iE];
  const double fmin = iE == 0 ? log(cfTot[nEnergySteps - 1]) : cfTotLog[iE - 1];
  const double emin = eHighLog + iE * lnStep;
  const double f = fmin + (eLog - emin) * (fmax - fmin) / lnStep;
  return exp(f);
}

Referenced by GetElectronCollisionRate().

◆ GetElectronCollisionRate() [2/2]

double Garfield::MediumMagboltz::GetElectronCollisionRate	(	const double	e,
		const int	level,
		const int	band
	)

Definition at line 603 of file MediumMagboltz.cc.

                                                                {
 
  // Check if the electron energy is within the currently set range.
  if (e <= 0.) {
    std::cerr << m_className << "::GetElectronCollisionRate:\n";
    std::cerr << "    Electron energy must be greater than zero.\n";
    return 0.;
  }
 
  // Check if the level exists.
  if (level < 0) {
    std::cerr << m_className << "::GetElectronCollisionRate:\n";
    std::cerr << "    Level must be greater than zero.\n";
    return 0.;
  } else if (level >= nTerms) {
    std::cerr << m_className << "::GetElectronCollisionRate:\n";
    std::cerr << "    Level " << level << " does not exist.\n";
    std::cerr << "    The present gas mixture has " << nTerms
              << " cross-section terms.\n";
    return 0.;
  }
 
  // Get the total scattering rate.
  double rate = GetElectronCollisionRate(e, band);
  // Get the energy interval.
  int iE = 0;
  if (e <= eHigh) {
    // Linear binning
    iE = int(e / eStep);
    if (iE >= nEnergySteps) return cfTot[nEnergySteps - 1];
    if (level == 0) {
      rate *= cf[iE][0];
    } else {
      rate *= cf[iE][level] - cf[iE][level - 1];
    }
  } else {
    // Logarithmic binning
    iE = int((log(e) - eHighLog) / lnStep);
    if (level == 0) {
      rate *= cfLog[iE][0];
    } else {
      rate *= cfLog[iE][level] - cfLog[iE][level - 1];
    }
  }
  return rate;
}

◆ GetElectronNullCollisionRate()

double Garfield::MediumMagboltz::GetElectronNullCollisionRate ( const int band )

virtual

Reimplemented from Garfield::Medium.

Definition at line 530 of file MediumMagboltz.cc.

                                                                  {
 
  // If necessary, update the collision rates table.
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetElectronNullCollisionRate:\n";
      std::cerr << "     Error calculating the collision rates table.\n";
      return 0.;
    }
    m_isChanged = false;
  }
 
  if (m_debug && band > 0) {
    std::cerr << m_className << "::GetElectronNullCollisionRate:\n";
    std::cerr << "    Warning: unexpected band index.\n";
  }
 
  return cfNull;
}

◆ GetIonisationProduct()

bool Garfield::MediumMagboltz::GetIonisationProduct	(	const int	i,
		int &	type,
		double &	energy
	)

virtual

Reimplemented from Garfield::Medium.

Definition at line 915 of file MediumMagboltz.cc.

                                                          {
 
  if (i < 0 || i >= nIonisationProducts) {
    std::cerr << m_className << "::GetIonisationProduct:\n";
    std::cerr << "    Index out of range.\n";
    return false;
  }
 
  type = ionProducts[i].type;
  energy = ionProducts[i].energy;
  return true;
}

◆ GetLevel()

bool Garfield::MediumMagboltz::GetLevel	(	const int	i,
		int &	ngas,
		int &	type,
		std::string &	descr,
		double &	e
	)

Definition at line 1127 of file MediumMagboltz.cc.

                                                           {
 
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetLevel:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return false;
    }
    m_isChanged = false;
  }
 
  if (i < 0 || i >= nTerms) {
    std::cerr << m_className << "::GetLevel:\n";
    std::cerr << "    Requested level (" << i << ") does not exist.\n";
    return false;
  }
 
  // Collision type
  type = csType[i] % nCsTypes;
  ngas = int(csType[i] / nCsTypes);
  // Description (from Magboltz)
  descr = std::string(50, ' ');
  for (int j = 50; j--;) descr[j] = description[i][j];
  // Threshold energy
  e = rgas[ngas] * energyLoss[i];
  if (m_debug) {
    std::cout << m_className << "::GetLevel:\n";
    std::cout << "    Level " << i << ": " << descr << "\n";
    std::cout << "    Type " << type << "\n",
        std::cout << "    Threshold energy: " << e << " eV\n";
    if (type == ElectronCollisionTypeExcitation && usePenning &&
        e > minIonPot) {
      std::cout << "    Penning transfer coefficient: " << rPenning[i] << "\n";
    } else if (type == ElectronCollisionTypeExcitation && useDeexcitation) {
      const int idxc = iDeexcitation[i];
      if (idxc < 0 || idxc >= nDeexcitations) {
        std::cout << "    Deexcitation cascade not implemented.\n";
        return true;
      }
      if (deexcitations[idxc].osc > 0.) {
        std::cout << "    Oscillator strength: " << deexcitations[idxc].osc
                  << "\n";
      }
      std::cout << "    Decay channels:\n";
      for (int j = 0; j < deexcitations[idxc].nChannels; ++j) {
        if (deexcitations[idxc].type[j] == DxcTypeRad) {
          std::cout << "      Radiative decay to ";
          if (deexcitations[idxc].final[j] < 0) {
            std::cout << "ground state: ";
          } else {
            std::cout << deexcitations[deexcitations[idxc].final[j]].label
                      << ": ";
          }
        } else if (deexcitations[idxc].type[j] == DxcTypeCollIon) {
          if (deexcitations[idxc].final[j] < 0) {
            std::cout << "      Penning ionisation: ";
          } else {
            std::cout << "      Associative ionisation: ";
          }
        } else if (deexcitations[idxc].type[j] == DxcTypeCollNonIon) {
          if (deexcitations[idxc].final[j] >= 0) {
            std::cout << "      Collision-induced transition to "
                      << deexcitations[deexcitations[idxc].final[j]].label
                      << ": ";
          } else {
            std::cout << "      Loss: ";
          }
        }
        if (j == 0) {
          std::cout << std::setprecision(5) << deexcitations[idxc].p[j] * 100.
                    << "%\n";
        } else {
          std::cout << std::setprecision(5) << (deexcitations[idxc].p[j] -
                                                deexcitations[idxc].p[j - 1]) *
                                                   100. << "%\n";
        }
      }
    }
  }
 
  return true;
}

◆ GetMaxElectronEnergy()

double Garfield::MediumMagboltz::GetMaxElectronEnergy ( ) const

inline

Definition at line 21 of file MediumMagboltz.hh.

21{ return eFinal; }

◆ GetMaxPhotonEnergy()

double Garfield::MediumMagboltz::GetMaxPhotonEnergy ( ) const

inline

Definition at line 26 of file MediumMagboltz.hh.

26{ return eFinalGamma; }

◆ GetNumberOfDeexcitationProducts()

int Garfield::MediumMagboltz::GetNumberOfDeexcitationProducts ( )

inlinevirtual

Reimplemented from Garfield::Medium.

Definition at line 88 of file MediumMagboltz.hh.

88{ return nDeexcitationProducts; }

◆ GetNumberOfElectronCollisions() [1/3]

int Garfield::MediumMagboltz::GetNumberOfElectronCollisions ( ) const

Definition at line 1092 of file MediumMagboltz.cc.

                                                        {
 
  int ncoll = 0;
  for (int j = nCsTypes; j--;) ncoll += nCollisions[j];
  return ncoll;
}

◆ GetNumberOfElectronCollisions() [2/3]

int Garfield::MediumMagboltz::GetNumberOfElectronCollisions ( const int level ) const

Definition at line 1211 of file MediumMagboltz.cc.

                                                                       {
 
  if (level < 0 || level >= nTerms) {
    std::cerr << m_className << "::GetNumberOfElectronCollisions:\n";
    std::cerr << "    Requested cross-section term (" << level
              << ") does not exist.\n";
    return 0;
  }
  return nCollisionsDetailed[level];
}

◆ GetNumberOfElectronCollisions() [3/3]

int Garfield::MediumMagboltz::GetNumberOfElectronCollisions	(	int &	nElastic,
		int &	nIonising,
		int &	nAttachment,
		int &	nInelastic,
		int &	nExcitation,
		int &	nSuperelastic
	)		const

Definition at line 1099 of file MediumMagboltz.cc.

                                                {
 
  nElastic = nCollisions[ElectronCollisionTypeElastic];
  nIonisation = nCollisions[ElectronCollisionTypeIonisation];
  nAttachment = nCollisions[ElectronCollisionTypeAttachment];
  nInelastic = nCollisions[ElectronCollisionTypeInelastic];
  nExcitation = nCollisions[ElectronCollisionTypeExcitation];
  nSuperelastic = nCollisions[ElectronCollisionTypeSuperelastic];
  return nElastic + nIonisation + nAttachment + nInelastic + nExcitation +
         nSuperelastic;
}

◆ GetNumberOfIonisationProducts()

int Garfield::MediumMagboltz::GetNumberOfIonisationProducts ( )

inlinevirtual

Reimplemented from Garfield::Medium.

Definition at line 85 of file MediumMagboltz.hh.

85{ return nIonisationProducts; }

◆ GetNumberOfLevels()

int Garfield::MediumMagboltz::GetNumberOfLevels ( )

Definition at line 1113 of file MediumMagboltz.cc.

                                      {
 
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetNumberOfLevels:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return 0;
    }
    m_isChanged = false;
  }
 
  return nTerms;
}

◆ GetNumberOfPenningTransfers()

int Garfield::MediumMagboltz::GetNumberOfPenningTransfers ( ) const

inline

Definition at line 112 of file MediumMagboltz.hh.

112{ return nPenning; }

◆ GetNumberOfPhotonCollisions() [1/2]

int Garfield::MediumMagboltz::GetNumberOfPhotonCollisions ( ) const

Definition at line 1222 of file MediumMagboltz.cc.

                                                      {
 
  int ncoll = 0;
  for (int j = nCsTypesGamma; j--;) ncoll += nPhotonCollisions[j];
  return ncoll;
}

◆ GetNumberOfPhotonCollisions() [2/2]

int Garfield::MediumMagboltz::GetNumberOfPhotonCollisions	(	int &	nElastic,
		int &	nIonising,
		int &	nInelastic
	)		const

Definition at line 1229 of file MediumMagboltz.cc.

                                                                       {
 
  nElastic = nPhotonCollisions[0];
  nIonising = nPhotonCollisions[1];
  nInelastic = nPhotonCollisions[2];
  return nElastic + nIonising + nInelastic;
}

◆ GetPhotonCollision()

bool Garfield::MediumMagboltz::GetPhotonCollision	(	const double	e,
		int &	type,
		int &	level,
		double &	e1,
		double &	ctheta,
		int &	nsec,
		double &	esec
	)

virtual

Reimplemented from Garfield::Medium.

Definition at line 974 of file MediumMagboltz.cc.

                                                      {
 
  if (e > eFinalGamma && useAutoAdjust) {
    std::cerr << m_className << "::GetPhotonCollision:\n";
    std::cerr << "    Provided electron energy  (" << e
              << " eV) exceeds current energy range  (" << eFinalGamma
              << " eV).\n";
    std::cerr << "    Increasing energy range to " << 1.05 * e << " eV.\n";
    SetMaxPhotonEnergy(1.05 * e);
  } else if (e <= 0.) {
    std::cerr << m_className << "::GetPhotonCollision:\n";
    std::cerr << "    Photon energy must be greater than zero.\n";
    return false;
  }
 
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetPhotonCollision:\n";
      std::cerr << "    Error calculating the collision rates table.\n";
      return false;
    }
    m_isChanged = false;
  }
 
  // Energy interval
  int iE = int(e / eStepGamma);
  if (iE >= nEnergyStepsGamma) iE = nEnergyStepsGamma - 1;
  if (iE < 0) iE = 0;
 
  double r = cfTotGamma[iE];
  if (useDeexcitation && useRadTrap && nDeexcitations > 0) {
    int nLines = 0;
    std::vector<double> pLine(0);
    std::vector<int> iLine(0);
    // Loop over the excitations.
    for (int i = nDeexcitations; i--;) {
      if (deexcitations[i].cf > 0. &&
          fabs(e - deexcitations[i].energy) <= deexcitations[i].width) {
        r += deexcitations[i].cf * TMath::Voigt(e - deexcitations[i].energy,
                                                deexcitations[i].sDoppler,
                                                2 * deexcitations[i].gPressure);
        pLine.push_back(r);
        iLine.push_back(i);
        ++nLines;
      }
    }
    r *= RndmUniform();
    if (nLines > 0 && r >= cfTotGamma[iE]) {
      // Photon is absorbed by a discrete line.
      for (int i = 0; i < nLines; ++i) {
        if (r <= pLine[i]) {
          ++nPhotonCollisions[PhotonCollisionTypeExcitation];
          int fLevel = 0;
          ComputeDeexcitationInternal(iLine[i], fLevel);
          type = PhotonCollisionTypeExcitation;
          nsec = nDeexcitationProducts;
          return true;
        }
      }
      std::cerr << m_className << "::GetPhotonCollision:\n";
      std::cerr << "    Random sampling of deexcitation line failed.\n";
      std::cerr << "    Program bug!\n";
      return false;
    }
  } else {
    r *= RndmUniform();
  }
 
  int iLow = 0;
  int iUp = nPhotonTerms - 1;
  if (r <= cfGamma[iE][iLow]) {
    level = iLow;
  } else if (r >= cfGamma[iE][iUp]) {
    level = iUp;
  } else {
    int iMid;
    while (iUp - iLow > 1) {
      iMid = (iLow + iUp) >> 1;
      if (r < cfGamma[iE][iMid]) {
        iUp = iMid;
      } else {
        iLow = iMid;
      }
    }
    level = iUp;
  }
 
  nsec = 0;
  esec = e1 = 0.;
  type = csTypeGamma[level];
  // Collision type
  type = type % nCsTypesGamma;
  int ngas = int(csTypeGamma[level] / nCsTypesGamma);
  ++nPhotonCollisions[type];
  // Ionising collision
  if (type == 1) {
    esec = e - ionPot[ngas];
    if (esec < Small) esec = Small;
    nsec = 1;
  }
 
  // Determine the scattering angle
  ctheta = 2 * RndmUniform() - 1.;
 
  return true;
}

◆ GetPhotonCollisionRate()

double Garfield::MediumMagboltz::GetPhotonCollisionRate ( const double & e )

virtual

Reimplemented from Garfield::Medium.

Definition at line 929 of file MediumMagboltz.cc.

                                                             {
 
  if (e <= 0.) {
    std::cerr << m_className << "::GetPhotonCollisionRate:\n";
    std::cerr << "    Photon energy must be greater than zero.\n";
    return cfTotGamma[0];
  }
  if (e > eFinalGamma && useAutoAdjust) {
    std::cerr << m_className << "::GetPhotonCollisionRate:\n";
    std::cerr << "    Collision rate at " << e
              << " eV is not included in the current table.\n";
    std::cerr << "    Increasing energy range to " << 1.05 * e << " eV.\n";
    SetMaxPhotonEnergy(1.05 * e);
  }
 
  if (m_isChanged) {
    if (!Mixer()) {
      std::cerr << m_className << "::GetPhotonCollisionRate:\n";
      std::cerr << "     Error calculating the collision rates table.\n";
      return 0.;
    }
    m_isChanged = false;
  }
 
  int iE = int(e / eStepGamma);
  if (iE >= nEnergyStepsGamma) iE = nEnergyStepsGamma - 1;
  if (iE < 0) iE = 0;
 
  double cfSum = cfTotGamma[iE];
  if (useDeexcitation && useRadTrap && nDeexcitations > 0) {
    // Loop over the excitations.
    for (int i = nDeexcitations; i--;) {
      if (deexcitations[i].cf > 0. &&
          fabs(e - deexcitations[i].energy) <= deexcitations[i].width) {
        cfSum +=
            deexcitations[i].cf * TMath::Voigt(e - deexcitations[i].energy,
                                               deexcitations[i].sDoppler,
                                               2 * deexcitations[i].gPressure);
      }
    }
  }
 
  return cfSum;
}

◆ Initialise()

bool Garfield::MediumMagboltz::Initialise ( const bool verbose = false )

Definition at line 421 of file MediumMagboltz.cc.

                                                  {
 
  if (!m_isChanged) {
    if (m_debug) {
      std::cerr << m_className << "::Initialise:\n";
      std::cerr << "    Nothing changed.\n";
    }
    return true;
  }
  if (!Mixer(verbose)) {
    std::cerr << m_className << "::Initialise:\n";
    std::cerr << "    Error calculating the collision rates table.\n";
    return false;
  }
  m_isChanged = false;
  return true;
}

Referenced by GarfieldPhysics::InitializePhysics(), and PrintGas().

◆ PrintGas()

void Garfield::MediumMagboltz::PrintGas ( )

Definition at line 439 of file MediumMagboltz.cc.

                              {
 
  MediumGas::PrintGas();
 
  if (m_isChanged) {
    if (!Initialise()) return;
  }
 
  std::cout << m_className << "::PrintGas:\n";
  for (int i = 0; i < nTerms; ++i) {
    // Collision type
    int type = csType[i] % nCsTypes;
    int ngas = int(csType[i] / nCsTypes);
    // Description (from Magboltz)
    std::string descr = std::string(50, ' ');
    for (int j = 50; j--;) descr[j] = description[i][j];
    // Threshold energy
    double e = rgas[ngas] * energyLoss[i];
    std::cout << "    Level " << i << ": " << descr << "\n";
    std::cout << "        Type " << type;
    if (type == ElectronCollisionTypeElastic) {
      std::cout << " (elastic)\n";
    } else if (type == ElectronCollisionTypeIonisation) {
      std::cout << " (ionisation)\n";
      std::cout << "        Ionisation threshold: " << e << " eV\n";
    } else if (type == ElectronCollisionTypeAttachment) {
      std::cout << " (attachment)\n";
    } else if (type == ElectronCollisionTypeInelastic) {
      std::cout << " (inelastic)\n";
      std::cout << "        Energy loss: " << e << " eV\n";
    } else if (type == ElectronCollisionTypeExcitation) {
      std::cout << " (excitation)\n";
      std::cout << "        Excitation energy: " << e << " eV\n";
    } else if (type == ElectronCollisionTypeSuperelastic) {
      std::cout << " (super-elastic)\n";
      std::cout << "        Energy gain: " << -e << " eV\n";
    } else {
      std::cout << " (unknown)\n";
    }
    if (type == ElectronCollisionTypeExcitation && usePenning &&
        e > minIonPot) {
      std::cout << "        Penning transfer coefficient: " << rPenning[i]
                << "\n";
    } else if (type == ElectronCollisionTypeExcitation && useDeexcitation) {
      const int idxc = iDeexcitation[i];
      if (idxc < 0 || idxc >= nDeexcitations) {
        std::cout << "        Deexcitation cascade not implemented.\n";
        continue;
      }
      if (deexcitations[idxc].osc > 0.) {
        std::cout << "        Oscillator strength: " << deexcitations[idxc].osc
                  << "\n";
      }
      std::cout << "        Decay channels:\n";
      for (int j = 0; j < deexcitations[idxc].nChannels; ++j) {
        if (deexcitations[idxc].type[j] == DxcTypeRad) {
          std::cout << "          Radiative decay to ";
          if (deexcitations[idxc].final[j] < 0) {
            std::cout << "ground state: ";
          } else {
            std::cout << deexcitations[deexcitations[idxc].final[j]].label
                      << ": ";
          }
        } else if (deexcitations[idxc].type[j] == DxcTypeCollIon) {
          if (deexcitations[idxc].final[j] < 0) {
            std::cout << "          Penning ionisation: ";
          } else {
            std::cout << "          Associative ionisation: ";
          }
        } else if (deexcitations[idxc].type[j] == DxcTypeCollNonIon) {
          if (deexcitations[idxc].final[j] >= 0) {
            std::cout << "          Collision-induced transition to "
                      << deexcitations[deexcitations[idxc].final[j]].label
                      << ": ";
          } else {
            std::cout << "          Loss: ";
          }
        }
        if (j == 0) {
          std::cout << std::setprecision(5) << deexcitations[idxc].p[j] * 100.
                    << "%\n";
        } else {
          std::cout << std::setprecision(5) << (deexcitations[idxc].p[j] -
                                                deexcitations[idxc].p[j - 1]) *
                                                   100. << "%\n";
        }
      }
    }
  }
}

◆ ResetCollisionCounters()

void Garfield::MediumMagboltz::ResetCollisionCounters ( )

Definition at line 1083 of file MediumMagboltz.cc.

                                            {
 
  for (int j = nCsTypes; j--;) nCollisions[j] = 0;
  nCollisionsDetailed.resize(nTerms);
  for (int j = nTerms; j--;) nCollisionsDetailed[j] = 0;
  nPenning = 0;
  for (int j = nCsTypesGamma; j--;) nPhotonCollisions[j] = 0;
}

◆ RunMagboltz()

void Garfield::MediumMagboltz::RunMagboltz	(	const double	e,
		const double	b,
		const double	btheta,
		const int	ncoll,
		bool	verbose,
		double &	vx,
		double &	vy,
		double &	vz,
		double &	dl,
		double &	dt,
		double &	alpha,
		double &	eta,
		double &	vxerr,
		double &	vyerr,
		double &	vzerr,
		double &	dlerr,
		double &	dterr,
		double &	alphaerr,
		double &	etaerr,
		double &	alphatof
	)

Definition at line 5390 of file MediumMagboltz.cc.

                                                                   {
 
  // Initialize the values.
  vx = vy = vz = 0.;
  dl = dt = 0.;
  alpha = eta = alphatof = 0.;
  vxerr = vyerr = vzerr = 0.;
  dlerr = dterr = 0.;
  alphaerr = etaerr = 0.;
 
  // Set input parameters in Magboltz common blocks.
  Magboltz::inpt_.nGas = m_nComponents;
  Magboltz::inpt_.nStep = 4000;
  Magboltz::inpt_.nAniso = 2;
 
  Magboltz::inpt_.tempc = m_temperature - ZeroCelsius;
  Magboltz::inpt_.torr = m_pressure;
  Magboltz::inpt_.ipen = 0;
  Magboltz::setp_.nmax = ncoll;
 
  Magboltz::setp_.efield = e;
  // Convert from Tesla to kGauss.
  Magboltz::bfld_.bmag = bmag * 10.;
  // Convert from radians to degree.
  Magboltz::bfld_.btheta = btheta * 180. / Pi;
 
  // Set the gas composition in Magboltz.
  for (unsigned int i = 0; i < m_nComponents; ++i) {
    int ng = 0;
    if (!GetGasNumberMagboltz(gas[i], ng)) {
      std::cerr << m_className << "::RunMagboltz:\n";
      std::cerr << "    Gas " << gas[i] << " has no corresponding"
                << " gas number in Magboltz.\n";
      return;
    }
    Magboltz::gasn_.ngasn[i] = ng;
    Magboltz::ratio_.frac[i] = 100 * fraction[i];
  }
 
  // Call Magboltz internal setup routine.
  Magboltz::setup1_();
 
  // Calculate the max. energy in the table.
  if (e * m_temperature / (293.15 * m_pressure) > 15) {
    // If E/p > 15 start with 8 eV.
    Magboltz::inpt_.efinal = 8.;
  } else {
    Magboltz::inpt_.efinal = 0.5;
  }
  Magboltz::setp_.estart = Magboltz::inpt_.efinal / 50.;
 
  long long ielow = 1;
  while (ielow == 1) {
    Magboltz::mixer_();
    if (bmag == 0. || btheta == 0. || fabs(btheta) == Pi) {
      Magboltz::elimit_(&ielow);
    } else if (btheta == HalfPi) {
      Magboltz::elimitb_(&ielow);
    } else {
      Magboltz::elimitc_(&ielow);
    }
    if (ielow == 1) {
      // Increase the max. energy.
      Magboltz::inpt_.efinal *= sqrt(2.);
      Magboltz::setp_.estart = Magboltz::inpt_.efinal / 50.;
    }
  }
 
  if (m_debug || verbose) Magboltz::prnter_();
 
  // Run the Monte Carlo calculation.
  if (bmag == 0.) {
    Magboltz::monte_();
  } else if (btheta == 0. || btheta == Pi) {
    Magboltz::montea_();
  } else if (btheta == HalfPi) {
    Magboltz::monteb_();
  } else {
    Magboltz::montec_();
  }
  if (m_debug || verbose) Magboltz::output_();
 
  // If attachment or ionisation rate is greater than sstmin,
  // include spatial gradients in the solution.
  const double sstmin = 30.;
  const double epscale = 760. * m_temperature / (m_pressure * 293.15);
  double alpp = Magboltz::ctowns_.alpha * epscale;
  double attp = Magboltz::ctowns_.att * epscale;
  bool useSST = false;
  if (fabs(alpp - attp) > sstmin || alpp > sstmin || attp > sstmin) {
    useSST = true;
    if (bmag == 0.) {
      Magboltz::alpcalc_();
    } else if (btheta == 0. || btheta == Pi) {
      Magboltz::alpclca_();
    } else if (btheta == HalfPi) {
      Magboltz::alpclcb_();
    } else {
      Magboltz::alpclcc_();
    }
    // Calculate the (effective) TOF Townsend coefficient.
    double alphapt = Magboltz::tofout_.ralpha;
    double etapt = Magboltz::tofout_.rattof;
    double fc1 =
        1.e5 * Magboltz::tofout_.tofwr / (2. * Magboltz::tofout_.tofdl);
    double fc2 = 1.e12 * (alphapt - etapt) / Magboltz::tofout_.tofdl;
    alphatof = fc1 - sqrt(fc1 * fc1 - fc2);
  }
  if (m_debug || verbose) Magboltz::output2_();
 
  // Convert to cm / ns.
  vx = Magboltz::vel_.wx * 1.e-9;
  vxerr = Magboltz::velerr_.dwx;
  vy = Magboltz::vel_.wy * 1.e-9;
  vyerr = Magboltz::velerr_.dwy;
  vz = Magboltz::vel_.wz * 1.e-9;
  vzerr = Magboltz::velerr_.dwz;
 
  dt = sqrt(0.2 * Magboltz::difvel_.diftr / vz) * 1.e-4;
  dterr = Magboltz::diferl_.dfter;
  dl = sqrt(0.2 * Magboltz::difvel_.difln / vz) * 1.e-4;
  dlerr = Magboltz::diferl_.dfler;
 
  alpha = Magboltz::ctowns_.alpha;
  alphaerr = Magboltz::ctwner_.alper;
  eta = Magboltz::ctowns_.att;
  etaerr = Magboltz::ctwner_.atter;
 
  // Print the results.
  if (m_debug) {
    std::cout << m_className << "::RunMagboltz:\n";
    std::cout << "    Results: \n";
    std::cout << "      Drift velocity along E:           " << std::right
              << std::setw(10) << std::setprecision(6) << vz << " cm/ns +/- "
              << std::setprecision(2) << vzerr << "%\n";
    std::cout << "      Drift velocity along Bt:          " << std::right
              << std::setw(10) << std::setprecision(6) << vx << " cm/ns +/- "
              << std::setprecision(2) << vxerr << "%\n";
    std::cout << "      Drift velocity along ExB:         " << std::right
              << std::setw(10) << std::setprecision(6) << vy << " cm/ns +/- "
              << std::setprecision(2) << vyerr << "%\n";
    std::cout << "      Longitudinal diffusion:           " << std::right
              << std::setw(10) << std::setprecision(6) << dl << " cm1/2 +/- "
              << std::setprecision(2) << dlerr << "%\n";
    std::cout << "      Transverse diffusion:             " << std::right
              << std::setw(10) << std::setprecision(6) << dt << " cm1/2 +/- "
              << std::setprecision(2) << dterr << "%\n";
    if (useSST) {
      std::cout << "      Townsend coefficient (SST):       " << std::right
                << std::setw(10) << std::setprecision(6) << alpha
                << " cm-1  +/- " << std::setprecision(2) << alphaerr << "%\n";
      std::cout << "      Attachment coefficient (SST):     " << std::right
                << std::setw(10) << std::setprecision(6) << eta << " cm-1  +/- "
                << std::setprecision(2) << etaerr << "%\n";
      std::cout << "      Eff. Townsend coefficient (TOF):  " << std::right
                << std::setw(10) << std::setprecision(6) << alphatof
                << " cm-1\n";
    } else {
      std::cout << "      Townsend coefficient:             " << std::right
                << std::setw(10) << std::setprecision(6) << alpha
                << " cm-1  +/- " << std::setprecision(2) << alphaerr << "%\n";
      std::cout << "      Attachment coefficient:           " << std::right
                << std::setw(10) << std::setprecision(6) << eta << " cm-1  +/- "
                << std::setprecision(2) << etaerr << "%\n";
    }
  }
}

Referenced by GenerateGasTable().

◆ SetExcitationScalingFactor()

void Garfield::MediumMagboltz::SetExcitationScalingFactor	(	const double	r,
		std::string	gasname
	)

Definition at line 384 of file MediumMagboltz.cc.

                                                                   {
 
  if (r <= 0.) {
    std::cerr << m_className << "::SetScalingFactor:\n";
    std::cerr << "    Incorrect value for scaling factor: " << r << "\n";
    return;
  }
 
  // Get the "standard" name of this gas.
  if (!GetGasName(gasname, gasname)) {
    std::cerr << m_className << "::SetExcitationScalingFactor:\n";
    std::cerr << "    Unknown gas name.\n";
    return;
  }
 
  // Look for this gas in the present gas mixture.
  bool found = false;
  for (unsigned int i = 0; i < m_nComponents; ++i) {
    if (gas[i] == gasname) {
      scaleExc[i] = r;
      found = true;
      break;
    }
  }
 
  if (!found) {
    std::cerr << m_className << "::SetExcitationScalingFactor:\n";
    std::cerr << "    Specified gas (" << gasname
              << ") is not part of the present gas mixture.\n";
    return;
  }
 
  // Make sure that the collision rate table is updated.
  m_isChanged = true;
}

◆ SetMaxElectronEnergy()

bool Garfield::MediumMagboltz::SetMaxElectronEnergy ( const double e )

Definition at line 100 of file MediumMagboltz.cc.

                                                        {
 
  if (e <= Small) {
    std::cerr << m_className << "::SetMaxElectronEnergy:\n";
    std::cerr << "    Provided upper electron energy limit (" << e
              << " eV) is too small.\n";
    return false;
  }
  eFinal = e;
 
  // Determine the energy interval size.
  if (eFinal <= eHigh) {
    eStep = eFinal / nEnergySteps;
  } else {
    eStep = eHigh / nEnergySteps;
  }
 
  // Set max. energy and step size also in Magboltz common block.
  Magboltz::inpt_.efinal = eFinal;
  Magboltz::inpt_.estep = eStep;
 
  // Force recalculation of the scattering rates table.
  m_isChanged = true;
 
  return true;
}

Referenced by GetElectronCollision(), and GetElectronCollisionRate().

◆ SetMaxPhotonEnergy()

bool Garfield::MediumMagboltz::SetMaxPhotonEnergy ( const double e )

Definition at line 127 of file MediumMagboltz.cc.

                                                      {
 
  if (e <= Small) {
    std::cerr << m_className << "::SetMaxPhotonEnergy:\n";
    std::cerr << "    Provided upper photon energy limit (" << e
              << " eV) is too small.\n";
    return false;
  }
  eFinalGamma = e;
 
  // Determine the energy interval size.
  eStepGamma = eFinalGamma / nEnergyStepsGamma;
 
  // Force recalculation of the scattering rates table.
  m_isChanged = true;
 
  return true;
}

Referenced by GetPhotonCollision(), and GetPhotonCollisionRate().

◆ SetSplittingFunctionFlat()

void Garfield::MediumMagboltz::SetSplittingFunctionFlat ( )

Definition at line 171 of file MediumMagboltz.cc.

                                              {
 
  useOpalBeaty = false;
  useGreenSawada = false;
}

◆ SetSplittingFunctionGreenSawada()

void Garfield::MediumMagboltz::SetSplittingFunctionGreenSawada ( )

Definition at line 152 of file MediumMagboltz.cc.

                                                     {
 
  useOpalBeaty = false;
  useGreenSawada = true;
  if (m_isChanged) return;
 
  bool allset = true;
  for (unsigned int i = 0; i < m_nComponents; ++i) {
    if (!m_hasGreenSawada[i]) {
      if (allset) {
        std::cout << m_className << "::SetSplittingFunctionGreenSawada:\n";
        allset = false;
      }
      std::cout << "    Fit parameters for " << gas[i] << " not available.\n";
      std::cout << "    Opal-Beaty formula is used instead.\n";
    }
  }
}

◆ SetSplittingFunctionOpalBeaty()

void Garfield::MediumMagboltz::SetSplittingFunctionOpalBeaty ( )

Definition at line 146 of file MediumMagboltz.cc.

                                                   {
 
  useOpalBeaty = true;
  useGreenSawada = false;
}

Member Data Documentation

◆ fit3d4p

double Garfield::MediumMagboltz::fit3d4p

Definition at line 131 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit3dEtaC2H6

double Garfield::MediumMagboltz::fit3dEtaC2H6

Definition at line 134 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit3dEtaCH4

double Garfield::MediumMagboltz::fit3dEtaCH4

Definition at line 133 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit3dEtaCO2

double Garfield::MediumMagboltz::fit3dEtaCO2

Definition at line 132 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit3dQC2H6

double Garfield::MediumMagboltz::fit3dQC2H6

Definition at line 134 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit3dQCH4

double Garfield::MediumMagboltz::fit3dQCH4

Definition at line 133 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit3dQCO2

double Garfield::MediumMagboltz::fit3dQCO2

Definition at line 132 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit4pEtaC2H6

double Garfield::MediumMagboltz::fit4pEtaC2H6

Definition at line 136 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit4pEtaCH4

double Garfield::MediumMagboltz::fit4pEtaCH4

Definition at line 135 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fit4sEtaC2H6

double Garfield::MediumMagboltz::fit4sEtaC2H6

Definition at line 137 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fitHigh4p

double Garfield::MediumMagboltz::fitHigh4p

Definition at line 131 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

◆ fitLineCut

double Garfield::MediumMagboltz::fitLineCut

Definition at line 138 of file MediumMagboltz.hh.

Referenced by MediumMagboltz().

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MediumMagboltz()

◆ ~MediumMagboltz()

Member Function Documentation

◆ ComputeDeexcitation()

◆ DisableAnisotropicScattering()

◆ DisableCrossSectionOutput()

◆ DisableDeexcitation()

◆ DisableEnergyRangeAdjustment()

◆ DisablePenningTransfer() [1/2]

◆ DisablePenningTransfer() [2/2]

◆ DisableRadiationTrapping()

◆ EnableAnisotropicScattering()

◆ EnableCrossSectionOutput()

◆ EnableDeexcitation()

◆ EnableEnergyRangeAdjustment()

◆ EnablePenningTransfer() [1/2]

◆ EnablePenningTransfer() [2/2]

◆ EnableRadiationTrapping()

◆ GenerateGasTable()

◆ GetDeexcitationProduct()

◆ GetElectronCollision()

◆ GetElectronCollisionRate() [1/2]

◆ GetElectronCollisionRate() [2/2]

◆ GetElectronNullCollisionRate()

◆ GetIonisationProduct()

◆ GetLevel()

◆ GetMaxElectronEnergy()

◆ GetMaxPhotonEnergy()

◆ GetNumberOfDeexcitationProducts()

◆ GetNumberOfElectronCollisions() [1/3]

◆ GetNumberOfElectronCollisions() [2/3]

◆ GetNumberOfElectronCollisions() [3/3]

◆ GetNumberOfIonisationProducts()

◆ GetNumberOfLevels()

◆ GetNumberOfPenningTransfers()

◆ GetNumberOfPhotonCollisions() [1/2]

◆ GetNumberOfPhotonCollisions() [2/2]

◆ GetPhotonCollision()

◆ GetPhotonCollisionRate()

◆ Initialise()

◆ PrintGas()

◆ ResetCollisionCounters()

◆ RunMagboltz()

◆ SetExcitationScalingFactor()

◆ SetMaxElectronEnergy()

◆ SetMaxPhotonEnergy()

◆ SetSplittingFunctionFlat()

◆ SetSplittingFunctionGreenSawada()

◆ SetSplittingFunctionOpalBeaty()

Member Data Documentation

◆ fit3d4p

◆ fit3dEtaC2H6

◆ fit3dEtaCH4

◆ fit3dEtaCO2

◆ fit3dQC2H6

◆ fit3dQCH4

◆ fit3dQCO2

◆ fit4pEtaC2H6

◆ fit4pEtaCH4

◆ fit4sEtaC2H6

◆ fitHigh4p

◆ fitLineCut