ComponentVoxel.hh

Go to the documentation of this file.

#ifndef G_COMPONENT_VOXEL_H
#define G_COMPONENT_VOXEL_H
 
#include "Garfield/Component.hh"
 
namespace Garfield {

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

  void EnableInterpolation(const bool on = true) { m_interpolate = on; }

  void SetMesh(const unsigned int nx, const unsigned int ny,
               const unsigned int nz, const double xmin, const double xmax,
               const double ymin, const double ymax, const double zmin,
               const double zmax);
  bool LoadElectricField(const std::string& filename, const std::string& format,
                         const bool withPotential, const bool withRegion,
                         const double scaleX = 1., const double scaleE = 1.,
                         const double scaleP = 1.);
  bool LoadWeightingField(const std::string& filename,
                          const std::string& format, const bool withPotential,
                          const double scaleX = 1., const double scaleE = 1.,
                          const double scaleP = 1.);
  void SetWeightingFieldOffset(const double x, const double y, const double z);

  bool LoadWeightingField(const std::string& filename,
                          const std::string& format, const double time,
                          const bool withPotential, const double scaleX = 1.,
                          const double scaleE = 1., const double scaleP = 1.);
  bool LoadMagneticField(const std::string& filename, const std::string& format,
                         const double scaleX = 1., const double scaleB = 1.);

  void SetMedium(const unsigned int i, Medium* m);
  Medium* GetMedium(const unsigned int i) const;
  void PrintRegions() const;

  bool GetElement(const double xi, const double yi, const double zi,
                  unsigned int& i, unsigned int& j, unsigned int& k,
                  bool& xMirrored, bool& yMirrored, bool& zMirrored) const;
  bool GetElement(const unsigned int i, const unsigned int j,
                  const unsigned int k, double& v, double& ex, double& ey,
                  double& ez) const;
 
  void Clear() override { Reset(); }
  void ElectricField(const double x, const double y, const double z, double& ex,
                     double& ey, double& ez, double& v, Medium*& m,
                     int& status) override;
  void ElectricField(const double x, const double y, const double z, double& ex,
                     double& ey, double& ez, Medium*& m, int& status) override;
  using Component::ElectricField;
  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;
  void MagneticField(const double x, const double y, const double z, double& bx,
                     double& by, double& bz, int& status) override;
  bool HasMagneticField() const override;
 
  Medium* GetMedium(const double x, const double y, const double z) override;
 
  bool GetVoltageRange(double& vmin, double& vmax) override;
  bool GetElectricFieldRange(double& exmin, double& exmax, double& eymin,
                             double& eymax, double& ezmin, double& ezmax);
  bool GetBoundingBox(double& xmin, double& ymin, double& zmin, double& xmax,
                      double& ymax, double& zmax) override;
  bool GetElementaryCell(double& xmin, double& ymin, double& zmin, double& xmax,
                         double& ymax, double& zmax) override;
 
 private:
  std::vector<Medium*> m_media;
  struct Element {
    double fx, fy, fz;  
    double v;           
  };

  std::vector<std::vector<std::vector<int> > > m_regions;
  std::vector<std::vector<std::vector<Element> > > m_efields;
  std::vector<std::vector<std::vector<Element> > > m_bfields;
  std::vector<std::vector<std::vector<Element> > > m_wfields;
  std::vector<std::vector<std::vector<std::vector<Element> > > > m_wdfields;
 
  // Dimensions of the mesh
  unsigned int m_nX = 0, m_nY = 0, m_nZ = 0;
  double m_xMin = 0., m_yMin = 0., m_zMin = 0.;
  double m_xMax = 0., m_yMax = 0., m_zMax = 0.;
  double m_dx = 0., m_dy = 0., m_dz = 0.;
 
  bool m_interpolate = false;
 
  bool m_hasMesh = false;
  bool m_hasPotential = false;
  bool m_hasEfield = false;
  bool m_hasBfield = false;
  bool m_hasWfield = false;
 
  // Offset for weighting field
  double m_wField_xOffset = 0.;
  double m_wField_yOffset = 0.;
  double m_wField_zOffset = 0.;
 
  // Voltage range
  double m_pMin = 0., m_pMax = 0.;

  bool LoadData(const std::string& filename, std::string format,
                const bool withPotential, const bool withRegion,
                const double scaleX, const double scaleF, const double scaleP,
                std::vector<std::vector<std::vector<Element> > >& field);
 
  void Reset() override;
  void UpdatePeriodicity() override;

  bool GetField(const double x, const double y, const double z,
                const std::vector<std::vector<std::vector<Element> > >& field,
                double& fx, double& fy, double& fz, double& p, int& region);
  double Reduce(const double xin, const double xmin, const double xmax,
                const bool simplePeriodic, const bool mirrorPeriodic,
                bool& isMirrored) const;
  void Initialise(std::vector<std::vector<std::vector<Element> > >& fields);
  void InitialiseRegions();
};
}  // namespace Garfield
#endif