Garfield::Medium Class Reference

Abstract base class for media. More...

#include <Medium.hh>

Inheritance diagram for Garfield::Medium:

Public Member Functions
	Medium ()
	Constructor.
virtual	~Medium ()
	Destructor.
int	GetId () const
	Return the id number of the class instance.
const std::string &	GetName () const
	Get the medium name/identifier.
virtual bool	IsGas () const
	Is this medium a gas?
virtual bool	IsSemiconductor () const
	Is this medium a semiconductor?
virtual bool	IsConductor () const
	Is this medium a conductor?
void	SetTemperature (const double t)
	Set the temperature [K].
double	GetTemperature () const
	Get the temperature [K].
void	SetPressure (const double p)
double	GetPressure () const
void	SetDielectricConstant (const double eps)
	Set the relative static dielectric constant.
double	GetDielectricConstant () const
	Get the relative static dielectric constant.
unsigned int	GetNumberOfComponents () const
	Get number of components of the medium.
virtual void	GetComponent (const unsigned int i, std::string &label, double &f)
	Get the name and fraction of a given component.
virtual void	SetAtomicNumber (const double z)
	Set the effective atomic number.
virtual double	GetAtomicNumber () const
	Get the effective atomic number.
virtual void	SetAtomicWeight (const double a)
	Set the effective atomic weight.
virtual double	GetAtomicWeight () const
	Get the effective atomic weight.
virtual void	SetNumberDensity (const double n)
	Set the number density [cm-3].
virtual double	GetNumberDensity () const
	Get the number density [cm-3].
virtual void	SetMassDensity (const double rho)
	Set the mass density [g/cm3].
virtual double	GetMassDensity () const
	Get the mass density [g/cm3].
virtual void	EnableDrift (const bool on=true)
	Switch electron/ion/hole transport on/off.
virtual void	EnablePrimaryIonisation (const bool on=true)
	Make the medium ionisable or non-ionisable.
bool	IsDriftable () const
	Is charge carrier transport enabled in this medium?
bool	IsMicroscopic () const
	Does the medium have electron scattering rates?
bool	IsIonisable () const
	Is charge deposition by charged particles/photon enabled in this medium?
void	SetW (const double w)
	Set the W value (average energy to produce an electron/ion or e/h pair).
double	GetW () const
	Get the W value.
void	SetFanoFactor (const double f)
	Set the Fano factor.
double	GetFanoFactor () const
	Get the Fano factor.
void	PlotVelocity (const std::string &carriers, TPad *pad)
	Plot the drift velocity as function of the electric field.
void	PlotDiffusion (const std::string &carriers, TPad *pad)
	Plot the diffusion coefficients as function of the electric field.
void	PlotTownsend (const std::string &carriers, TPad *pad)
	Plot the Townsend coefficient(s) as function of the electric field.
void	PlotAttachment (const std::string &carriers, TPad *pad)
	Plot the attachment coefficient(s) as function of the electric field.
void	PlotAlphaEta (const std::string &carriers, TPad *pad)
	Plot Townsend and attachment coefficients.
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)
	Drift velocity [cm / ns].
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)
	Longitudinal and transverse diffusion coefficients [cm1/2].
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)
	Ionisation coefficient [cm-1].
virtual bool	ElectronAttachment (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &eta)
	Attachment coefficient [cm-1].
virtual bool	ElectronLorentzAngle (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &lor)
	Lorentz angle.
virtual double	ElectronMobility ()
	Low-field mobility [cm2 V-1 ns-1].
virtual double	GetElectronEnergy (const double px, const double py, const double pz, double &vx, double &vy, double &vz, const int band=0)
	Dispersion relation (energy vs. wave vector)
virtual void	GetElectronMomentum (const double e, double &px, double &py, double &pz, int &band)
virtual double	GetElectronNullCollisionRate (const int band=0)
	Null-collision rate [ns-1].
virtual double	GetElectronCollisionRate (const double e, const int band=0)
	Collision rate [ns-1] for given electron energy.
virtual bool	ElectronCollision (const double e, int &type, int &level, double &e1, double &dx, double &dy, double &dz, std::vector< std::pair< Particle, double > > &secondaries, int &ndxc, int &band)
	Sample the collision type. Update energy and direction vector.
virtual unsigned int	GetNumberOfDeexcitationProducts () const
virtual bool	GetDeexcitationProduct (const unsigned int i, double &t, double &s, int &type, double &energy) const
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)
	Drift velocity [cm / ns].
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)
	Longitudinal and transverse diffusion coefficients [cm1/2].
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])
	Diffusion tensor.
virtual bool	HoleTownsend (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &alpha)
	Ionisation coefficient [cm-1].
virtual bool	HoleAttachment (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &eta)
	Attachment coefficient [cm-1].
virtual double	HoleMobility ()
	Low-field mobility [cm2 V-1 ns-1].
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)
	Ion drift velocity [cm / ns].
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)
	Longitudinal and transverse diffusion coefficients [cm1/2].
virtual bool	IonDissociation (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &diss)
	Dissociation coefficient.
virtual double	IonMobility ()
	Low-field ion mobility [cm2 V-1 ns-1].
virtual bool	NegativeIonVelocity (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double &vx, double &vy, double &vz)
	Negative ion drift velocity [cm / ns].
virtual double	NegativeIonMobility ()
	Low-field negative ion mobility [cm2 V-1 ns-1].
void	SetFieldGrid (double emin, double emax, const size_t ne, bool logE, double bmin=0., double bmax=0., const size_t nb=1, double amin=HalfPi, double amax=HalfPi, const size_t na=1)
	Set the range of fields to be covered by the transport tables.
void	SetFieldGrid (const std::vector< double > &efields, const std::vector< double > &bfields, const std::vector< double > &angles)
	Set the fields and E-B angles to be used in the transport tables.
void	GetFieldGrid (std::vector< double > &efields, std::vector< double > &bfields, std::vector< double > &angles)
	Get the fields and E-B angles used in the transport tables.
bool	SetElectronVelocityE (const size_t ie, const size_t ib, const size_t ia, const double v)
	Set an entry in the table of drift speeds along E.
bool	GetElectronVelocityE (const size_t ie, const size_t ib, const size_t ia, double &v)
	Get an entry in the table of drift speeds along E.
bool	SetElectronVelocityExB (const size_t ie, const size_t ib, const size_t ia, const double v)
	Set an entry in the table of drift speeds along ExB.
bool	GetElectronVelocityExB (const size_t ie, const size_t ib, const size_t ia, double &v)
	Get an entry in the table of drift speeds along ExB.
bool	SetElectronVelocityB (const size_t ie, const size_t ib, const size_t ia, const double v)
	Set an entry in the table of drift speeds along Btrans.
bool	GetElectronVelocityB (const size_t ie, const size_t ib, const size_t ia, double &v)
	Get an entry in the table of drift speeds along Btrans.
bool	SetElectronLongitudinalDiffusion (const size_t ie, const size_t ib, const size_t ia, const double dl)
	Set an entry in the table of longitudinal diffusion coefficients.
bool	GetElectronLongitudinalDiffusion (const size_t ie, const size_t ib, const size_t ia, double &dl)
	Get an entry in the table of longitudinal diffusion coefficients.
bool	SetElectronTransverseDiffusion (const size_t ie, const size_t ib, const size_t ia, const double dt)
	Set an entry in the table of transverse diffusion coefficients.
bool	GetElectronTransverseDiffusion (const size_t ie, const size_t ib, const size_t ia, double &dt)
	Get an entry in the table of transverse diffusion coefficients.
bool	SetElectronTownsend (const size_t ie, const size_t ib, const size_t ia, const double alpha)
	Set an entry in the table of Townsend coefficients.
bool	GetElectronTownsend (const size_t ie, const size_t ib, const size_t ia, double &alpha)
	Get an entry in the table of Townsend coefficients.
bool	SetElectronAttachment (const size_t ie, const size_t ib, const size_t ia, const double eta)
	Set an entry in the table of attachment coefficients.
bool	GetElectronAttachment (const size_t ie, const size_t ib, const size_t ia, double &eta)
	Get an entry in the table of attachment coefficients.
bool	SetElectronLorentzAngle (const size_t ie, const size_t ib, const size_t ia, const double lor)
	Set an entry in the table of Lorentz angles.
bool	GetElectronLorentzAngle (const size_t ie, const size_t ib, const size_t ia, double &lor)
	Get an entry in the table of Lorentz angles.
bool	SetHoleVelocityE (const size_t ie, const size_t ib, const size_t ia, const double v)
	Set an entry in the table of drift speeds along E.
bool	GetHoleVelocityE (const size_t ie, const size_t ib, const size_t ia, double &v)
	Get an entry in the table of drift speeds along E.
bool	SetHoleVelocityExB (const size_t ie, const size_t ib, const size_t ia, const double v)
	Set an entry in the table of drift speeds along ExB.
bool	GetHoleVelocityExB (const size_t ie, const size_t ib, const size_t ia, double &v)
	Get an entry in the table of drift speeds along ExB.
bool	SetHoleVelocityB (const size_t ie, const size_t ib, const size_t ia, const double v)
	Set an entry in the table of drift speeds along Btrans.
bool	GetHoleVelocityB (const size_t ie, const size_t ib, const size_t ia, double &v)
	Get an entry in the table of drift speeds along Btrans.
bool	SetHoleLongitudinalDiffusion (const size_t ie, const size_t ib, const size_t ia, const double dl)
	Set an entry in the table of longitudinal diffusion coefficients.
bool	GetHoleLongitudinalDiffusion (const size_t ie, const size_t ib, const size_t ia, double &dl)
	Get an entry in the table of longitudinal diffusion coefficients.
bool	SetHoleTransverseDiffusion (const size_t ie, const size_t ib, const size_t ia, const double dt)
	Set an entry in the table of transverse diffusion coefficients.
bool	GetHoleTransverseDiffusion (const size_t ie, const size_t ib, const size_t ia, double &dt)
	Get an entry in the table of transverse diffusion coefficients.
bool	SetHoleTownsend (const size_t ie, const size_t ib, const size_t ia, const double alpha)
	Set an entry in the table of Townsend coefficients.
bool	GetHoleTownsend (const size_t ie, const size_t ib, const size_t ia, double &alpha)
	Get an entry in the table of Townsend coefficients.
bool	SetHoleAttachment (const size_t ie, const size_t ib, const size_t ia, const double eta)
	Set an entry in the table of attachment coefficients.
bool	GetHoleAttachment (const size_t ie, const size_t ib, const size_t ia, double &eta)
	Get an entry in the table of attachment coefficients.
bool	SetIonMobility (const std::vector< double > &fields, const std::vector< double > &mobilities, const bool negativeIons=false)
bool	SetIonMobility (const size_t ie, const size_t ib, const size_t ia, const double mu)
	Set an entry in the table of ion mobilities.
bool	GetIonMobility (const size_t ie, const size_t ib, const size_t ia, double &mu)
	Get an entry in the table of ion mobilities.
bool	SetIonLongitudinalDiffusion (const size_t ie, const size_t ib, const size_t ia, const double dl)
	Set an entry in the table of longitudinal diffusion coefficients.
bool	GetIonLongitudinalDiffusion (const size_t ie, const size_t ib, const size_t ia, double &dl)
	Get an entry in the table of longitudinal diffusion coefficients.
bool	SetIonTransverseDiffusion (const size_t ie, const size_t ib, const size_t ia, const double dt)
	Set an entry in the table of transverse diffusion coefficients.
bool	GetIonTransverseDiffusion (const size_t ie, const size_t ib, const size_t ia, double &dt)
	Get an entry in the table of transverse diffusion coefficients.
bool	SetIonDissociation (const size_t ie, const size_t ib, const size_t ia, const double diss)
	Set an entry in the table of dissociation coefficients.
bool	GetIonDissociation (const size_t ie, const size_t ib, const size_t ia, double &diss)
	Get an entry in the table of dissociation coefficients.
bool	SetNegativeIonMobility (const size_t ie, const size_t ib, const size_t ia, const double mu)
	Set an entry in the table of negative ion mobilities.
bool	GetNegativeIonMobility (const size_t ie, const size_t ib, const size_t ia, double &mu)
	Get an entry in the table of negative ion mobilities.
virtual void	ResetTables ()
	Reset all tables of transport parameters.
void	ResetElectronVelocity ()
void	ResetElectronDiffusion ()
void	ResetElectronTownsend ()
void	ResetElectronAttachment ()
void	ResetElectronLorentzAngle ()
void	ResetHoleVelocity ()
void	ResetHoleDiffusion ()
void	ResetHoleTownsend ()
void	ResetHoleAttachment ()
void	ResetIonMobility ()
void	ResetIonDiffusion ()
void	ResetIonDissociation ()
void	ResetNegativeIonMobility ()
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)
	Set the degree of polynomial interpolation (usually 2).
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	ScaleLorentzAngle (const double lor) const
virtual double	ScaleDissociation (const double diss) const
virtual bool	GetOpticalDataRange (double &emin, double &emax, const unsigned int i=0)
	Get the energy range [eV] of the available optical data.
virtual bool	GetDielectricFunction (const double e, double &eps1, double &eps2, const unsigned int i=0)
	Get the complex dielectric function at a given energy.
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 ()
	Switch on/off debugging messages.
void	DisableDebugging ()

Protected Member Functions
bool	Velocity (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< double > > > &velE, const std::vector< std::vector< std::vector< double > > > &velB, const std::vector< std::vector< std::vector< double > > > &velX, const double q, double &vx, double &vy, double &vz) const
bool	Diffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< double > > > &difL, const std::vector< std::vector< std::vector< double > > > &difT, double &dl, double &dt) const
bool	Diffusion (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< std::vector< double > > > > &diff, double cov[3][3]) const
bool	Alpha (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< double > > > &tab, unsigned int intp, const unsigned int thr, const std::pair< unsigned int, unsigned int > &extr, double &alpha) const
double	GetAngle (const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const double e, const double b) const
bool	Interpolate (const double e, const double b, const double a, const std::vector< std::vector< std::vector< double > > > &table, double &y, const unsigned int intp, const std::pair< unsigned int, unsigned int > &extr) const
double	Interpolate1D (const double e, const std::vector< double > &table, const std::vector< double > &fields, const unsigned int intpMeth, const std::pair< unsigned int, unsigned int > &extr) const
bool	SetEntry (const size_t i, const size_t j, const size_t k, const std::string &fcn, std::vector< std::vector< std::vector< double > > > &tab, const double val)
bool	GetEntry (const size_t i, const size_t j, const size_t k, const std::string &fcn, const std::vector< std::vector< std::vector< double > > > &tab, double &val) const
void	SetExtrapolationMethod (const std::string &low, const std::string &high, std::pair< unsigned int, unsigned int > &extr, const std::string &fcn)
bool	GetExtrapolationIndex (std::string str, unsigned int &nb) const
size_t	SetThreshold (const std::vector< std::vector< std::vector< double > > > &tab) const
void	Clone (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 std::pair< unsigned int, unsigned int > &extr, const double init, const std::string &label)
void	Clone (std::vector< std::vector< std::vector< std::vector< double > > > > &tab, const size_t n, const std::vector< double > &efields, const std::vector< double > &bfields, const std::vector< double > &angles, const unsigned int intp, const std::pair< unsigned int, unsigned int > &extr, const double init, const std::string &label)
void	Init (const size_t nE, const size_t nB, const size_t nA, std::vector< std::vector< std::vector< double > > > &tab, const double val)
void	Init (const size_t nE, const size_t nB, const size_t nA, const size_t nT, std::vector< std::vector< std::vector< std::vector< double > > > > &tab, const double val)

Static Protected Member Functions
static void	Langevin (const double ex, const double ey, const double ez, double bx, double by, double bz, const double mu, double &vx, double &vy, double &vz)
static void	Langevin (const double ex, const double ey, const double ez, double bx, double by, double bz, const double mu, const double muH, double &vx, double &vy, double &vz)

Protected Attributes
std::string	m_className = "Medium"
int	m_id
unsigned int	m_nComponents = 1
std::string	m_name = ""
double	m_temperature = 293.15
double	m_pressure = 760.
double	m_epsilon = 1.
double	m_z = 1.
double	m_a = 0.
double	m_density = 0.
double	m_w = 0.
double	m_fano = 0.
bool	m_driftable = false
bool	m_microscopic = false
bool	m_ionisable = false
bool	m_isChanged = true
bool	m_debug = false
bool	m_tab2d = false
std::vector< double >	m_eFields
std::vector< double >	m_bFields
std::vector< double >	m_bAngles
std::vector< std::vector< std::vector< double > > >	m_eVelE
std::vector< std::vector< std::vector< double > > >	m_eVelX
std::vector< std::vector< std::vector< double > > >	m_eVelB
std::vector< std::vector< std::vector< double > > >	m_eDifL
std::vector< std::vector< std::vector< double > > >	m_eDifT
std::vector< std::vector< std::vector< double > > >	m_eAlp
std::vector< std::vector< std::vector< double > > >	m_eAtt
std::vector< std::vector< std::vector< double > > >	m_eLor
std::vector< std::vector< std::vector< std::vector< double > > > >	m_eDifM
std::vector< std::vector< std::vector< double > > >	m_hVelE
std::vector< std::vector< std::vector< double > > >	m_hVelX
std::vector< std::vector< std::vector< double > > >	m_hVelB
std::vector< std::vector< std::vector< double > > >	m_hDifL
std::vector< std::vector< std::vector< double > > >	m_hDifT
std::vector< std::vector< std::vector< double > > >	m_hAlp
std::vector< std::vector< std::vector< double > > >	m_hAtt
std::vector< std::vector< std::vector< std::vector< double > > > >	m_hDifM
std::vector< std::vector< std::vector< double > > >	m_iMob
std::vector< std::vector< std::vector< double > > >	m_iDifL
std::vector< std::vector< std::vector< double > > >	m_iDifT
std::vector< std::vector< std::vector< double > > >	m_iDis
std::vector< std::vector< std::vector< double > > >	m_nMob
unsigned int	m_eThrAlp = 0
unsigned int	m_eThrAtt = 0
unsigned int	m_hThrAlp = 0
unsigned int	m_hThrAtt = 0
unsigned int	m_iThrDis = 0
std::pair< unsigned int, unsigned int >	m_extrVel = {0, 1}
std::pair< unsigned int, unsigned int >	m_extrDif = {0, 1}
std::pair< unsigned int, unsigned int >	m_extrAlp = {0, 1}
std::pair< unsigned int, unsigned int >	m_extrAtt = {0, 1}
std::pair< unsigned int, unsigned int >	m_extrLor = {0, 1}
std::pair< unsigned int, unsigned int >	m_extrMob = {0, 1}
std::pair< unsigned int, unsigned int >	m_extrDis = {0, 1}
unsigned int	m_intpVel = 2
unsigned int	m_intpDif = 2
unsigned int	m_intpAlp = 2
unsigned int	m_intpAtt = 2
unsigned int	m_intpLor = 2
unsigned int	m_intpMob = 2
unsigned int	m_intpDis = 2

