EMM_LandauLifschitzFunction.h

Go to the documentation of this file.

#ifndef EMM_LandauLifschitzFunction_H
#define EMM_LandauLifschitzFunction_H

#include "EMM_Object.h"

#include "EMM_RealArray.h"
#include "EMM_RealField.h"

DEFINE_SPTR(EMM_LandauLifschitzFunction);
class EMM_LandauLifschitzFunction : public  EMM_Object {
  
    SP_OBJECT(EMM_LandauLifschitzFunction);
    // ATTRIBUTES
  
public:
   
  
   
    
private:

    //alpha parameter of the landau lifschitz equation
    tReal mAlpha;

    //beta parameter of the landau lifschitz equation
    EMM_RealArray mBetas;

    //working array for computing function & gradient of the function
    tUSInt mLDW;
    mutable tReal *mWork;
    
protected: 
    // METHODS
  
    // CONSTRUCTORS 
  
    EMM_LandauLifschitzFunction(void);
  
  
    // DESTRUCTORS 
  
    
    virtual ~EMM_LandauLifschitzFunction(void);
  
public:

 
    // SET methods 

  
    inline void setAlphaParameter(const tReal& v) {
        mAlpha=v;
    }
    inline void setBetaParameter(const tReal& v) {
        mBetas.setSize(1);
        mBetas[0]=v;
        
    }
    inline void setBetaParameter(const tUIndex& i,const tReal& v) {
        if (i>=mBetas.getSize()) mBetas.setSize(i+1);
        mBetas[i]=v;
    }
 
    
    
    // GET methods
    // ============
    
    inline const tReal&  getAlphaParameter() const {
        return mAlpha;
    }
    inline const tReal&  getBetaParameter() const {
        return mBetas[0];
    }
    inline const EMM_RealArray&  getBetasParameter() const {
        return mBetas;
    }
    inline EMM_RealArray&  getBetasParameter() {
        return mBetas;
    }


   

    

   
public:
   
    
    virtual void computeFunction(const EMM_RealArray& sigma,
                                 const EMM_RealField& M,
                                 const EMM_RealField& H,
                                 EMM_RealField& F) const=0;

protected:
    
    void computeFunction(const tUIndex& nCells,const tUSInt& dim,
                         const tReal& alpha,
                         const tBoolean& incB,const tReal* betas,
                         const tBoolean& incS,const tReal *sigmas,
                         const tReal* M,const tReal *H, tReal *F) const;
  

    
    void computeFunction(const tUIndex& nCells,const tUSInt& dim,
                         const tReal& alpha,const tReal& betaSigma,
                         const tReal* M,const tReal *H, tReal *F) const;
    
    
public:
    virtual void computeGradFunction(const EMM_RealArray& sigma,
                                     const EMM_RealField& M,
                                     const EMM_RealField& H,
                                     const EMM_RealField& D,
                                     const EMM_RealField& GradH,
                                     EMM_RealField& GradF) const=0;
    
    
protected:
    
    void computeGradFunction(const tUIndex& nCells,
                             const tUSInt& dim,
                             const tReal& alpha,
                             const tBoolean& incB,
                             const tReal* betas,
                             const tBoolean& incS,
                             const tReal* sigmas,
                             const tReal* M,
                             const tReal* H,
                             const tReal* D,
                             const tReal * GradH,
                             tReal *GradF) const;
 

    void computeGradFunction(const tUIndex& nCells,
                             const tUSInt& dim,
                             const tReal& alpha,
                             const tReal& betaSigma,
                             const tReal* M,
                             const tReal* H,
                             const tReal* D,
                             const tReal * GradH,
                             tReal *GradF) const;

public:
    virtual void computePartialGradMFunction(const EMM_RealArray& sigma,
                                             const EMM_RealField& M,
                                             const EMM_RealField& H,
                                             const EMM_RealField& D,
                                             EMM_RealField& GradF) const=0;
protected:
    void computePartialGradMFunction(const tUIndex& nCells,
                                     const tUSInt& dim,
                                     const tReal& alpha,
                                     const tBoolean& incB,
                                     const tReal* betas,
                                     const tBoolean& incS,
                                     const tReal* sigmas,
                                     const tReal* M,
                                     const tReal* H,
                                     const tReal* D,
                                     tReal *GradF) const;
public:
    virtual tString toString() const;


};

#endif