uniform_magnetic_field.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2012-04-24
 * Last modified: 2013-02-24
 *
 * License:
 *
 * Description:
 *
 *   Uniform magnetic field
 *
 * History:
 *
 */

#ifndef EMFIELD_UNIFORM_MAGNETIC_FIELD_H
#define EMFIELD_UNIFORM_MAGNETIC_FIELD_H 1

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

namespace emfield {

  class uniform_magnetic_field : public base_electromagnetic_field
  {
  public:

    uniform_magnetic_field(uint32_t = 0);

    virtual ~uniform_magnetic_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;


    const geomtools::vector_3d & get_uniform_magnetic_field() const;

    void set_uniform_magnetic_field(const geomtools::vector_3d & b_);

    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:

    geomtools::vector_3d _uniform_magnetic_field_; 

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

  };

} // end of namespace emfield

#endif // EMFIELD_UNIFORM_MAGNETIC_FIELD_H

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