linear_combination_field.h

Go to the documentation of this file.

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

#ifndef EMFIELD_LINEAR_COMBINATION_FIELD_H
#define EMFIELD_LINEAR_COMBINATION_FIELD_H 1

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

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

namespace emfield {

  class linear_combination_field : public base_electromagnetic_field
  {
  public:

    struct combined_field_entry
    {
      std::string                             label;        
      base_electromagnetic_field::handle_type field_handle; 
      double                                  weight;       
      combined_field_entry ();
      ~combined_field_entry ();
    };

    typedef std::map<std::string,combined_field_entry> combined_field_dict_type;

    linear_combination_field(uint32_t = 0);

    virtual ~linear_combination_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_combined_field (const std::string & label_,
                             base_electromagnetic_field::handle_type & field_handle_,
                             double weight_ = 1.0,
                             bool force_combined_ = false);

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

  private:

    combined_field_dict_type _combined_fields_; 

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

  };

} // end of namespace emfield

#endif // EMFIELD_LINEAR_COMBINATION_FIELD_H

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