ComponentUser.hh

Go to the documentation of this file.

#ifndef G_COMPONENT_USER_H
#define G_COMPONENT_USER_H
 
#include <array>
#include <functional>
#include <map>
 
#include "Garfield/Component.hh"
 
namespace Garfield {

 
class ComponentUser : public Component {
 public:
  ComponentUser();
  ~ComponentUser() {}

  void SetElectricField(
      std::function<void(const double, const double, const double, double&,
                         double&, double&)>);
  void SetElectricField(const std::string& expression);

  void SetPotential(
      std::function<double(const double, const double, const double)>);
  void SetPotential(const std::string& expression);

  void SetWeightingField(
      std::function<void(const double, const double, const double, double&,
                         double&, double&)>,
      const std::string& label);
  void SetWeightingField(const std::string& expression,
                         const std::string& label);

  void SetWeightingPotential(
      std::function<double(const double, const double, const double)>,
      const std::string& label);
  void SetWeightingPotential(const std::string& expression,
                             const std::string& label);

  void SetDelayedWeightingField(
      std::function<void(const double, const double, const double, const double,
                         double&, double&, double&)>,
      const std::string& label);
  void SetDelayedWeightingField(const std::string& expression,
                                const std::string& label);

  void SetDelayedWeightingPotential(
      std::function<double(const double, const double, const double,
                           const double)>,
      const std::string& label);
  void SetDelayedWeightingPotential(const std::string& expression,
                                    const std::string& label);
  void SetDelayedSignalTimes(const std::vector<double>& ts);
  void SetMagneticField(
      std::function<void(const double, const double, const double, double&,
                         double&, double&)>);
  void SetMagneticField(const std::string& expression);

  void SetArea(const double xmin, const double ymin, const double zmin,
               const double xmax, const double ymax, const double zmax);
  void UnsetArea();
  void SetMedium(Medium* medium) { m_medium = medium; }
 
  Medium* GetMedium(const double x, const double y, const double z) override {
    return !m_hasArea        ? Component::GetMedium(x, y, z)
           : InArea(x, y, z) ? m_medium
                             : nullptr;
  }
  void ElectricField(const double x, const double y, const double z, double& ex,
                     double& ey, double& ez, Medium*& m, int& status) override;
  void ElectricField(const double x, const double y, const double z, double& ex,
                     double& ey, double& ez, double& v, Medium*& m,
                     int& status) override;
  using Component::ElectricField;
  bool GetVoltageRange(double& vmin, double& vmax) override;
  void MagneticField(const double x, const double y, const double z, double& bx,
                     double& by, double& bz, int& status) override;
  void WeightingField(const double x, const double y, const double z,
                      double& wx, double& wy, double& wz,
                      const std::string& label) override;
  double WeightingPotential(const double x, const double y, const double z,
                            const std::string& label) override;
  void DelayedWeightingField(const double x, const double y, const double z,
                             const double t, double& wx, double& wy, double& wz,
                             const std::string& label) override;
  double DelayedWeightingPotential(const double x, const double y,
                                   const double z, const double t,
                                   const std::string& label) override;
  bool GetBoundingBox(double& xmin, double& ymin, double& zmin, double& xmax,
                      double& ymax, double& zmax) override;
 
  bool HasMagneticField() const override;
 
 private:
  std::function<void(const double, const double, const double, double&, double&,
                     double&)>
      m_efield;
  std::function<double(const double, const double, const double)> m_epot;

  std::map<std::string,
           std::function<void(const double, const double, const double, double&,
                              double&, double&)> >
      m_wfield;

  std::map<std::string,
           std::function<double(const double, const double, const double)> >
      m_wpot;

  std::map<std::string,
           std::function<void(const double, const double, const double,
                              const double, double&, double&, double&)> >
      m_dwfield;

  std::map<std::string, std::function<double(const double, const double,
                                             const double, const double)> >
      m_dwpot;

  std::function<void(const double, const double, const double, double&, double&,
                     double&)>
      m_bfield;
 
  // Active area.
  std::array<double, 3> m_xmin = {{0., 0., 0.}};
  std::array<double, 3> m_xmax = {{0., 0., 0.}};
  // Did we specify the active area explicitly?
  bool m_hasArea = false;
  // Medium in the active area.
  Medium* m_medium = nullptr;

  void Reset() override;
  // Verify periodicities
  void UpdatePeriodicity() override;
 
  bool InArea(const double x, const double y, const double z) {
    return (x >= m_xmin[0] && x <= m_xmax[0] && y >= m_xmin[1] &&
            y <= m_xmax[1] && z >= m_xmin[2] && z <= m_xmax[2]);
  }
};
}  // namespace Garfield
#endif