EMM_Stepper.h

Go to the documentation of this file.

#ifndef EMM_Stepper_H
#define EMM_Stepper_H

#include "EMM_Object.h"

DEFINE_SPTR(EMM_LandauLifschitzSystem);

#include "EMM_RealField.h"

DEFINE_SPTR(EMM_Stepper);
class EMM_Stepper : public EMM_Object {
  
    SP_OBJECT(EMM_Stepper);
    // ATTRIBUTES
    
public:
    
  
   
private:
    //set the dt factor
    tReal mDtFactor;
    
    //set the end time
    tReal mEndTime;
    //set the characteristic time
    tReal mCharacteristicTime;
    //time steps number
    tUInteger mTimeStepsNumber;

    //constant time step
    tReal mDt;
    
    //syste to optimize
    WP::EMM_LandauLifschitzSystem mSystem;
    
protected: 
    // METHODS
  
    // CONSTRUCTORS 
  
    EMM_Stepper(void);
  
  
  
    // DESTRUCTORS 
  
    
    virtual ~EMM_Stepper(void);   
  
  
private:
    // SET methods 

public:
       
    tBoolean setSystem(SP::EMM_LandauLifschitzSystem system);
    void resetSystem();
    
        
    inline void setCharacteristicTime(const tReal& t) {
        mCharacteristicTime=t;
    }
    inline void setTargetTime(const tReal& t){
        mEndTime=t;
        if (mTimeStepsNumber>0) mDt=mEndTime/mTimeStepsNumber;
        else mDt=mEndTime;
    }

    inline void setDt(const tReal& dt) {
        mDt=dt;
    }
    
    inline void setDtFactor(const tReal& f) {
        mDtFactor=f;
    }
    inline void setTimeStepsNumber(const tUInteger& n) {
        mTimeStepsNumber=n;
        if (n>1) mDt=mEndTime/(n-1);
        else mDt=mEndTime+1;
    }
    
  

    // GET methods

    
public:
    inline const tReal& getDtFactor() const {
        return mDtFactor;
    }
    inline const tReal& getTargetTime() const {
        return mEndTime;
    }
    inline const tReal& getCharacteristicTime() const {
        return mCharacteristicTime;
    }

    inline const tUInteger& getTimeStepsNumber() const {
        return mTimeStepsNumber;
    }
    
    inline const tReal& getDt() const {
        return mDt;
    }

    inline tReal& getDt()  {
        return mDt;
    }
    
    
   
protected:
   
    
    virtual tBoolean isSystemCompatible(SPC::EMM_LandauLifschitzSystem system) const {
        return (system.get()!=null);
    }

    

    inline SPC::EMM_LandauLifschitzSystem getSystem() const {
        SPC::EMM_LandauLifschitzSystem sys=mSystem.lock();
        return sys;
    }
    inline SP::EMM_LandauLifschitzSystem getSystem()  {
        SP::EMM_LandauLifschitzSystem sys=mSystem.lock();
        return sys;
    }
    
public:
    virtual tBoolean computeNewTimeStep(tReal& dt,tUInteger& nEvaluations)=0;
    
public:
    // OTHERS methods
   
    virtual tString toString() const;
    
  
};

#endif