Garfield::ViewMedium Class Reference

Plot transport coefficients as function of electric and magnetic field. More...

#include <ViewMedium.hh>

Inheritance diagram for Garfield::ViewMedium:

Public Types
enum	Property {   ElectronVelocityE , ElectronTransverseDiffusion , ElectronLongitudinalDiffusion , ElectronTownsend ,   ElectronAttachment , ElectronLorentzAngle , HoleVelocityE = 10 , HoleTransverseDiffusion ,   HoleLongitudinalDiffusion , HoleTownsend , HoleAttachment , IonVelocity = 20 ,   IonTransverseDiffusion , IonLongitudinalDiffusion , ElectronVelocityB , ElectronVelocityExB ,   HoleVelocityB , HoleVelocityExB }

Public Member Functions
	ViewMedium ()
	Constructor.
	~ViewMedium ()=default
	Destructor.
void	SetMedium (Medium *m)
	Set the medium from which to retrieve the transport coefficients.
void	EnableAutoRangeX (const bool on=true)
	Try to choose the x-axis range based on the field grid.
void	SetRangeE (const double emin, const double emax, const bool logscale)
	Set the limits of the electric field.
void	SetRangeB (const double bmin, const double bmax, const bool logscale)
	Set the limits of the magnetic field.
void	SetRangeA (const double amin, const double amax, const bool logscale)
	Set the limits of the angle between electric and magnetic field.
void	EnableAutoRangeY (const bool on=true)
	Choose the y-axis range based on the function's minima/maxima.
void	SetRangeY (const double ymin, const double ymax, const bool logscale=false)
	Set the range of the function (velocity etc.) to be plotted.
void	SetElectricField (const double efield)
	Set the electric field to use when plotting as function of B or angle.
void	SetMagneticField (const double bfield)
	Set the magnetic field to use when plotting as function of E or angle.
void	SetAngle (const double angle)
	Set the angle to use when plotting as function of E or B.
void	PlotElectronVelocity (const char xaxis, const bool same=false)
void	PlotHoleVelocity (const char xaxis, const bool same=false)
void	PlotIonVelocity (const char xaxis, const bool same=false)
void	PlotElectronDiffusion (const char xaxis, const bool same=false)
void	PlotHoleDiffusion (const char xaxis, const bool same=false)
void	PlotIonDiffusion (const char xaxis, const bool same=false)
void	PlotElectronTownsend (const char xaxis, const bool same=false)
void	PlotHoleTownsend (const char xaxis, const bool same=false)
void	PlotElectronAttachment (const char xaxis, const bool same=false)
void	PlotHoleAttachment (const char xaxis, const bool same=false)
void	PlotElectronLorentzAngle (const char xaxis, const bool same=false)
void	PlotElectronCrossSections ()
double	EvaluateFunction (double *pos, double *par)
Public Member Functions inherited from Garfield::ViewBase
	ViewBase ()=delete
	Default constructor.
	ViewBase (const std::string &name)
	Constructor.
virtual	~ViewBase ()
	Destructor.
void	SetCanvas (TCanvas *c)
	Set the canvas to be painted on.
TCanvas *	GetCanvas ()
	Retrieve the canvas.
void	EnableDebugging (const bool on=true)
	Switch on/off debugging output.

Additional Inherited Members
Protected Member Functions inherited from Garfield::ViewBase
std::string	FindUnusedFunctionName (const std::string &s) const
std::string	FindUnusedHistogramName (const std::string &s) const
Protected Attributes inherited from Garfield::ViewBase
std::string	m_className = "ViewBase"
bool	m_debug = false
TCanvas *	m_canvas = nullptr
bool	m_hasExternalCanvas = false
double	m_proj [3][3]

Detailed Description

Plot transport coefficients as function of electric and magnetic field.

Definition at line 19 of file ViewMedium.hh.

Member Enumeration Documentation

Property

enum Garfield::ViewMedium::Property

Enumerator
ElectronVelocityE
ElectronTransverseDiffusion
ElectronLongitudinalDiffusion
ElectronTownsend
ElectronAttachment
ElectronLorentzAngle
HoleVelocityE
HoleTransverseDiffusion
HoleLongitudinalDiffusion
HoleTownsend
HoleAttachment
IonVelocity
IonTransverseDiffusion
IonLongitudinalDiffusion
ElectronVelocityB
ElectronVelocityExB
HoleVelocityB
HoleVelocityExB

Definition at line 65 of file ViewMedium.hh.

                {
    ElectronVelocityE,
    ElectronTransverseDiffusion,
    ElectronLongitudinalDiffusion,
    ElectronTownsend,
    ElectronAttachment,
    ElectronLorentzAngle,
    HoleVelocityE = 10,
    HoleTransverseDiffusion,
    HoleLongitudinalDiffusion,
    HoleTownsend,
    HoleAttachment,
    IonVelocity = 20,
    IonTransverseDiffusion,
    IonLongitudinalDiffusion,
    ElectronVelocityB,
    ElectronVelocityExB,
    HoleVelocityB,
    HoleVelocityExB
  };

Constructor & Destructor Documentation

ViewMedium()

Garfield::ViewMedium::ViewMedium

(

)

Constructor.

Definition at line 32 of file ViewMedium.cc.

: ViewBase("ViewMedium") {}

~ViewMedium()

Garfield::ViewMedium::~ViewMedium ( )

default

Destructor.

Member Function Documentation

EnableAutoRangeX()

void Garfield::ViewMedium::EnableAutoRangeX ( const bool  on = true )

inline

Try to choose the x-axis range based on the field grid.

Definition at line 30 of file ViewMedium.hh.

{ m_autoRangeX = on; } 

EnableAutoRangeY()

void Garfield::ViewMedium::EnableAutoRangeY ( const bool  on = true )

inline

Choose the y-axis range based on the function's minima/maxima.

Definition at line 38 of file ViewMedium.hh.

{ m_autoRangeY = on; }

EvaluateFunction()

double Garfield::ViewMedium::EvaluateFunction	(	double *	pos,
		double *	par
	)

Definition at line 406 of file ViewMedium.cc.

                                                            {
  // to be modified to include B and angle
 
  if (!m_medium) return 0.;
  int type = int(par[0]);
  char xaxis = char(par[1]);
  const double x = pos[0];
 
  const double ctheta = xaxis == 'a' ? cos(x) : cos(par[4]);
  const double stheta = xaxis == 'a' ? sin(x) : sin(par[4]);
  double ex = xaxis == 'e' ? x : par[2];
  double ey = 0.;
  double bx = xaxis == 'b' ? x : par[3];
  double by = 0.;
  if (type == ElectronVelocityExB || type == HoleVelocityExB ||
             type == ElectronVelocityB || type == HoleVelocityB) {
    ex *= ctheta;
    ey = xaxis == 'e' ? x * stheta : par[2] * stheta; 
  } else {
    bx *= ctheta;
    by = xaxis == 'b' ? x * stheta : par[3] * stheta;
  } 
  // Return value.
  double y = 0.;
  // Auxiliary (dummy) variables.
  double s = 0., t = 0.;
  switch (type) {
    case ElectronVelocityE:
      if (!m_medium->ElectronVelocity(ex, 0, 0, bx, by, 0, y, s, t)) return 0.;
      y = fabs(y);
      break;
    case ElectronTransverseDiffusion:
      if (!m_medium->ElectronDiffusion(ex, 0, 0, bx, by, 0, s, y)) return 0.;
      break;
    case ElectronLongitudinalDiffusion:
      if (!m_medium->ElectronDiffusion(ex, 0, 0, bx, by, 0, y, s)) return 0.;
      break;
    case ElectronTownsend:
      if (!m_medium->ElectronTownsend(ex, 0, 0, bx, by, 0, y)) return 0.;
      break;
    case ElectronAttachment:
      if (!m_medium->ElectronAttachment(ex, 0, 0, bx, by, 0, y)) return 0.;
      break;
    case ElectronLorentzAngle:
      if (!m_medium->ElectronLorentzAngle(ex, 0, 0, bx, by, 0, y)) return 0.;
      break;
    case HoleVelocityE:
      if (!m_medium->HoleVelocity(ex, 0, 0, bx, by, 0, y, s, t)) return 0.;
      break;
    case HoleTransverseDiffusion:
      if (!m_medium->HoleDiffusion(ex, 0, 0, bx, by, 0, s, y)) return 0.;
      break;
    case HoleLongitudinalDiffusion:
      if (!m_medium->HoleDiffusion(ex, 0, 0, bx, by, 0, y, s)) return 0.;
      break;
    case HoleTownsend:
      if (!m_medium->HoleTownsend(ex, 0, 0, bx, by, 0, y)) return 0.;
      break;
    case HoleAttachment:
      if (!m_medium->HoleAttachment(ex, 0, 0, bx, by, 0, y)) return 0.;
      break;
    case IonVelocity:
      if (!m_medium->IonVelocity(ex, 0, 0, bx, by, 0, y, s, t)) return 0.;
      break;
    case IonTransverseDiffusion:
      if (!m_medium->IonDiffusion(ex, 0, 0, bx, by, 0, s, y)) return 0.;
      break;
    case IonLongitudinalDiffusion:
      if (!m_medium->IonDiffusion(ex, 0, 0, bx, by, 0, y, s)) return 0.;
      break;
    case ElectronVelocityB:
      if (!m_medium->ElectronVelocity(ex, ey, 0, bx, 0, 0, y, s, t)) return 0.;
      y = fabs(y);
      break;
    case ElectronVelocityExB:
      if (!m_medium->ElectronVelocity(ex, ey, 0, bx, 0, 0, s, t, y)) return 0.;
      y = fabs(y);
      break;
    case HoleVelocityB:
      if (!m_medium->HoleVelocity(ex, ey, 0, bx, 0, 0, y, s, t)) return 0.;
      y = fabs(y);
      break;
    case HoleVelocityExB:
      if (!m_medium->HoleVelocity(ex, ey, 0, bx, 0, 0, s, t, y)) return 0.;
      y = fabs(y);
      break;
    default:
      std::cerr << m_className << "::EvaluateFunction:\n    "
                << "Unknown type of transport coefficient requested. Bug!\n";
      return 0.;
  }
 
  return y;
}

PlotElectronAttachment()

void Garfield::ViewMedium::PlotElectronAttachment	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 136 of file ViewMedium.cc.

                                                                         {
  SetupCanvas();
  AddFunction(same, ElectronAttachment, xaxis);
}

PlotElectronCrossSections()

void Garfield::ViewMedium::PlotElectronCrossSections

(

)

Definition at line 151 of file ViewMedium.cc.

                                           {
  std::cerr << m_className << "::PlotElectronCrossSections: Not implemented.\n";
}

PlotElectronDiffusion()

void Garfield::ViewMedium::PlotElectronDiffusion	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 108 of file ViewMedium.cc.

                                                                        {
  SetupCanvas();
  AddFunction(same, ElectronTransverseDiffusion, xaxis);
  AddFunction(true, ElectronLongitudinalDiffusion, xaxis);
}

PlotElectronLorentzAngle()

void Garfield::ViewMedium::PlotElectronLorentzAngle	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 146 of file ViewMedium.cc.

                                                                           {
  SetupCanvas();
  AddFunction(same, ElectronLorentzAngle, xaxis);
}

PlotElectronTownsend()

void Garfield::ViewMedium::PlotElectronTownsend	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 126 of file ViewMedium.cc.

                                                                       {
  SetupCanvas();
  AddFunction(same, ElectronTownsend, xaxis);
}

PlotElectronVelocity()

void Garfield::ViewMedium::PlotElectronVelocity	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 89 of file ViewMedium.cc.

                                                                       {
  SetupCanvas();
  AddFunction(same, ElectronVelocityE, xaxis);
  AddFunction(true, ElectronVelocityB, xaxis);
  AddFunction(true, ElectronVelocityExB, xaxis);
}

PlotHoleAttachment()

void Garfield::ViewMedium::PlotHoleAttachment	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 141 of file ViewMedium.cc.

                                                                     {
  SetupCanvas();
  AddFunction(same, HoleAttachment, xaxis);
}

PlotHoleDiffusion()

void Garfield::ViewMedium::PlotHoleDiffusion	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 114 of file ViewMedium.cc.

                                                                    {
  SetupCanvas();
  AddFunction(same, HoleTransverseDiffusion, xaxis);
  AddFunction(true, HoleLongitudinalDiffusion, xaxis);
}

PlotHoleTownsend()

void Garfield::ViewMedium::PlotHoleTownsend	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 131 of file ViewMedium.cc.

                                                                   {
  SetupCanvas();
  AddFunction(same, HoleTownsend, xaxis);
}

PlotHoleVelocity()

void Garfield::ViewMedium::PlotHoleVelocity	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 96 of file ViewMedium.cc.

                                                                   {
  SetupCanvas();
  AddFunction(same, HoleVelocityE, xaxis);
  AddFunction(true, HoleVelocityB, xaxis);
  AddFunction(true, HoleVelocityExB, xaxis);
}

PlotIonDiffusion()

void Garfield::ViewMedium::PlotIonDiffusion	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 120 of file ViewMedium.cc.

                                                                   {
  SetupCanvas();
  AddFunction(same, IonTransverseDiffusion, xaxis);
  AddFunction(true, IonLongitudinalDiffusion, xaxis);
}

PlotIonVelocity()

void Garfield::ViewMedium::PlotIonVelocity	(	const char	xaxis,
		const bool	same = false
	)

Definition at line 103 of file ViewMedium.cc.

                                                                  {
  SetupCanvas();
  AddFunction(same, IonVelocity, xaxis);
}

SetAngle()

void Garfield::ViewMedium::SetAngle ( const double  angle )

inline

Set the angle to use when plotting as function of E or B.

Definition at line 48 of file ViewMedium.hh.

{ m_angle = angle; }

SetElectricField()

void Garfield::ViewMedium::SetElectricField ( const double  efield )

inline

Set the electric field to use when plotting as function of B or angle.

Definition at line 44 of file ViewMedium.hh.

{ m_efield = efield; }

SetMagneticField()

void Garfield::ViewMedium::SetMagneticField ( const double  bfield )

inline

Set the magnetic field to use when plotting as function of E or angle.

Definition at line 46 of file ViewMedium.hh.

{ m_bfield = bfield; }

SetMedium()

void Garfield::ViewMedium::SetMedium

(

Medium *

m

)

Set the medium from which to retrieve the transport coefficients.

Definition at line 34 of file ViewMedium.cc.

                                    {
  if (!m) {
    std::cerr << m_className << "::SetMedium: Null pointer.\n";
    return;
  }
 
  m_medium = m;
}

SetRangeA()

void Garfield::ViewMedium::SetRangeA	(	const double	amin,
		const double	amax,
		const bool	logscale
	)

Set the limits of the angle between electric and magnetic field.

Definition at line 66 of file ViewMedium.cc.

                                                                                    {
  if (amin >= amax || amin < 0.) {
    std::cerr << m_className << "::SetRangeA: Incorrect range.\n";
    return;
  }
 
  m_aMin = amin;
  m_aMax = amax;
  m_logA = logscale;
}

SetRangeB()

void Garfield::ViewMedium::SetRangeB	(	const double	bmin,
		const double	bmax,
		const bool	logscale
	)

Set the limits of the magnetic field.

Definition at line 55 of file ViewMedium.cc.

                                                                                    {
  if (bmin >= bmax || bmin < 0.) {
    std::cerr << m_className << "::SetRangeB: Incorrect range.\n";
    return;
  }
 
  m_bMin = bmin;
  m_bMax = bmax;
  m_logB = logscale;
}

SetRangeE()

void Garfield::ViewMedium::SetRangeE	(	const double	emin,
		const double	emax,
		const bool	logscale
	)

Set the limits of the electric field.

Definition at line 43 of file ViewMedium.cc.

                                                {
  if (emin >= emax || emin < 0.) {
    std::cerr << m_className << "::SetRangeE: Incorrect range.\n";
    return;
  }
 
  m_eMin = emin;
  m_eMax = emax;
  m_logE = logscale;
}

SetRangeY()

void Garfield::ViewMedium::SetRangeY	(	const double	ymin,
		const double	ymax,
		const bool	logscale = false
	)

Set the range of the function (velocity etc.) to be plotted.

Definition at line 77 of file ViewMedium.cc.

                                                {
  if (ymin >= ymax || ymin < 0.) {
    std::cerr << m_className << "::SetRangeY: Incorrect range.\n";
    return;
  }
 
  m_yMin = ymin;
  m_yMax = ymax;
  m_logY = logscale;
}

---

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

• ViewMedium.hh
• ViewMedium.cc