EMM_DemagnetizedPeriodicalTest.h

Go to the documentation of this file.

#ifndef EMM_DemagnetizedPeriodicalTest_H
#define EMM_DemagnetizedPeriodicalTest_H

#include "EMM_Test.h"


DEFINE_SPTR(EMM_DemagnetizedPeriodicalTest);

class EMM_DemagnetizedPeriodicalTest : public EMM_Test {
  
    SP_OBJECT(EMM_DemagnetizedPeriodicalTest);
    // ATTRIBUTES


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

public:
    inline static SP::EMM_DemagnetizedPeriodicalTest New() {
        SP::EMM_DemagnetizedPeriodicalTest p(new EMM_DemagnetizedPeriodicalTest(),
                                       EMM_DemagnetizedPeriodicalTest::Delete());
        p->setThis(p);
        return p;
    };

   

    
    
    virtual tBoolean test(const CORE_Run& runner,const map<tString,tString>& options) const;

   
private:
    tBoolean shrinkingTest() const;

    tBoolean multiCDGridScaleTest() const;
    
    tBoolean multiSDGridScaleTest(const CORE_Run& runner,const map<tString,tString>& options) const;

    
    /* \brief testing of H computing on a domain Nx x Ny x Nz with periodicity from constannt M
     * @param[in] Xperiodicity : periodicity on x is enabled
     * @param[in] Yperiodicity : periodicity on y is enabled
     * @param[in] Zperiodicity : periodicity on z is enabled
     * @param[in] storage: type of storage in {"SL","GP","LP","LC","LT"}
     * @param[in] multiGrid: type of multi-grid in {"","RP","SDX","SDXL"}
     * @param[in] Nx: number of segments along x-direction
     * @param[in] Ny: number of segments along y-direction
     * @param[in] Nz: number of segments along z-direction
     * @param[in] Lx : length of the geometry in the direction x
     * @param[in] Ly : length of the geometry in the direction y
     * @param[in] Lz : length of the geometry in the direction z
     * @param[in] Ms : magnetization at saturation of the matter
     * @param[in] p : levels number
     * @param[in] zlevels : zonal levels number for SDG method
     * @param[in] M0: M values
     * @patam[in] Href : H values
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stéphane Labbe, Sylvain Faure
     *
     *
     * The demagnetized field is computed from M0 and supposed to be equals to Href
     *
     */
    tBoolean HTest(const tBoolean& Xperiodicity,const tBoolean& Yperiodicity,const tBoolean& Zperiodicity,
                   const tString& storage,const tString& multiGrid,
                   const tUInteger& Nx,const tUInteger& Ny,const tUInteger& Nz,
                   const tReal& Lx,const tReal& Ly,const tReal& Lz,
                   const tReal& Ms,const tSInt& p,const tSInt& zlevels,
                   tReal M0[3],tReal Href[3],
                   const CORE_Run& runner,const map<tString,tString>& options) const;
    
    
    /* \brief periodical on X & Y  cube test for H
     *
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stéphane Labbe, Sylvain Faure
     *
     * - M(0,0,1) in a cube of size L x L x L periodical in the direction x and y
     * - the number p of levels verifies \f$ L=2^p=16\f$
     * - we choose p=4
     *
     * The demagnetized field is supposed to be \f$ H_d=(0,0,-1) \f$
     */
    tBoolean xyPeriodicalCubeHTest(const CORE_Run& runner,const map<tString,tString>& options) const;

    /* \brief periodical on X & Y  cube test for H
     * @param[in] newVersion : true to run the SDG method, false to run SDG-RP method
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stéphane Labbe, Sylvain Faure
     *
     * - M(0,0,1) in a cube of size L x L x L periodical in the direction x and y
     *
     * We compare the results given by SL/SDG-RP and LC/SDG with nLevels=1 and 2 and zlevels=1
     *
     */
    tBoolean xyPeriodicalCubeSDGTest(const tBoolean& newVersion,const CORE_Run& runner,const map<tString,tString>& options) const;

    /* \brief periodical on X & Y  cube test for H
     * @param[in] newVersion : true to run the SDG method, false to run SDG-RP method
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stéphane Labbe, Sylvain Faure
     *
     * - M(0,0,1) in a cube of size L x L x L periodical in the direction x and y
     * 
     * We compare the results given by SL/SDG-RP and LC/SDG with nLevels=1 and 2 and zlevels=1
     */
    tBoolean xyPeriodicalSheetSDGTest(const tBoolean& newVersion,const CORE_Run& runner,const map<tString,tString>& options) const;
    
