quantumcoupling.h

/***************************************************************************
                          quantumcoupling.h  -  description
                             -------------------
    author               : Armando Navarro-Vazquez
    email                : armando.deus@gmail.com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef MAGNES_QUANTUMCOUPLING_H
#define MAGNES_QUANTUMCOUPLING_H


#include "coreexport.h"
#include "mathtools.h"

namespace magnes
{ 
class QuantumCouplingPrivate;

class MAGNES_CORE_API QuantumCoupling
{
public:
    QuantumCoupling(size_t i, size_t j);
    QuantumCoupling(size_t i,size_t j, double v);
    QuantumCoupling( const QuantumCoupling& c );
    QuantumCoupling& operator= ( const QuantumCoupling& c );
    ~QuantumCoupling();
    const size_t& I() const;
    const size_t& J() const;
    size_t& I();
    size_t& J();
    const Scalar<double>& TotalCoupling() const;
    void SetTotalCoupling(double v);
    const Scalar<double>& FermiContact() const;
    const Scalar<double>& SpinDipole() const;
    const Scalar<double>& FCSDCrossTerm() const;
    const Scalar<double>& ParamagneticSpinOrbit() const;
    const Scalar<double>& DiamagneticSpinOrbit() const;
    void SetFermiContact(double v);
    void SetSpinDipole(double v);
    void SetFCSDCrossTerm(double v);
    void SetParamagneticSpinOrbit(double v);
    void SetDiamagneticSpinOrbit(double v);
    void Reset();
    QuantumCoupling operator *(double d) const;
    QuantumCoupling operator +(const QuantumCoupling& q) const;
    void operator +=(const QuantumCoupling& q);
private:
    QuantumCouplingPrivate* _d;
};
}
#endif //MAGNES_QUANTUMCOUPLING_H