C++ main module for emicrom Package  1.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
EMM_MultiScaleCDGrid Class Reference

This class describes the building of fields on multiscale centered dioptic grids initialized by the initialize() method. More...

#include <EMM_MultiScaleCDGrid.h>

Inheritance diagram for EMM_MultiScaleCDGrid:
Inheritance graph
[legend]
Collaboration diagram for EMM_MultiScaleCDGrid:
Collaboration graph
[legend]

Public Member Functions

 EMM_MultiScaleCDGrid (void)
 create More...
 
virtual ~EMM_MultiScaleCDGrid (void)
 destroy More...
 
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)
 set the discretization More...
 
void meanValuesFromFineToCoarseGrid (const tUIndex &nCells, const tDimension &dim, const tReal *Mf, tReal *Ml) const
 compute the field in a corse field from its fine grid. More...
 
void completeValuesOutsideFineGridByPeriodicity (const tUIndex &nCells, const tDimension &dim, tReal *Ml) const
 complete the values of the field in the coarse grid is set from its values in its included fine grid by periodicity More...
 
tBoolean resetValuesWithinCenteredZone (const tUIndex &nCells, const tDimension &dim, tReal *Mz) const
 
void addValuesFromCoarseGridToFinestGrid (const tUIndex &nCells, const tDimension &dim, const tUInteger &twoPowerL, const tReal *Ml, tReal *Mf) const
 add the value of the field defined in coarse grid $ 2^l $ bigger than its finest grid into the field defined in its finest grid More...
 
void setToeplitzMatrix (SP::MATH_MultiLevelsToeplitzMatrix toeplitz)
 setthe toeplitz associated matrix More...
 
tUInteger computeLevelsNumber (const tUInteger &Nx, const tUInteger &Ny, const tUInteger &Nz, const tBoolean &isXPeriodic, const tBoolean &isYPeriodic, const tBoolean &isZPeriodic) const
 compute the optimal levels number More...
 
const tUCIntgetFineElementsNumberPerCoarseElement () const
 get the number of elements of the fine grid per cell of the corse grid More...
 
void getSegmentsNumber (tUInteger &Nx, tUInteger &Ny, tUInteger &Nz) const
 get the segments number in all directions More...
 
const tUIntegergetSegmentsNumber () const
 get the segments number per dierction More...
 
const tBooleangetPeriodicDirections () const
 get the periodicity per direction More...
 
void getPeriodicDirections (tBoolean &isXPeriodic, tBoolean &isYPeriodic, tBoolean &isZPeriodic) const
 get the periodicity per direction More...
 
const tUIntegergetLevelsNumber () const
 get the leves number More...
 
const MATH_MultiLevelsToeplitzMatrixgetToeplitzMatrix () const
 get the toeplitz matrix More...
 
EMM_RealFieldgetLevelMagnetizationField ()
 get the magnetization field at level l More...
 
EMM_RealFieldgetLevelUpMagnetizationField ()
 get the magnetization field at level l+1 More...
 
EMM_RealFieldgetZonalMagnetizationField ()
 get the magnetization field at zone More...
 
virtual void computeMultiGridExcitationField (const tUIndex &nCells, const tDimension &dim, const tReal *sigmaM, tReal *H)
 compute the magnetic excitation field by superposition of multi scale grids More...
 
virtual tString toString () const
 return the class information in a tString More...
 
void getSharedPointer (SP::CORE_Object &p)
 get the shared pointer of this class into p More...
 
void getSharedPointer (SPC::CORE_Object &p) const
 get the shared pointer of this class into p More...
 
tString getClassName () const
 return the class name of the object More...
 
tString getIdentityString () const
 return the identity string of the object of the form className_at_address More...
 
tString getPointerAddress () const
 return the identity string of the object More...
 
template<class T >
tBoolean isInstanceOf () const
 test if the clas T is an instance of this class More...
 
tBoolean isInstanceOf (const tString &name) const
 test if the object is an instance of className More...
 

Static Public Member Functions

