polynomial_magnetic_field.h

Go to the documentation of this file.

/* Author(s):     Xavier Garrido <garrido@lal.in2p3.fr>
 * Creation date: 2015-02-14
 * Last modified: 2015-02-14
 *
 * License:
 *
 * Description:
 *
 *   Magnetic field with polynomial variations
 *    - Bx = pxx0 + pxx1*x + pxx2*x²
 *    - By = pyx0 + pyx1*x + pyy0 + pyy1*y
 *    - Bz = 0
 *
 * History:
 *
 */

#ifndef EMFIELD_POLYNOMIAL_MAGNETIC_FIELD_H
#define EMFIELD_POLYNOMIAL_MAGNETIC_FIELD_H 1

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

namespace emfield {

  class polynomial_magnetic_field : public base_electromagnetic_field
  {
  public:

    typedef std::vector<double> polynomial_parameters_type;

    typedef std::pair<double,double> coordinate_limits_type;

    struct magnetic_field_coordinate {
      magnetic_field_coordinate();

      polynomial_parameters_type px;
      polynomial_parameters_type py;
      polynomial_parameters_type pz;

      coordinate_limits_type xlimits;
      coordinate_limits_type ylimits;
      coordinate_limits_type zlimits;
    };

    polynomial_magnetic_field(uint32_t flags_ = 0);

    virtual ~polynomial_magnetic_field();

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

    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;

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

  private:

    double _magnetic_field_unit_;   
    magnetic_field_coordinate _bx_; 
    magnetic_field_coordinate _by_; 
    magnetic_field_coordinate _bz_; 

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

  };

} // end of namespace emfield

#endif // EMFIELD_POLYNOMIAL_MAGNETIC_FIELD_H

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