Static Protected Attributes
static int	m_idCounter = -1

Detailed Description

Abstract base class for media.

Definition at line 16 of file Medium.hh.

Constructor & Destructor Documentation

Medium()

Garfield::Medium::Medium

(

)

Constructor.

Definition at line 61 of file Medium.cc.

               : m_id(++m_idCounter) {
  // Initialise the tables.
  m_bFields.assign(1, 0.);
  m_bAngles.assign(1, HalfPi);
 
  // Set the default grid.
  SetFieldGrid(100., 100000., 20, true, 0., 0., 1, HalfPi, HalfPi, 1);
}

Referenced by Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumConductor::MediumConductor(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumPlastic::MediumPlastic(), and Garfield::MediumSilicon::MediumSilicon().

~Medium()

Garfield::Medium::~Medium ( )

virtual

Destructor.

Definition at line 70 of file Medium.cc.

{}

Member Function Documentation

Alpha()

bool Garfield::Medium::Alpha ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< double > > > & tab, unsigned int intp, const unsigned int thr, const std::pair< unsigned int, unsigned int > & extr, double & alpha ) const

protected

Definition at line 413 of file Medium.cc.

                                        {
                  
  alpha = 0.;
  if (tab.empty()) return false;
 
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return true;
 
  // Compute the magnitude of the magnetic field.
  const double b = m_tab2d ? sqrt(bx * bx + by * by + bz * bz) : 0.;
  // Compute the angle between B field and E field.
  const double ebang = m_tab2d ? GetAngle(ex, ey, ez, bx, by, bz, e, b) : 0.;
 
  // Interpolate.
  if (e0 < m_eFields[thr]) intp = 1;
  if (!Interpolate(e0, b, ebang, tab, alpha, intp, extr)) alpha = -30.;
  if (alpha < -20.) {
    alpha = 0.;
  } else {
    alpha = exp(alpha);
  }
  return true;
}

Referenced by ElectronAttachment(), ElectronTownsend(), HoleAttachment(), HoleTownsend(), and IonDissociation().

Clone() [1/2]

void Garfield::Medium::Clone ( 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 std::pair< unsigned int, unsigned int > & extr, const double init, const std::string & label )

protected

Definition at line 1018 of file Medium.cc.

                                                            {
  if (m_debug) {
    std::cout << m_className << "::Clone: Copying " << lbl << " to new grid.\n";
  }
 
  if (tab.empty()) {
    if (m_debug) std::cout << m_className << "::Clone: Table is empty.\n";
    return;
  }
  // Get the dimensions of the new grid.
  const auto nE = efields.size();
  const auto nB = bfields.size();
  const auto nA = angles.size();
 
  // Create a temporary table to store the values at the new grid points.
  std::vector<std::vector<std::vector<double> > > tabClone;
  Init(nE, nB, nA, tabClone, init);
 
  // Fill the temporary table.
  for (size_t i = 0; i < nE; ++i) {
    const double e = efields[i];
    for (size_t j = 0; j < nB; ++j) {
      const double b = bfields[j];
      for (size_t k = 0; k < nA; ++k) {
        const double a = angles[k];
        double val = 0.;
        if (!Interpolate(e, b, a, tab, val, intp, extr)) {
          std::cerr << m_className << "::Clone:\n"
                    << "    Interpolation of " << lbl << " failed.\n"
                    << "    Cannot copy value to new grid at E = " << e
                    << ", B = " << b << ", angle: " << a << "\n";
          continue;
        }
        tabClone[k][j][i] = val;
      }
    }
  }
  // Copy the values to the original table.
  tab.swap(tabClone);
}

Referenced by SetFieldGrid().

Clone() [2/2]

void Garfield::Medium::Clone ( std::vector< std::vector< std::vector< std::vector< double > > > > & tab, const size_t n, const std::vector< double > & efields, const std::vector< double > & bfields, const std::vector< double > & angles, const unsigned int intp, const std::pair< unsigned int, unsigned int > & extr, const double init, const std::string & label )

protected

Definition at line 1065 of file Medium.cc.

                                             {
  // If the table does not exist, do nothing.
  if (tab.empty()) return;
 
  // Get the dimensions of the new grid.
  const auto nE = efields.size();
  const auto nB = bfields.size();
  const auto nA = angles.size();
 
  // Create a temporary table to store the values at the new grid points.
  std::vector<std::vector<std::vector<std::vector<double> > > > tabClone;
  Init(nE, nB, nA, n, tabClone, init);
 
  // Fill the temporary table.
  for (size_t l = 0; l < n; ++l) {
    for (size_t i = 0; i < nE; ++i) {
      const double e = efields[i];
      for (size_t j = 0; j < nB; ++j) {
        const double b = bfields[j];
        for (size_t k = 0; k < nA; ++k) {
          const double a = angles[k];
          double val = 0.;
          if (!Interpolate(e, b, a, tab[l], val, intp, extr)) {
            std::cerr << m_className << "::Clone:\n"
                      << "    Interpolation of " << lbl << " failed.\n"
                      << "    Cannot copy value to new grid at index " << l
                      << ", E = " << e << ", B = " << b << ", angle: " << a
                      << "\n";
            continue;
          }
          tabClone[l][k][j][i] = val;
        }
      }
    }
  }
  // Copy the values to the original table.
  tab.swap(tabClone);
}

Diffusion() [1/2]

bool Garfield::Medium::Diffusion ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< double > > > & difL, const std::vector< std::vector< std::vector< double > > > & difT, double & dl, double & dt ) const

protected

Definition at line 334 of file Medium.cc.

                                                     { 
 
  dl = dt = 0.;
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return true;
 
  // Compute the magnitude of the magnetic field.
  const double b = m_tab2d ? sqrt(bx * bx + by * by + bz * bz) : 0.;
  // Compute the angle between B field and E field.
  const double ebang = m_tab2d ? GetAngle(ex, ey, ez, bx, by, bz, e, b) : 0.;
 
  // Interpolate.
  if (!difL.empty()) {
    if (!Interpolate(e0, b, ebang, difL, dl, m_intpDif, m_extrDif)) dl = 0.;
  }
  if (!difT.empty()) {
    if (!Interpolate(e0, b, ebang, difT, dt, m_intpDif, m_extrDif)) dt = 0.;
  }
 
  // If no data available, calculate
  // the diffusion coefficients using the Einstein relation
  if (difL.empty() || difT.empty()) {
    const double d = sqrt(2. * BoltzmannConstant * m_temperature / e);
    if (difL.empty()) dl = d;
    if (difT.empty()) dt = d;
  }
  // Verify values and apply scaling.
  dl = ScaleDiffusion(std::max(dl, 0.));
  dt = ScaleDiffusion(std::max(dt, 0.));
  return true;
}

Referenced by ElectronDiffusion(), ElectronDiffusion(), HoleDiffusion(), HoleDiffusion(), and IonDiffusion().

Diffusion() [2/2]

bool Garfield::Medium::Diffusion ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< std::vector< double > > > > & diff, double cov[3][3] ) const

protected

Definition at line 372 of file Medium.cc.

                          {
 
  // Initialise the tensor.
  cov[0][0] = cov[0][1] = cov[0][2] = 0.;
  cov[1][0] = cov[1][1] = cov[1][2] = 0.;
  cov[2][0] = cov[2][1] = cov[2][2] = 0.;
 
  if (diff.empty()) return false;
 
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return true;
 
  // Compute the magnitude of the magnetic field.
  const double b = m_tab2d ? sqrt(bx * bx + by * by + bz * bz) : 0.;
  // Compute the angle between B field and E field.
  const double ebang = m_tab2d ? GetAngle(ex, ey, ez, bx, by, bz, e, b) : 0.;
 
  for (int j = 0; j < 6; ++j) {
    // Interpolate.
    double y = 0.;
    if (!Interpolate(e0, b, ebang, diff[j], y, m_intpDif, m_extrDif)) y = 0.;
    // Apply scaling.
    y = ScaleDiffusionTensor(y);
    if (j < 3) {
      cov[j][j] = y;
    } else if (j == 3) {
      cov[0][1] = cov[1][0] = y;
    } else if (j == 4) {
      cov[0][2] = cov[2][0] = y;
    } else if (j == 5) {
      cov[1][2] = cov[2][1] = y;
    }
  }
  return true;
}

DisableDebugging()

void Garfield::Medium::DisableDebugging ( )

inline

Definition at line 526 of file Medium.hh.

{ m_debug = false; }

ElectronAttachment()

bool Garfield::Medium::ElectronAttachment ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double & eta )

virtual

Attachment coefficient [cm-1].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 481 of file Medium.cc.

                                                                               {
 
  if (!Alpha(ex, ey, ez, bx, by, bz, m_eAtt, m_intpAtt, m_eThrAtt, m_extrAtt, 
             eta)) {
    return false;
  } 
  // Apply scaling.
  eta = ScaleAttachment(eta);
  return true;
}

Referenced by Garfield::MediumCdTe::ElectronAttachment(), Garfield::MediumDiamond::ElectronAttachment(), Garfield::MediumGaAs::ElectronAttachment(), Garfield::MediumGaN::ElectronAttachment(), and Garfield::MediumSilicon::ElectronAttachment().

ElectronCollision()

bool Garfield::Medium::ElectronCollision ( const double e, int & type, int & level, double & e1, double & dx, double & dy, double & dz, std::vector< std::pair< Particle, double > > & secondaries, int & ndxc, int & band )

virtual

Sample the collision type. Update energy and direction vector.

Reimplemented in Garfield::MediumMagboltz, and Garfield::MediumSilicon.

Definition at line 556 of file Medium.cc.

                          {
  type = level = -1;
  e1 = e;
  ndxc = band = 0;
  RndmDirection(dx, dy, dz);
 
  if (m_debug) PrintNotImplemented(m_className, "GetElectronCollision");
  return false;
}

ElectronDiffusion() [1/2]

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

virtual

Longitudinal and transverse diffusion coefficients [cm1/2].

Definition at line 452 of file Medium.cc.

                                           {
 
  return Diffusion(ex, ey, ez, bx, by, bz, m_eDifL, m_eDifT, dl, dt);
}

ElectronDiffusion() [2/2]

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

virtual

Diffusion tensor: diagonal elements are the diffusion coefficients [cm] along e, btrans, e x b, off-diagonal elements are the covariances

Definition at line 460 of file Medium.cc.

                                                 {
 
  return Diffusion(ex, ey, ez, bx, by, bz, m_eDifM, cov);
}

ElectronLorentzAngle()

bool Garfield::Medium::ElectronLorentzAngle ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double & lor )

virtual

Lorentz angle.

Definition at line 494 of file Medium.cc.

                                               {
  lor = 0.;
  if (m_eLor.empty()) return false;
 
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return true;
 
  // Compute the magnitude of the magnetic field.
  const double b = m_tab2d ? sqrt(bx * bx + by * by + bz * bz) : 0.;
  // Compute the angle between B field and E field.
  const double ebang = m_tab2d ? GetAngle(ex, ey, ez, bx, by, bz, e, b) : 0.;
 
  // Interpolate.
  if (!Interpolate(e0, b, ebang, m_eLor, lor, m_intpLor, m_extrLor)) lor = 0.;
  // Apply scaling.
  lor = ScaleLorentzAngle(lor);
  return true;
}

ElectronMobility()

double Garfield::Medium::ElectronMobility ( )

virtual

Low-field mobility [cm2 V-1 ns-1].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 518 of file Medium.cc.

                                {
  if (m_eVelE.empty()) return -1.;
  return m_eVelE[0][0][0] / UnScaleElectricField(m_eFields[0]);
}

ElectronTownsend()

bool Garfield::Medium::ElectronTownsend ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double & alpha )

virtual

Ionisation coefficient [cm-1].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 468 of file Medium.cc.

                                             {
 
  if (!Alpha(ex, ey, ez, bx, by, bz, m_eAlp, m_intpAlp, m_eThrAlp, m_extrAlp, 
             alpha)) {
    return false;
  } 
  // Apply scaling.
  alpha = ScaleTownsend(alpha);
  return true;
}

Referenced by Garfield::MediumCdTe::ElectronTownsend(), Garfield::MediumDiamond::ElectronTownsend(), Garfield::MediumGaAs::ElectronTownsend(), Garfield::MediumGaN::ElectronTownsend(), and Garfield::MediumSilicon::ElectronTownsend().

ElectronVelocity()

bool Garfield::Medium::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

Drift velocity [cm / ns].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 444 of file Medium.cc.

                                                                  {
 
  return Velocity(ex, ey, ez, bx, by, bz, m_eVelE, m_eVelB, m_eVelX, -1., 
                  vx, vy, vz);
}

Referenced by Garfield::MediumCdTe::ElectronVelocity(), Garfield::MediumDiamond::ElectronVelocity(), Garfield::MediumGaAs::ElectronVelocity(), Garfield::MediumGaN::ElectronVelocity(), and Garfield::MediumSilicon::ElectronVelocity().

EnableDebugging()

void Garfield::Medium::EnableDebugging ( )

inline

Switch on/off debugging messages.

Definition at line 525 of file Medium.hh.

{ m_debug = true; }

EnableDrift()

virtual void Garfield::Medium::EnableDrift ( const bool on = true )

inlinevirtual

Switch electron/ion/hole transport on/off.

Reimplemented in Garfield::MediumConductor, and Garfield::MediumPlastic.

Definition at line 70 of file Medium.hh.

{ m_driftable = on; }

EnablePrimaryIonisation()

virtual void Garfield::Medium::EnablePrimaryIonisation ( const bool on = true )

inlinevirtual

Make the medium ionisable or non-ionisable.

Reimplemented in Garfield::MediumConductor, and Garfield::MediumPlastic.

Definition at line 72 of file Medium.hh.

                                                             { 
    m_ionisable = on; 
  }

GetAngle()

double Garfield::Medium::GetAngle ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const double e, const double b ) const

protected

Definition at line 1300 of file Medium.cc.

                                                                    {
  const double eb = emag * bmag; 
  if (eb <= 0.) return m_bAngles[0];
  const double einb = fabs(ex * bx + ey * by + ez * bz);
  if (einb > 0.2 * eb) {
    double exb[3] = {ex * by - ey * bx, ex * bz - ez * bx, ez * by - ey * bz};
    return asin(
        std::min(1., sqrt(exb[0] * exb[0] + exb[1] * exb[1] + exb[2] * exb[2]) / eb));
  }
  return acos(std::min(1., einb / eb));
}

Referenced by Alpha(), Diffusion(), Diffusion(), ElectronLorentzAngle(), IonVelocity(), NegativeIonVelocity(), and Velocity().

GetAtomicNumber()

virtual double Garfield::Medium::GetAtomicNumber ( ) const

inlinevirtual

Get the effective atomic number.

Reimplemented in Garfield::MediumGas.

Definition at line 55 of file Medium.hh.

{ return m_z; }

Referenced by Garfield::TrackSrim::NewTrack().

GetAtomicWeight()

virtual double Garfield::Medium::GetAtomicWeight ( ) const

inlinevirtual

Get the effective atomic weight.

Reimplemented in Garfield::MediumGas.

Definition at line 59 of file Medium.hh.

{ return m_a; }

GetComponent()

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

virtual

Get the name and fraction of a given component.

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumGas.

Definition at line 106 of file Medium.cc.

                                                                           {
  if (i >= m_nComponents) {
    std::cerr << m_className << "::GetComponent: Index out of range.\n";
  }
 
  label = m_name;
  f = 1.;
}

Referenced by Garfield::TrackDegrade::Initialise(), and Garfield::TrackDegrade::SetupPenning().

GetDeexcitationProduct()

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

virtual

Reimplemented in Garfield::MediumMagboltz.

Definition at line 569 of file Medium.cc.

                                                          {
  if (m_debug) PrintNotImplemented(m_className, "GetDeexcitationProduct");
  t = s = energy = 0.;
  type = 0;
  return false;
}

GetDielectricConstant()

double Garfield::Medium::GetDielectricConstant ( ) const

inline

Get the relative static dielectric constant.

Definition at line 45 of file Medium.hh.

{ return m_epsilon; }

Referenced by Garfield::ComponentNeBem3d::GetVolume(), and Garfield::ComponentNeBem3d::Initialise().

GetDielectricFunction()

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

virtual

Get the complex dielectric function at a given energy.

Reimplemented in Garfield::MediumSilicon.

Definition at line 734 of file Medium.cc.

                                                         {
  if (i >= m_nComponents) {
    std::cerr << m_className << "::GetDielectricFunction: Index out of range.\n";
    return false;
  }
 
  if (e < 0.) {
    std::cerr << m_className << "::GetDielectricFunction: Energy must be > 0.\n";
    return false;
  }
 
  if (m_debug) PrintNotImplemented(m_className, "GetDielectricFunction");
  eps1 = 1.;
  eps2 = 0.;
  return false;
}

GetElectronAttachment()

bool Garfield::Medium::GetElectronAttachment ( const size_t ie, const size_t ib, const size_t ia, double & eta )

inline

Get an entry in the table of attachment coefficients.

Definition at line 291 of file Medium.hh.

                                                           {
    return GetEntry(ie, ib, ia, "ElectronAttachment", m_eAtt, eta);
  }

GetElectronCollisionRate()

double Garfield::Medium::GetElectronCollisionRate ( const double e, const int band = 0 )

virtual

Collision rate [ns-1] for given electron energy.

Reimplemented in Garfield::MediumMagboltz, and Garfield::MediumSilicon.

Definition at line 550 of file Medium.cc.

                                                     {
  if (m_debug) PrintNotImplemented(m_className, "GetElectronCollisionRate");
  return 0.;
}

GetElectronEnergy()

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

virtual

Dispersion relation (energy vs. wave vector)

Reimplemented in Garfield::MediumSilicon.

Definition at line 523 of file Medium.cc.

                                                             {
  if (band > 0) {
    std::cerr << m_className << "::GetElectronEnergy:\n";
    std::cerr << "    Unknown band index.\n";
  }
 
  vx = SpeedOfLight * px / ElectronMass;
  vy = SpeedOfLight * py / ElectronMass;
  vz = SpeedOfLight * pz / ElectronMass;
 
  return 0.5 * (px * px + py * py + pz * pz) / ElectronMass;
}

GetElectronLongitudinalDiffusion()

bool Garfield::Medium::GetElectronLongitudinalDiffusion ( const size_t ie, const size_t ib, const size_t ia, double & dl )

inline

Get an entry in the table of longitudinal diffusion coefficients.

Definition at line 261 of file Medium.hh.

                                                                     {
    return GetEntry(ie, ib, ia, "ElectronLongitudinalDiffusion", m_eDifL, dl);
  }

GetElectronLorentzAngle()

bool Garfield::Medium::GetElectronLorentzAngle ( const size_t ie, const size_t ib, const size_t ia, double & lor )

inline

Get an entry in the table of Lorentz angles.

Definition at line 302 of file Medium.hh.

                                                             {
    return GetEntry(ie, ib, ia, "ElectronLorentzAngle", m_eLor, lor);
  }

GetElectronMomentum()

void Garfield::Medium::GetElectronMomentum ( const double e, double & px, double & py, double & pz, int & band )

virtual

Sample the momentum vector for a given energy (only meaningful in semiconductors).

Reimplemented in Garfield::MediumSilicon.

Definition at line 538 of file Medium.cc.

                                                        {
  const double p = sqrt(2. * ElectronMass * e) / SpeedOfLight;
  RndmDirection(px, py, pz, p);
  band = -1;
}

GetElectronNullCollisionRate()

double Garfield::Medium::GetElectronNullCollisionRate ( const int band = 0 )

virtual

Null-collision rate [ns-1].

Reimplemented in Garfield::MediumMagboltz, and Garfield::MediumSilicon.

Definition at line 545 of file Medium.cc.

                                                       {
  if (m_debug) PrintNotImplemented(m_className, "GetElectronNullCollisionRate");
  return 0.;
}

GetElectronTownsend()

bool Garfield::Medium::GetElectronTownsend ( const size_t ie, const size_t ib, const size_t ia, double & alpha )

inline

Get an entry in the table of Townsend coefficients.

Definition at line 281 of file Medium.hh.

                                                           {
    return GetEntry(ie, ib, ia, "ElectronTownsend", m_eAlp, alpha);
  }

GetElectronTransverseDiffusion()

bool Garfield::Medium::GetElectronTransverseDiffusion ( const size_t ie, const size_t ib, const size_t ia, double & dt )

inline

Get an entry in the table of transverse diffusion coefficients.

Definition at line 271 of file Medium.hh.

                                                                   {
    return GetEntry(ie, ib, ia, "ElectronTransverseDiffusion", m_eDifT, dt);
  }

GetElectronVelocityB()

bool Garfield::Medium::GetElectronVelocityB ( const size_t ie, const size_t ib, const size_t ia, double & v )

inline

Get an entry in the table of drift speeds along Btrans.

Definition at line 251 of file Medium.hh.

                                                        {
    return GetEntry(ie, ib, ia, "ElectronVelocityB", m_eVelB, v);
  }

GetElectronVelocityE()

bool Garfield::Medium::GetElectronVelocityE ( const size_t ie, const size_t ib, const size_t ia, double & v )

inline

Get an entry in the table of drift speeds along E.

Definition at line 231 of file Medium.hh.

                                                        {
    return GetEntry(ie, ib, ia, "ElectronVelocityE", m_eVelE, v);
  }

GetElectronVelocityExB()

bool Garfield::Medium::GetElectronVelocityExB ( const size_t ie, const size_t ib, const size_t ia, double & v )

inline

Get an entry in the table of drift speeds along ExB.

Definition at line 241 of file Medium.hh.

                                                          {
    return GetEntry(ie, ib, ia, "ElectronVelocityExB", m_eVelX, v);
  }

GetEntry()

bool Garfield::Medium::GetEntry ( const size_t i, const size_t j, const size_t k, const std::string & fcn, const std::vector< std::vector< std::vector< double > > > & tab, double & val ) const

protected

Definition at line 982 of file Medium.cc.

                                         {
  val = 0.;
  if (i >= m_eFields.size() || j >= m_bFields.size() || k >= m_bAngles.size()) {
    PrintOutOfRange(m_className, "Get" + fcn, i, j, k);
    return false;
  }
  if (tab.empty()) {
    if (m_debug) PrintDataNotAvailable(m_className, "Get" + fcn);
    return false;
  }
  val = tab[k][j][i];
  return true;
}

Referenced by GetElectronAttachment(), Garfield::MediumGas::GetElectronExcitationRate(), Garfield::MediumGas::GetElectronIonisationRate(), GetElectronLongitudinalDiffusion(), GetElectronLorentzAngle(), GetElectronTownsend(), GetElectronTransverseDiffusion(), GetElectronVelocityB(), GetElectronVelocityE(), GetElectronVelocityExB(), GetHoleAttachment(), GetHoleLongitudinalDiffusion(), GetHoleTownsend(), GetHoleTransverseDiffusion(), GetHoleVelocityB(), GetHoleVelocityE(), GetHoleVelocityExB(), GetIonDissociation(), GetIonLongitudinalDiffusion(), GetIonMobility(), GetIonTransverseDiffusion(), and GetNegativeIonMobility().

GetExtrapolationIndex()

bool Garfield::Medium::GetExtrapolationIndex ( std::string str, unsigned int & nb ) const

protected

Definition at line 1235 of file Medium.cc.

                                                                        {
  // Convert to upper-case.
  std::transform(str.begin(), str.end(), str.begin(), toupper);
 
  if (str == "CONST" || str == "CONSTANT") {
    nb = 0;
  } else if (str == "LIN" || str == "LINEAR") {
    nb = 1;
  } else if (str == "EXP" || str == "EXPONENTIAL") {
    nb = 2;
  } else {
    return false;
  }
 
  return true;
}

Referenced by SetExtrapolationMethod().

GetFanoFactor()

double Garfield::Medium::GetFanoFactor ( ) const

inline

Get the Fano factor.

Definition at line 90 of file Medium.hh.

{ return m_fano; }

Referenced by Garfield::TrackSrim::NewTrack(), and Garfield::TrackTrim::NewTrack().

GetFieldGrid()

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

Get the fields and E-B angles used in the transport tables.

Definition at line 958 of file Medium.cc.

                                                     {
  efields = m_eFields;
  bfields = m_bFields;
  angles = m_bAngles;
}

GetHoleAttachment()

bool Garfield::Medium::GetHoleAttachment ( const size_t ie, const size_t ib, const size_t ia, double & eta )

inline

Get an entry in the table of attachment coefficients.

Definition at line 374 of file Medium.hh.

                                                       {
    return GetEntry(ie, ib, ia, "HoleAttachment", m_hAtt, eta);
  }

GetHoleLongitudinalDiffusion()

bool Garfield::Medium::GetHoleLongitudinalDiffusion ( const size_t ie, const size_t ib, const size_t ia, double & dl )

inline

Get an entry in the table of longitudinal diffusion coefficients.

Definition at line 344 of file Medium.hh.

                                                                 {
    return GetEntry(ie, ib, ia, "HoleLongitudinalDiffusion", m_hDifL, dl);
  }

GetHoleTownsend()

bool Garfield::Medium::GetHoleTownsend ( const size_t ie, const size_t ib, const size_t ia, double & alpha )

inline

Get an entry in the table of Townsend coefficients.

Definition at line 364 of file Medium.hh.

                                                       {
    return GetEntry(ie, ib, ia, "HoleTownsend", m_hAlp, alpha);
  }

GetHoleTransverseDiffusion()

bool Garfield::Medium::GetHoleTransverseDiffusion ( const size_t ie, const size_t ib, const size_t ia, double & dt )

inline

Get an entry in the table of transverse diffusion coefficients.

Definition at line 354 of file Medium.hh.

                                                               {
    return GetEntry(ie, ib, ia, "HoleTransverseDiffusion", m_hDifT, dt);
  }

GetHoleVelocityB()

bool Garfield::Medium::GetHoleVelocityB ( const size_t ie, const size_t ib, const size_t ia, double & v )

inline

Get an entry in the table of drift speeds along Btrans.

Definition at line 333 of file Medium.hh.

                                                    {
    return GetEntry(ie, ib, ia, "HoleVelocityB", m_hVelB, v);
  }

GetHoleVelocityE()

bool Garfield::Medium::GetHoleVelocityE ( const size_t ie, const size_t ib, const size_t ia, double & v )

inline

Get an entry in the table of drift speeds along E.

Definition at line 313 of file Medium.hh.

                                                    {
    return GetEntry(ie, ib, ia, "HoleVelocityE", m_hVelE, v);
  }

GetHoleVelocityExB()

bool Garfield::Medium::GetHoleVelocityExB ( const size_t ie, const size_t ib, const size_t ia, double & v )

inline

Get an entry in the table of drift speeds along ExB.

Definition at line 323 of file Medium.hh.

                                                      {
    return GetEntry(ie, ib, ia, "HoleVelocityExB", m_hVelX, v);
  }

GetId()

int Garfield::Medium::GetId ( ) const

inline

Return the id number of the class instance.

Definition at line 24 of file Medium.hh.

{ return m_id; }

Referenced by Garfield::ComponentNeBem3d::GetVolume(), and Garfield::ViewGeometry::Plot3d().

GetIonDissociation()

bool Garfield::Medium::GetIonDissociation ( const size_t ie, const size_t ib, const size_t ia, double & diss )

inline

Get an entry in the table of dissociation coefficients.

Definition at line 421 of file Medium.hh.

                                                         {
    return GetEntry(ie, ib, ia, "IonDissociation", m_iDis, diss);
  }

GetIonLongitudinalDiffusion()

bool Garfield::Medium::GetIonLongitudinalDiffusion ( const size_t ie, const size_t ib, const size_t ia, double & dl )

inline

Get an entry in the table of longitudinal diffusion coefficients.

Definition at line 401 of file Medium.hh.

                                                                {
    return GetEntry(ie, ib, ia, "IonLongitudinalDiffusion", m_iDifL, dl);
  } 

GetIonMobility()

bool Garfield::Medium::GetIonMobility ( const size_t ie, const size_t ib, const size_t ia, double & mu )

inline

Get an entry in the table of ion mobilities.

Definition at line 390 of file Medium.hh.

                                                   {
    return GetEntry(ie, ib, ia, "IonMobility", m_iMob, mu);
  }

GetIonTransverseDiffusion()

bool Garfield::Medium::GetIonTransverseDiffusion ( const size_t ie, const size_t ib, const size_t ia, double & dt )

inline

Get an entry in the table of transverse diffusion coefficients.

Definition at line 411 of file Medium.hh.

                                                              {
    return GetEntry(ie, ib, ia, "IonTransverseDiffusion", m_iDifT, dt);
  }

GetMassDensity()

double Garfield::Medium::GetMassDensity ( ) const

virtual

Get the mass density [g/cm3].

Reimplemented in Garfield::MediumGas.

Definition at line 102 of file Medium.cc.

                                    {
  return m_density * AtomicMassUnit * m_a;
}

Referenced by Garfield::TrackHeed::NewTrack(), Garfield::TrackSrim::NewTrack(), Garfield::GeometryRoot::SetMedium(), Garfield::TrackHeed::TransportDeltaElectron(), and Garfield::TrackHeed::TransportPhoton().

GetName()

const std::string & Garfield::Medium::GetName ( ) const

inline

Get the medium name/identifier.

Definition at line 26 of file Medium.hh.

{ return m_name; }

Referenced by Garfield::TrackDegrade::Initialise(), Garfield::TrackDegrade::IsInside(), Garfield::TrackBichsel::NewTrack(), Garfield::TrackDegrade::NewTrack(), Garfield::TrackElectron::NewTrack(), Garfield::TrackHeed::NewTrack(), Garfield::TrackPAI::NewTrack(), Garfield::TrackSrim::NewTrack(), Garfield::ComponentFieldMap::SetGas(), Garfield::ComponentFieldMap::SetMedium(), Garfield::ComponentTcadBase< N >::SetMedium(), Garfield::GeometryRoot::SetMedium(), Garfield::TrackHeed::TransportDeltaElectron(), and Garfield::TrackHeed::TransportPhoton().

GetNegativeIonMobility()

bool Garfield::Medium::GetNegativeIonMobility ( const size_t ie, const size_t ib, const size_t ia, double & mu )

inline

Get an entry in the table of negative ion mobilities.

Definition at line 432 of file Medium.hh.

                                                           {
    return GetEntry(ie, ib, ia, "NegativeIonMobility", m_nMob, mu);
  }

GetNumberDensity()

virtual double Garfield::Medium::GetNumberDensity ( ) const

inlinevirtual

Get the number density [cm-3].

Reimplemented in Garfield::MediumGas.

Definition at line 63 of file Medium.hh.

{ return m_density; }

Referenced by Garfield::TrackBichsel::Initialise(), Garfield::TrackElectron::NewTrack(), Garfield::TrackPAI::NewTrack(), and Garfield::TrackSrim::NewTrack().

GetNumberOfComponents()

unsigned int Garfield::Medium::GetNumberOfComponents ( ) const

inline

Get number of components of the medium.

Definition at line 48 of file Medium.hh.

{ return m_nComponents; }

Referenced by Garfield::TrackDegrade::Initialise(), and Garfield::TrackDegrade::SetupPenning().

GetNumberOfDeexcitationProducts()

virtual unsigned int Garfield::Medium::GetNumberOfDeexcitationProducts ( ) const

inlinevirtual

Reimplemented in Garfield::MediumMagboltz.

Definition at line 159 of file Medium.hh.

{ return 0; }

GetOpticalDataRange()

bool Garfield::Medium::GetOpticalDataRange ( double & emin, double & emax, const unsigned int i = 0 )

virtual

Get the energy range [eV] of the available optical data.

Reimplemented in Garfield::MediumSilicon.

Definition at line 722 of file Medium.cc.

                                                       {
  if (i >= m_nComponents) {
    std::cerr << m_className << "::GetOpticalDataRange: Index out of range.\n";
    return false;
  }
 
  if (m_debug) PrintNotImplemented(m_className, "GetOpticalDataRange");
  emin = emax = 0.;
  return false;
}

GetPhotoAbsorptionCrossSection()

bool Garfield::Medium::GetPhotoAbsorptionCrossSection ( const double e, double & sigma, const unsigned int i = 0 )

virtual

Reimplemented in Garfield::MediumGas.

Definition at line 752 of file Medium.cc.

                                                                  {
  if (i >= m_nComponents) {
    std::cerr << m_className << "::GetPhotoAbsorptionCrossSection:\n";
    std::cerr << "    Component " << i << " does not exist.\n";
    return false;
  }
 
  if (e < 0.) {
    std::cerr << m_className << "::GetPhotoAbsorptionCrossSection:\n";
    std::cerr << "    Energy must be > 0.\n";
    return false;
  }
 
  if (m_debug) {
    PrintNotImplemented(m_className, "GetPhotoAbsorptionCrossSection");
  }
  sigma = 0.;
  return false;
}

Referenced by GetPhotonCollisionRate().

GetPhotonCollision()

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

virtual

Reimplemented in Garfield::MediumMagboltz.

Definition at line 780 of file Medium.cc.

                                              {
  type = level = -1;
  e1 = e;
  ctheta = 1.;
  nsec = 0;
  esec = 0.;
  return false;
}

GetPhotonCollisionRate()

double Garfield::Medium::GetPhotonCollisionRate ( const double e )

virtual

Reimplemented in Garfield::MediumMagboltz.

Definition at line 773 of file Medium.cc.

                                                    {
  double sigma = 0.;
  if (!GetPhotoAbsorptionCrossSection(e, sigma)) return 0.;
 
  return sigma * m_density * SpeedOfLight;
}

GetPressure()

double Garfield::Medium::GetPressure ( ) const

inline

Definition at line 41 of file Medium.hh.

{ return m_pressure; }

Referenced by Garfield::TrackDegrade::Initialise(), Garfield::TrackDegrade::IsInside(), and Garfield::TrackDegrade::NewTrack().

GetTemperature()

double Garfield::Medium::GetTemperature ( ) const

inline

Get the temperature [K].

Definition at line 37 of file Medium.hh.

{ return m_temperature; }

Referenced by Garfield::TrackDegrade::Initialise(), Garfield::TrackDegrade::IsInside(), and Garfield::TrackDegrade::NewTrack().

GetW()

double Garfield::Medium::GetW ( ) const

inline

Get the W value.

Definition at line 86 of file Medium.hh.

{ return m_w; }

Referenced by Garfield::TrackSrim::NewTrack(), and Garfield::TrackTrim::NewTrack().

HoleAttachment()

bool Garfield::Medium::HoleAttachment ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double & eta )

virtual

Attachment coefficient [cm-1].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 612 of file Medium.cc.

                                         {
 
  if (!Alpha(ex, ey, ez, bx, by, bz, m_hAtt, m_intpAtt, m_hThrAtt, m_extrAtt, 
             eta)) {
    return false;
  } 
  // Apply scaling.
  eta = ScaleAttachment(eta);
  return true;
}

Referenced by Garfield::MediumCdTe::HoleAttachment(), Garfield::MediumDiamond::HoleAttachment(), Garfield::MediumGaAs::HoleAttachment(), Garfield::MediumGaN::HoleAttachment(), and Garfield::MediumSilicon::HoleAttachment().

HoleDiffusion() [1/2]

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

virtual

Longitudinal and transverse diffusion coefficients [cm1/2].

Definition at line 586 of file Medium.cc.

                                                   {
  return Diffusion(ex, ey, ez, bx, by, bz, m_hDifL, m_hDifT, dl, dt);
}

HoleDiffusion() [2/2]

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

virtual

Diffusion tensor.

Definition at line 592 of file Medium.cc.

                                             {
 
  return Diffusion(ex, ey, ez, bx, by, bz, m_hDifM, cov);
}

HoleMobility()

double Garfield::Medium::HoleMobility ( )

virtual

Low-field mobility [cm2 V-1 ns-1].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 625 of file Medium.cc.

                            {
  if (m_hVelE.empty()) return -1.;
  return m_hVelE[0][0][0] / UnScaleElectricField(m_eFields[0]);
}

HoleTownsend()

bool Garfield::Medium::HoleTownsend ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double & alpha )

virtual

Ionisation coefficient [cm-1].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 599 of file Medium.cc.

                                         {
 
  if (!Alpha(ex, ey, ez, bx, by, bz, m_hAlp, m_intpAlp, m_hThrAlp, m_extrAlp, 
             alpha)) {
    return false;
  } 
  // Apply scaling.
  alpha = ScaleTownsend(alpha);
  return true;
}

Referenced by Garfield::MediumCdTe::HoleTownsend(), Garfield::MediumDiamond::HoleTownsend(), Garfield::MediumGaAs::HoleTownsend(), Garfield::MediumGaN::HoleTownsend(), and Garfield::MediumSilicon::HoleTownsend().

HoleVelocity()

bool Garfield::Medium::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

Drift velocity [cm / ns].

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 578 of file Medium.cc.

                                                              {
 
  return Velocity(ex, ey, ez, bx, by, bz, m_hVelE, m_hVelB, m_hVelX, +1., 
                  vx, vy, vz);
}

Referenced by Garfield::MediumCdTe::HoleVelocity(), Garfield::MediumDiamond::HoleVelocity(), Garfield::MediumGaAs::HoleVelocity(), Garfield::MediumGaN::HoleVelocity(), and Garfield::MediumSilicon::HoleVelocity().

Init() [1/2]

void Garfield::Medium::Init ( const size_t nE, const size_t nB, const size_t nA, const size_t nT, std::vector< std::vector< std::vector< std::vector< double > > > > & tab, const double val )

protected

Definition at line 1419 of file Medium.cc.

                      {
  if (nE == 0 || nB == 0 || nA == 0 || nT == 0) {
    std::cerr << m_className << "::Init: Invalid grid.\n";
    return;
  }
 
  tab.assign(nT, std::vector<std::vector<std::vector<double> > >(
                     nA, std::vector<std::vector<double> >(
                             nB, std::vector<double>(nE, val))));
}

Init() [2/2]

void Garfield::Medium::Init ( const size_t nE, const size_t nB, const size_t nA, std::vector< std::vector< std::vector< double > > > & tab, const double val )

protected

Definition at line 1408 of file Medium.cc.

                                    {
  if (nE == 0 || nB == 0 || nA == 0) {
    std::cerr << m_className << "::Init: Invalid grid.\n";
    return;
  }
  tab.assign(
      nA, std::vector<std::vector<double> >(nB, std::vector<double>(nE, val)));
}

Referenced by Clone(), Clone(), Garfield::MediumMagboltz::GenerateGasTable(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), SetEntry(), and SetIonMobility().

Interpolate()

bool Garfield::Medium::Interpolate ( const double e, const double b, const double a, const std::vector< std::vector< std::vector< double > > > & table, double & y, const unsigned int intp, const std::pair< unsigned int, unsigned int > & extr ) const

protected

Definition at line 1314 of file Medium.cc.

                                                           {
  if (table.empty()) {
    y = 0.;
    return false;  // TODO: true!
  }
 
  if (m_tab2d) {
    return Numerics::Boxin3(table, m_bAngles, m_bFields, m_eFields,
                            m_bAngles.size(), m_bFields.size(), m_eFields.size(),
                            a, b, e, y, intp);
  } else {
    y = Interpolate1D(e, table[0][0], m_eFields, intp, extr);
  }
  return true;
}

Referenced by Alpha(), Clone(), Clone(), Diffusion(), Diffusion(), ElectronLorentzAngle(), IonVelocity(), NegativeIonVelocity(), and Velocity().

Interpolate1D()

double Garfield::Medium::Interpolate1D ( const double e, const std::vector< double > & table, const std::vector< double > & fields, const unsigned int intpMeth, const std::pair< unsigned int, unsigned int > & extr ) const

protected

Definition at line 1334 of file Medium.cc.

                                                           {
  // This function is a generalized version of the Fortran functions
  // GASVEL, GASVT1, GASVT2, GASLOR, GASMOB, GASDFT, and GASDFL
  // for the case of a 1D table. All variables are generic.
 
  const auto nSizeTable = fields.size();
 
  if (e < 0. || nSizeTable < 1) return 0.;
 
  double result = 0.;
 
  if (nSizeTable == 1) {
    // Only one point
    result = table[0];
  } else if (e < fields[0]) {
    // Extrapolation towards small fields
    if (fields[0] >= fields[1]) {
      if (m_debug) {
        std::cerr << m_className << "::Interpolate1D:\n";
        std::cerr << "    First two field values coincide.\n";
        std::cerr << "    No extrapolation to lower fields.\n";
      }
      result = table[0];
    } else if (extr.first == 1) {
      // Linear extrapolation
      const double extr4 = (table[1] - table[0]) / (fields[1] - fields[0]);
      const double extr3 = table[0] - extr4 * fields[0];
      result = extr3 + extr4 * e;
    } else if (extr.first == 2) {
      // Logarithmic extrapolation
      const double extr4 = log(table[1] / table[0]) / (fields[1] - fields[0]);
      const double extr3 = log(table[0] - extr4 * fields[0]);
      result = std::exp(std::min(50., extr3 + extr4 * e));
    } else {
      result = table[0];
    }
  } else if (e > fields[nSizeTable - 1]) {
    // Extrapolation towards large fields
    if (fields[nSizeTable - 1] <= fields[nSizeTable - 2]) {
      if (m_debug) {
        std::cerr << m_className << "::Interpolate1D:\n";
        std::cerr << "    Last two field values coincide.\n";
        std::cerr << "    No extrapolation to higher fields.\n";
      }
      result = table[nSizeTable - 1];
    } else if (extr.second == 1) {
      // Linear extrapolation
      const double extr2 = (table[nSizeTable - 1] - table[nSizeTable - 2]) /
                           (fields[nSizeTable - 1] - fields[nSizeTable - 2]);
      const double extr1 =
          table[nSizeTable - 1] - extr2 * fields[nSizeTable - 1];
      result = extr1 + extr2 * e;
    } else if (extr.second == 2) {
      // Logarithmic extrapolation
      const double extr2 = log(table[nSizeTable - 1] / table[nSizeTable - 2]) /
                           (fields[nSizeTable - 1] - fields[nSizeTable - 2]);
      const double extr1 =
          log(table[nSizeTable - 1]) - extr2 * fields[nSizeTable - 1];
      result = exp(std::min(50., extr1 + extr2 * e));
    } else {
      result = table[nSizeTable - 1];
    }
  } else {
    // Intermediate points, spline interpolation (not implemented).
    // Intermediate points, Newtonian interpolation
    result = Numerics::Divdif(table, fields, nSizeTable, e, intpMeth);
  }
 
  return result;
}

Referenced by Interpolate(), and SetIonMobility().

IonDiffusion()

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

virtual

Longitudinal and transverse diffusion coefficients [cm1/2].

Definition at line 660 of file Medium.cc.

                                                  {
 
  return Diffusion(ex, ey, ez, bx, by, bz, m_iDifL, m_iDifT, dl, dt);
}

IonDissociation()

bool Garfield::Medium::IonDissociation ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, double & diss )

virtual

Dissociation coefficient.

Definition at line 667 of file Medium.cc.

                                           {
 
  if (!Alpha(ex, ey, ez, bx, by, bz, m_iDis, m_intpDis, m_iThrDis, m_extrDis, 
             diss)) {
    return false;
  } 
  // Apply scaling.
  diss = ScaleDissociation(diss);
  return true;
}

IonMobility()

double Garfield::Medium::IonMobility ( )

virtual

Low-field ion mobility [cm2 V-1 ns-1].

Definition at line 680 of file Medium.cc.

                           {
  return m_iMob.empty() ? -1. : m_iMob[0][0][0];
}

Referenced by NegativeIonMobility().

IonVelocity()

bool Garfield::Medium::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

Ion drift velocity [cm / ns].

Definition at line 630 of file Medium.cc.

                                                             {
  vx = vy = vz = 0.;
  if (m_iMob.empty()) return false;
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return true;
  // Compute the magnitude of the electric field.
  const double b = sqrt(bx * bx + by * by + bz * bz);
 
  // Compute the angle between B field and E field.
  const double ebang = m_tab2d ? GetAngle(ex, ey, ez, bx, by, bz, e, b) : 0.;
  double mu = 0.;
  if (!Interpolate(e0, b, ebang, m_iMob, mu, m_intpMob, m_extrMob)) mu = 0.;
 
  constexpr double q = 1.;
  mu *= q;
  if (b < Small) {
    vx = mu * ex;
    vy = mu * ey;
    vz = mu * ez;
  } else {
    Langevin(ex, ey, ez, bx, by, bz, mu, vx, vy, vz);
  }
 
  return true;
}

IsConductor()

virtual bool Garfield::Medium::IsConductor ( ) const

inlinevirtual

Is this medium a conductor?

Reimplemented in Garfield::MediumConductor.

Definition at line 32 of file Medium.hh.

{ return false; }

Referenced by Garfield::ComponentNeBem3d::Initialise().

IsDriftable()

bool Garfield::Medium::IsDriftable ( ) const

inline

Is charge carrier transport enabled in this medium?

Definition at line 77 of file Medium.hh.

{ return m_driftable; }

Referenced by Garfield::ComponentAnalyticField::ElectricField(), Garfield::ComponentAnalyticField::ElectricField(), Garfield::ComponentConstant::ElectricField(), Garfield::ComponentConstant::ElectricField(), Garfield::ComponentFieldMap::ElectricField(), Garfield::ComponentNeBem3d::ElectricField(), Garfield::ComponentUser::ElectricField(), and Garfield::ComponentUser::ElectricField().

IsGas()

virtual bool Garfield::Medium::IsGas ( ) const

inlinevirtual

Is this medium a gas?

Reimplemented in Garfield::MediumGas.

Definition at line 28 of file Medium.hh.

{ return false; }

Referenced by Garfield::TrackDegrade::Initialise(), Garfield::TrackHeed::Initialise(), Garfield::TrackDegrade::IsInside(), Garfield::TrackElectron::NewTrack(), and Garfield::ViewGeometry::Plot3d().

IsIonisable()

bool Garfield::Medium::IsIonisable ( ) const

inline

Is charge deposition by charged particles/photon enabled in this medium?

Definition at line 81 of file Medium.hh.

{ return m_ionisable; }

Referenced by Garfield::TrackSrim::GetMedium(), Heed::HeedFieldMap::inside(), Garfield::TrackDegrade::IsInside(), Garfield::TrackBichsel::NewTrack(), Garfield::TrackElectron::NewTrack(), Garfield::TrackHeed::NewTrack(), Garfield::TrackPAI::NewTrack(), Garfield::TrackTrim::NewTrack(), Garfield::TrackHeed::TransportDeltaElectron(), and Garfield::TrackHeed::TransportPhoton().

IsMicroscopic()

bool Garfield::Medium::IsMicroscopic ( ) const

inline

Does the medium have electron scattering rates?

Definition at line 79 of file Medium.hh.

{ return m_microscopic; }

IsSemiconductor()

virtual bool Garfield::Medium::IsSemiconductor ( ) const

inlinevirtual

Is this medium a semiconductor?

Reimplemented in Garfield::MediumCdTe, Garfield::MediumDiamond, Garfield::MediumGaAs, Garfield::MediumGaN, and Garfield::MediumSilicon.

Definition at line 30 of file Medium.hh.

{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

Langevin() [1/2]

void Garfield::Medium::Langevin ( const double ex, const double ey, const double ez, double bx, double by, double bz, const double mu, const double muH, double & vx, double & vy, double & vz )

staticprotected

Definition at line 317 of file Medium.cc.

                                                          {
 
  bx *= Tesla2Internal;
  by *= Tesla2Internal;
  bz *= Tesla2Internal;
  const double b2 = bx * bx + by * by + bz * bz;
  const double mu2 = muH * muH;
  const double f = mu / (1. + mu2 * b2);
  const double eb = bx * ex + by * ey + bz * ez;
  vx = f * (ex + muH * (ey * bz - ez * by) + mu2 * bx * eb);
  vy = f * (ey + muH * (ez * bx - ex * bz) + mu2 * by * eb);
  vz = f * (ez + muH * (ex * by - ey * bx) + mu2 * bz * eb);
}

Langevin() [2/2]

void Garfield::Medium::Langevin ( const double ex, const double ey, const double ez, double bx, double by, double bz, const double mu, double & vx, double & vy, double & vz )

staticprotected

Definition at line 301 of file Medium.cc.

                                                          {
 
  bx *= Tesla2Internal;
  by *= Tesla2Internal;
  bz *= Tesla2Internal;
  const double b2 = bx * bx + by * by + bz * bz;
  const double mu2 = mu * mu;
  const double eb = bx * ex + by * ey + bz * ez;
  const double f = mu / (1. + mu2 * b2);
  vx = f * (ex + mu * (ey * bz - ez * by) + mu2 * bx * eb);
  vy = f * (ey + mu * (ez * bx - ex * bz) + mu2 * by * eb);
  vz = f * (ez + mu * (ex * by - ey * bx) + mu2 * bz * eb);
}

Referenced by Garfield::MediumCdTe::ElectronVelocity(), Garfield::MediumDiamond::ElectronVelocity(), Garfield::MediumGaAs::ElectronVelocity(), Garfield::MediumGaN::ElectronVelocity(), Garfield::MediumSilicon::ElectronVelocity(), Garfield::MediumCdTe::HoleVelocity(), Garfield::MediumDiamond::HoleVelocity(), Garfield::MediumGaAs::HoleVelocity(), Garfield::MediumGaN::HoleVelocity(), Garfield::MediumSilicon::HoleVelocity(), IonVelocity(), NegativeIonVelocity(), and Velocity().

NegativeIonMobility()

double Garfield::Medium::NegativeIonMobility ( )

virtual

Low-field negative ion mobility [cm2 V-1 ns-1].

Definition at line 718 of file Medium.cc.

                                   {
  return m_nMob.empty() ? IonMobility() : m_nMob[0][0][0];
}

NegativeIonVelocity()

bool Garfield::Medium::NegativeIonVelocity ( 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

Negative ion drift velocity [cm / ns].

Definition at line 684 of file Medium.cc.

                                        {
  vx = vy = vz = 0.;
  if (m_iMob.empty() && m_nMob.empty()) return false;
 
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return true;
  // Compute the magnitude of the electric field.
  const double b = sqrt(bx * bx + by * by + bz * bz);
 
  // Compute the angle between B field and E field.
  const double ebang = m_tab2d ? GetAngle(ex, ey, ez, bx, by, bz, e, b) : 0.;
  double mu = 0.;
  if (m_nMob.empty()) {
    if (!Interpolate(e0, b, ebang, m_iMob, mu, m_intpMob, m_extrMob)) mu = 0.;
  } else {
    if (!Interpolate(e0, b, ebang, m_nMob, mu, m_intpMob, m_extrMob)) mu = 0.;
  }
  constexpr double q = -1.;
  mu *= q;
  if (b < Small) {
    vx = mu * ex;
    vy = mu * ey;
    vz = mu * ez;
  } else {
    Langevin(ex, ey, ez, bx, by, bz, mu, vx, vy, vz);
  }
  return true;
}

PlotAlphaEta()

void Garfield::Medium::PlotAlphaEta	(	const std::string &	carriers,
		TPad *	pad )

Plot Townsend and attachment coefficients.

Definition at line 189 of file Medium.cc.

                                                         {
  ViewMedium view;
  view.SetMedium(this);
  if (pad) view.SetCanvas(pad);
  view.PlotAlphaEta(opt, 'e');
}

PlotAttachment()

void Garfield::Medium::PlotAttachment	(	const std::string &	carriers,
		TPad *	pad )

Plot the attachment coefficient(s) as function of the electric field.

Definition at line 182 of file Medium.cc.

                                                           {
  ViewMedium view;
  view.SetMedium(this);
  if (pad) view.SetCanvas(pad);
  view.PlotAttachment(opt, 'e');
}

PlotDiffusion()

void Garfield::Medium::PlotDiffusion	(	const std::string &	carriers,
		TPad *	pad )

Plot the diffusion coefficients as function of the electric field.

Definition at line 168 of file Medium.cc.

                                                          {
  ViewMedium view;
  view.SetMedium(this);
  if (pad) view.SetCanvas(pad);
  view.PlotDiffusion(opt, 'e');
}

PlotTownsend()

void Garfield::Medium::PlotTownsend	(	const std::string &	carriers,
		TPad *	pad )

Plot the Townsend coefficient(s) as function of the electric field.

Definition at line 175 of file Medium.cc.

                                                         {
  ViewMedium view;
  view.SetMedium(this);
  if (pad) view.SetCanvas(pad);
  view.PlotTownsend(opt, 'e');
}

PlotVelocity()

void Garfield::Medium::PlotVelocity	(	const std::string &	carriers,
		TPad *	pad )

Plot the drift velocity as function of the electric field.

Definition at line 161 of file Medium.cc.

                                                         {
  ViewMedium view;
  view.SetMedium(this);
  if (pad) view.SetCanvas(pad);
  view.PlotVelocity(opt, 'e');
}

ResetElectronAttachment()

void Garfield::Medium::ResetElectronAttachment ( )

inline

Definition at line 451 of file Medium.hh.

{ m_eAtt.clear(); }

Referenced by ResetTables().

ResetElectronDiffusion()

void Garfield::Medium::ResetElectronDiffusion ( )

inline

Definition at line 445 of file Medium.hh.

                                {
    m_eDifL.clear();
    m_eDifT.clear();
    m_eDifM.clear();
  }

Referenced by ResetTables().

ResetElectronLorentzAngle()

void Garfield::Medium::ResetElectronLorentzAngle ( )

inline

Definition at line 452 of file Medium.hh.

{ m_eLor.clear(); }

Referenced by ResetTables().

ResetElectronTownsend()

void Garfield::Medium::ResetElectronTownsend ( )

inline

Definition at line 450 of file Medium.hh.

{ m_eAlp.clear(); }

Referenced by ResetTables().

ResetElectronVelocity()

void Garfield::Medium::ResetElectronVelocity ( )

inline

Definition at line 440 of file Medium.hh.

                               {
    m_eVelE.clear();
    m_eVelB.clear();
    m_eVelX.clear();
  }

Referenced by ResetTables().

ResetHoleAttachment()

void Garfield::Medium::ResetHoleAttachment ( )

inline

Definition at line 465 of file Medium.hh.

{ m_hAtt.clear(); }

Referenced by ResetTables().

ResetHoleDiffusion()

void Garfield::Medium::ResetHoleDiffusion ( )

inline

Definition at line 459 of file Medium.hh.

                            {
    m_hDifL.clear();
    m_hDifT.clear();
    m_hDifM.clear();
  }

Referenced by ResetTables().

ResetHoleTownsend()

void Garfield::Medium::ResetHoleTownsend ( )

inline

Definition at line 464 of file Medium.hh.

{ m_hAlp.clear(); }

Referenced by ResetTables().

ResetHoleVelocity()

void Garfield::Medium::ResetHoleVelocity ( )

inline

Definition at line 454 of file Medium.hh.

                           {
    m_hVelE.clear();
    m_hVelB.clear();
    m_hVelX.clear();
  }

Referenced by ResetTables().

ResetIonDiffusion()

void Garfield::Medium::ResetIonDiffusion ( )

inline

Definition at line 468 of file Medium.hh.

                           {
    m_iDifL.clear();
    m_iDifT.clear();
  }

Referenced by ResetTables().

ResetIonDissociation()

void Garfield::Medium::ResetIonDissociation ( )

inline

Definition at line 472 of file Medium.hh.

{ m_iDis.clear(); }

Referenced by ResetTables().

ResetIonMobility()

void Garfield::Medium::ResetIonMobility ( )

inline

Definition at line 467 of file Medium.hh.

{ m_iMob.clear(); }

Referenced by ResetTables(), and SetIonMobility().

ResetNegativeIonMobility()

void Garfield::Medium::ResetNegativeIonMobility ( )

inline

Definition at line 473 of file Medium.hh.

{ m_nMob.clear(); }

Referenced by ResetTables(), and SetIonMobility().

ResetTables()

void Garfield::Medium::ResetTables ( )

virtual

Reset all tables of transport parameters.

Reimplemented in Garfield::MediumGas.

Definition at line 999 of file Medium.cc.

                         {
  ResetElectronVelocity();
  ResetElectronDiffusion();
  ResetElectronTownsend();
  ResetElectronAttachment();
  ResetElectronLorentzAngle();
  
  ResetHoleVelocity();
  ResetHoleDiffusion();
  ResetHoleTownsend();
  ResetHoleAttachment();
 
  ResetIonMobility();
  ResetIonDiffusion();
  ResetIonDissociation();
 
  ResetNegativeIonMobility();
}

Referenced by Garfield::MediumGas::ResetTables().

ScaleAttachment()

virtual double Garfield::Medium::ScaleAttachment ( const double eta ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 505 of file Medium.hh.

{ return eta; }

Referenced by ElectronAttachment(), and HoleAttachment().

ScaleDiffusion()

virtual double Garfield::Medium::ScaleDiffusion ( const double d ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 502 of file Medium.hh.

{ return d; }

Referenced by Diffusion().

ScaleDiffusionTensor()

virtual double Garfield::Medium::ScaleDiffusionTensor ( const double d ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 503 of file Medium.hh.

{ return d; }

Referenced by Diffusion().

ScaleDissociation()

virtual double Garfield::Medium::ScaleDissociation ( const double diss ) const

inlinevirtual

Definition at line 507 of file Medium.hh.

{ return diss; }

Referenced by IonDissociation().

ScaleElectricField()

virtual double Garfield::Medium::ScaleElectricField ( const double e ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 499 of file Medium.hh.

{ return e; }

Referenced by Alpha(), Diffusion(), Diffusion(), ElectronLorentzAngle(), IonVelocity(), NegativeIonVelocity(), and Velocity().

ScaleLorentzAngle()

virtual double Garfield::Medium::ScaleLorentzAngle ( const double lor ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 506 of file Medium.hh.

{ return lor; }

Referenced by ElectronLorentzAngle().

ScaleTownsend()

virtual double Garfield::Medium::ScaleTownsend ( const double alpha ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 504 of file Medium.hh.

{ return alpha; }

Referenced by ElectronTownsend(), and HoleTownsend().

ScaleVelocity()

virtual double Garfield::Medium::ScaleVelocity ( const double v ) const

inlinevirtual

Definition at line 501 of file Medium.hh.

{ return v; }

SetAtomicNumber()

void Garfield::Medium::SetAtomicNumber ( const double z )

virtual

Set the effective atomic number.

Reimplemented in Garfield::MediumGas.

Definition at line 115 of file Medium.cc.

                                           {
  if (z < 1.) {
    std::cerr << m_className << "::SetAtomicNumber:\n"
              << "    Atomic number must be >= 1.\n";
    return;
  }
  m_z = z;
  m_isChanged = true;
}

Referenced by Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), and Garfield::MediumSilicon::MediumSilicon().

SetAtomicWeight()

void Garfield::Medium::SetAtomicWeight ( const double a )

virtual

Set the effective atomic weight.

Reimplemented in Garfield::MediumGas.

Definition at line 125 of file Medium.cc.

                                           {
  if (a <= 0.) {
    std::cerr << m_className << "::SetAtomicWeight:\n"
              << "    Atomic weight must be greater than zero.\n";
    return;
  }
  m_a = a;
  m_isChanged = true;
}

Referenced by Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), and Garfield::MediumSilicon::MediumSilicon().

SetDielectricConstant()

void Garfield::Medium::SetDielectricConstant

(

const double

eps

)

Set the relative static dielectric constant.

Definition at line 92 of file Medium.cc.

                                                   {
  if (eps < 1.) {
    std::cerr << m_className << "::SetDielectricConstant:\n"
              << "    Dielectric constant must be >= 1.\n";
    return;
  }
  m_epsilon = eps;
  m_isChanged = true;
}

Referenced by Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), and Garfield::MediumSilicon::MediumSilicon().

SetElectronAttachment()

bool Garfield::Medium::SetElectronAttachment ( const size_t ie, const size_t ib, const size_t ia, const double eta )

inline

Set an entry in the table of attachment coefficients.

Definition at line 286 of file Medium.hh.

                                                                {
    return SetEntry(ie, ib, ia, "ElectronAttachment", m_eAtt, eta);
  }

SetElectronLongitudinalDiffusion()

bool Garfield::Medium::SetElectronLongitudinalDiffusion ( const size_t ie, const size_t ib, const size_t ia, const double dl )

inline

Set an entry in the table of longitudinal diffusion coefficients.

Definition at line 256 of file Medium.hh.

                                                                          {
    return SetEntry(ie, ib, ia, "ElectronLongitudinalDiffusion", m_eDifL, dl);
  }

SetElectronLorentzAngle()

bool Garfield::Medium::SetElectronLorentzAngle ( const size_t ie, const size_t ib, const size_t ia, const double lor )

inline

Set an entry in the table of Lorentz angles.

Definition at line 297 of file Medium.hh.

                                                                  {
    return SetEntry(ie, ib, ia, "ElectronLorentzAngle", m_eLor, lor);
  }

SetElectronTownsend()

bool Garfield::Medium::SetElectronTownsend ( const size_t ie, const size_t ib, const size_t ia, const double alpha )

inline

Set an entry in the table of Townsend coefficients.

Definition at line 276 of file Medium.hh.

                                                                {
    return SetEntry(ie, ib, ia, "ElectronTownsend", m_eAlp, alpha);
  }

SetElectronTransverseDiffusion()

bool Garfield::Medium::SetElectronTransverseDiffusion ( const size_t ie, const size_t ib, const size_t ia, const double dt )

inline

Set an entry in the table of transverse diffusion coefficients.

Definition at line 266 of file Medium.hh.

                                                                        {
    return SetEntry(ie, ib, ia, "ElectronTransverseDiffusion", m_eDifT, dt);
  }

SetElectronVelocityB()

bool Garfield::Medium::SetElectronVelocityB ( const size_t ie, const size_t ib, const size_t ia, const double v )

inline

Set an entry in the table of drift speeds along Btrans.

Definition at line 246 of file Medium.hh.

                                                             {
    return SetEntry(ie, ib, ia, "ElectronVelocityB", m_eVelB, v);
  }

SetElectronVelocityE()

bool Garfield::Medium::SetElectronVelocityE ( const size_t ie, const size_t ib, const size_t ia, const double v )

inline

Set an entry in the table of drift speeds along E.

Definition at line 226 of file Medium.hh.

                                                             {
    return SetEntry(ie, ib, ia, "ElectronVelocityE", m_eVelE, v);
  }

SetElectronVelocityExB()

bool Garfield::Medium::SetElectronVelocityExB ( const size_t ie, const size_t ib, const size_t ia, const double v )

inline

Set an entry in the table of drift speeds along ExB.

Definition at line 236 of file Medium.hh.

                                                               {
    return SetEntry(ie, ib, ia, "ElectronVelocityExB", m_eVelX, v);
  }

SetEntry()

bool Garfield::Medium::SetEntry ( const size_t i, const size_t j, const size_t k, const std::string & fcn, std::vector< std::vector< std::vector< double > > > & tab, const double val )

protected

Definition at line 966 of file Medium.cc.

                                        {
 
  if (i >= m_eFields.size() || j >= m_bFields.size() || k >= m_bAngles.size()) {
    PrintOutOfRange(m_className, "Set" + fcn, i, j, k);
    return false;
  }
  if (tab.empty()) {
    Init(m_eFields.size(), m_bFields.size(), m_bAngles.size(), tab, val);
  }
  tab[k][j][i] = val;
  return true;
}

Referenced by SetElectronAttachment(), SetElectronLongitudinalDiffusion(), SetElectronLorentzAngle(), SetElectronTownsend(), SetElectronTransverseDiffusion(), SetElectronVelocityB(), SetElectronVelocityE(), SetElectronVelocityExB(), SetHoleAttachment(), SetHoleLongitudinalDiffusion(), SetHoleTownsend(), SetHoleTransverseDiffusion(), SetHoleVelocityB(), SetHoleVelocityE(), SetHoleVelocityExB(), SetIonDissociation(), SetIonLongitudinalDiffusion(), SetIonTransverseDiffusion(), and SetNegativeIonMobility().

SetExtrapolationMethod()

void Garfield::Medium::SetExtrapolationMethod ( const std::string & low, const std::string & high, std::pair< unsigned int, unsigned int > & extr, const std::string & fcn )

protected

Definition at line 1215 of file Medium.cc.

                                                          {
  unsigned int i = 0;
  if (GetExtrapolationIndex(low, i)) {
    extr.first = i;
  } else {
    std::cerr << m_className << "::SetExtrapolationMethod" << fcn << ":\n"
              << "    Unknown extrapolation method (" << low << ")\n";
  }
  unsigned int j = 0;
  if (GetExtrapolationIndex(high, j)) {
    extr.second = j;
  } else {
    std::cerr << m_className << "::SetExtrapolationMethod" << fcn << ":\n"
              << "    Unknown extrapolation method (" << high << ")\n";
  }
}

Referenced by SetExtrapolationMethodAttachment(), SetExtrapolationMethodDiffusion(), Garfield::MediumGas::SetExtrapolationMethodExcitationRates(), SetExtrapolationMethodIonDissociation(), Garfield::MediumGas::SetExtrapolationMethodIonisationRates(), SetExtrapolationMethodIonMobility(), SetExtrapolationMethodTownsend(), and SetExtrapolationMethodVelocity().

SetExtrapolationMethodAttachment()

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

Definition at line 1200 of file Medium.cc.

                                                                     {
  SetExtrapolationMethod(low, high, m_extrAtt, "Attachment");
}

SetExtrapolationMethodDiffusion()

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

Definition at line 1190 of file Medium.cc.

                                                                    {
  SetExtrapolationMethod(low, high, m_extrDif, "Diffusion");
}

SetExtrapolationMethodIonDissociation()

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

Definition at line 1210 of file Medium.cc.

                                                                          {
  SetExtrapolationMethod(low, high, m_extrDis, "IonDissociation");
}

SetExtrapolationMethodIonMobility()

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

Definition at line 1205 of file Medium.cc.

                                                                      {
  SetExtrapolationMethod(low, high, m_extrMob, "IonMobility");
}

SetExtrapolationMethodTownsend()

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

Definition at line 1195 of file Medium.cc.

                                                                   {
  SetExtrapolationMethod(low, high, m_extrAlp, "Townsend");
}

SetExtrapolationMethodVelocity()

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

Select the extrapolation method for fields below/above the table range. Possible options are "constant", "linear", and "exponential".

Definition at line 1185 of file Medium.cc.

                                                                   {
  SetExtrapolationMethod(low, high, m_extrVel, "Velocity");
}

SetFanoFactor()

void Garfield::Medium::SetFanoFactor ( const double f )

inline

Set the Fano factor.

Definition at line 88 of file Medium.hh.

{ m_fano = f; }

SetFieldGrid() [1/2]

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

Set the fields and E-B angles to be used in the transport tables.

Definition at line 882 of file Medium.cc.

                                                           {
  const std::string hdr = m_className + "::SetFieldGrid";
  if (!CheckFields(efields, hdr, "E-fields")) return;
  if (!CheckFields(bfields, hdr, "B-fields")) return;
  if (!CheckFields(angles, hdr, "angles")) return;
 
  if (m_debug) {
    std::cout << m_className << "::SetFieldGrid:\n    E-fields:\n";
    for (const auto efield : efields) std::cout << "      " << efield << "\n";
    std::cout << "    B-fields:\n";
    for (const auto bfield : bfields) std::cout << "      " << bfield << "\n";
    std::cout << "    Angles:\n";
    for (const auto angle : angles) std::cout << "      " << angle << "\n";
  }
 
  // Clone the existing tables.
  // Electrons
  Clone(m_eVelE, efields, bfields, angles, m_intpVel, m_extrVel, 0.,
        "electron velocity along E");
  Clone(m_eVelB, efields, bfields, angles, m_intpVel, m_extrVel, 0.,
        "electron velocity along Bt");
  Clone(m_eVelX, efields, bfields, angles, m_intpVel, m_extrVel, 0.,
        "electron velocity along ExB");
  Clone(m_eDifL, efields, bfields, angles, m_intpDif, m_extrDif, 0.,
        "electron longitudinal diffusion");
  Clone(m_eDifT, efields, bfields, angles, m_intpDif, m_extrDif, 0.,
        "electron transverse diffusion");
  Clone(m_eAlp, efields, bfields, angles, m_intpAlp, m_extrAlp, -30., 
        "electron Townsend coefficient");
  Clone(m_eAtt, efields, bfields, angles, m_intpAtt, m_extrAtt, -30., 
        "electron attachment coefficient");
  Clone(m_eLor, efields, bfields, angles, m_intpLor, m_extrLor, 0., 
        "electron Lorentz angle");
  if (!m_eDifM.empty()) {
    Clone(m_eDifM, 6, efields, bfields, angles, m_intpDif, m_extrDif, 0., 
          "electron diffusion tensor");
  }
 
  // Holes
  Clone(m_hVelE, efields, bfields, angles, m_intpVel, m_extrVel, 0.,
        "hole velocity along E");
  Clone(m_hVelB, efields, bfields, angles, m_intpVel, m_extrVel, 0.,
        "hole velocity along Bt");
  Clone(m_hVelX, efields, bfields, angles, m_intpVel, m_extrVel, 0.,
        "hole velocity along ExB");
  Clone(m_hDifL, efields, bfields, angles, m_intpDif, m_extrDif, 0.,
        "hole longitudinal diffusion");
  Clone(m_hDifT, efields, bfields, angles, m_intpDif, m_extrDif, 0.,
        "hole transverse diffusion");
  Clone(m_hAlp, efields, bfields, angles, m_intpAlp, m_extrAlp, -30., 
        "hole Townsend coefficient");
  Clone(m_hAtt, efields, bfields, angles, m_intpAtt, m_extrAtt, -30., 
        "hole attachment coefficient");
  if (!m_hDifM.empty()) {
    Clone(m_hDifM, 6, efields, bfields, angles, m_intpDif, m_extrDif, 0., 
          "hole diffusion tensor");
  }
 
  // Ions
  Clone(m_iMob, efields, bfields, angles, m_intpMob, m_extrMob, 0.,
        "ion mobility");
  Clone(m_iDifL, efields, bfields, angles, m_intpDif, m_extrDif, 0., 
        "ion longitudinal diffusion");
  Clone(m_iDifT, efields, bfields, angles, m_intpDif, m_extrDif, 0., 
        "ion transverse diffusion");
  Clone(m_iDis, efields, bfields, angles, m_intpDis, m_extrDis, -30., 
        "ion dissociation");
 
  if (bfields.size() > 1 || angles.size() > 1) m_tab2d = true;
  m_eFields = efields;
  m_bFields = bfields;
  m_bAngles = angles;
}

SetFieldGrid() [2/2]

void Garfield::Medium::SetFieldGrid	(	double	emin,
		double	emax,
		const size_t	ne,
		bool	logE,
		double	bmin = 0.,
		double	bmax = 0.,
		const size_t	nb = 1,
		double	amin = HalfPi,
		double	amax = HalfPi,
		const size_t	na = 1 )

Set the range of fields to be covered by the transport tables.

Definition at line 791 of file Medium.cc.

                                                                     {
  // Check if the requested E-field range makes sense.
  if (ne <= 0) {
    std::cerr << m_className << "::SetFieldGrid:\n"
              << "    Number of E-fields must be > 0.\n";
    return;
  }
 
  if (emin < 0. || emax < 0.) {
    std::cerr << m_className << "::SetFieldGrid:\n"
              << "    Electric fields must be positive.\n";
    return;
  }
 
  if (emax < emin) {
    std::cerr << m_className << "::SetFieldGrid: Swapping min./max. E-field.\n";
    std::swap(emin, emax);
  }
 
  double estep = 0.;
  if (logE) {
    // Logarithmic scale
    if (emin < Small) {
      std::cerr << m_className << "::SetFieldGrid:\n"
                << "    Min. E-field must be non-zero for log. scale.\n";
      return;
    }
    if (ne == 1) {
      std::cerr << m_className << "::SetFieldGrid:\n"
                << "    Number of E-fields must be > 1 for log. scale.\n";
      return;
    }
    estep = pow(emax / emin, 1. / (ne - 1.));
  } else {
    // Linear scale
    if (ne > 1) estep = (emax - emin) / (ne - 1.);
  }
 
  // Check if the requested B-field range makes sense.
  if (nb <= 0) {
    std::cerr << m_className << "::SetFieldGrid:\n"
              << "    Number of B-fields must be > 0.\n";
    return;
  }
  if (bmax < 0. || bmin < 0.) {
    std::cerr << m_className << "::SetFieldGrid:\n"
              << "    Magnetic fields must be positive.\n";
    return;
  }
  if (bmax < bmin) {
    std::cerr << m_className << "::SetFieldGrid: Swapping min./max. B-field.\n";
    std::swap(bmin, bmax);
  }
 
  const double bstep = nb > 1 ? (bmax - bmin) / (nb - 1.) : 0.;
 
  // Check if the requested angular range makes sense.
  if (na <= 0) {
    std::cerr << m_className << "::SetFieldGrid:\n"
              << "    Number of angles must be > 0.\n";
    return;
  }
  if (amax < 0. || amin < 0.) {
    std::cerr << m_className << "::SetFieldGrid:"
              << "    Angles must be positive.\n";
    return;
  }
  if (amax < amin) {
    std::cerr << m_className << "::SetFieldGrid: Swapping min./max. angle.\n";
    std::swap(amin, amax);
  }
  const double astep = na > 1 ? (amax - amin) / (na - 1.) : 0;
 
  // Setup the field grids.
  std::vector<double> eFields(ne);
  std::vector<double> bFields(nb);
  std::vector<double> bAngles(na);
  for (size_t i = 0; i < ne; ++i) {
    eFields[i] = logE ? emin * pow(estep, i) : emin + i * estep;
  }
  for (size_t i = 0; i < nb; ++i) {
    bFields[i] = bmin + i * bstep;
  }
  for (size_t i = 0; i < na; ++i) {
    bAngles[i] = amin + i * astep;
  }
  SetFieldGrid(eFields, bFields, bAngles);
}

Referenced by Medium(), and SetFieldGrid().

SetHoleAttachment()

bool Garfield::Medium::SetHoleAttachment ( const size_t ie, const size_t ib, const size_t ia, const double eta )

inline

Set an entry in the table of attachment coefficients.

Definition at line 369 of file Medium.hh.

                                                            {
    return SetEntry(ie, ib, ia, "HoleAttachment", m_hAtt, eta);
  }

SetHoleLongitudinalDiffusion()

bool Garfield::Medium::SetHoleLongitudinalDiffusion ( const size_t ie, const size_t ib, const size_t ia, const double dl )

inline

Set an entry in the table of longitudinal diffusion coefficients.

Definition at line 339 of file Medium.hh.

                                                                      {
    return SetEntry(ie, ib, ia, "HoleLongitudinalDiffusion", m_hDifL, dl);
  }

SetHoleTownsend()

bool Garfield::Medium::SetHoleTownsend ( const size_t ie, const size_t ib, const size_t ia, const double alpha )

inline

Set an entry in the table of Townsend coefficients.

Definition at line 359 of file Medium.hh.

                                                            {
    return SetEntry(ie, ib, ia, "HoleTownsend", m_hAlp, alpha);
  }

SetHoleTransverseDiffusion()

bool Garfield::Medium::SetHoleTransverseDiffusion ( const size_t ie, const size_t ib, const size_t ia, const double dt )

inline

Set an entry in the table of transverse diffusion coefficients.

Definition at line 349 of file Medium.hh.

                                                                    {
    return SetEntry(ie, ib, ia, "HoleTransverseDiffusion", m_hDifT, dt);
  }

SetHoleVelocityB()

bool Garfield::Medium::SetHoleVelocityB ( const size_t ie, const size_t ib, const size_t ia, const double v )

inline

Set an entry in the table of drift speeds along Btrans.

Definition at line 328 of file Medium.hh.

                                                         {
    return SetEntry(ie, ib, ia, "HoleVelocityB", m_hVelB, v);
  }

SetHoleVelocityE()

bool Garfield::Medium::SetHoleVelocityE ( const size_t ie, const size_t ib, const size_t ia, const double v )

inline

Set an entry in the table of drift speeds along E.

Definition at line 308 of file Medium.hh.

                                                         {
    return SetEntry(ie, ib, ia, "HoleVelocityE", m_hVelE, v);
  }

SetHoleVelocityExB()

bool Garfield::Medium::SetHoleVelocityExB ( const size_t ie, const size_t ib, const size_t ia, const double v )

inline

Set an entry in the table of drift speeds along ExB.

Definition at line 318 of file Medium.hh.

                                                           {
    return SetEntry(ie, ib, ia, "HoleVelocityExB", m_hVelX, v);
  }

SetInterpolationMethodAttachment()

void Garfield::Medium::SetInterpolationMethodAttachment

(

const unsigned int

intrp

)

Definition at line 1288 of file Medium.cc.

                                                                      {
  if (intrp > 0) m_intpAtt = intrp;
}

SetInterpolationMethodDiffusion()

void Garfield::Medium::SetInterpolationMethodDiffusion

(

const unsigned int

intrp

)

Definition at line 1280 of file Medium.cc.

                                                                     {
  if (intrp > 0) m_intpDif = intrp;
}

SetInterpolationMethodIonDissociation()

void Garfield::Medium::SetInterpolationMethodIonDissociation

(

const unsigned int

intrp

)

Definition at line 1296 of file Medium.cc.

                                                                           {
  if (intrp > 0) m_intpDis = intrp;
}

SetInterpolationMethodIonMobility()

void Garfield::Medium::SetInterpolationMethodIonMobility

(

const unsigned int

intrp

)

Definition at line 1292 of file Medium.cc.

                                                                       {
  if (intrp > 0) m_intpMob = intrp;
}

SetInterpolationMethodTownsend()

void Garfield::Medium::SetInterpolationMethodTownsend

(

const unsigned int

intrp

)

Definition at line 1284 of file Medium.cc.

                                                                    {
  if (intrp > 0) m_intpAlp = intrp;
}

SetInterpolationMethodVelocity()

void Garfield::Medium::SetInterpolationMethodVelocity

(

const unsigned int

intrp

)

Set the degree of polynomial interpolation (usually 2).

Definition at line 1276 of file Medium.cc.

                                                                    {
  if (intrp > 0) m_intpVel = intrp;
}

SetIonDissociation()

bool Garfield::Medium::SetIonDissociation ( const size_t ie, const size_t ib, const size_t ia, const double diss )

inline

Set an entry in the table of dissociation coefficients.

Definition at line 416 of file Medium.hh.

                                                              {
    return SetEntry(ie, ib, ia, "IonDissociation", m_iDis, diss);
  }

SetIonLongitudinalDiffusion()

bool Garfield::Medium::SetIonLongitudinalDiffusion ( const size_t ie, const size_t ib, const size_t ia, const double dl )

inline

Set an entry in the table of longitudinal diffusion coefficients.

Definition at line 396 of file Medium.hh.

                                                                     {
    return SetEntry(ie, ib, ia, "IonLongitudinalDiffusion", m_iDifL, dl);
  } 

SetIonMobility() [1/2]

bool Garfield::Medium::SetIonMobility	(	const size_t	ie,
		const size_t	ib,
		const size_t	ia,
		const double	mu )

Set an entry in the table of ion mobilities.

Definition at line 1109 of file Medium.cc.

                                                              {
  // Check the index.
  if (ie >= m_eFields.size() || ib >= m_bFields.size() ||
      ia >= m_bAngles.size()) {
    PrintOutOfRange(m_className, "SetIonMobility", ie, ib, ia);
    return false;
  }
 
  if (m_iMob.empty()) {
    std::cerr << m_className << "::SetIonMobility:\n"
              << "    Ion mobility table not initialised.\n";
    return false;
  }
 
  if (mu == 0.) {
    std::cerr << m_className << "::SetIonMobility: Zero value not allowed.\n";
    return false;
  }
 
  m_iMob[ia][ib][ie] = mu;
  if (m_debug) {
    std::cout << m_className << "::SetIonMobility:\n    Ion mobility at E = "
              << m_eFields[ie] << " V/cm, B = " 
              << m_bFields[ib] << " T, angle " 
              << m_bAngles[ia] << " set to " << mu << " cm2/(V ns).\n";
  }
  return true;
}

SetIonMobility() [2/2]

bool Garfield::Medium::SetIonMobility	(	const std::vector< double > &	fields,
		const std::vector< double > &	mobilities,
		const bool	negativeIons = false )

Initialise the table of ion mobilities from a list of electric fields and corresponding mobilities. The mobilities will be interpolated at the electric fields of the currently set grid.

Definition at line 1139 of file Medium.cc.

                                                     {
  if (efields.size() != mobs.size()) {
    std::cerr << m_className << "::SetIonMobility:\n"
              << "    E-field and mobility arrays have different sizes.\n";
    return false;
  }
 
  if (negativeIons) {
    ResetNegativeIonMobility();
  } else {
    ResetIonMobility();
  }
  const auto nE = m_eFields.size();
  const auto nB = m_bFields.size();
  const auto nA = m_bAngles.size();
  if (negativeIons) {
    Init(nE, nB, nA, m_nMob, 0.);
  } else {
    Init(nE, nB, nA, m_iMob, 0.);
  }
  for (size_t i = 0; i < nE; ++i) {
    const double e = m_eFields[i];
    const double mu = Interpolate1D(e, mobs, efields, m_intpMob, m_extrMob);
    if (negativeIons) {
      m_nMob[0][0][i] = mu;
    } else {
      m_iMob[0][0][i] = mu;
    }
  }
  if (!m_tab2d) return true;
  for (size_t i = 0; i < nA; ++i) {
    for (size_t j = 0; j < nB; ++j) {
      for (size_t k = 0; k < nE; ++k) {
        if (negativeIons) {
          m_nMob[i][j][k] = m_nMob[0][0][k];
        } else {
          m_iMob[i][j][k] = m_iMob[0][0][k];
        }
      }
    }
  }
  return true;
}

Referenced by Garfield::MediumGas::LoadMobility().

SetIonTransverseDiffusion()

bool Garfield::Medium::SetIonTransverseDiffusion ( const size_t ie, const size_t ib, const size_t ia, const double dt )

inline

Set an entry in the table of transverse diffusion coefficients.

Definition at line 406 of file Medium.hh.

                                                                   {
    return SetEntry(ie, ib, ia, "IonTransverseDiffusion", m_iDifT, dt);
  } 

SetMassDensity()

void Garfield::Medium::SetMassDensity ( const double rho )

virtual

Set the mass density [g/cm3].

Reimplemented in Garfield::MediumGas.

Definition at line 145 of file Medium.cc.

                                            {
  if (rho <= 0.) {
    std::cerr << m_className << "::SetMassDensity:\n"
              << "    Density [g/cm3] must be greater than zero.\n";
    return;
  }
 
  if (m_a <= 0.) {
    std::cerr << m_className << "::SetMassDensity:\n"
              << "    Atomic weight is not defined.\n";
    return;
  }
  m_density = rho / (AtomicMassUnit * m_a);
  m_isChanged = true;
}

Referenced by Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), and Garfield::MediumSilicon::MediumSilicon().

SetNegativeIonMobility()

bool Garfield::Medium::SetNegativeIonMobility ( const size_t ie, const size_t ib, const size_t ia, const double mu )

inline

Set an entry in the table of negative ion mobilities.

Definition at line 427 of file Medium.hh.

                                                                {
    return SetEntry(ie, ib, ia, "NegativeIonMobility", m_nMob, mu);
  }

SetNumberDensity()

void Garfield::Medium::SetNumberDensity ( const double n )

virtual

Set the number density [cm-3].

Reimplemented in Garfield::MediumGas.

Definition at line 135 of file Medium.cc.

                                            {
  if (n <= 0.) {
    std::cerr << m_className << "::SetNumberDensity:\n"
              << "    Density [cm-3] must be greater than zero.\n";
    return;
  }
  m_density = n;
  m_isChanged = true;
}

SetPressure()

void Garfield::Medium::SetPressure

(

const double

p

)

Definition at line 82 of file Medium.cc.

                                       {
  if (p <= 0.) {
    std::cerr << m_className << "::SetPressure:\n"
              << "    Pressure [Torr] must be greater than zero.\n";
    return;
  }
  m_pressure = p;
  m_isChanged = true;
}

Referenced by main().

SetTemperature()

void Garfield::Medium::SetTemperature

(

const double

t

)

Set the temperature [K].

Definition at line 72 of file Medium.cc.

                                          {
  if (t <= 0.) {
    std::cerr << m_className << "::SetTemperature:\n"
              << "    Temperature [K] must be greater than zero.\n";
    return;
  }
  m_temperature = t;
  m_isChanged = true;
}

Referenced by main(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), and Garfield::MediumSilicon::MediumSilicon().

SetThreshold()

size_t Garfield::Medium::SetThreshold ( const std::vector< std::vector< std::vector< double > > > & tab ) const

protected

Definition at line 1252 of file Medium.cc.

                                                                {
 
  if (tab.empty()) return 0;
  const auto nE = m_eFields.size();
  const auto nB = m_bFields.size();
  const auto nA = m_bAngles.size();
  for (size_t i = 0; i < nE; ++i) {
    bool below = false;
    for (size_t k = 0; k < nA; ++k) {
      for (size_t j = 0; j < nB; ++j) {
        if (tab[k][j][i] < -20.) {
          below = true;
          break;
        } 
      }
      if (below) break; 
    }
    if (below) continue;
    return i;
  } 
  return nE - 1; 
}

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Garfield::MediumMagboltz::GenerateGasTable(), and Garfield::MediumGas::MergeGasFile().

SetW()

void Garfield::Medium::SetW ( const double w )

inline

Set the W value (average energy to produce an electron/ion or e/h pair).

Definition at line 84 of file Medium.hh.

{ m_w = w; }

UnScaleElectricField()

virtual double Garfield::Medium::UnScaleElectricField ( const double e ) const

inlinevirtual

Reimplemented in Garfield::MediumGas.

Definition at line 500 of file Medium.hh.

{ return e; }

Referenced by ElectronMobility(), and HoleMobility().

Velocity()

bool Garfield::Medium::Velocity ( const double ex, const double ey, const double ez, const double bx, const double by, const double bz, const std::vector< std::vector< std::vector< double > > > & velE, const std::vector< std::vector< std::vector< double > > > & velB, const std::vector< std::vector< std::vector< double > > > & velX, const double q, double & vx, double & vy, double & vz ) const

protected

Definition at line 196 of file Medium.cc.

                                                              {
 
  vx = vy = vz = 0.;
  // Make sure there is at least a table of velocities along E.
  if (velE.empty()) return false;
 
  // Compute the magnitude of the electric field.
  const double e = sqrt(ex * ex + ey * ey + ez * ez);
  const double e0 = ScaleElectricField(e);
  if (e < Small || e0 < Small) return false;
 
  // Compute the magnitude of the magnetic field.
  const double b = sqrt(bx * bx + by * by + bz * bz);
  // Compute the angle between B field and E field.
  const double ebang = GetAngle(ex, ey, ez, bx, by, bz, e, b);
 
  // Calculate the velocity along E.
  double ve = 0.;
  if (!Interpolate(e0, b, ebang, velE, ve, m_intpVel, m_extrVel)) {
    std::cerr << m_className << "::Velocity: Interpolation along E failed.\n";
    return false;
  }
  if (b < Small) {
    // No magnetic field.
    const double mu = q * ve / e;
    vx = mu * ex;
    vy = mu * ey;
    vz = mu * ez;
    return true;
  } else if (velX.empty() || velB.empty() ||
             (m_bFields.size() == 1 && fabs(m_bFields[0]) < Small)) {
    // Magnetic field, velocities along ExB, Bt not available.
    Langevin(ex, ey, ez, bx, by, bz, q * ve / e, vx, vy, vz);
    return true;
  }
 
  // Magnetic field, velocities along ExB and Bt available.
  // Compute unit vectors along E, E x B and Bt.
  double ue[3] = {ex / e, ey / e, ez / e};
  double uexb[3] = {ey * bz - ez * by, ez * bx - ex * bz, ex * by - ey * bx};
  const double exb =
      sqrt(uexb[0] * uexb[0] + uexb[1] * uexb[1] + uexb[2] * uexb[2]);
  if (exb > 0.) {
    uexb[0] /= exb;
    uexb[1] /= exb;
    uexb[2] /= exb;
  } else {
    uexb[0] = ue[0];
    uexb[1] = ue[1];
    uexb[2] = ue[2];
  }
 
  double ubt[3] = {uexb[1] * ez - uexb[2] * ey, 
                   uexb[2] * ex - uexb[0] * ez,
                   uexb[0] * ey - uexb[1] * ex};
  const double bt = sqrt(ubt[0] * ubt[0] + ubt[1] * ubt[1] + ubt[2] * ubt[2]);
  if (bt > 0.) {
    ubt[0] /= bt;
    ubt[1] /= bt;
    ubt[2] /= bt;
  } else {
    ubt[0] = ue[0];
    ubt[1] = ue[1];
    ubt[2] = ue[2];
  }
 
  if (m_debug) {
    std::cout << m_className << "::Velocity:\n";
    std::printf("    unit vector along E:     (%15.5f, %15.5f, %15.5f)\n",
                ue[0], ue[1], ue[2]);
    std::printf("    unit vector along E x B: (%15.5f, %15.5f, %15.5f)\n",
                uexb[0], uexb[1], uexb[2]);
    std::printf("    unit vector along Bt:    (%15.5f, %15.5f, %15.5f)\n",
                ubt[0], ubt[1], ubt[2]);
  }
 
  // Calculate the velocities in all directions.
  double vexb = 0.;
  if (!Interpolate(e0, b, ebang, velX, vexb, m_intpVel, m_extrVel)) {
    std::cerr << m_className << "::Velocity: Interpolation along ExB failed.\n";
    return false;
  }
  vexb *= q;
  double vbt = 0.;
  if (!Interpolate(e0, b, ebang, velB, vbt, m_intpVel, m_extrVel)) {
    std::cerr << m_className << "::Velocity: Interpolation along Bt failed.\n";
    return false;
  }
  if (ex * bx + ey * by + ez * bz > 0.) {
    vbt = fabs(vbt);
  } else {
    vbt = -fabs(vbt);
  }
  vbt *= q * q;
  vx = q * (ve * ue[0] + vbt * ubt[0] + vexb * uexb[0]);
  vy = q * (ve * ue[1] + vbt * ubt[1] + vexb * uexb[1]);
  vz = q * (ve * ue[2] + vbt * ubt[2] + vexb * uexb[2]);
  return true;
}

Referenced by ElectronVelocity(), and HoleVelocity().

Member Data Documentation

m_a

double Garfield::Medium::m_a = 0.

protected

Definition at line 548 of file Medium.hh.

Referenced by GetAtomicWeight(), GetMassDensity(), SetAtomicWeight(), and SetMassDensity().

m_bAngles

std::vector<double> Garfield::Medium::m_bAngles

protected

Definition at line 574 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Garfield::MediumMagboltz::GenerateGasTable(), GetAngle(), GetEntry(), GetFieldGrid(), Interpolate(), Garfield::MediumGas::LoadGasFile(), Medium(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetEntry(), SetFieldGrid(), SetIonMobility(), SetIonMobility(), SetThreshold(), and Garfield::MediumGas::WriteGasFile().

m_bFields

std::vector<double> Garfield::Medium::m_bFields

protected

Definition at line 573 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Garfield::MediumMagboltz::GenerateGasTable(), GetEntry(), GetFieldGrid(), Interpolate(), Garfield::MediumGas::LoadGasFile(), Medium(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetEntry(), SetFieldGrid(), SetIonMobility(), SetIonMobility(), SetThreshold(), Velocity(), and Garfield::MediumGas::WriteGasFile().

m_className

std::string Garfield::Medium::m_className = "Medium"

protected

Definition at line 529 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Clone(), Clone(), Garfield::MediumMagboltz::ComputeDeexcitation(), Garfield::MediumGas::DisablePenningTransfer(), Garfield::MediumMagboltz::DisablePenningTransfer(), Garfield::MediumSilicon::ElectronAttachment(), ElectronCollision(), Garfield::MediumMagboltz::ElectronCollision(), Garfield::MediumSilicon::ElectronCollision(), Garfield::MediumSilicon::ElectronTownsend(), Garfield::MediumSilicon::ElectronVelocity(), Garfield::MediumMagboltz::EnableDeexcitation(), Garfield::MediumGas::EnablePenningTransfer(), Garfield::MediumGas::EnablePenningTransfer(), Garfield::MediumGas::EnablePenningTransfer(), Garfield::MediumMagboltz::EnablePenningTransfer(), Garfield::MediumMagboltz::EnablePenningTransfer(), Garfield::MediumMagboltz::EnableRadiationTrapping(), Garfield::MediumMagboltz::GenerateGasTable(), GetComponent(), Garfield::MediumCdTe::GetComponent(), Garfield::MediumDiamond::GetComponent(), Garfield::MediumGas::GetComponent(), Garfield::MediumSilicon::GetConductionBandDensityOfStates(), GetDeexcitationProduct(), GetDielectricFunction(), Garfield::MediumSilicon::GetDielectricFunction(), Garfield::MediumSilicon::GetElectronBandPopulation(), GetElectronCollisionRate(), Garfield::MediumMagboltz::GetElectronCollisionRate(), Garfield::MediumMagboltz::GetElectronCollisionRate(), Garfield::MediumSilicon::GetElectronCollisionRate(), GetElectronEnergy(), Garfield::MediumSilicon::GetElectronEnergy(), Garfield::MediumGas::GetElectronExcitationRate(), Garfield::MediumGas::GetElectronIonisationRate(), Garfield::MediumSilicon::GetElectronMomentum(), GetElectronNullCollisionRate(), Garfield::MediumSilicon::GetElectronNullCollisionRate(), GetEntry(), Garfield::MediumGas::GetExcitationLevel(), Garfield::MediumGas::GetIonisationLevel(), Garfield::MediumMagboltz::GetLevel(), Garfield::MediumGas::GetMixture(), Garfield::MediumMagboltz::GetNumberOfElectronCollisions(), Garfield::MediumSilicon::GetNumberOfElectronCollisions(), GetOpticalDataRange(), Garfield::MediumSilicon::GetOpticalDataRange(), Garfield::MediumGas::GetPenningTransfer(), GetPhotoAbsorptionCrossSection(), Garfield::MediumGas::GetPhotoAbsorptionCrossSection(), Garfield::MediumMagboltz::GetPhotonCollision(), Garfield::MediumMagboltz::GetPhotonCollisionRate(), Garfield::MediumSilicon::GetValenceBandDensityOfStates(), Garfield::MediumSilicon::HoleAttachment(), Garfield::MediumSilicon::HoleTownsend(), Garfield::MediumSilicon::HoleVelocity(), Init(), Init(), Garfield::MediumMagboltz::Initialise(), Garfield::MediumSilicon::Initialise(), Interpolate1D(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::LoadMobility(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumConductor::MediumConductor(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumMagboltz::MediumMagboltz(), Garfield::MediumPlastic::MediumPlastic(), Garfield::MediumSilicon::MediumSilicon(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), Garfield::MediumGas::ReadHeader(), Garfield::MediumMagboltz::RunMagboltz(), SetAtomicNumber(), Garfield::MediumGas::SetAtomicNumber(), SetAtomicWeight(), Garfield::MediumGas::SetAtomicWeight(), Garfield::MediumGas::SetComposition(), SetDielectricConstant(), Garfield::MediumSilicon::SetDoping(), Garfield::MediumGaN::SetElectronConcentration(), SetEntry(), Garfield::MediumMagboltz::SetExcitationScaling(), SetExtrapolationMethod(), SetFieldGrid(), SetFieldGrid(), SetIonMobility(), SetIonMobility(), Garfield::MediumCdTe::SetLowFieldMobility(), Garfield::MediumDiamond::SetLowFieldMobility(), Garfield::MediumGaAs::SetLowFieldMobility(), Garfield::MediumGaN::SetLowFieldMobility(), Garfield::MediumSilicon::SetLowFieldMobility(), SetMassDensity(), Garfield::MediumGas::SetMassDensity(), Garfield::MediumMagboltz::SetMaxElectronEnergy(), Garfield::MediumSilicon::SetMaxElectronEnergy(), Garfield::MediumMagboltz::SetMaxPhotonEnergy(), SetNumberDensity(), Garfield::MediumGas::SetNumberDensity(), SetPressure(), Garfield::MediumDiamond::SetSaturationVelocity(), Garfield::MediumSilicon::SetSaturationVelocity(), Garfield::MediumMagboltz::SetSplittingFunctionGreenSawada(), SetTemperature(), Garfield::MediumSilicon::SetTrapCrossSection(), Garfield::MediumSilicon::SetTrapDensity(), Garfield::MediumSilicon::SetTrappingTime(), Velocity(), and Garfield::MediumGas::WriteGasFile().

m_debug

bool Garfield::Medium::m_debug = false

protected

Definition at line 566 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Clone(), DisableDebugging(), ElectronCollision(), Garfield::MediumMagboltz::ElectronCollision(), EnableDebugging(), GetDeexcitationProduct(), GetDielectricFunction(), GetElectronCollisionRate(), Garfield::MediumSilicon::GetElectronMomentum(), GetElectronNullCollisionRate(), GetEntry(), Garfield::MediumMagboltz::GetLevel(), GetOpticalDataRange(), Garfield::MediumSilicon::GetOpticalDataRange(), GetPhotoAbsorptionCrossSection(), Garfield::MediumMagboltz::Initialise(), Garfield::MediumSilicon::Initialise(), Interpolate1D(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::LoadMobility(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::ReadHeader(), Garfield::MediumMagboltz::RunMagboltz(), SetFieldGrid(), SetIonMobility(), Velocity(), and Garfield::MediumGas::WriteGasFile().

m_density

double Garfield::Medium::m_density = 0.

protected

Definition at line 550 of file Medium.hh.

Referenced by GetMassDensity(), GetNumberDensity(), GetPhotonCollisionRate(), SetMassDensity(), and SetNumberDensity().

m_driftable

bool Garfield::Medium::m_driftable = false

protected

Definition at line 558 of file Medium.hh.

Referenced by EnableDrift(), IsDriftable(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumMagboltz::MediumMagboltz(), and Garfield::MediumSilicon::MediumSilicon().

m_eAlp

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eAlp

protected

Definition at line 582 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), ElectronTownsend(), Garfield::MediumCdTe::ElectronTownsend(), Garfield::MediumDiamond::ElectronTownsend(), Garfield::MediumGaAs::ElectronTownsend(), Garfield::MediumGaN::ElectronTownsend(), Garfield::MediumSilicon::ElectronTownsend(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronTownsend(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronTownsend(), SetElectronTownsend(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_eAtt

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eAtt

protected

Definition at line 583 of file Medium.hh.

Referenced by ElectronAttachment(), Garfield::MediumCdTe::ElectronAttachment(), Garfield::MediumDiamond::ElectronAttachment(), Garfield::MediumGaAs::ElectronAttachment(), Garfield::MediumGaN::ElectronAttachment(), Garfield::MediumSilicon::ElectronAttachment(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronAttachment(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronAttachment(), SetElectronAttachment(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_eDifL

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eDifL

protected

Definition at line 580 of file Medium.hh.

Referenced by ElectronDiffusion(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronLongitudinalDiffusion(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronDiffusion(), SetElectronLongitudinalDiffusion(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_eDifM

std::vector<std::vector<std::vector<std::vector<double> > > > Garfield::Medium::m_eDifM

protected

Definition at line 586 of file Medium.hh.

Referenced by ElectronDiffusion(), Garfield::MediumMagboltz::GenerateGasTable(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronDiffusion(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_eDifT

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eDifT

protected

Definition at line 581 of file Medium.hh.

Referenced by ElectronDiffusion(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronTransverseDiffusion(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronDiffusion(), SetElectronTransverseDiffusion(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_eFields

std::vector<double> Garfield::Medium::m_eFields

protected

Definition at line 572 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Alpha(), ElectronMobility(), Garfield::MediumMagboltz::GenerateGasTable(), GetEntry(), GetFieldGrid(), HoleMobility(), Interpolate(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetEntry(), SetFieldGrid(), SetIonMobility(), SetIonMobility(), SetThreshold(), and Garfield::MediumGas::WriteGasFile().

m_eLor

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eLor

protected

Definition at line 584 of file Medium.hh.

Referenced by ElectronLorentzAngle(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronLorentzAngle(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronLorentzAngle(), SetElectronLorentzAngle(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_epsilon

double Garfield::Medium::m_epsilon = 1.

protected

Definition at line 544 of file Medium.hh.

Referenced by GetDielectricConstant(), Garfield::MediumPlastic::MediumPlastic(), and SetDielectricConstant().

m_eThrAlp

unsigned int Garfield::Medium::m_eThrAlp = 0

protected

Definition at line 608 of file Medium.hh.

Referenced by ElectronTownsend(), Garfield::MediumGas::LoadGasFile(), and Garfield::MediumGas::WriteGasFile().

m_eThrAtt

unsigned int Garfield::Medium::m_eThrAtt = 0

protected

Definition at line 609 of file Medium.hh.

Referenced by ElectronAttachment(), Garfield::MediumGas::LoadGasFile(), and Garfield::MediumGas::WriteGasFile().

m_eVelB

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eVelB

protected

Definition at line 579 of file Medium.hh.

Referenced by ElectronVelocity(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronVelocityB(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronVelocity(), SetElectronVelocityB(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_eVelE

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eVelE

protected

Definition at line 577 of file Medium.hh.

Referenced by ElectronMobility(), ElectronVelocity(), Garfield::MediumCdTe::ElectronVelocity(), Garfield::MediumDiamond::ElectronVelocity(), Garfield::MediumGaAs::ElectronVelocity(), Garfield::MediumGaN::ElectronVelocity(), Garfield::MediumSilicon::ElectronVelocity(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronVelocityE(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronVelocity(), SetElectronVelocityE(), SetFieldGrid(), Garfield::MediumGas::WriteGasFile(), Garfield::MediumGas::ZeroRowA(), Garfield::MediumGas::ZeroRowB(), and Garfield::MediumGas::ZeroRowE().

m_eVelX

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_eVelX

protected

Definition at line 578 of file Medium.hh.

Referenced by ElectronVelocity(), Garfield::MediumMagboltz::GenerateGasTable(), GetElectronVelocityExB(), Garfield::MediumGas::GetGasBits(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetElectronVelocity(), SetElectronVelocityExB(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_extrAlp

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrAlp = {0, 1}

protected

Definition at line 617 of file Medium.hh.

{0, 1};

Referenced by ElectronTownsend(), HoleTownsend(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetExtrapolationMethodTownsend(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_extrAtt

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrAtt = {0, 1}

protected

Definition at line 618 of file Medium.hh.

{0, 1};

Referenced by ElectronAttachment(), HoleAttachment(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetExtrapolationMethodAttachment(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_extrDif

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrDif = {0, 1}

protected

Definition at line 616 of file Medium.hh.

{0, 1};

Referenced by Diffusion(), Diffusion(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetExtrapolationMethodDiffusion(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_extrDis

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrDis = {0, 1}

protected

Definition at line 621 of file Medium.hh.

{0, 1};

Referenced by IonDissociation(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetExtrapolationMethodIonDissociation(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_extrLor

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrLor = {0, 1}

protected

Definition at line 619 of file Medium.hh.

{0, 1};

Referenced by ElectronLorentzAngle(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_extrMob

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrMob = {0, 1}

protected

Definition at line 620 of file Medium.hh.

{0, 1};

Referenced by IonVelocity(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), NegativeIonVelocity(), Garfield::MediumGas::PrintGas(), SetExtrapolationMethodIonMobility(), SetFieldGrid(), SetIonMobility(), and Garfield::MediumGas::WriteGasFile().

m_extrVel

std::pair<unsigned int, unsigned int> Garfield::Medium::m_extrVel = {0, 1}

protected

Definition at line 615 of file Medium.hh.

{0, 1};

Referenced by Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetExtrapolationMethodVelocity(), SetFieldGrid(), Velocity(), and Garfield::MediumGas::WriteGasFile().

m_fano

double Garfield::Medium::m_fano = 0.

protected

Definition at line 555 of file Medium.hh.

Referenced by GetFanoFactor(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumSilicon::MediumSilicon(), Garfield::MediumGas::SetComposition(), and SetFanoFactor().

m_hAlp

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hAlp

protected

Definition at line 594 of file Medium.hh.

Referenced by GetHoleTownsend(), HoleTownsend(), Garfield::MediumCdTe::HoleTownsend(), Garfield::MediumDiamond::HoleTownsend(), Garfield::MediumGaAs::HoleTownsend(), Garfield::MediumGaN::HoleTownsend(), Garfield::MediumSilicon::HoleTownsend(), ResetHoleTownsend(), SetFieldGrid(), and SetHoleTownsend().

m_hAtt

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hAtt

protected

Definition at line 595 of file Medium.hh.

Referenced by GetHoleAttachment(), HoleAttachment(), Garfield::MediumCdTe::HoleAttachment(), Garfield::MediumDiamond::HoleAttachment(), Garfield::MediumGaAs::HoleAttachment(), Garfield::MediumGaN::HoleAttachment(), Garfield::MediumSilicon::HoleAttachment(), ResetHoleAttachment(), SetFieldGrid(), and SetHoleAttachment().

m_hDifL

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hDifL

protected

Definition at line 592 of file Medium.hh.

Referenced by GetHoleLongitudinalDiffusion(), HoleDiffusion(), ResetHoleDiffusion(), SetFieldGrid(), and SetHoleLongitudinalDiffusion().

m_hDifM

std::vector<std::vector<std::vector<std::vector<double> > > > Garfield::Medium::m_hDifM

protected

Definition at line 597 of file Medium.hh.

Referenced by HoleDiffusion(), ResetHoleDiffusion(), and SetFieldGrid().

m_hDifT

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hDifT

protected

Definition at line 593 of file Medium.hh.

Referenced by GetHoleTransverseDiffusion(), HoleDiffusion(), ResetHoleDiffusion(), SetFieldGrid(), and SetHoleTransverseDiffusion().

m_hThrAlp

unsigned int Garfield::Medium::m_hThrAlp = 0

protected

Definition at line 610 of file Medium.hh.

Referenced by HoleTownsend().

m_hThrAtt

unsigned int Garfield::Medium::m_hThrAtt = 0

protected

Definition at line 611 of file Medium.hh.

Referenced by HoleAttachment().

m_hVelB

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hVelB

protected

Definition at line 591 of file Medium.hh.

Referenced by GetHoleVelocityB(), HoleVelocity(), ResetHoleVelocity(), SetFieldGrid(), and SetHoleVelocityB().

m_hVelE

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hVelE

protected

Definition at line 589 of file Medium.hh.

Referenced by GetHoleVelocityE(), HoleMobility(), HoleVelocity(), Garfield::MediumCdTe::HoleVelocity(), Garfield::MediumDiamond::HoleVelocity(), Garfield::MediumGaAs::HoleVelocity(), Garfield::MediumGaN::HoleVelocity(), Garfield::MediumSilicon::HoleVelocity(), ResetHoleVelocity(), SetFieldGrid(), and SetHoleVelocityE().

m_hVelX

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_hVelX

protected

Definition at line 590 of file Medium.hh.

Referenced by GetHoleVelocityExB(), HoleVelocity(), ResetHoleVelocity(), SetFieldGrid(), and SetHoleVelocityExB().

m_id

int Garfield::Medium::m_id

protected

Definition at line 534 of file Medium.hh.

Referenced by GetId(), and Medium().

m_idCounter

int Garfield::Medium::m_idCounter = -1

staticprotected

Definition at line 531 of file Medium.hh.

Referenced by Medium().

m_iDifL

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_iDifL

protected

Definition at line 601 of file Medium.hh.

Referenced by GetIonLongitudinalDiffusion(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), IonDiffusion(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetIonDiffusion(), SetFieldGrid(), SetIonLongitudinalDiffusion(), and Garfield::MediumGas::WriteGasFile().

m_iDifT

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_iDifT

protected

Definition at line 602 of file Medium.hh.

Referenced by GetIonTransverseDiffusion(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), IonDiffusion(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetIonDiffusion(), SetFieldGrid(), SetIonTransverseDiffusion(), and Garfield::MediumGas::WriteGasFile().

m_iDis

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_iDis

protected

Definition at line 603 of file Medium.hh.

Referenced by Garfield::MediumGas::GetGasBits(), GetIonDissociation(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), IonDissociation(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), ResetIonDissociation(), SetFieldGrid(), SetIonDissociation(), and Garfield::MediumGas::WriteGasFile().

m_iMob

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_iMob

protected

Definition at line 600 of file Medium.hh.

Referenced by Garfield::MediumGas::GetGasBits(), GetIonMobility(), Garfield::MediumGas::InsertA(), Garfield::MediumGas::InsertB(), Garfield::MediumGas::InsertE(), IonMobility(), IonVelocity(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), NegativeIonVelocity(), Garfield::MediumGas::PrintGas(), ResetIonMobility(), SetFieldGrid(), SetIonMobility(), SetIonMobility(), and Garfield::MediumGas::WriteGasFile().

m_intpAlp

unsigned int Garfield::Medium::m_intpAlp = 2

protected

Definition at line 626 of file Medium.hh.

Referenced by ElectronTownsend(), HoleTownsend(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), SetInterpolationMethodTownsend(), and Garfield::MediumGas::WriteGasFile().

m_intpAtt

unsigned int Garfield::Medium::m_intpAtt = 2

protected

Definition at line 627 of file Medium.hh.

Referenced by ElectronAttachment(), HoleAttachment(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), SetInterpolationMethodAttachment(), and Garfield::MediumGas::WriteGasFile().

m_intpDif

unsigned int Garfield::Medium::m_intpDif = 2

protected

Definition at line 625 of file Medium.hh.

Referenced by Diffusion(), Diffusion(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), SetInterpolationMethodDiffusion(), and Garfield::MediumGas::WriteGasFile().

m_intpDis

unsigned int Garfield::Medium::m_intpDis = 2

protected

Definition at line 630 of file Medium.hh.

Referenced by IonDissociation(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), SetInterpolationMethodIonDissociation(), and Garfield::MediumGas::WriteGasFile().

m_intpLor

unsigned int Garfield::Medium::m_intpLor = 2

protected

Definition at line 628 of file Medium.hh.

Referenced by ElectronLorentzAngle(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), and Garfield::MediumGas::WriteGasFile().

m_intpMob

unsigned int Garfield::Medium::m_intpMob = 2

protected

Definition at line 629 of file Medium.hh.

Referenced by IonVelocity(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), NegativeIonVelocity(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), SetInterpolationMethodIonMobility(), SetIonMobility(), and Garfield::MediumGas::WriteGasFile().

m_intpVel

unsigned int Garfield::Medium::m_intpVel = 2

protected

Definition at line 624 of file Medium.hh.

Referenced by Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumGas::PrintGas(), SetFieldGrid(), SetInterpolationMethodVelocity(), Velocity(), and Garfield::MediumGas::WriteGasFile().

m_ionisable

bool Garfield::Medium::m_ionisable = false

protected

Definition at line 560 of file Medium.hh.

Referenced by EnablePrimaryIonisation(), IsIonisable(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumMagboltz::MediumMagboltz(), and Garfield::MediumSilicon::MediumSilicon().

m_isChanged

bool Garfield::Medium::m_isChanged = true

protected

Definition at line 563 of file Medium.hh.

Referenced by Garfield::MediumSilicon::ElectronAttachment(), Garfield::MediumSilicon::ElectronCollision(), Garfield::MediumGaAs::ElectronTownsend(), Garfield::MediumGaN::ElectronTownsend(), Garfield::MediumSilicon::ElectronTownsend(), Garfield::MediumCdTe::ElectronVelocity(), Garfield::MediumDiamond::ElectronVelocity(), Garfield::MediumGaAs::ElectronVelocity(), Garfield::MediumGaN::ElectronVelocity(), Garfield::MediumSilicon::ElectronVelocity(), Garfield::MediumMagboltz::EnableAnisotropicScattering(), Garfield::MediumMagboltz::EnableDeexcitation(), Garfield::MediumMagboltz::EnableRadiationTrapping(), Garfield::MediumSilicon::GetElectronCollisionRate(), Garfield::MediumSilicon::GetElectronNullCollisionRate(), Garfield::MediumSilicon::HoleAttachment(), Garfield::MediumGaAs::HoleTownsend(), Garfield::MediumGaN::HoleTownsend(), Garfield::MediumSilicon::HoleTownsend(), Garfield::MediumCdTe::HoleVelocity(), Garfield::MediumDiamond::HoleVelocity(), Garfield::MediumGaAs::HoleVelocity(), Garfield::MediumGaN::HoleVelocity(), Garfield::MediumSilicon::HoleVelocity(), Garfield::MediumMagboltz::Initialise(), Garfield::MediumSilicon::Initialise(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MediumGas(), Garfield::MediumMagboltz::MediumMagboltz(), Garfield::MediumMagboltz::PrintGas(), SetAtomicNumber(), SetAtomicWeight(), Garfield::MediumGas::SetComposition(), SetDielectricConstant(), Garfield::MediumSilicon::SetDoping(), Garfield::MediumSilicon::SetDopingMobilityModelMasetti(), Garfield::MediumSilicon::SetDopingMobilityModelMinimos(), Garfield::MediumMagboltz::SetExcitationScaling(), Garfield::MediumSilicon::SetHighFieldMobilityModelCanali(), Garfield::MediumSilicon::SetHighFieldMobilityModelMinimos(), Garfield::MediumSilicon::SetHighFieldMobilityModelReggiani(), Garfield::MediumSilicon::SetImpactIonisationModelGrant(), Garfield::MediumSilicon::SetImpactIonisationModelMassey(), Garfield::MediumSilicon::SetImpactIonisationModelOkutoCrowell(), Garfield::MediumSilicon::SetImpactIonisationModelVanOverstraetenDeMan(), Garfield::MediumSilicon::SetLatticeMobilityModelMinimos(), Garfield::MediumSilicon::SetLatticeMobilityModelReggiani(), Garfield::MediumSilicon::SetLatticeMobilityModelSentaurus(), Garfield::MediumCdTe::SetLowFieldMobility(), Garfield::MediumDiamond::SetLowFieldMobility(), Garfield::MediumGaAs::SetLowFieldMobility(), Garfield::MediumGaN::SetLowFieldMobility(), Garfield::MediumSilicon::SetLowFieldMobility(), SetMassDensity(), Garfield::MediumMagboltz::SetMaxElectronEnergy(), Garfield::MediumSilicon::SetMaxElectronEnergy(), Garfield::MediumMagboltz::SetMaxPhotonEnergy(), SetNumberDensity(), SetPressure(), Garfield::MediumSilicon::SetSaturationVelocity(), Garfield::MediumSilicon::SetSaturationVelocityModelCanali(), Garfield::MediumSilicon::SetSaturationVelocityModelMinimos(), Garfield::MediumSilicon::SetSaturationVelocityModelReggiani(), Garfield::MediumMagboltz::SetSplittingFunctionGreenSawada(), SetTemperature(), Garfield::MediumSilicon::SetTrapCrossSection(), Garfield::MediumSilicon::SetTrapDensity(), Garfield::MediumSilicon::SetTrappingTime(), Garfield::MediumCdTe::UnsetLowFieldMobility(), Garfield::MediumDiamond::UnsetLowFieldMobility(), Garfield::MediumGaAs::UnsetLowFieldMobility(), and Garfield::MediumGaN::UnsetLowFieldMobility().

m_iThrDis

unsigned int Garfield::Medium::m_iThrDis = 0

protected

Definition at line 612 of file Medium.hh.

Referenced by IonDissociation(), Garfield::MediumGas::LoadGasFile(), and Garfield::MediumGas::WriteGasFile().

m_microscopic

bool Garfield::Medium::m_microscopic = false

protected

Definition at line 559 of file Medium.hh.

Referenced by IsMicroscopic(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumMagboltz::MediumMagboltz(), and Garfield::MediumSilicon::MediumSilicon().

m_name

std::string Garfield::Medium::m_name = ""

protected

Definition at line 538 of file Medium.hh.

Referenced by Garfield::MediumGas::EnablePenningTransfer(), GetComponent(), GetName(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumConductor::MediumConductor(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumPlastic::MediumPlastic(), Garfield::MediumSilicon::MediumSilicon(), Garfield::MediumGas::PrintGas(), and Garfield::MediumGas::SetComposition().

m_nComponents

unsigned int Garfield::Medium::m_nComponents = 1

protected

Definition at line 536 of file Medium.hh.

Referenced by Garfield::MediumGas::DisablePenningTransfer(), Garfield::MediumMagboltz::DisablePenningTransfer(), Garfield::MediumGas::EnablePenningTransfer(), Garfield::MediumGas::EnablePenningTransfer(), Garfield::MediumMagboltz::EnablePenningTransfer(), Garfield::MediumMagboltz::GenerateGasTable(), Garfield::MediumGas::GetAtomicNumber(), Garfield::MediumGas::GetAtomicWeight(), GetComponent(), Garfield::MediumGas::GetComponent(), GetDielectricFunction(), GetNumberOfComponents(), GetOpticalDataRange(), Garfield::MediumGas::GetPenningTransfer(), GetPhotoAbsorptionCrossSection(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumMagboltz::MediumMagboltz(), Garfield::MediumGas::MergeGasFile(), Garfield::MediumMagboltz::PlotElectronCrossSections(), Garfield::MediumGas::PrintGas(), Garfield::MediumMagboltz::RunMagboltz(), Garfield::MediumGas::SetComposition(), Garfield::MediumMagboltz::SetExcitationScaling(), Garfield::MediumMagboltz::SetSplittingFunctionGreenSawada(), and Garfield::MediumGas::WriteGasFile().

m_nMob

std::vector<std::vector<std::vector<double> > > Garfield::Medium::m_nMob

protected

Definition at line 605 of file Medium.hh.

Referenced by GetNegativeIonMobility(), NegativeIonMobility(), NegativeIonVelocity(), ResetNegativeIonMobility(), SetIonMobility(), and SetNegativeIonMobility().

m_pressure

double Garfield::Medium::m_pressure = 760.

protected

Definition at line 542 of file Medium.hh.

Referenced by Garfield::MediumGas::AdjustTownsendCoefficient(), Garfield::MediumGas::EnablePenningTransfer(), Garfield::MediumMagboltz::GenerateGasTable(), Garfield::MediumGas::GetNumberDensity(), GetPressure(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MediumGas(), Garfield::MediumMagboltz::MediumMagboltz(), Garfield::MediumGas::PrintGas(), Garfield::MediumMagboltz::RunMagboltz(), Garfield::MediumGas::ScaleAttachment(), Garfield::MediumGas::ScaleDiffusion(), Garfield::MediumGas::ScaleDiffusionTensor(), Garfield::MediumGas::ScaleElectricField(), Garfield::MediumGas::ScaleLorentzAngle(), Garfield::MediumGas::ScaleTownsend(), SetPressure(), and Garfield::MediumGas::UnScaleElectricField().

m_tab2d

bool Garfield::Medium::m_tab2d = false

protected

Definition at line 569 of file Medium.hh.

Referenced by Alpha(), Diffusion(), Diffusion(), ElectronLorentzAngle(), Interpolate(), IonVelocity(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MergeGasFile(), NegativeIonVelocity(), SetFieldGrid(), SetIonMobility(), and Garfield::MediumGas::WriteGasFile().

m_temperature

double Garfield::Medium::m_temperature = 293.15

protected

Definition at line 540 of file Medium.hh.

Referenced by Diffusion(), Garfield::MediumMagboltz::GenerateGasTable(), Garfield::MediumGas::GetNumberDensity(), GetTemperature(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumGas::MediumGas(), Garfield::MediumMagboltz::MediumMagboltz(), Garfield::MediumGas::PrintGas(), Garfield::MediumMagboltz::RunMagboltz(), and SetTemperature().

m_w

double Garfield::Medium::m_w = 0.

protected

Definition at line 553 of file Medium.hh.

Referenced by GetW(), Garfield::MediumGas::LoadGasFile(), Garfield::MediumCdTe::MediumCdTe(), Garfield::MediumDiamond::MediumDiamond(), Garfield::MediumGaAs::MediumGaAs(), Garfield::MediumGaN::MediumGaN(), Garfield::MediumGas::MediumGas(), Garfield::MediumSilicon::MediumSilicon(), Garfield::MediumGas::SetComposition(), and SetW().

m_z

double Garfield::Medium::m_z = 1.

protected

Definition at line 546 of file Medium.hh.

Referenced by GetAtomicNumber(), and SetAtomicNumber().

---

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

• Medium.hh
• Medium.cc