EMM_ODETimeStep.h

Go to the documentation of this file.

#ifndef EMM_ODETimeStep_H
#define EMM_ODETimeStep_H

#include "EMM_RegularTimeStep.h"


DEFINE_SPTR(EMM_ODETimeStep);
class EMM_ODETimeStep : public EMM_RegularTimeStep {
  
    SP_OBJECT(EMM_ODETimeStep);
    // ATTRIBUTES
    
public:
    
    static const tFlag L2_NORM=0;
    static const tFlag LINF_NORM=1;
   
   
private:

    //number of iterations number
    tUSInt mIterationsNumber;
    //torlerance for the error
    tReal mTolerance;
    //error norm
    tFlag mErrorNorm;
    
    //current error
    tReal mError;

    //evaluations number
    tUInteger mEvaluationsNumber;
    
    //time for computing Mt
    tReal mT;

   
    
    //M variable: the normalized magnetization field at t into current time step
    SP::EMM_RealField mMt;
    
protected: 
    // METHODS
  
    // CONSTRUCTORS 
  
    EMM_ODETimeStep(void);
  
  
  
    // DESTRUCTORS 
  
    
    virtual ~EMM_ODETimeStep(void);
  
  
private:

public:
    // New share pointer constructor
    static inline SP::EMM_ODETimeStep New() {
        SP::EMM_ODETimeStep p(new EMM_ODETimeStep(),EMM_ODETimeStep::Delete());
        p->setThis(p);
        return p;
    }
    
    // SET methods 
    virtual tBoolean isSystemCompatible(SPC::EMM_LandauLifschitzSystem system) const;


    inline void setMaximumIterationsNumber(const tUSInt& n) {
        mIterationsNumber=n;
    }
    inline void setMaximumError(const tReal& tol) {
        mTolerance=tol;
    }
    inline void setErrorNorm(const tFlag& n) {
        mErrorNorm=n;
    }
    inline void setErrorNorm(const tString& n) {
        if (n.compare("linf")==0) setErrorNorm(LINF_NORM);
        else setErrorNorm(L2_NORM);
    }
    inline const tFlag&  getErrorNorm() const {
        return mErrorNorm;
    }
    
    // GET methods 
    inline const EMM_RealField& getMagnetizationFieldAtTime(tReal& t) const {
        t=mT;
        return *mMt.get();
    }
    
    inline const tReal& getError() const {
        return mError;
    }
    inline const tUInteger& getEvaluationsNumber() const {
        return mEvaluationsNumber;
    }
   
  
public:
    // OTHERS methods
    virtual tBoolean computeNewTimeStep(tReal& dt);
    

  
};

#endif