    /* \brief periodical on X & Y  cube ith not cubic mesh test for H
     *
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stéphane Labbe, Sylvain Faure
     *
     * - M(0,0,1) in a cube of size L x L x L periodical in the direction x and y with discretization  32x16x8
     * - the number p of levels verifies \f$ L=2^p=16\f$
     * - we choose p=4
     *
     * The demagnetized field is supposed to be \f$ H_d=(0,0,-1) \f$
     */
    tBoolean xyPeriodicalNotCubicCubeHTest(const CORE_Run& runner,const map<tString,tString>& options) const;
      

    
    /* \brief periodical on X & Y  sheet test for H
     *
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stephane Labbe, Sylvain Faure
     *
     * - \f$ M(0,1/\sqrt{2},1/\sqrt{2}) \f$ in a rectangular sheet of size L x H  periodical in the direction x and y
     * - the number p of levels verifies \f$ min(L,H)=2^p\f$
     * - L=16 H=64 with cubic/rectangular mesh
     * - we choose p=4
     *
     *
     * The demagnetized field is supposed to be \f$ H=(0,0,-1/\sqrt{2}) \f$
     *
     */
    tBoolean xyPeriodicalSheetHTest(const CORE_Run& runner,const map<tString,tString>& options) const;

    /* \brief periodical on X & Y  sheet test for H
     *
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     * from Stephane Labbe, Sylvain Faure
     *
     * - \f$ M(1,0,0) \f$ in a rectangular sheet of size L x H  periodical in the direction x and y
     * - the number p of levels verifies \f$ min(L,H)=2^p\f$
     * - L=16 H=64 with cubic/rectangular mesh
     * - we choose p=4
     *
     *
     * The demagnetized field is supposed to be \f$ H=(0,0,0) \f$
     *
     */
    tBoolean xyPeriodicalSheetNullHTest(const CORE_Run& runner,const map<tString,tString>& options) const;


    /* \brief testing of relxation computing on a domain Nx x Ny x Nz with periodicity from constannt M
     * @param[in] Xperiodicity : periodicity on x is enabled
     * @param[in] Yperiodicity : periodicity on y is enabled
     * @param[in] Zperiodicity : periodicity on z is enabled
     * @param[in] storage: type of storage in {"SL","GP","LP","LC","LT"}
     * @param[in] multiGrid: type of multi-grid in {"","CDG","SDG","SDG-RP"}
     * @param[in] Nx: number of segments along x-direction
     * @param[in] Ny: number of segments along y-direction
     * @param[in] Nz: number of segments along z-direction
     * @param[in] p : levels number
     * @param[in] zlevels : zonal levels number for SDG method
     * @param[in] Lx: size in the x-direction of the box
     * @param[in] Ly: size in the y-direction of the box
     * @param[in] Lz: size in the z-direction of the box
     * @param[in] A: exchange coefficient
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     *
     */
    tBoolean relaxationTest(const tBoolean& Xperiodicity,const tBoolean& Yperiodicity,const tBoolean& Zperiodicity,
                            const tString& storage,const tString& multiGrid,
                            const tUInteger& Nx,const tUInteger& Ny,const tUInteger& Nz,const tSInt& p,const tSInt& zlevels,
                            const tReal& Lx,const tReal& Ly,const tReal& Lz,
                            const tReal& A,const tReal *M0,
                            const CORE_Run& runner,const map<tString,tString>& options) const;
    
    /* \brief periodical on X & Y  cubic test
     *
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     *
     * We compute the equilibrium of the state M in a cube of size L (L=8) wit the different periodiity configuration
     * - a non periodical domain
     * - a periodical domain the the y-direction only
     * - a periodical domain the the x,y-directions only
     *
     * The exchange operator is used wth A=1.3e-11, the cubic or rectangular cell mesh size is more or less equalts to 2.5e-9 and M is randomized at initial state
     * 
     */
    tBoolean periodicalCubeRelaxationTest(const CORE_Run& runner,const map<tString,tString>& options) const;

    /* \brief periodical on X & Y  cubic test
     * @param[in] runner : main class of the program
     * @param[in] options : options from the command line
     *
     *
     * test issue from 
     * Multilevel computation of the demagnetization field in eriodic domains applied to micromagnetism computations
     *
     * We compute the equilibrium of the state M in a sheet of size L x L x H  (L=16 H=4) with the different periodiciiy configuration :
     * - a non periodical domain
     * - a periodical domain the the x-direction only
     * - a periodical domain the the y-direction only
     * - a periodical domain the the z-direction only
     *
     * The exchange operator is used wth A=1.3e-11, the cubic cell mesh size is 2.5e-9 and M is randomized at initial state
     *
     */
    tBoolean periodicalSheetRelaxationTest(const CORE_Run& runner,const map<tString,tString>& options) const;



    tBoolean periodicalDemagnetizedTestCase(const tString& name,
                                            const tString& ms,
                                            const tBoolean& isMHlSaved,
                                            const CORE_Run& runner) const;
        
    
};

#endif