Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Types | Public Member Functions | Protected Member Functions | List of all members
emfield::oscillating_field Class Reference

Class representing a weighted electric/magnetic field with some oscillating coefficient. More...

#include <bayeux/emfield/oscillating_field.h>

Inheritance diagram for emfield::oscillating_field:
emfield::base_electromagnetic_field datatools::i_tree_dumpable

Public Types

enum  mode_sin_cos_type { SC_MODE_INVALID = 0, SC_MODE_COSINE = 1, SC_MODE_SINE = 2, SC_MODE_DEFAULT = SC_MODE_COSINE }
 
- Public Types inherited from emfield::base_electromagnetic_field
enum  flag_type {
  DEBUG = datatools::bit_mask::bit01, ELECTRIC_FIELD = datatools::bit_mask::bit02, MAGNETIC_FIELD = datatools::bit_mask::bit03, ELECTRIC_FIELD_CAN_BE_COMBINED = datatools::bit_mask::bit04,
  MAGNETIC_FIELD_CAN_BE_COMBINED = datatools::bit_mask::bit05, ELECTRIC_FIELD_IS_TIME_DEPENDENT = datatools::bit_mask::bit06, MAGNETIC_FIELD_IS_TIME_DEPENDENT = datatools::bit_mask::bit07
}
 Initialization flags. More...
 
enum  status_type {
  STATUS_SUCCESS = 0, STATUS_ERROR = 1, STATUS_NOT_INITIALIZED = 2, STATUS_INVALID_POSITION_TIME = 3,
  STATUS_NO_ELECTRIC_FIELD = 4, STATUS_NO_MAGNETIC_FIELD = 5
}
 Status at field computation. More...
 
typedef datatools::handle< base_electromagnetic_fieldhandle_type
 
typedef std::map< std::string, handle_typefield_dict_type
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
 Enumeration for standard output streams. More...
 

Public Member Functions

 oscillating_field (uint32_t=0)
 Default constructor. More...
 
virtual ~oscillating_field ()
 Destructor. More...
 
virtual void initialize (const ::datatools::properties &, ::datatools::service_manager &, ::emfield::base_electromagnetic_field::field_dict_type &)
 Initialization. More...
 
virtual void reset ()
 Reset. More...
 
virtual int compute_electric_field (const ::geomtools::vector_3d &position_, double time_, ::geomtools::vector_3d &electric_field_) const
 Compute electric field. More...
 
virtual int compute_magnetic_field (const ::geomtools::vector_3d &position_, double time_, geomtools::vector_3d &magnetic_field_) const
 Compute magnetic field. More...
 
void set_sine_cosine_mode (mode_sin_cos_type)
 
bool is_cosine_mode () const
 
bool is_sine_mode () const
 
double get_frequency () const
 
double get_period () const
 
double get_phase () const
 
double get_scale () const
 
double get_pedestal () const
 
void set_frequency (double)
 
void set_phase (double)
 
void set_scale (double)
 
void set_pedestal (double)
 
void set_field (base_electromagnetic_field::handle_type &)
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 
- Public Member Functions inherited from emfield::base_electromagnetic_field
void set_logging_priority (datatools::logger::priority priority_)
 Return the logging priority. More...
 
datatools::logger::priority get_logging_priority () const
 Set the logging priority. More...
 
bool is_initialized () const
 Check initialization status. More...
 
void set_name (const std::string &)
 Set the name of the field. More...
 
const std::string & get_name () const
 Return the name of the field. More...
 
bool is_debug () const
 Check debug status. More...
 
void set_debug (bool debug_)
 Set debug status. More...
 
bool is_electric_field () const
 Check if the field is an electric field. More...
 
bool is_magnetic_field () const
 Check if the field is a magnetic field. More...
 
bool electric_field_can_be_combined () const
 Check if the electric field can be combined. More...
 
bool magnetic_field_can_be_combined () const
 Check if the magnetic field can be combined. More...
 
bool electric_field_is_time_dependent () const
 Check if the electric field depends on time. More...
 
bool magnetic_field_is_time_dependent () const
 Check if the magnetic field depends on time. More...
 
 base_electromagnetic_field (uint32_t flags_=0)
 Constructor. More...
 
virtual ~base_electromagnetic_field ()
 Destructor. More...
 
virtual int compute_electromagnetic_field (const geomtools::vector_3d &position_, double time_, geomtools::vector_3d &electric_field_, geomtools::vector_3d &magnetic_field_) const
 Compute the coordinates of the electric and magnetic fields at given position and time. More...
 
virtual int compute_field (char label_, const geomtools::vector_3d &position_, double time_, geomtools::vector_3d &field_) const
 Compute the coordinates of the electric or magnetic field at given position and time. More...
 
virtual void initialize_simple ()
 Naked initialization. More...
 
virtual void initialize_standalone (const datatools::properties &setup_)
 Standalone initialization, no external resources are needed, only a set of parameters. More...
 
virtual void initialize_with_service_only (const datatools::properties &setup_, datatools::service_manager &service_manager_)
 Initialization using a set of parameters and a service manager. More...
 