static SP::EMM_MultiScaleCDGrid New ()
 build a new instance of class More...
 
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)
 reset the values in a block grid [iMin,iMax[x[jMin,jMax[x[kMin,kMax[ of dimension dim per point inside a grid of size [0,Nx[x[0,Ny[x[0,Nz[ More...
 
static void setIsMemoryChecked (const tBoolean &v)
 set if the memory checking is used More...
 
static void setOut (SP::CORE_Out out)
 set the output stream More...
 
static void resetOut ()
 reset the output stream More...
 
static void setThread (SP::CORE_Thread thread)
 set the thread More...
 
static void resetThread ()
 reset the output stream More...
 
static CORE_Outout ()
 get the output More...
 
static SP::CORE_Out getOut ()
 get the output More...
 
static CORE_ThreadgetThread ()
 get the profilier More...
 
static const tBooleanisMemoryChecked ()
 get if the memory checking is used More...
 
static tString getClassName (const tString &identityString)
 return the class name of the object More...
 
template<class T >
static tString getTypeName ()
 get type name More...
 
static tBoolean is64Architecture ()
 return true if the machine is a 64 bits machine More...
 
static tBoolean is32Architecture ()
 return true if the machine is a 32 bits machine More...
 
static tString pointer2String (const void *obj)
 return the string representation of a pointer More...
 
static void printObjectsInMemory (ostream &f)
 print object in memory More...
 
static void printObjectsInMemory ()
 print object in memory in the standart output More...
 
static tChar getMaxChar ()
 get the max value for tChar type More...
 
static tChar getMinChar ()
 get the min value for tChar type More...
 
static tUChar getMaxUChar ()
 get the max value for tUChar type More...
 
static tUChar getMinUChar ()
 get the min value for tUChar type More...
 
static tSInt getMaxSInt ()
 get the max value for tSInt type More...
 
static tSInt getMinSInt ()
 get the min value for tSInt type More...
 
static tUSInt getMaxUSInt ()
 get the max value for tUSInt type More...
 
static tUSInt getMinUSInt ()
 get the min value for tUSInt type More...
 
static tInt getMaxInt ()
 get the max value for tInt type More...
 
static tInt getMinInt ()
 get the min value for tInt type More...
 
static tUInt getMaxUInt ()
 get the max value for tUInt type More...
 
static tUInt getMinUInt ()
 get the min value for tUInt type More...
 
static tLInt getMaxLInt ()
 get the max value for tLInt type More...
 
static tLInt getMinLInt ()
 get the min value for tLInt type More...
 
static tULInt getMaxULInt ()
 get the max value for tULInt type More...
 
static tULInt getMinULInt ()
 get the min value for tULInt type More...
 
static tLLInt getMaxLLInt ()
 get the max value for tULInt type More...
 
static tLLInt getMinLLInt ()
 get the min value for tLLInt type More...
 
static tULLInt getMaxULLInt ()
 get the max value for tULLInt type More...
 
static tULLInt getMinULLInt ()
 get the min value for tULLInt type More...
 
static tFloat getMaxFloat ()
 get the max value for tFloat type More...
 
static tFloat getMinFloat ()
 get the min value for tFloat type More...
 
template<class T >
static T getEpsilon ()
 get the epsilon value for T type More...
 
template<class T >
static T getInfinity ()
 get the infinity for T type More...
 
static tFloat getFloatEpsilon ()
 get the epsilon value for tFloat type More...
 
static tFloat getFloatInfinity ()
 get the infinity value for tFloat type More...
 
static tDouble getMaxDouble ()
 get the max value for tDouble type More...
 
static tDouble getMinDouble ()
 get the min value for tDouble type More...
 
static tDouble getDoubleInfinity ()
 get the infinity value for tFloat type More...
 
static tDouble getDoubleEpsilon ()
 get the epsilon value for tDouble type More...
 
static tLDouble getMinLDouble ()
 get the min value for tLDouble type More...
 
static tLDouble getMaxLDouble ()
 get the max value for tLDouble type More...
 
static tLDouble getLDoubleEpsilon ()
 get the epsilon value for tLDouble type More...
 
static tDouble getLDoubleInfinity ()
 get the infinity value for tDouble type More...
 
static tIndex getMaxIndex ()
 get the max value for the array/vector indexing type More...
 
static tIndex getMinIndex ()
 get the min value for the array/vector indexing type More...
 
static tUIndex getMaxUIndex ()
 get the max value for difference the array/vector indexing type More...
 
static tUIndex getMinUIndex ()
 get the min value for difference the array/vector indexing type More...
 
static tFlag getMaxFlag ()
 get the max value for the tFlag type More...
 
static tFlag getMinFlag ()
 get the min value for the tFlag type More...
 
static tUInteger getMaxUInteger ()
 get the max value for the unsigned integer type More...
 
static tUInteger getMinUInteger ()
 get the min value for the unsigned integer type More...
 
static tInteger getMaxInteger ()
 get the max value for the integer type More...
 
static tInteger getMinInteger ()
 get the min value for the integer type More...
 
static tReal getMaxReal ()
 get the max value for the real type More...
 
static tReal getMinReal ()
 get the min value for the real type More...
 
static tReal getRealEpsilon ()
 get the eps which is the difference between 1 and the least value greater than 1 that is representable. More...
 
static tReal getRealInfinity ()
 get the infinity value More...
 
template<class T >
static T computeEpsilon ()
 compute epsilon More...
 

Static Public Attributes

static tBoolean SAVE_H_M_AT_LEVEL_1 =false
 
static const tReal Mu0 =4*M_PI*1e-07
 
static const tReal Gamma =-1.7e11
 
static const tDimension X =0
 
static const tDimension Y =1
 
static const tDimension Z =2
 
static const tReal NULL_VALUE [] ={0,0,0}
 

Protected Member Functions

virtual void computeZonalDemagnetizedFieldAndNextLevelMagnetizationField (const tUInteger &twoPowerL, const tUIndex &nCells, const tDimension &dim, const tReal *Ml, tReal *Mz, tReal *Mlp1, tReal *H0) const
 compute the zonal demagnetized field added to demagnetized field at level 0 and compute the magnetization field at level l+1 More...
 
virtual void computeZonalCenteredDemagnetizedFieldFromLevel (const tUInteger &twoPowerL, const tUIndex &nCells, const tDimension &dim, tReal *Ml, tReal *Mz, tReal *H0) const
 compute the centered demagnetized field of level l outside zone anad add it to demagnetized field at level 0 More...
 
tUIntegergetLevelComputationsNumber ()
 return the number of calls of the level computations only for debug More...
 
const tUIntegergetLevelComputationsNumber () const
 return the number of calls of the level computations only for debug More...
 
virtual void toDoAfterThisSetting ()
 method called after the setting of the shared pointer this method can only be called once. More...
 
void setThis (SP::CORE_Object p)
 set this weak shared pointer called toDoAfterThis setting method More...
 

Private Member Functions

 SP_OBJECT (EMM_MultiScaleCDGrid)
 
void completeValuesOutsideFineGridByPeriodicityByExclusion (const tUIndex &nCells, const tDimension &dim, tReal *Ml) const
 complete the values of the field in the coarse grid is set from its values in its included fine grid by periodicity More...
 
void computeMagnetizationFieldAtNextLevel (const tUIndex &nCells, const tDimension &dim, const tReal *Ml, tReal *Mlp1) const
 compute the magntization field at level l+1 for field at level l More...
 
void computeDemagnetizedExcitationFieldFromLevel (const tUInteger &twoPowerL, const tUIndex &nCells, const tDimension &dim, tReal *Ml, tReal *H0) const
 compute the magnetic exitation of the grid at level l and add it to the magnetic excitation field of level 0 More...
 

Detailed Description

This class describes the building of fields on multiscale centered dioptic grids initialized by the initialize() method.

For building centered dyotic coarse grids, the number of segments in each direction must be 1 or a pair number.

For computing the magnetic excitation field for periodic domain, a sequence of l-dyotic grids is built: the grid of level l is included into the grid of level l+1. The grid of level l+1 is twice size of the grid of level l in each direction. The total magnetic excitation field is built as follow see computeMultiGridExcitationField() :

the number of levels is set to 1 for non periodic domain. the number of levels of periodic domain must be at least 2

To compute the demagnetized magnetic excitation field in a grid 4x4x1 with peridicity on x & y.

Step 1 M at level l
Step 2 M at level l+1

the values of the field $ M^{1+1} $ is meaned in the common part of the both grids as follow:

because of periodicity the value of the magnetization ouside the fine grid is for the x periodicity:

and for the y periodicity (if there is periodicity on y, 0 otherwise) we have:

Step 3 Mh for computing magnetic excitation contribution of level l+1

To compute the contribution of magnetic excitation field of the level l+1 over the grid at level 0 , M is set to 0 on common cells between grid at level l and at level l+1 $ M^h= M^{l+1} $ and

Then, the magnetic excitation at level l+1 is $ H^{l+1}$ is computed for all levels $ H^{l+1}=H_d(M^h) $

Then, the magnetic excitation is $ H_d = \sum_{l=0}^{L} H_d^{l} $ over the grid at level 0 .

Step 4 go to the step 1 for next level
to compute the contribution of the next periodic cells

Note that this algorithm is not valid if the number of segments in only pair (such as N=2 for example). Consider the fine grid as a periodical to compute the mean of the magnetization inside the coarse grid:

For example, consider N=6 at first level with the magnetized field :

       | 1 | 2 | 3 | 4 | 5 | 6 |  -> H0

By periodicity the mean is as follow:

| | 7/2 | 5/2 | 9/2 | 7/2 | |

and then the magnetization at next level is as follow:

| 7/2 | 7/2 | 5/2 | 9/2 | 7/2 | 7/2 |

So to compute H1, the magnetization field is turned into :

| 7/2 |x 0 | 0 | 0 |0 x | 7/2 | -> H1

But the part of the x set to 0 is forgotten in H0 and H1...

To remains valid all the cells in common of the grid the level l+1 and l must be equal to the union of cells at level l.

Author
Stephane Despreaux
Version
1.0

Constructor & Destructor Documentation

◆ EMM_MultiScaleCDGrid()

EMM_MultiScaleCDGrid::EMM_MultiScaleCDGrid ( void  )

create

Referenced by New().

Here is the caller graph for this function:

◆ ~EMM_MultiScaleCDGrid()

EMM_MultiScaleCDGrid::~EMM_MultiScaleCDGrid ( void  )
virtual

destroy

Member Function Documentation

◆ addValuesFromCoarseGridToFinestGrid()

void EMM_MultiScaleCDGrid::addValuesFromCoarseGridToFinestGrid ( const tUIndex nCells,
const tDimension dim,
const tUInteger twoPowerL,
const tReal Ml,
tReal Mf 
) const

add the value of the field defined in coarse grid $ 2^l $ bigger than its finest grid into the field defined in its finest grid

Parameters
[in]nCellsnumber of elements of the field
[in]dimdimension of the field
[in]twoPowerL: step size of the coarse grid with respect of the finest grid
[in]Ml: the large field values of size dim . Nx . Ny . Nz
[in,out]Mf: the fine field values of size dim . Nx . Ny . Nz

add the value of the field Ml to the value of the field Mf on the cells in common.

For each cell of the finest grid, the corresponding cell of the coarse grid is computed and the values of the field at the coarse element is added to the value of the field at the fine element.

The corresponding coarse elements to the element from the fine grid is computed such that the coarse element contains the center of the element of the fine grid by the following relation.

For each element (i,j,k) of the grid at level 0, the corresponding element (I(i),J(j),K(k)) of the grid at level l is searched such that the center of the element (i,j,k) of the grid at level 0 is inside the element (I,J,K) of the grid at level l.

The left boundary of the grid at level l is $ y_I=-N_x.2^{l-1} + 2^l.I $ when the origin is at the center of the grid

The center of the grid at level 0 is $ x_i=\frac{1}{2}+i-\frac{N_x}{2}$ when the origin is at the center of the grid

So, to search the cell of the grid at level l containing the center of the grid at level 0 leads to $ y_I \leq x_i < y_{I+1} $. We conclude that

  • $ I(i)=\displaystyle E(\frac{(2^l-1).N_x+1+2.i}{2^{l+1}}) $
  • $ J(j)=\displaystyle E(\frac{(2^l-1).N_y+1+2.j}{2^{l+1}}) $
  • $ K(k)=\displaystyle E(\frac{(2^l-1).N_z+1+2.k}{2^{l+1}}) $.

References EMM_MultiScaleGrid::getLevelComputationsNumber(), EMM_MultiScaleGrid::getSegmentsNumber(), null, OMP_GET_THREAD_ID, OMP_GET_THREADS_NUMBER, OMP_PARALLEL_PRIVATE_SHARED_DEFAULT, EMM_Output::saveVTI(), tDimension, CORE_Integer::toString(), tReal, tUIndex, and tUInteger.

Referenced by completeValuesOutsideFineGridByPeriodicity(), and computeDemagnetizedExcitationFieldFromLevel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ completeValuesOutsideFineGridByPeriodicity()

void EMM_MultiScaleCDGrid::completeValuesOutsideFineGridByPeriodicity ( const tUIndex nCells,
const tDimension dim,
tReal Ml 
) const
inline

complete the values of the field in the coarse grid is set from its values in its included fine grid by periodicity

Parameters
[in]nCellsnumber of elements of the mesh
[in]dimdimension of the field
[in,out]Ml: the coarse field values of size dim . nCells

Step 1 M at level l
Step 2 M at level l+1

If there is periodicity on x, we have:

  • $ M^1_{10}=M^1_{12}$
  • $ M^1_{20}=M^1_{22}$
  • $ M^1_{13}=M^1_{11}$
  • $ M^1_{23}=M^1_{21}$

If there is periodicity on y, we have:

  • $ M^1_{01}=M^1_{21}$
  • $ M^1_{02}=M^1_{22}$
  • $ M^1_{31}=M^1_{11}$
  • $ M^1_{32}=M^1_{12}$

    If there is periodicity on x and y, we have in addition:

  • $ M^1_{00}=M^1_{22}$
  • $ M^1_{33}=M^1_{11}$
  • $ M^1_{03}=M^1_{21}$
  • $ M^1_{30}=M^1_{12}$

References addValuesFromCoarseGridToFinestGrid(), completeValuesOutsideFineGridByPeriodicityByExclusion(), resetValuesWithinCenteredZone(), tBoolean, tDimension, tReal, tUIndex, and tUInteger.

Referenced by computeMagnetizationFieldAtNextLevel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ completeValuesOutsideFineGridByPeriodicityByExclusion()

void EMM_MultiScaleCDGrid::completeValuesOutsideFineGridByPeriodicityByExclusion ( const tUIndex nCells,
const tDimension dim,
tReal Ml 
) const
private

complete the values of the field in the coarse grid is set from its values in its included fine grid by periodicity

Parameters
[in]nCellsnumber of elements of the mesh
[in]dimdimension of the field
[in,out]Ml: the coarse field values of size dim . nCells

Step 1 M at level l
Step 2 M at level l+1
If there is periodicity on x, we have:

  • $ M^1_{10}=M^1_{12}$
  • $ M^1_{20}=M^1_{22}$
  • $ M^1_{13}=M^1_{11}$
  • $ M^1_{23}=M^1_{21}$

If there is periodicity on y, we have:

  • $ M^1_{01}=M^1_{21}$
  • $ M^1_{02}=M^1_{22}$
  • $ M^1_{31}=M^1_{11}$
  • $ M^1_{32}=M^1_{12}$

    If there is periodicity on x and y, we have in addition:

  • $ M^1_{00}=M^1_{22}$
  • $ M^1_{33}=M^1_{11}$
  • $ M^1_{03}=M^1_{21}$
  • $ M^1_{30}=M^1_{12}$

loop all elements of the coarse grid.

  • If there is an intersection with the fine grid, the element is ignored
  • othersize, the element of the coarse grid with not null intersection with the fine grid is found by periodicity

References EMM_MultiScaleGrid::getPeriodicDirections(), EMM_MultiScaleGrid::getSegmentsNumber(), OMP_GET_THREAD_ID, OMP_GET_THREADS_NUMBER, OMP_PARALLEL_PRIVATE_SHARED_DEFAULT, tBoolean, tDimension, tReal, tUIndex, and tUInteger.

Referenced by completeValuesOutsideFineGridByPeriodicity().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeDemagnetizedExcitationFieldFromLevel()

void EMM_MultiScaleCDGrid::computeDemagnetizedExcitationFieldFromLevel ( const tUInteger twoPowerL,
const tUIndex nCells,
const tDimension dim,
tReal Ml,
tReal H0 
) const
private

compute the magnetic exitation of the grid at level l and add it to the magnetic excitation field of level 0

Parameters
[in]twoPowerL: ratio size of the grid at level l
[in]nCells: number of cells of the mesh
[in]dimdimension of each point of the mesh
[in,out]Mlmagnetization values of size nCells x dim at level L
[in,out]H0: demagnetized excitation field at level l
  • reset the magnetization M0 on cells of the coarse grid at level l which are included in its fine grid at level l-1
  • computes H=Hd(M0)
  • add H to H0 from the level 0

References addValuesFromCoarseGridToFinestGrid(), EMM_MultiScaleGrid::getLevelComputationsNumber(), EMM_MultiScaleGrid::getSegmentsNumber(), EMM_MultiScaleGrid::getToeplitzMatrix(), resetValuesWithinCenteredZone(), EMM_Output::saveVTI(), CORE_Integer::toString(), tReal, tUInteger, and MATH_MultiLevelsToeplitzMatrix::vectorProduct().

Referenced by computeZonalCenteredDemagnetizedFieldFromLevel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeEpsilon()

template<class T >
static T CORE_Object::computeEpsilon ( )
inlinestaticinherited

compute epsilon

Returns
the epsilon value eps=10^{-p/3} where p is defined by getEpsilon()=10^{-p}

◆ computeLevelsNumber()

tUInteger EMM_MultiScaleGrid::computeLevelsNumber ( const tUInteger Nx,
const tUInteger Ny,
const tUInteger Nz,
const tBoolean isXPeriodic,
const tBoolean isYPeriodic,
const tBoolean isZPeriodic 
) const
inherited

compute the optimal levels number

Parameters
Nxnumber of segments along x-direction
Nynumber of segments along y-direction
Nznumber of segments along z-direction
isXPeriodictrue if the x-direction is periodic
isYPeriodictrue if the y-direction is periodic
isZPeriodictrue if the z-direction is periodic

The level number per direction $ l_d $ is such that if $ N_d=2^l_d $ If the domain is not periodic the level number is 0

Returns
the minimum of the level number for all directions

References CORE_Object::getMaxUInteger(), tBoolean, tUInteger, and tUSInt.

Referenced by EMM_MultiScaleGrid::setToeplitzMatrix().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeMagnetizationFieldAtNextLevel()

void EMM_MultiScaleCDGrid::computeMagnetizationFieldAtNextLevel ( const tUIndex nCells,
const tDimension dim,
const tReal Ml,
tReal Mlp1 
) const
private

compute the magntization field at level l+1 for field at level l

Parameters
[in]nCells: number of cells of the mesh
[in]dimdimension of each point of the mesh
[in]Mlmagnetization values of size nCells x dim at level l
[out]Mlp1: magnetization values of size nCells x dim at level l+1
  • computes the mean values of M at each cell of the grid at level l+1 from all its included cells from its fine grid at level l
  • computes the values of M at each call of the grid at level l+1 with no intersection with its fine grid at level l

References completeValuesOutsideFineGridByPeriodicity(), and meanValuesFromFineToCoarseGrid().

Referenced by computeZonalCenteredDemagnetizedFieldFromLevel(), and computeZonalDemagnetizedFieldAndNextLevelMagnetizationField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeMultiGridExcitationField()

void EMM_MultiScaleGrid::computeMultiGridExcitationField ( const tUIndex nCells,
const tDimension dim,
const tReal sigmaM,
tReal H 
)
virtualinherited

compute the magnetic excitation field by superposition of multi scale grids

Parameters
[in]nCells: number of cells of the mesh
[in]dimdimension of each point of the mesh
[in]sigmaMmagnetization values of size nCells x dim not necessarly normalized : sigmaM=sigma.M
[out]Hreturn excitation magnetic values of size nCells x dim

The following algorithm needs 3 temporary fields $ M_{l+1} $ , $ M_l $ and $ M_z $ for computing by zone

Computes the magnetic excitation field as follow:

Reimplemented in EMMG_SLSDXPeriodicMultiScale, and EMMG_SLRPPeriodicMultiScale.

References EMM_MultiScaleGrid::computeZonalCenteredDemagnetizedFieldFromLevel(), EMM_MultiScaleGrid::computeZonalDemagnetizedFieldAndNextLevelMagnetizationField(), EMM_MultiScaleGrid::getLevelMagnetizationField(), EMM_MultiScaleGrid::getLevelsNumber(), EMM_MultiScaleGrid::getLevelUpMagnetizationField(), EMM_MultiScaleGrid::getToeplitzMatrix(), EMM_MultiScaleGrid::getZonalMagnetizationField(), EMM_MultiScaleGrid::mLevelComputationsNumber, EMM_MultiScaleGrid::mN, null, EMM_MultiScaleGrid::SAVE_H_M_AT_LEVEL_1, EMM_Output::saveVTI(), CORE_Integer::toString(), tReal, tUIndex, tUInteger, and MATH_MultiLevelsToeplitzMatrix::vectorProduct().

Referenced by EMM_MultiScaleGrid::getZonalMagnetizationField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeZonalCenteredDemagnetizedFieldFromLevel()

virtual void EMM_MultiScaleCDGrid::computeZonalCenteredDemagnetizedFieldFromLevel ( const tUInteger twoPowerL,
const tUIndex nCells,
const tDimension dim,
tReal Ml,
tReal Mz,
tReal H0 
) const
inlineprotectedvirtual

compute the centered demagnetized field of level l outside zone anad add it to demagnetized field at level 0

Parameters
[in]twoPowerL: ratio size of the grid at level l
[in]nCells: number of cells of the mesh
[in]dimdimension of each point of the mesh
[in,out]Mlmagnetization values of size nCells x dim at level l
[out]Mzmagnetization at zone . Working field
[in,out]H0: demagnetized excitation field at level 0
  • reset the magnetization M0 on cells of the coarse grid at level l which are included in its fine grid at level l-1
  • computes H=Hd(M0)
  • add H to H0 from the level 0

Implements EMM_MultiScaleGrid.

Reimplemented in EMM_MultiScaleSDGrid.

References computeDemagnetizedExcitationFieldFromLevel(), computeMagnetizationFieldAtNextLevel(), tDimension, tReal, tUIndex, and tUInteger.

Referenced by EMM_MultiScaleSDGrid::computeZonalCenteredDemagnetizedFieldFromLevel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeZonalDemagnetizedFieldAndNextLevelMagnetizationField()

virtual void EMM_MultiScaleCDGrid::computeZonalDemagnetizedFieldAndNextLevelMagnetizationField ( const tUInteger twoPowerL,
const tUIndex nCells,
const tDimension dim,
const tReal Ml,
tReal Mz,
tReal Mlp1,
tReal H0 
) const
inlineprotectedvirtual

compute the zonal demagnetized field added to demagnetized field at level 0 and compute the magnetization field at level l+1

Parameters
[in]twoPowerL: ratio size of the grid at level l
[in]nCells: number of cells of the mesh
[in]dimdimension of each point of the mesh
[in]Mlmagnetization at level l
[out]Mzmagnetization at zone . Working field
[in,out]Mlp1magnetization values of size nCells x dim at level l+1
[in,out]H0: demagnetized excitation field at level 0

It computes the magnetization field at level l+1. No zone.

Implements EMM_MultiScaleGrid.

Reimplemented in EMM_MultiScaleSDGrid.

References computeMagnetizationFieldAtNextLevel().

Referenced by EMM_MultiScaleSDGrid::computeZonalDemagnetizedFieldAndNextLevelMagnetizationField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getClassName() [1/2]

tString CORE_Object::getClassName ( ) const
inherited

return the class name of the object

Returns
the class name of the object

References tString.

Referenced by CORE_Object::getIdentityString(), EMM_Operator::getName(), and CORE_Object::isMemoryChecked().

Here is the caller graph for this function:

◆ getClassName() [2/2]

static tString CORE_Object::getClassName ( const tString identityString)
inlinestaticinherited

return the class name of the object

Parameters
identityStringthe identity string of the object
Returns
the class name

◆ getDoubleEpsilon()

static tDouble CORE_Object::getDoubleEpsilon ( )
inlinestaticinherited

get the epsilon value for tDouble type

Returns
the epsilon value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getDoubleInfinity()

static tDouble CORE_Object::getDoubleInfinity ( )
inlinestaticinherited

get the infinity value for tFloat type

Returns
the intinity value for tFloat type

◆ getEpsilon()

template<class T >
static T CORE_Object::getEpsilon ( )
inlinestaticinherited

get the epsilon value for T type

Returns
the epsilon value for T type

◆ getFineElementsNumberPerCoarseElement()

const tUCInt& EMM_MultiScaleGrid::getFineElementsNumberPerCoarseElement ( ) const
inlineinherited

get the number of elements of the fine grid per cell of the corse grid

Returns
the number of elements of the fine grid per cell of the corse grid

References EMM_MultiScaleGrid::mFineElementsNumberPerCoarseElement.

Referenced by meanValuesFromFineToCoarseGrid(), and EMM_MultiScaleSDGrid::meanValuesFromShiftFineGridToCoarseGrid().

Here is the caller graph for this function:

◆ getFloatEpsilon()

static tFloat CORE_Object::getFloatEpsilon ( )
inlinestaticinherited

get the epsilon value for tFloat type

Returns
the epsilon value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getFloatInfinity()

static tFloat CORE_Object::getFloatInfinity ( )
inlinestaticinherited

get the infinity value for tFloat type

Returns
the intinity value for tFloat type

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const
inlineinherited

◆ getInfinity()

template<class T >
static T CORE_Object::getInfinity ( )
inlinestaticinherited

get the infinity for T type

Returns
the infinity value for T type

◆ getLDoubleEpsilon()

static tLDouble CORE_Object::getLDoubleEpsilon ( )
inlinestaticinherited

get the epsilon value for tLDouble type

Returns
the epsilon value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getLDoubleInfinity()

static tDouble CORE_Object::getLDoubleInfinity ( )
inlinestaticinherited

get the infinity value for tDouble type

Returns
the infinity value for tDouble type

◆ getLevelComputationsNumber() [1/2]

tUInteger& EMM_MultiScaleGrid::getLevelComputationsNumber ( )
inlineprotectedinherited

◆ getLevelComputationsNumber() [2/2]

const tUInteger& EMM_MultiScaleGrid::getLevelComputationsNumber ( ) const
inlineprotectedinherited

return the number of calls of the level computations only for debug

Returns
the number of calls of the level computations only for debug

References EMM_MultiScaleGrid::mLevelComputationsNumber, EMM_MultiScaleGrid::toString(), and tString.

Here is the call graph for this function:

◆ getLevelMagnetizationField()

EMM_RealField& EMM_MultiScaleGrid::getLevelMagnetizationField ( )
inlineinherited

get the magnetization field at level l

Returns
the magnetiaztion field at level l

Referenced by EMM_MultiScaleGrid::computeMultiGridExcitationField().

Here is the caller graph for this function:

◆ getLevelsNumber()

const tUInteger& EMM_MultiScaleGrid::getLevelsNumber ( ) const
inlineinherited

◆ getLevelUpMagnetizationField()

EMM_RealField& EMM_MultiScaleGrid::getLevelUpMagnetizationField ( )
inlineinherited

get the magnetization field at level l+1

Returns
the magnetiaztion field at level l+1

Referenced by EMM_MultiScaleGrid::computeMultiGridExcitationField().

Here is the caller graph for this function:

◆ getMaxChar()

static tChar CORE_Object::getMaxChar ( )
inlinestaticinherited

get the max value for tChar type

Returns
the max value for tChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxDouble()

static tDouble CORE_Object::getMaxDouble ( )
inlinestaticinherited

get the max value for tDouble type

Returns
the max value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxFlag()

static tFlag CORE_Object::getMaxFlag ( )
inlinestaticinherited

get the max value for the tFlag type

Returns
the max value for the tFlag type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxFloat()

static tFloat CORE_Object::getMaxFloat ( )
inlinestaticinherited

get the max value for tFloat type

Returns
the max value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxIndex()

static tIndex CORE_Object::getMaxIndex ( )
inlinestaticinherited

get the max value for the array/vector indexing type

Returns
the max value for the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxInt()

static tInt CORE_Object::getMaxInt ( )
inlinestaticinherited

get the max value for tInt type

Returns
the max value for tInt type

Referenced by MATSGN_FFT::fastFourierTransform3D_FFTW(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxInteger()

static tInteger CORE_Object::getMaxInteger ( )
inlinestaticinherited

get the max value for the integer type

Returns
the max value for the integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLDouble()

static tLDouble CORE_Object::getMaxLDouble ( )
inlinestaticinherited

get the max value for tLDouble type

Returns
the max value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLInt()

static tLInt CORE_Object::getMaxLInt ( )
inlinestaticinherited

get the max value for tLInt type

Returns
the max value for tLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLLInt()

static tLLInt CORE_Object::getMaxLLInt ( )
inlinestaticinherited

get the max value for tULInt type

Returns
the max value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxReal()

static tReal CORE_Object::getMaxReal ( )
inlinestaticinherited

get the max value for the real type

Returns
he max value for the real type

Referenced by EMM_MatterField::adimensionize(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxSInt()

static tSInt CORE_Object::getMaxSInt ( )
inlinestaticinherited

get the max value for tSInt type

Returns
the max value for tSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUChar()

static tUChar CORE_Object::getMaxUChar ( )
inlinestaticinherited

get the max value for tUChar type

Returns
the max value for tUChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUIndex()

static tUIndex CORE_Object::getMaxUIndex ( )
inlinestaticinherited

get the max value for difference the array/vector indexing type

Returns
the max value for difference the array/vector indexing type

Referenced by CORE_Vector< T >::addAfterIndices(), CORE_Vector< T >::search(), CORE_Test::testType(), CORE_Integer::toHexString(), and CORE_Integer::toString().

Here is the caller graph for this function:

◆ getMaxUInt()

static tUInt CORE_Object::getMaxUInt ( )
inlinestaticinherited

get the max value for tUInt type

Returns
the max value for tUInt type

Referenced by EMM_Array< tCellFlag >::loadFromFile(), EMM_RealField::loadFromFile(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUInteger()

static tUInteger CORE_Object::getMaxUInteger ( )
inlinestaticinherited

get the max value for the unsigned integer type

Returns
the max value for the unsigned integer type

Referenced by MATH_Pn::computeExtrenums(), EMM_MultiScaleGrid::computeLevelsNumber(), EMM_Input::restoreBackup(), MATH_P0::solve(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxULInt()

static tULInt CORE_Object::getMaxULInt ( )
inlinestaticinherited

get the max value for tULInt type

Returns
the max value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxULLInt()

static tULLInt CORE_Object::getMaxULLInt ( )
inlinestaticinherited

get the max value for tULLInt type

Returns
the max value for tULLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUSInt()

static tUSInt CORE_Object::getMaxUSInt ( )
inlinestaticinherited

get the max value for tUSInt type

Returns
the max value for tUSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinChar()

static tChar CORE_Object::getMinChar ( )
inlinestaticinherited

get the min value for tChar type

Returns
the min value for tChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinDouble()

static tDouble CORE_Object::getMinDouble ( )
inlinestaticinherited

get the min value for tDouble type

Returns
the min value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinFlag()

static tFlag CORE_Object::getMinFlag ( )
inlinestaticinherited

get the min value for the tFlag type

Returns
the min value for the tFlag type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinFloat()

static tFloat CORE_Object::getMinFloat ( )
inlinestaticinherited

get the min value for tFloat type

Returns
the min value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinIndex()

static tIndex CORE_Object::getMinIndex ( )
inlinestaticinherited

get the min value for the array/vector indexing type

Returns
the min value for the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinInt()

static tInt CORE_Object::getMinInt ( )
inlinestaticinherited

get the min value for tInt type

Returns
the min value for tInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinInteger()

static tInteger CORE_Object::getMinInteger ( )
inlinestaticinherited

get the min value for the integer type

Returns
the minin value for the integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLDouble()

static tLDouble CORE_Object::getMinLDouble ( )
inlinestaticinherited

get the min value for tLDouble type

Returns
the min value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLInt()

static tLInt CORE_Object::getMinLInt ( )
inlinestaticinherited

get the min value for tLInt type

Returns
the min value for tLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLLInt()

static tLLInt CORE_Object::getMinLLInt ( )
inlinestaticinherited

get the min value for tLLInt type

Returns
the min value for tLLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinReal()

static tReal CORE_Object::getMinReal ( )
inlinestaticinherited

get the min value for the real type

Returns
the min value for the real type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinSInt()

static tSInt CORE_Object::getMinSInt ( )
inlinestaticinherited

get the min value for tSInt type

Returns
the min value for tSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUChar()

static tUChar CORE_Object::getMinUChar ( )
inlinestaticinherited

get the min value for tUChar type

Returns
the min value for tUChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUIndex()

static tUIndex CORE_Object::getMinUIndex ( )
inlinestaticinherited

get the min value for difference the array/vector indexing type

Returns
the min value for difference the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUInt()

static tUInt CORE_Object::getMinUInt ( )
inlinestaticinherited

get the min value for tUInt type

Returns
the min value for tUInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUInteger()

static tUInteger CORE_Object::getMinUInteger ( )
inlinestaticinherited

get the min value for the unsigned integer type

Returns
the min value for the unsigned integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinULInt()

static tULInt CORE_Object::getMinULInt ( )
inlinestaticinherited

get the min value for tULInt type

Returns
the min value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinULLInt()

static tULLInt CORE_Object::getMinULLInt ( )
inlinestaticinherited

get the min value for tULLInt type

Returns
the min value for tULLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUSInt()

static tUSInt CORE_Object::getMinUSInt ( )
inlinestaticinherited

get the min value for tUSInt type

Returns
the min value for tUSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getOut()

static SP::CORE_Out CORE_Object::getOut ( )
inlinestaticinherited

get the output

Returns
the shared pointer to the output stream

References CORE_Object::OUT.

◆ getPeriodicDirections() [1/2]

const tBoolean* EMM_MultiScaleGrid::getPeriodicDirections ( ) const
inlineinherited

get the periodicity per direction

Returns
if the direction is periodic indexed by the index of the direction (x=0,y=1,z=2)

References EMM_MultiScaleGrid::mIsPeriodic.

Referenced by completeValuesOutsideFineGridByPeriodicityByExclusion(), EMMG_SLRPPeriodicMultiScale::computeMultiGridExcitationField(), EMMG_SLSDXPeriodicMultiScale::computeMultiGridExcitationField(), EMM_MultiScaleSDGrid::computeValuesOnShiftFineGrid(), and meanValuesFromFineToCoarseGrid().

Here is the caller graph for this function:

◆ getPeriodicDirections() [2/2]

void EMM_MultiScaleGrid::getPeriodicDirections ( tBoolean isXPeriodic,
tBoolean isYPeriodic,
tBoolean isZPeriodic 
) const
inlineinherited

get the periodicity per direction

Parameters
isXPeriodic: true if the x-direction is periodic
isYPeriodic: true if the y-direction is periodic
isZPeriodic: true if the z-direction is periodic

◆ getPointerAddress()

tString CORE_Object::getPointerAddress ( ) const
inlineinherited

return the identity string of the object

Returns
the identity string of the object

References CORE_Object::pointer2String().

Here is the call graph for this function:

◆ getRealEpsilon()

static tReal CORE_Object::getRealEpsilon ( )
inlinestaticinherited

get the eps which is the difference between 1 and the least value greater than 1 that is representable.

Returns
the eps which is the difference between 1 and the least value greater than 1 that is representable.

Referenced by MATH_P4::solveP4De(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getRealInfinity()

static tReal CORE_Object::getRealInfinity ( )
inlinestaticinherited

◆ getSegmentsNumber() [1/2]

void EMM_MultiScaleGrid::getSegmentsNumber ( tUInteger Nx,
tUInteger Ny,
tUInteger Nz 
) const
inlineinherited

get the segments number in all directions

Parameters
Nxthe segments number in x-direction
Nythe segments number in y-direction
Nzthe segments number in z-direction

◆ getSegmentsNumber() [2/2]

const tUInteger* EMM_MultiScaleGrid::getSegmentsNumber ( ) const
inlineinherited

◆ getSharedPointer() [1/2]

void CORE_Object::getSharedPointer ( SP::CORE_Object &  p)
inlineinherited

◆ getSharedPointer() [2/2]

void CORE_Object::getSharedPointer ( SPC::CORE_Object &  p) const
inlineinherited

get the shared pointer of this class into p

Parameters
p: shared pointer of the class This

◆ getThread()

static CORE_Thread& CORE_Object::getThread ( )
inlinestaticinherited

get the profilier

Returns
the profiler

Referenced by MATH_MaskVector::add(), MATH_Vector::add(), EMM_DisplacementFEMOperator::addBoundaryElasticStress(), EMM_DisplacementFEMOperator::buildDataOnNeumannBoundaryFaces(), EMM_DisplacementFVMOperator::computeCineticEnergy(), EMM_DisplacementFVMOperator::computeElasticStress(), EMM_DisplacementFEMOperator::computeElasticStress(), EMM_DisplacementFVMOperator::computeElasticTensor(), EMM_DisplacementFEMOperator::computeElasticTensor(), EMM_StaticMagneticTensorOperator::computeEnergy(), EMM_CubicAnisotropyOperator::computeEnergy(), EMM_MagnetostrictionOperator::computeEnergy(), EMM_DisplacementOperator::computeEnergy(), EMM_AnisotropyOperator::computeEnergyWithMagneticExcitation(), EMM_DisplacementFVMOperator::computeEquilibriumMatrixDiagonalConditioner(), EMM_DisplacementFEMOperator::computeEquilibriumMatrixDiagonalConditioner(), EMM_FullExchangeOperator::computeMagneticExcitationField(), EMM_StaticMagnetostrictionOperator::computeMagneticExcitationField(), EMM_LinearAnisotropyOperator::computeMagneticExcitationField(), EMM_StaticMagneticTensorOperator::computeMagneticExcitationField(), EMM_CubicAnisotropyOperator::computeMagneticExcitationField(), EMM_MinimalExchangeOperator::computeMagneticExcitationField(), EMM_AnisotropyOperator::computeMagneticExcitationField(), EMM_MagnetostrictionOperator::computeMagneticExcitationField(), EMM_CubicAnisotropyOperator::computeMagneticExcitationFieldGradient(), EMM_AnisotropyOperator::computeMagneticExcitationFieldGradient(), EMM_DisplacementFVMOperator::computeMagneticStress(), EMM_DisplacementFEMOperator::computeMagneticStress(), EMM_OptimalTimeStep::computeOptimalTimeStep(), EMM_DisplacementFEMOperator::computeStressConstraintEnergy(), EMM_FullExchangeOperator::discretize(), EMM_MinimalExchangeOperator::discretize(), EMM_CondensedMassMatrix::discretize(), EMM_LinearAnisotropyOperator::discretize(), EMM_AnisotropyOperator::discretize(), EMM_DemagnetizedOperator::discretize(), EMMG_SLDemagnetizedOperator::discretize(), EMM_LandauLifschitzSystem::discretize(), MATH_Vector::divide(), MATH_MaskVector::dot(), MATH_Vector::dot(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_4Tensors::doubleDotCrossProduct(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_4Tensors::doubleDotProduct(), MATH_Vector::init(), MATH_MaskVector::init(), EMM_LandauLifschitzODE_RK::integrateMagnetizationFieldAtTime(), EMM_DisplacementFVM_Interpolator::interpolateUAtVertices(), EMMG_SLDemagnetizedOperator::localAssembly(), EMM_DisplacementOperator::nullProjectionOnDirichletBoundary(), EMM_DisplacementOperator::periodicProjection(), EMM_2PackedSymmetricTensors::product(), EMM_CanonicalMassMatrix::product(), MATH_FullMatrix::product(), EMM_CondensedMassMatrix::product(), EMM_BlockMassMatrix::product(), MATH_MorseMatrix::product(), EMMG_SLDemagnetizedOperator::product(), EMM_DisplacementOperator::projectionOnDirichletBoundary(), EMM_LandauLifschitzSystem::resetOperatorsToInitialState(), EMM_DisplacementFVMOperator::setBoundaryFaceTypes(), FFTW_MultiDFTs::setFFT(), FFTW_MultiLevelsDFT::setFFT(), FFTW_MultiLevelsDFT::setLevels(), FFTW_MultiDFTs::setPlan(), FFTW_MultiLevelsDFT::setPlan(), EMM_CondensedMassMatrix::solve(), EMM_LandauLifschitzODE::solveODE(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_CanonicalMassMatrix::symmetricDot(), EMM_CondensedMassMatrix::symmetricDot(), EMM_BlockMassMatrix::symmetricDot(), FFTW_Test::test(), MATH_SolverTest::test(), EMM_ODETest::testODE(), and EMM_Grid3D::updateLimitConditionOnPoints().

Here is the caller graph for this function:

◆ getToeplitzMatrix()

const MATH_MultiLevelsToeplitzMatrix& EMM_MultiScaleGrid::getToeplitzMatrix ( ) const
inlineinherited

◆ getTypeName()

template<class T >
static tString CORE_Object::getTypeName ( )
inlinestaticinherited

get type name

Returns
the type name of the class

References tString.

◆ getZonalMagnetizationField()

EMM_RealField& EMM_MultiScaleGrid::getZonalMagnetizationField ( )
inlineinherited

◆ initialize()

void EMM_MultiScaleCDGrid::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 
)
virtual

set the discretization

Parameters
dimdimension of the field
Nx: number of segements along x-direction
Ny: number of segements along y-direction
Nz: number of segements along z-direction
Px: periodicity along x-direction
Py: periodicity along y-direction
Pz: periodicity along z-direction
l: number of levels
  • initialize the fine grid bounds with a corse grid
  • initialise the size of the M fields.
  • compute the number of elements from the fine grid included in one element of the coarse grid.

Reimplemented from EMM_MultiScaleGrid.

Reimplemented in EMM_MultiScaleSDGrid.

References EMM_MultiScaleGrid::initialize().

Referenced by EMM_MultiScaleSDGrid::initialize(), and New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is32Architecture()

static tBoolean CORE_Object::is32Architecture ( )
inlinestaticinherited

return true if the machine is a 32 bits machine

Returns
true is the computing is done in a 32 bits machine

References CORE_Object::pointer2String(), CORE_Object::printObjectsInMemory(), and tString.

Referenced by CORE_Test::testType().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is64Architecture()

static tBoolean CORE_Object::is64Architecture ( )
inlinestaticinherited

return true if the machine is a 64 bits machine

Returns
true is the computing is done in a 64 bits machine

Referenced by EMM_VTK::getVTKType(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ isInstanceOf() [1/2]

template<class T >
tBoolean CORE_Object::isInstanceOf ( ) const
inlineinherited

test if the clas T is an instance of this class

Returns
true if the object is an instance of T

References null.

Referenced by MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ isInstanceOf() [2/2]

tBoolean CORE_Object::isInstanceOf ( const tString name) const
inlineinherited

test if the object is an instance of className

Parameters
namename of the class
Returns
true if the object is an instance of class Name

References CORE_Object::getIdentityString().

Here is the call graph for this function:

◆ isMemoryChecked()

static const tBoolean& CORE_Object::isMemoryChecked ( )
inlinestaticinherited

get if the memory checking is used

Returns
true: if the memory checking is used.

References CORE_Object::getClassName(), CORE_Object::mIsMemoryTesting, and tString.

Referenced by main().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ meanValuesFromFineToCoarseGrid()

void EMM_MultiScaleCDGrid::meanValuesFromFineToCoarseGrid ( const tUIndex nCells,
const tDimension dim,
const tReal Mf,
tReal Ml 
) const

compute the field in a corse field from its fine grid.

Parameters
[in]nCellsnumber of cells of the mesh
[in]dimdimension of the field
[in]Mf: the finest field values of size dim . Nx . Ny . Nz
[out]Ml: the coarse field values of size dim . Nx . Ny . Nz
Step 1 the finest grid with Nx=Ny=4 and Nz=1
Step 2 value of the field in the coarse grid is in green value/td>

the values of the field is meaned in the common part of the both grids as follow:

  • $ M^1_{11}=\displaystyle \frac{1}{4}\left ( M^0_{00}+M^0_{01}+M^0_{10}+M^0_{11}\right )$
  • $ M^1_{12}=\displaystyle \frac{1}{4}\left ( M^0_{10}+M^0_{11}+M^0_{20}+M^0_{21}\right )$
  • $ M^1_{21}=\displaystyle \frac{1}{4}\left ( M^0_{02}+M^0_{03}+M^0_{12}+M^0_{13}\right )$
  • $ M^1_{22}=\displaystyle \frac{1}{4}\left ( M^0_{22}+M^0_{23}+M^0_{32}+M^0_{33}\right )$

The values outside the fine grid $ M^1 $ are set to 0 by defaut.

For each element of the fine grid (i,j,k), the corresponding element (I(i),J(j),K(k)) of the coarse grid is searched such that the center of the element (i,j,k) of the finest grid is inside the element (I,J,K) of the coarse grid.

The left boundary of the coarse grid is $ y_I=-N_x+2.I $ when the origin is at the center of the grid

The center of the cell i of the fine grid is $ x_i=\frac{1}{2}+i-\frac{N_x}{2}$ when the origin is at the center of the grid

So, to search the cell of the coarse grid containing the center of the fine grid leads to $ y_I \leq x_i < y_{I+1} $. We conclude that

  • $ I(i)=\displaystyle E(\frac{N_x+1+2.i}{4}) $
  • $ J(j)=\displaystyle E(\frac{N_y+1+2.j}{4}) $
  • $ K(k)=\displaystyle E(\frac{N_z+1+2.k}{4}) $.

So than $ M_l(I,J,K)= \sum_{i,j,k} M_f(i,j,k) $ for all (i,j,k) such that I(i)=I, J(j)=J and K(k)=k

In the reverse way, we have $ i \in \{ E_{N_x}(\frac{4.I-N_x-1+4}{2}) , E_{N_x}(\frac{4.I-N_x-1+2}{2} \} $ where $ E_{N_x}(x)=null $ for $ x <0 $ or $ x\geq N_x$.

References EMM_MultiScaleGrid::getFineElementsNumberPerCoarseElement(), EMM_MultiScaleGrid::getPeriodicDirections(), EMM_MultiScaleGrid::getSegmentsNumber(), OMP_GET_THREAD_ID, OMP_GET_THREADS_NUMBER, OMP_PARALLEL_PRIVATE_SHARED_DEFAULT, tBoolean, tDimension, tInteger, tReal, tUCInt, tUIndex, and tUInteger.

Referenced by computeMagnetizationFieldAtNextLevel(), and New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ New()

static SP::EMM_MultiScaleCDGrid EMM_MultiScaleCDGrid::New ( )
inlinestatic

build a new instance of class

Returns
a shared pointer to This

References EMM_MultiScaleCDGrid(), initialize(), meanValuesFromFineToCoarseGrid(), tBoolean, tDimension, tReal, tUIndex, and tUInteger.

Referenced by EMM_DemagnetizedPeriodicalTest::multiCDGridScaleTest(), and EMMG_ClassFactory::NewInstance().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ out()

static CORE_Out& CORE_Object::out ( )
inlinestaticinherited

get the output

Returns
the output stream

Referenced by EMM_Matter::adimensionize(), EMM_DisplacementFVMOperator::backup(), EMM_DisplacementOperator::backup(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralVectorProjector(), EMM_Test::caseTest(), EMM_Test::caseTests(), EMM_MatterField::computeAnisotropyDirectionsField(), EMM_OptimalTimeStep::computeOptimalTimeStep(), MATH_MultiLevelsToeplitzMatrix::copy(), CORE_Exception::CORE_Exception(), EMM_MatterField::createAnisotropyOperator(), CORE_Run::createIO(), EMM_ElementaryTest::defaultBackupTest(), EMM_ElementaryTest::defaultTest(), MATH_MultiLevelsFFTToeplitzMatrix::diagonalize(), EMM_DisplacementFVMOperator::discretize(), EMM_MagnetostrictionOperator::discretize(), EMM_DisplacementFEMOperator::discretize(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_TensorsTest::doubleDotCrossDoubleDotScalarTests(), EMM_4Tensors::doubleDotCrossProduct(), EMM_TensorsTest::doubleDotCrossProductTests(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_TensorsTest::doubleDotCrossSquaredScalarTests(), EMM_4Tensors::doubleDotProduct(), EMM_TensorsTest::doubleDotProductTests(), EMM_DisplacementWaveTest::elasticWaveTest(), EMM_Test::elementaryTests(), FFTW_Test::fftwTutorial(), MATH_IntegrationTest::gaussLegendreTest(), EMM_MagnetostrictionTest::HComputingTest(), EMM_DemagnetizedPeriodicalTest::HTest(), EMMH_HysteresisTest::hysteresisDefaultCycleTest(), EMM_TensorsTest::initializationTests(), EMM_MultiScaleGrid::initialize(), EMM_MultiScaleSDGrid::initialize(), EMM_MatterField::loadFromANIFile(), EMM_AnisotropyDirectionsField::loadFromFile(), EMM_Matter::loadFromFile(), EMM_Grid3D::loadFromGEOFile(), EMM_MatterField::loadFromLOCFile(), EMM_Array< tCellFlag >::loadFromStream(), EMM_Matter::loadFromStream(), EMM_Matter::loadMattersFromFile(), EMM_Run::loadSystemFromOptions(), EMM_ElementaryTest::magnetostrictionBackupTest(), CORE_Run::make(), EMMH_Run::makeHysteresis(), EMM_Run::makeRun(), CORE_Run::makeType(), EMM_ElementaryTest::optionsTest(), MATH_PolynomialTest::P4Tests(), EMM_Test::primaryTests(), EMM_LandauLifschitzSystem::printLog(), CORE_Run::printOptions(), EMM_2PackedSymmetricTensors::product(), EMMG_SLDemagnetizedOperator::projectionOnSpectralSpace(), CORE_Run::readOptionsFromCommandLine(), CORE_Test::readVectorTest(), EMM_DemagnetizedPeriodicalTest::relaxationTest(), EMM_DisplacementFVMOperator::restore(), EMM_DisplacementOperator::restore(), EMM_Input::restoreBackup(), EMMH_Hysteresis::run(), EMM_Output::save(), EMM_AnisotropyDirectionsField::saveToFile(), EMM_MatterField::saveToFile(), EMM_Grid3D::saveToGEOFile(), CORE_IOTest::searchTest(), EMMH_Hysteresis::setInitialMagnetizationField(), MATH_MultiLevelsToeplitzMatrix::setLevels(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_TensorsTest::squaredDoubleDotCrossScalarTests(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_TensorsTest::squaredDoubleDotScalarTests(), EMM_TensorsTest::squaredDoubleDotTests(), EMM_MatterTest::testAdimensionize(), EMM_MatterTest::testANIFile(), CORE_Test::testComplex(), CORE_Test::testDateWeek(), FFTW_Test::testDFT(), EMM_MatterTest::testIO(), EMM_ODETest::testODE(), CORE_Test::testOut(), CORE_Test::testReal(), EMM_FieldTest::testRealArray(), EMM_Grid3DTest::testSegment(), EMM_Grid3DTest::testThinSheet(), CORE_Test::testTime(), CORE_Test::testType(), MATH_FullMatrix::toString(), EMM_DemagnetizedPeriodicalTest::xyPeriodicalCubeSDGTest(), and EMM_DemagnetizedPeriodicalTest::xyPeriodicalSheetSDGTest().

Here is the caller graph for this function:

◆ pointer2String()

tString CORE_Object::pointer2String ( const void *  obj)
staticinherited

return the string representation of a pointer

Parameters
obj: oject to get the string pointer
Returns
the string pointer of the object

References tString.

Referenced by CORE_Object::CORE_Object(), CORE_Object::getIdentityString(), CORE_Object::getPointerAddress(), CORE_Object::is32Architecture(), and CORE_Object::~CORE_Object().

Here is the caller graph for this function:

◆ printObjectsInMemory() [1/2]

void CORE_Object::printObjectsInMemory ( ostream &  f)
staticinherited

print object in memory

Parameters
f: output to print the objects in memory

References CORE_Object::getIdentityString(), CORE_Object::getSharedPointer(), CORE_Object::mIsMemoryTesting, CORE_Object::mObjects, and tInteger.

Here is the call graph for this function:

◆ printObjectsInMemory() [2/2]

static void CORE_Object::printObjectsInMemory ( )
inlinestaticinherited

print object in memory in the standart output

Referenced by CORE_Object::is32Architecture(), and main().

Here is the caller graph for this function:

◆ resetBlockValues()

tBoolean EMM_MultiScaleGrid::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 
)
staticinherited

reset the values in a block grid [iMin,iMax[x[jMin,jMax[x[kMin,kMax[ of dimension dim per point inside a grid of size [0,Nx[x[0,Ny[x[0,Nz[

Parameters
[in]dimdimension of point
[in]Nx: size of the grid in the x direction
[in]Ny: size of the grid in the y direction
[in]Nz: size of the grid in the z direction
[in]iMinbounds if the block grid in [0,Nx[
[in]iMaxbounds if the block grid in [0,Nx[
[in]jMinbounds if the block grid in [0,Ny[
[in]jMaxbounds if the block grid in [0,Ny[
[in]kMinbounds if the block grid in [0,Nz[
[in]kMaxbounds if the block grid in [0,Nz[
[in,out]M: field to reset values within the block grid
Returns
false if the block is empty

M is set to 0 on all points inside the grid [iMin,iMax[x[jMin,jMax[x[kMin,kMax[

References null, OMP_PARALLEL_PRIVATE_SHARED_DEFAULT, tReal, tUIndex, and tUInteger.

Referenced by EMM_MultiScaleGrid::getZonalMagnetizationField(), resetValuesWithinCenteredZone(), and EMM_MultiScaleSDGrid::resetValuesWithinShiftZone().

Here is the caller graph for this function:

◆ resetOut()

static void CORE_Object::resetOut ( )
inlinestaticinherited

reset the output stream

Referenced by run().

Here is the caller graph for this function:

◆ resetThread()

static void CORE_Object::resetThread ( )
inlinestaticinherited

reset the output stream

Referenced by run().

Here is the caller graph for this function:

◆ resetValuesWithinCenteredZone()

tBoolean EMM_MultiScaleCDGrid::resetValuesWithinCenteredZone ( const tUIndex nCells,
const tDimension dim,
tReal Mz 
) const

◆ setIsMemoryChecked()

static void CORE_Object::setIsMemoryChecked ( const tBoolean v)
inlinestaticinherited

set if the memory checking is used

Parameters
v: true to check memory

Referenced by main().

Here is the caller graph for this function:

◆ setOut()

static void CORE_Object::setOut ( SP::CORE_Out  out)
inlinestaticinherited

set the output stream

Parameters
out: the shared pointer to the new output stream

References null.

◆ setThis()

void CORE_Object::setThis ( SP::CORE_Object  p)
inlineprotectedinherited

set this weak shared pointer called toDoAfterThis setting method

Parameters
p: shared pointer of the class This

References CORE_Object::toDoAfterThisSetting().

Here is the call graph for this function:

◆ setThread()

static void CORE_Object::setThread ( SP::CORE_Thread  thread)
inlinestaticinherited

set the thread

Parameters
threadthe shared pointer to the thread

References null.

Referenced by EMM_Run::EMM_Run(), EMM_TensorsRun::EMM_TensorsRun(), and MATH_SolverRun::MATH_SolverRun().

Here is the caller graph for this function:

◆ setToeplitzMatrix()

void EMM_MultiScaleGrid::setToeplitzMatrix ( SP::MATH_MultiLevelsToeplitzMatrix  toeplitz)
inlineinherited

setthe toeplitz associated matrix

Parameters
toeplitzthe toeplitz matrix to set

References EMM_MultiScaleGrid::computeLevelsNumber(), EMM_MultiScaleGrid::initialize(), tBoolean, tDimension, and tUInteger.

Here is the call graph for this function:

◆ SP_OBJECT()

EMM_MultiScaleCDGrid::SP_OBJECT ( EMM_MultiScaleCDGrid  )
private

◆ toDoAfterThisSetting()

virtual void EMM_Object::toDoAfterThisSetting ( )
inlineprotectedvirtualinherited

method called after the setting of the shared pointer this method can only be called once.

Reimplemented from CORE_Object.

Reimplemented in EMM_DisplacementOperator, EMM_DisplacementFVMOperator, EMM_GaussLegendreRelaxation, and EMM_GradGaussLegendreRelaxation.

Referenced by EMM_GaussLegendreRelaxation::toDoAfterThisSetting(), and EMM_DisplacementOperator::toDoAfterThisSetting().

Here is the caller graph for this function:

◆ toString()

tString EMM_MultiScaleGrid::toString ( ) const
virtualinherited

return the class information in a tString

Reimplemented from CORE_Object.

Reimplemented in EMMG_SLPeriodicMultiScale.

References CORE_Object::getIdentityString().

Referenced by EMM_MultiScaleGrid::getLevelComputationsNumber().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ Gamma

const tReal EMM_Object::Gamma =-1.7e11
staticinherited

◆ Mu0

const tReal EMM_Object::Mu0 =4*M_PI*1e-07
staticinherited

◆ NULL_VALUE

const tReal EMM_Object::NULL_VALUE ={0,0,0}
staticinherited

◆ SAVE_H_M_AT_LEVEL_1

tBoolean EMM_MultiScaleGrid::SAVE_H_M_AT_LEVEL_1 =false
staticinherited

◆ X

const tDimension EMM_Object::X =0
staticinherited

◆ Y

const tDimension EMM_Object::Y =1
staticinherited

◆ Z

const tDimension EMM_Object::Z =2
staticinherited

The documentation for this class was generated from the following files: