ViewField.hh

Go to the documentation of this file.

#ifndef G_VIEW_FIELD
#define G_VIEW_FIELD
 
#include <Rtypes.h>
 
#include "Garfield/ViewBase.hh"
 
namespace Garfield {
 
class Sensor;
class Component;

 
class ViewField : public ViewBase {
 public:
  ViewField();
  ViewField(Sensor* sensor);
  ViewField(Component* component);
  ~ViewField() = default;

  void SetSensor(Sensor* s);
  void SetComponent(Component* c);

  void SetVoltageRange(const double vmin, const double vmax);
  void SetElectricFieldRange(const double emin, const double emax);
  void SetWeightingFieldRange(const double wmin, const double wmax);
  void SetMagneticFieldRange(const double bmin, const double bmax);

  void SetNumberOfContours(const unsigned int n);
  void SetNumberOfSamples1d(const unsigned int n);
  void SetNumberOfSamples2d(const unsigned int nx, const unsigned int ny);

  void PlotContour(const std::string& option = "v");
  void Plot(const std::string& option = "v",
            const std::string& drawopt = "arr");
  void PlotProfile(const double x0, const double y0, const double z0,
                   const double x1, const double y1, const double z1,
                   const std::string& option = "v",
                   const bool normalised = true);

  void PlotContourWeightingField(const std::string& label,
                                 const std::string& option);
  void PlotWeightingField(const std::string& label, const std::string& option,
                          const std::string& drawopt, const double t = 0.);

  void PlotProfileWeightingField(const std::string& label, const double x0,
                                 const double y0, const double z0,
                                 const double x1, const double y1,
                                 const double z1,
                                 const std::string& option = "v",
                                 const bool normalised = true);
  void EnableAutoRange(const bool on = true,
                       const bool samplePotential = true) {
    m_useAutoRange = on;
    m_samplePotential = samplePotential;
  }

  void AcknowledgeStatus(const bool on, const double v0 = 0.) {
    m_useStatus = on;
    m_vBkg = v0;
  }

  void PlotFieldLines(const std::vector<double>& x0,
                      const std::vector<double>& y0,
                      const std::vector<double>& z0, const bool electron = true,
                      const bool axis = true, const short col = kOrange - 3);
  bool EqualFluxIntervals(const double x0, const double y0, const double z0,
                          const double x1, const double y1, const double z1,
                          std::vector<double>& xf, std::vector<double>& yf,
                          std::vector<double>& zf,
                          const unsigned int nPoints = 20) const;
  bool FixedFluxIntervals(const double x0, const double y0, const double z0,
                          const double x1, const double y1, const double z1,
                          std::vector<double>& xf, std::vector<double>& yf,
                          std::vector<double>& zf,
                          const double interval = 10.) const;
 
 private:
  enum class Parameter {
    Potential = 0,
    Emag,
    Ex,
    Ey,
    Ez,
    Bmag,
    Bx,
    By,
    Bz,
    Unknown
  };
 
  bool m_useAutoRange = true;
  bool m_samplePotential = true;
  bool m_useStatus = false;
  double m_vBkg = 0.;
 
  // Sensor
  Sensor* m_sensor = nullptr;
  Component* m_component = nullptr;
 
  // Function range
  double m_vmin = 0., m_vmax = 100.;
  double m_emin = 0., m_emax = 10000.;
  double m_wmin = 0., m_wmax = 100.;
  double m_bmin = 0., m_bmax = 10.;
 
  // Number of contours
  unsigned int m_nContours = 20;
  // Number of points used to draw the functions
  unsigned int m_nSamples1d = 1000;
  unsigned int m_nSamples2dX = 200;
  unsigned int m_nSamples2dY = 200;
 
  bool SetPlotLimits();
  void Draw2d(const std::string& option, const bool contour, const bool wfield,
              const std::string& electrode, const std::string& drawopt,
              const double t = 0.);
  void DrawProfile(const double x0, const double y0, const double z0,
                   const double x1, const double y1, const double z1,
                   const std::string& option, const bool wfield,
                   const std::string& electrode, const bool normalised);
  Parameter GetPar(const std::string& option, std::string& title,
                   bool& bfield) const;
  double Efield(const double x, const double y, const double z,
                const Parameter par) const;
  double Wfield(const double x, const double y, const double z,
                const Parameter par, const std::string& electrode,
                const double t = 0.) const;
  double Bfield(const double x, const double y, const double z,
                const Parameter par) const;
};
}  // namespace Garfield
#endif