virtual void initialize_with_dictionary_only (const datatools::properties &setup_, field_dict_type &dictionary_)
 Initialization using a set of parameters and an external dictionary of EM fields. More...
 
virtual void initialize (const datatools::properties &setup_, datatools::service_manager &service_manager_, field_dict_type &dictionary_)=0
 Main initialization. More...
 
virtual std::string get_class_id () const =0
 Return the class string identifier. More...
 
virtual bool position_and_time_are_valid (const geomtools::vector_3d &position_, double time_) const
 Check if position and time are valid for this field. More...
 
virtual int compute_electric_field (const geomtools::vector_3d &position_, double time_, geomtools::vector_3d &electric_field_) const
 Compute the coordinates of the electric field at given position and time. More...
 
virtual int compute_magnetic_field (const geomtools::vector_3d &position_, double time_, geomtools::vector_3d &magnetic_field_) const
 Compute the coordinates of the magnetic field at given position and time. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 Constructor. More...
 
virtual ~i_tree_dumpable ()
 Destructor. More...
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 Main new interface method for printing. More...
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 Printing with jsonized options. More...
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 Printing with jsonized options. More...
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 

Protected Member Functions

void _set_defaults ()
 
double _get_coefficient (double time_) const
 
- Protected Member Functions inherited from emfield::base_electromagnetic_field
void _set_initialized (bool initialized_)
 
void _set_electric_field (bool=true)
 
void _set_magnetic_field (bool=true)
 
void _set_electric_field_can_be_combined (bool=true)
 
void _set_magnetic_field_can_be_combined (bool=true)
 
void _set_electric_field_is_time_dependent (bool=true)
 
void _set_magnetic_field_is_time_dependent (bool=true)
 
void _parse_basic_parameters (const datatools::properties &setup_, datatools::service_manager &service_manager_, field_dict_type &dictionary_)
 
void _set_defaults ()
 Set default attributes values. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 
- Static Public Attributes inherited from emfield::base_electromagnetic_field
static const char ELECTRIC_FIELD_LABEL = 'E'
 
static const char MAGNETIC_FIELD_LABEL = 'B'
 

Detailed Description

Class representing a weighted electric/magnetic field with some oscillating coefficient.

Given a field F(x, y, z, t), one computes the resulting weighted field F'(x, y, z, t) :

F'(x, y, z, t) = F(x, y, z, t) * (ped + sca * osc(2*pi*fre + pha))

Default values are:

Member Enumeration Documentation

◆ mode_sin_cos_type

Enumerator
SC_MODE_INVALID 

Invalid sine/cosine mode.

SC_MODE_COSINE 

Cosine mode.

SC_MODE_SINE 

Sine mode.

SC_MODE_DEFAULT 

Default mode.

Constructor & Destructor Documentation

◆ oscillating_field()

emfield::oscillating_field::oscillating_field ( uint32_t  = 0)

Default constructor.

◆ ~oscillating_field()

virtual emfield::oscillating_field::~oscillating_field ( )
virtual

Destructor.

Member Function Documentation

◆ _get_coefficient()

double emfield::oscillating_field::_get_coefficient ( double  time_) const
protected

◆ _set_defaults()

void emfield::oscillating_field::_set_defaults ( )
protected

◆ compute_electric_field()

virtual int emfield::oscillating_field::compute_electric_field ( const ::geomtools::vector_3d position_,
double  time_,
::geomtools::vector_3d electric_field_ 
) const
virtual

Compute electric field.

◆ compute_magnetic_field()

virtual int emfield::oscillating_field::compute_magnetic_field ( const ::geomtools::vector_3d position_,
double  time_,
geomtools::vector_3d magnetic_field_ 
) const
virtual

Compute magnetic field.

◆ get_frequency()

double emfield::oscillating_field::get_frequency ( ) const

◆ get_pedestal()

double emfield::oscillating_field::get_pedestal ( ) const

◆ get_period()

double emfield::oscillating_field::get_period ( ) const

◆ get_phase()

double emfield::oscillating_field::get_phase ( ) const

◆ get_scale()

double emfield::oscillating_field::get_scale ( ) const

◆ initialize()

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

Initialization.

◆ is_cosine_mode()

bool emfield::oscillating_field::is_cosine_mode ( ) const

◆ is_sine_mode()

bool emfield::oscillating_field::is_sine_mode ( ) const

◆ reset()

virtual void emfield::oscillating_field::reset ( )
virtual

◆ set_field()

void emfield::oscillating_field::set_field ( base_electromagnetic_field::handle_type )

◆ set_frequency()

void emfield::oscillating_field::set_frequency ( double  )

◆ set_pedestal()

void emfield::oscillating_field::set_pedestal ( double  )

◆ set_phase()

void emfield::oscillating_field::set_phase ( double  )

◆ set_scale()

void emfield::oscillating_field::set_scale ( double  )

◆ set_sine_cosine_mode()

void emfield::oscillating_field::set_sine_cosine_mode ( mode_sin_cos_type  )

◆ tree_dump()

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

Smart print.

Reimplemented from emfield::base_electromagnetic_field.


The documentation for this class was generated from the following file: