dipole.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef DIPOLE_H
#define DIPOLE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
#include <iostream>
 
//=============================================================================================================
// DEFINE NAMESPACE INVERSELIB
//=============================================================================================================
 
namespace INVERSELIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
template<typename T>
class Dipole;
 
//=============================================================================================================
template<typename T>
struct DipolePair
{
    int m_iIdx1;            
    Dipole<T> m_Dipole1;    
 
    int m_iIdx2;            
    Dipole<T> m_Dipole2;    
 
    T m_vCorrelation;     
};
 
//=============================================================================================================
template<class T>
class Dipole
{
//typedef Eigen::Matrix<T, 3, 1> Point3D;
 
public:
 
    //=========================================================================================================
    Dipole();
 
    //=========================================================================================================
    /*  Dipole();*/
 
    //=========================================================================================================
    virtual ~Dipole();
 
    inline T& x() { return m_vecPosition[0] ; }
    inline T& y() { return m_vecPosition[1] ; }
    inline T& z() { return m_vecPosition[2] ; }
    inline T x() const { return m_vecPosition[0] ; }
    inline T y() const { return m_vecPosition[1] ; }
    inline T z() const { return m_vecPosition[2] ; }
 
    inline T& phi_x() { return m_vecDirection[0] ; }
    inline T& phi_y() { return m_vecDirection[1] ; }
    inline T& phi_z() { return m_vecDirection[2] ; }
    inline T phi_x() const { return m_vecDirection[0] ; }
    inline T phi_y() const { return m_vecDirection[1] ; }
    inline T phi_z() const { return m_vecDirection[2] ; }
 
    //=========================================================================================================
    void clean();
 
protected:
 
private:
 
    Eigen::Matrix<T, 3, 1> m_vecPosition;
    Eigen::Matrix<T, 3, 1> m_vecDirection;
 
    double  m_dLength;
    double  m_dFrequency;
 
    //TGreensFunction* green;
};
} // NAMESPACE
 
//TypeDefs
typedef INVERSELIB::Dipole<int>     Dipole_INT;
typedef INVERSELIB::Dipole<float>   Dipole_FLOAT;
typedef INVERSELIB::Dipole<double>  Dipole_DOUBLE;
 
//Make the template definition visible to compiler in the first point of instantiation
#include "dipole.cpp"
 
#endif // DIPOLE_H