ComponentElmer2d.hh

Go to the documentation of this file.

#ifndef G_COMPONENT_ELMER_2D_H
#define G_COMPONENT_ELMER_2D_H
 
#include "ComponentFieldMap.hh"
 
namespace Garfield {
 
/// Component for importing two-dimensional field maps computed by Elmer.
 
class ComponentElmer2d : public ComponentFieldMap {
 public:
  /// Default constructor
  ComponentElmer2d();
  /// Constructor with a set of field map files, see Initialise().
  ComponentElmer2d(const std::string& header, const std::string& elist,
                   const std::string& nlist, const std::string& mplist,
                   const std::string& volt, const std::string& unit);
  /// Destructor
  ~ComponentElmer2d() {}
 
  /** Import a field map from a set of files.
    * \param header name of the header file
                    (contains the number of elements and nodes).
    * \param elist name of the file that contains the list of mesh elements
    * \param nlist name of the file that contains the list of mesh nodes
    * \param mplist name of the file that contains the material properties
    * \param volt output of the field solver (list of voltages)
    * \param unit length unit to be used
    */
  bool Initialise(const std::string& header = "mesh.header",
                  const std::string& elist = "mesh.elements",
                  const std::string& nlist = "mesh.nodes",
                  const std::string& mplist = "dielectrics.dat",
                  const std::string& volt = "out.result",
                  const std::string& unit = "cm");
  /// Import a list of voltages to be used as weighting potentials.
  bool SetWeightingPotential(const std::string& prnsol, 
                             const std::string& label) {
    return SetWeightingField(prnsol, label);
  }
  bool SetWeightingField(const std::string& prnsol, const std::string& label);
 
  void SetRangeZ(const double zmin, const double zmax);
 private:
  bool LoadPotentials(const std::string& prnsol, std::vector<double>& pot);
};
}
#endif