multi_zone_field.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-04-19
 * Last modified: 2015-04-19
 *
 * License:
 *
 * Description:
 *
 *   Multi zone field
 *
 * History:
 *
 */

#ifndef EMFIELD_MULTI_ZONE_FIELD_H
#define EMFIELD_MULTI_ZONE_FIELD_H 1

// Standard library:
#include <string>
#include <vector>
#include <map>

// Third party:
// - Bayeux/geomtools:
#include <geomtools/placement.h>
#include <geomtools/i_shape_3d.h>
#include <geomtools/shape_factory.h>

// This project:
#include <emfield/base_electromagnetic_field.h>

namespace emfield {

  class multi_zone_field : public base_electromagnetic_field
  {
  public:

    enum zone_priority_type {
      ZONE_PRIORITY_INVALID   = -1,
      ZONE_PRIORITY_VERY_LOW  =  0,
      ZONE_PRIORITY_LOW       =  1,
      ZONE_PRIORITY_HIGH      =  2,
      ZONE_PRIORITY_VERY_HIGH =  3,
      ZONE_PRIORITY_MIN       =  ZONE_PRIORITY_VERY_LOW,
      ZONE_PRIORITY_MAX       =  ZONE_PRIORITY_VERY_HIGH,
      ZONE_PRIORITY_DEFAULT   =  ZONE_PRIORITY_MIN
    };

    static std::string zone_priority_to_label(zone_priority_type);

    static zone_priority_type label_to_zone_priority(const std::string &);

    class zone_field_entry {
    public:

      zone_field_entry();

      void reset();

    protected:

      void _set_defaults();

      static bool _higher_zone_priority(const zone_field_entry * zfe1_,
                                        const zone_field_entry * zfe2_);

    private:

      std::string _label_; 
      geomtools::placement _zone_positioning_; 
      double _zone_tolerance_; 
      const geomtools::i_shape_3d * _zone_shape_; 
      const base_electromagnetic_field * _zone_field_; 
      bool _absolute_positioning_; 
      zone_priority_type _priority_; 

      friend class multi_zone_field;
    };

    typedef std::map<std::string, zone_field_entry> zone_field_dict_type;

    multi_zone_field(uint32_t = 0);

    virtual ~multi_zone_field();

    virtual void initialize(const ::datatools::properties &,
                            ::datatools::service_manager &,
                            ::emfield::base_electromagnetic_field::field_dict_type &);

    virtual void reset();

    virtual int compute_electric_field(const ::geomtools::vector_3d & position_,
                                       double time_,
                                       ::geomtools::vector_3d & electric_field_) const;

    virtual int compute_magnetic_field(const ::geomtools::vector_3d & position_,
                                       double time_,
                                       geomtools::vector_3d & magnetic_field_) const;

    void add_zone_field(const std::string & zone_label_,
                        const geomtools::placement & zone_positioning_,
                        const geomtools::i_shape_3d & zone_shape_,
                        double zone_tolerance_,
                        const base_electromagnetic_field & zone_field_,
                        bool absolute_positioning_ = true,
                        zone_priority_type priority_ = ZONE_PRIORITY_DEFAULT);

    const zone_field_entry & get_zone_field(const std::string & zone_label_) const;

    void fine_zones(const geomtools::vector_3d & position_,
                    std::vector<const zone_field_entry *> & zones_) const;

    bool owns_shape_factory() const;

    bool has_shape_factory() const;

    void reset_shape_factory();

    void set_shape_factory(const geomtools::shape_factory & shfact_);

    void create_shape_factory(const ::datatools::properties & setup_);

    virtual void tree_dump (std::ostream & out_         = std::clog,
                            const std::string & title_  = "",
                            const std::string & indent_ = "",
                            bool inherit_               = false) const;

  protected:

    void _set_defaults();

  private:

    bool _own_shape_factory_; 
    geomtools::shape_factory * _shape_factory_; 
    zone_field_dict_type _zone_fields_; 

    // Macro to automate the registration of the EM field :
    EMFIELD_REGISTRATION_INTERFACE(multi_zone_field)

  };

} // end of namespace emfield

#endif // EMFIELD_MULTI_ZONE_FIELD_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --