EMM_MultiScaleGrid.h

Go to the documentation of this file.

#ifndef EMM_MultiScaleGrid_H
#define EMM_MultiScaleGrid_H

#include "EMM_Object.h"
#include "EMM_Array.h"
#include "EMM_RealField.h"
#include "MATH_MultiLevelsToeplitzMatrix.h"


DEFINE_SPTR(EMM_MultiScaleGrid);
class EMM_MultiScaleGrid : public virtual EMM_Object {
  
    SP_OBJECT(EMM_MultiScaleGrid);
    // ATTRIBUTES

public:
    static tBoolean SAVE_H_M_AT_LEVEL_1;
    
private:

    //dicretization of the grid
    tUInteger mN[3];
    
    //periodicity of the grid
    tBoolean mIsPeriodic[3];
    
    
  

    // the associated toeplitz matrix common for all grids
    SP::MATH_MultiLevelsToeplitzMatrix mToeplitzMatrix;

    //levels nuumber
    tUInteger mLevelsNumber;
  
    //working array M at level l+1 and at level l
    SP::EMM_RealField mMlp1,mMl;

    //working M on field z
    SP::EMM_RealField mMz;
    
    //number of cells of the fine grid into the coarse grid
    tUCInt mFineElementsNumberPerCoarseElement;
    
    //number of calls of level computation
    tUInteger mLevelComputationsNumber=0;

    
    
public: 
    // METHODS
  
    // CONSTRUCTORS 
  
    EMM_MultiScaleGrid(void);
  
    // DESTRUCTORS 
    
    virtual ~EMM_MultiScaleGrid(void);   
  
  
public:
  
  

    // SET methods 
public:
   

    inline void setToeplitzMatrix(SP::MATH_MultiLevelsToeplitzMatrix toeplitz) {
        mToeplitzMatrix=toeplitz;
    }
    

    
    
    tUInteger computeLevelsNumber(const tUInteger& Nx,
                                  const tUInteger& Ny,
                                  const tUInteger& Nz,
                                  const tBoolean & isXPeriodic,
                                  const tBoolean & isYPeriodic,
                                  const tBoolean & isZPeriodic) const;
    
    virtual void initialize(const tDimension& dim,
                            const tUInteger& Nx,
                            const tUInteger& Ny,
                            const tUInteger& Nz,
                            const tBoolean& Px,
                            const tBoolean& Py,
                            const tBoolean& Pz,
                            const tUInteger& l);

    inline const tUCInt& getFineElementsNumberPerCoarseElement() const {
        return  mFineElementsNumberPerCoarseElement;
    }
    
    inline void getSegmentsNumber(tUInteger& Nx,tUInteger& Ny,tUInteger& Nz) const {
        Nx=mN[0];
        Ny=mN[1];
        Nz=mN[2];
    }
    inline const tUInteger* getSegmentsNumber() const {
        return mN;
    }

    inline const tBoolean* getPeriodicDirections() const {
        return mIsPeriodic;
       
    }
    inline void getPeriodicDirections(tBoolean& isXPeriodic,
                                      tBoolean& isYPeriodic,
                                      tBoolean& isZPeriodic) const {
        isXPeriodic=mIsPeriodic[0];
        isYPeriodic=mIsPeriodic[1];
        isZPeriodic=mIsPeriodic[2];
       
    }
  
    
   
    inline const tUInteger& getLevelsNumber() const {
        return mLevelsNumber;
    }


    inline const MATH_MultiLevelsToeplitzMatrix& getToeplitzMatrix() const {
        return *mToeplitzMatrix.get();
    }
    
    inline EMM_RealField& getLevelMagnetizationField() {
        return *mMl.get();
    } 
    inline EMM_RealField& getLevelUpMagnetizationField() {
        return *mMlp1.get();
    }
    inline EMM_RealField& getZonalMagnetizationField() {
        return *mMz.get();
    }


    static tBoolean resetBlockValues(const tDimension& dim,
                                     const tUInteger& Nx,const tUInteger& Ny,const tUInteger& Nz,
                                     const tUInteger& iMin,const tUInteger& iMax,
                                     const tUInteger& jMin,const tUInteger& jMax,
                                     const tUInteger& kMin,const tUInteger& kMax,
                                     tReal* M);

    
   
    
    virtual void computeMultiGridExcitationField(const tUIndex& nCells,
                                                 const tDimension& dim,
                                                 const tReal* sigmaM,
                                                 tReal * H);


protected:

    virtual void computeZonalDemagnetizedFieldAndNextLevelMagnetizationField(const tUInteger& twoPowerL,
                                                                             const tUIndex& nCells,
                                                                             const tDimension& dim,
                                                                             const tReal* Ml,
                                                                             tReal *Mz,
                                                                             tReal *Mlp1,
                                                                             tReal *H0) const=0;

    virtual void computeZonalCenteredDemagnetizedFieldFromLevel(const tUInteger& twoPowerL,
                                                                const tUIndex& nCells,
                                                                const tDimension& dim,
                                                                tReal* Ml,
                                                                tReal *Mz,
                                                                tReal *H0) const=0;
    
   

protected:
    inline tUInteger& getLevelComputationsNumber() {
        return mLevelComputationsNumber;
    }
    inline const tUInteger& getLevelComputationsNumber() const {
        return mLevelComputationsNumber;
    }
    
public:
  
    //OTHER methods
 
    virtual tString toString() const;
    
};

#endif