This class describes a resolution of landau-lifschitz system of the Core Package for E-MicroM. More...

#include <EMM_LandauLifschitzSystem.h>

Inheritance diagram for EMM_LandauLifschitzSystem:

[legend]

Collaboration diagram for EMM_LandauLifschitzSystem:

Public Member Functions
tBoolean	setMesh (SP::EMM_Grid3D mesh)
	set the mesh More...

const EMM_Grid3D &	getMesh () const
	return the mesh associated to the problem for reading More...

EMM_Grid3D &	getMesh ()
	return the mesh associated to the problem for writing More...

const tUIndex &	getMagnetizedElementsNumber () const
	get the number of mage,ntozed elements More...

const EMM_MatterField &	getMatterField () const
	return the matter index for each cell for reading More...

EMM_MatterField &	getMatterField ()
	return the matter index for each cell for writing More...

const tString &	getPrefix () const
	get the prefix of the generating files More...

const tString &	getOutputPath () const
	get the output path in which the files are generated More...

virtual void	adimensionize ()
	adimensionize the system: It get the max length of the cell and adimensionize the physical parameters of all matters see EMM_Matter::adimensionize() and compute the charactristic time see EMM_Stepper::setCharacteriticTime() More...

virtual tBoolean	discretize (const tBoolean &isMnormalized)
	discretize the problem More...

tBoolean	discretize ()
	discretize the problem More...

virtual tBoolean	addOperator (SP::EMM_MagneticExcitationOperator op)
	add an operator More...

void	clearOperators ()
	clear all operators More...

const SV::EMM_MagneticExcitationOperator &	getOperators () const
	return the operators vector More...

SV::EMM_MagneticExcitationOperator &	getOperators ()
	return the operators vector More...

tUIndex	getOperatorsNumber () const
	return the number of operators More...

const EMM_Operator &	getOperator (const tUIndex &index) const
	get the operator at index for reading More...

EMM_Operator &	getOperator (const tUIndex &index)
	get the operator at index for writing More...

tBoolean	isAffine () const
	return true if the system has only affine operators More...

tBoolean	resetToInitialState ()
	reset to initial state More...

virtual tBoolean	resetOperatorsToInitialState ()
	initialize the problem More...

void	computeFunction (const EMM_RealField &M, const EMM_RealField &H, EMM_RealField &F) const
	compute the landau-lifschitz function More...

void	computeGradFunction (const EMM_RealField &M, const EMM_RealField &H, const EMM_RealField &D, const EMM_RealField &gradH, EMM_RealField &gradF) const
	compute the gradient landau-lifschitz function at the direction D in M More...

void	computePartialGradMFunction (const EMM_RealField &M, const EMM_RealField &H, const EMM_RealField &D, EMM_RealField &gradF) const
	compute the partial gradient with respect to M of landau-lifschitz function at the direction D in M More...

void	setInitialMagnetization (const tString &dataFile)
	set the initialization data for magnetization field More...

void	setInitialMagnetization (const tReal data[3])
	set the initialization data for magnetization field More...

void	setInitialMagnetization (const tReal &M0, const tReal &M1, const tReal &M2)
	set the initialization data for magnetization field More...

void	setInitialMagnetization (const EMM_RealField &data)
	set the initialization data for magnetization field More...

void	setEvolutionScheme (const tFlag &f)
	set the evolution scheme More...

const tFlag &	getEvolutionScheme () const
	return the evolution scheme between M & opertaor fields More...

tBoolean	isMagnetizationStatic () const
	return true if M is permanent More...

const EMM_RealField &	getMagnetizationField () const
	return the adimensionized magnetisation field associated to the problem for reading at time 0 of the current time step More...

EMM_RealField &	getMagnetizationField ()
	return the adimensionized magnetizaton field associated to the problem for writing at time 0 of the current time step More...

const EMM_RealField &	getMagnetizationFieldTimeDerivative () const
	get the magnetization variation field with respect to time at time 0 of the current time step More...

EMM_RealField &	getMagnetizationFieldTimeDerivative ()
	get the magnetization variation field with respect to time at time 0 of the current time step More...

const EMM_RealArray &	getSigma () const
	get the sigma parameters More...

void	computeMagnetizationFieldTimeDerivative (const EMM_RealField &Mt, const EMM_RealField &Ht, EMM_RealField &Ft) const
	compute the time variation of magnetization field at Mt and Ht for time t of the current time step More...

EMM_RealField &	getWorkingMagneticExcitationField () const
	get mutable adimensionized magnetic excitation working field More...

const EMM_RealField &	getMagneticExcitationField () const
	get adimensionized magnetic excitation at time 0 of time step More...

EMM_RealField &	getMagneticExcitationField ()
	get adimensionized magnetic excitation at time 0 of time step More...

void	computeMagneticExcitationField (const EMM_RealField &M, EMM_RealField &H) const
	compute the total adimensionized magnetic excitation H of the system (real magnetic excitation is ) More...

void	computeMagnetizationExcitationField (const EMM_RealField &M, EMM_RealField &H) const
	compute the magnetic excittaion corresponting the the magnetized operator ) More...

const EMM_RealField &	computeMagneticExcitationField ()
	compute the total adimensionized magnetic excitation H of the system (real magnetic excitation is ) More...

tReal	computeMagneticExcitationFieldAndEnergies (const EMM_RealField &M, EMM_RealField &H, tReal Es[]) const
	compute the total adimensionized magnetic excitation H of the system (real magnetic excitation is ) and return its energy More...

virtual void	computeLandauLifschitzFields (const EMM_RealField &M, const EMM_RealField &H, EMM_RealField &F)
	compute the landau lifschitz fields More...

void	computeMeanMagnetizationField (tReal *meanM) const
	compute the mean of magnetization field with respect of sigma weight at time 0 of time step More...

void	computeMeanField (const EMM_RealField &F, tReal *meanF) const
	compute the mean of field over the magnetized domain More...

const tReal &	getEnergy () const
	return the energy More...

const tReal &	getEnergyTimeDerivative (tReal &dE_dt) const
	return the energy and its first derivative with respect to time More...

void	setMinimumEnergyVariation (const tReal &v)
	set minimum energy variation under which the relaxation is supposed to be reached More...

const tReal &	getMinimumEnergyVariation () const
	get minimum energy variation under which the relaxation is supposed to be reached More...

tReal	computeEnergy () const
	compute the energy More...

tReal	computeEnergyTimeDerivative (const EMM_RealField &F, const EMM_RealField &H) const
	compute the energy derivative with rsepect to t More...

void	setMinimumTimeStep (const tReal &v)
	set minimum time step under which the relaxation process is supposed to be reached More...

const tReal &	getMinimumTimeStep () const
	get minimum time step under which the relaxation process is supposed to be reached More...

virtual const tUInteger &	getTimeStepsNumber () const =0
	return the computed time steps More...

virtual const tReal &	getTime () const =0
	return the current time More...

virtual const tReal &	getTimeStep () const =0
	return the current time step More...

tBoolean	setStepper (SP::EMM_Stepper time)
	set the reverse time relation More...

void	resetStepper ()
	reset the reverse time relation More...

const EMM_Stepper &	getStepper () const
	get the time descriptor for reading More...

EMM_Stepper &	getStepper ()
	get the time descriptor for writing More...

virtual void	integrate (const tBoolean &isRestoring, tSInt &retCode)=0
	integrate the system over the time More...

virtual tString	getInformation (const tUSInt &retCode)
	return the information relativly to ret code of the integrate method More...

void	setIsLogPrinted (const tBoolean &v)
	set if the log is printed in log file More...

const tBoolean &	isLogPrinted () const
	get if the log is printed in log file More...

void	printLog (const tUInteger &timeStep, const tReal &t, const map< tString, tString > &stepperData, const tUIndex &nMagnetizedElements, const tReal Es[], const tReal &dE_dt, const tReal &DeltaE_DeltaT, const tReal meanM, const tReal meanH) const
	print the log More...

void	setOutputPath (const tString &currentPath, const tString &path, const tString &prefix)
	set the output path More...

void	setBackupStep (const tUInteger &n)
	set the backup steps to save relaxation More...

void	setBackupsNumber (const tUInteger &n)
	set the backups number More...

void	setIsBackupEnabled (const tBoolean &v)
	set if the backup is enabled More...

const tBoolean &	isBackupEnabled () const
	get if the backup is enabled More...

const tUInteger &	getBackupsNumber () const
	get the backups number More...

const tUInteger &	getBackupStep () const
	get the backup step More...

virtual tString	toString () const
	turn the class into a string 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 tUSInt	getEnergiesNumber ()
	return the energie number 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_Out &	out ()
	get the output More...

static SP::CORE_Out	getOut ()
	get the output More...

static CORE_Thread &	getThread ()
	get the profilier More...

static const tBoolean &	isMemoryChecked ()
	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 const tSInt	MIN_CODE =-4

static const tSInt	MAGNETIZATION_FIELD_UPDATE_ERROR =-4

static const tSInt	OPERATORS_FIELDS_UPDATE_ERROR =-3

static const tSInt	E_INCREASING =-2

static const tSInt	E_IS_NAN =-1

static const tSInt	RELAXATION_IS_REACHED =0

static const tSInt	DE_DT_MIN_IS_REACHED =1

static const tSInt	MAXIMUM_ITERATION_IS_REACHED =2

static const tSInt	M_PARALLEL_H =3

static const tSInt	DT_MIN_IS_REACHED =4

static const tFlag	OsM =1

static const tFlag	MOs =2

static const tFlag	M =3

static const tFlag	Os =4

static const tReal	Mu0 =4M_PI1e-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
	EMM_LandauLifschitzSystem (void)
	create the class More...

virtual	~EMM_LandauLifschitzSystem (void)
	destroy the class More...

tBoolean	computeOperatorsFieldsAtTime (const tReal &t, const tFlag &order, const EMM_RealArray &sigma, const EMM_RealField &dM_dt, const EMM_RealField &M)
	compute the fields of all operators at time t More...

tBoolean	updateOperatorsAtNextTimeStep (const tReal &dt, const EMM_RealArray &sigma, const EMM_RealField &Mt)
	update the operator at next time time with respect of the value of the magnetization field at next time More...

tBoolean	initializeOperators (const EMM_RealArray &sigma, const EMM_RealField &M)
	initialize the data of operator field at t=0 from M More...

tReal *	getEnergies ()
	get the energies More...

tReal &	getEnergyTimeDerivative ()
	get the energgy time derivative 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_LandauLifschitzSystem)

Private Attributes
tString	mOutputPath

tString	mPrefix

tUInteger	mBackupStep

tUInteger	mBackupsNumber

tBoolean	mIsBackupEnabled

tBoolean	mIsLogPrinted

tString	mMInitialDataFile

SP::EMM_RealField	mMInitialData

tFlag	mEvolutionScheme

tReal	mMinDt

tReal	mMinEnergyVariation

tReal	mEs [MAX_OPERATORS+1]

tReal	mdE_dt

SP::EMM_LandauLifschitzFunction	mLLFunction

SP::EMM_Grid3D	mMesh

SP::EMM_MatterField	mMatters

SV::EMM_MagneticExcitationOperator	mOperators

SP::EMM_Stepper	mStepper

SP::EMM_RealArray	mSigma

SP::EMM_RealField	mM

SP::EMM_RealField	mF

SP::EMM_RealField	mH

SP::EMM_RealField	mHop

Static Private Attributes
static const tString	RET_STRING []

static const tFlag	MAX_OPERATORS =5

Detailed Description

This class describes a resolution of landau-lifschitz system of the Core Package for E-MicroM.

The physical problem consists in solving the equation :

$\displaystyle \frac{\partial M}{\partial \tau} = \displaystyle - | \gamma | \mu_0 \left ( M \wedge H(M) + \frac{\beta}{M_s} M \wedge ( M \wedge H(M) ) \right )$

where :

is the total magnetic excitation
the magnetization field
$\tau$ is the time in second
is the magnetization at saturation
$\mu_0$ is vacuum permeability
$\gamma$ is the gyroscopic precession
$\beta$ is the absorption coefficient

By default, the physical values are:

$\mu_0=4\pi e^{-7} m.kg.s^{-2}.A^{-2}$
$\gamma=-1.7e^{11} A.s.kg^{-1}$
$\beta=\frac{1}{2}$ (which may depend on matter)

We will adimensionize the equation by :

$M(X)=M_s \sigma(X) m$ where m is adimensionized and $\displaystyle \sigma(X)=\frac{M_s(X)}{M_s}$ with is the magnetization at saturation in point X
, where h and H are not necessarly linears
$\tau=\bar{t} t$ where t is adimensionized and $\bar{t}$ in seconds.
$\Omega=\sum_{\Omega_i} \Omega_i$ a set of domains in which matter is uniform.

With this kind of normalization, the adimensionized equation is:

$\displaystyle \frac{\partial m}{\partial t} = - \displaystyle \left ( m \wedge h(m) + \beta \sigma(x) m \wedge \left ( m \wedge h(m) \right) \right ) = f(m)$

with $\tau=\displaystyle \frac{t}{|\gamma| \mu_0 M_s}$ . The caracteristic time is $\bar t=\displaystyle \frac{1}{|\gamma| \mu_0 M_s}$ expressed in secunds. see EMM_LandauLifschitzSystem class for description of the system

We note :

$B=\mu_0 \cdot H$ the magnetic field.
, the adimensionized length relation with real length where L is the caracteristic dimension of a mesh cell. Its order is about $1 \mu m$ .
$\omega=\sum_{\omega_i} \omega_i$ the corresponding set of adimensionized domains in which matter is uniform.

The energy of the system is

$E=\int_\Omega E_c(M) d\Omega$ with the relation $\displaystyle \frac{dE_c}{dM}=-2B(M)$ .

So, $\displaystyle -\frac{1}{2\mu_0} \frac{dE}{dt}=\displaystyle \int_{\Omega} H(M) \frac{\partial M}{\partial t}$

The normalized energy is $\tilde E$ is defined as $E=\mu_0 M_s^2 L^3 \tilde E$ where $\tilde E=\displaystyle \sum_i \int_{\omega_i} \tilde e_c d\omega_i$ where $\displaystyle \frac{d\tilde e_c}{dm}(m) \cdot \delta= \displaystyle -2 \int_{\omega_i} \sigma_i h(m) \cdot \delta d\omega_i$ where $\sigma_i=\frac{M_{s_i}}{M_s}$ .

The characteritic volumic energy $\mu_0 M_s^2 L^3$ is expressed in $J=Kg \cdot m^2 \cdot s^{-2}$ .

So, we have $\displaystyle \frac{d\tilde E}{dt}=-2 \sum_i \int_{\omega_i} \sigma_i h(m)\frac{\partial m}{\partial t}dx=-2 \sum_i \int_{\omega_i} \sigma_i h(m)f(m)dx$ .

And $\displaystyle \frac{d\tilde E}{dm} \cdot \delta= \displaystyle -2 \sum_i \int_{\omega_i} \sigma_i h(m) \cdot \delta d\omega_i$

In particular case where h is linear and self-adjointness, the adimensionized energy can be written as

$\tilde E= \displaystyle - \sum_i \int_{\omega_i} \sigma_i h(m) m dx$ in order to respect the general relation $\displaystyle \frac{d\tilde E}{dm}[\delta]=-2 \sum_i \int_{\omega_i} \sigma_i h(m) \delta dx$ .

the silving of the system consists in :

adimensionizing the data by the method EMM_LandauLifschitzSystem::adimensionize().
discretizing the data by the method EMM_LandauLifschitzSystem::discretize().
computing the evolution of the magnetization field by the method EMM_LandauLifschitzSystem::makeRelaxation() by the solve() method

@author Stephane Despreaux
@version 1.0

Constructor & Destructor Documentation

◆ EMM_LandauLifschitzSystem()

EMM_LandauLifschitzSystem::EMM_LandauLifschitzSystem ( void )

protected

create the class

References CORE_Run::getClassFactory(), and mLLFunction.

Here is the call graph for this function:

◆ ~EMM_LandauLifschitzSystem()

EMM_LandauLifschitzSystem::~EMM_LandauLifschitzSystem ( void )

protectedvirtual

destroy the class

Member Function Documentation

◆ addOperator()

virtual tBoolean EMM_LandauLifschitzSystem::addOperator ( SP::EMM_MagneticExcitationOperator op )

inlinevirtual

add an operator

Parameters

op	the operator to add

Reimplemented in EMM_GradGaussLegendreRelaxation.

References null.

Referenced by EMM_GradGaussLegendreRelaxation::addOperator(), and EMMH_Hysteresis::run().

Here is the caller graph for this function:

◆ adimensionize()

void EMM_LandauLifschitzSystem::adimensionize ( )

virtual

adimensionize the system: It get the max length of the cell and adimensionize the physical parameters of all matters see EMM_Matter::adimensionize() and compute the charactristic time see EMM_Stepper::setCharacteriticTime()

References getStepper(), mMatters, mMesh, mOperators, EMM_Stepper::setCharacteristicTime(), and tReal.

Referenced by getOutputPath(), and EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearOperators()

void EMM_LandauLifschitzSystem::clearOperators ( )

inline

clear all operators

◆ computeEnergy()

tReal EMM_LandauLifschitzSystem::computeEnergy ( ) const

compute the energy

Returns

the computed energy :

gets the matgnetization field and
computes the energy for each operator

References getMagnetizationField(), getSigma(), M, mHop, mOperators, and tReal.

Referenced by getMinimumEnergyVariation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeEnergyTimeDerivative()

tReal EMM_LandauLifschitzSystem::computeEnergyTimeDerivative	(	const EMM_RealField &	F,
		const EMM_RealField &	H
	)		const

inline

compute the energy derivative with rsepect to t

Parameters

F	the time variation of magnetization field
H	the total magnetic excitation field

Returns: the computed energy variation : $\frac{dE}{dt}=-2.\int_\omega \sigma H \cdot F d\omega$

References EMM_RealField::dot(), getMesh(), and getSigma().

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivatives(), and EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime().

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}

◆ computeFunction()

void EMM_LandauLifschitzSystem::computeFunction	(	const EMM_RealField &	M,
		const EMM_RealField &	H,
		EMM_RealField &	F
	)		const

inline

compute the landau-lifschitz function

Parameters

M	the magnetization field
H	the total excitation magnetic field
F	the return output vector landau-lifschitz function compute $F= \alpha* (M \wedge H + \beta M \wedge \left (M \wedge H \right )$

References getSigma().

Referenced by EMM_GaussLegendreRelaxation::computeMagnetizationFieldAtTimeWithGLnInterpolation(), and computeMagnetizationFieldTimeDerivative().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeGradFunction()

void EMM_LandauLifschitzSystem::computeGradFunction	(	const EMM_RealField &	M,
		const EMM_RealField &	H,
		const EMM_RealField &	D,
		const EMM_RealField &	gradH,
		EMM_RealField &	gradF
	)		const

inline

compute the gradient landau-lifschitz function at the direction D in M

Parameters

M	: the magnetization field
H	: the total excitation magnetic field
D	: the gradient direction
gradH	: the gradient of H at M in the direction D
gradF	: the gradient of the landau-lisfchtiz function at M in the direction D

compute the gradient of the landau lifschitz at M in the direction D: $GradF_M(D)=\alpha.[D \wedge H+\beta (D \wedge (M \wedge H)+M \wedge (D \wedge H))]+F(M,GradH_M(D))$

References getSigma().

Referenced by EMM_GradGaussLegendreRelaxation::computeMagnetizationFieldTimeDerivativeGradient().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeLandauLifschitzFields()

virtual void EMM_LandauLifschitzSystem::computeLandauLifschitzFields	(	const EMM_RealField &	M,
		const EMM_RealField &	H,
		EMM_RealField &	F
	)

inlinevirtual

compute the landau lifschitz fields

Parameters

M	the magnetization field
H	the total magnetic excitation field
F	the total magnetization field time derivative

Returns: the derivative of the energy with respect to time $\frac{dE}{dt}=-2.\int_\omega \sigma H \cdot F d\omega$ compute $F=\displaystyle - \left ( M \wedge H + \beta \sigma(x) M \wedge ( M \wedge H ) \right )$ .

Reimplemented in EMM_GradGaussLegendreRelaxation.

References computeMagnetizationFieldTimeDerivative(), computeMeanField(), computeMeanMagnetizationField(), and tReal.

Referenced by EMM_GradGaussLegendreRelaxation::computeLandauLifschitzFields(), EMM_LandauLifschitzODE_RKd::integrateMagnetizationFieldAtTime(), and EMM_LandauLifschitzODE_RK::integrateMagnetizationFieldAtTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMagneticExcitationField() [1/2]

void EMM_LandauLifschitzSystem::computeMagneticExcitationField	(	const EMM_RealField &	M,
		EMM_RealField &	H
	)		const

compute the total adimensionized magnetic excitation H of the system (real magnetic excitation is $M_s H(M) $ )

Parameters

M	the magnetization field
H	the total magnetic excitation field

use the working field at index 1

References getSigma(), EMM_RealField::getSize(), mHop, mOperators, and EMM_RealField::setSize().

Referenced by EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMagneticExcitationField() [2/2]

const EMM_RealField& EMM_LandauLifschitzSystem::computeMagneticExcitationField ( )

inline

compute the total adimensionized magnetic excitation H of the system (real magnetic excitation is $M_s H(m) $ )

Returns: the total magnetic excitation field

References computeMagneticExcitationFieldAndEnergies(), getMagneticExcitationField(), getMagnetizationField(), and tReal.

Referenced by EMM_GaussLegendreRelaxation::computeMagnetizationFieldAtTimeWithGLnInterpolation(), getMagneticExcitationField(), EMM_LandauLifschitzODE_RKd::integrateMagnetizationFieldAtTime(), and EMM_LandauLifschitzODE_RK::integrateMagnetizationFieldAtTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMagneticExcitationFieldAndEnergies()

tReal EMM_LandauLifschitzSystem::computeMagneticExcitationFieldAndEnergies	(	const EMM_RealField &	M,
		EMM_RealField &	H,
		tReal	Es[]
	)		const

compute the total adimensionized magnetic excitation H of the system (real magnetic excitation is $M_s H(m) $ ) and return its energy

Parameters

M	the magnetization field
H	the total magetic excitation field
Es	the energy of each operators

Returns: the energy of the system

use the Hop mutable field

References getSigma(), EMM_RealField::getSize(), mHop, mOperators, EMM_RealField::setSize(), and tReal.

Referenced by computeMagneticExcitationField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMagnetizationExcitationField()

void EMM_LandauLifschitzSystem::computeMagnetizationExcitationField	(	const EMM_RealField &	M,
		EMM_RealField &	H
	)		const

compute the magnetic excittaion corresponting the the magnetized operator $M_s H_d(M) $ )

Parameters

M	the magnetization field
H	the magnetization excitation field

References getSigma(), EMM_RealField::getSize(), mOperators, and EMM_RealField::setSize().

Referenced by getMagneticExcitationField(), and EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMagnetizationFieldTimeDerivative()

void EMM_LandauLifschitzSystem::computeMagnetizationFieldTimeDerivative	(	const EMM_RealField &	Mt,
		const EMM_RealField &	Ht,
		EMM_RealField &	Ft
	)		const

inline

compute the time variation of magnetization field at Mt and Ht for time t of the current time step

Parameters

Mt	the magnetization field
Ht	the total magnetic excitation field
Ft	the return derivation of the magnetization field with respect of time:

$F_t=\displaystyle - \left ( M_t \wedge H_t + \beta \sigma(x) M_t \wedge ( M_t \wedge H_t ) \right )$ .

References computeFunction().

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime(), and computeLandauLifschitzFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMeanField()

void EMM_LandauLifschitzSystem::computeMeanField	(	const EMM_RealField &	F,
		tReal *	meanF
	)		const

compute the mean of field over the magnetized domain

Parameters

F	: field to compute the mean
meanF	mean of the field F in dimension 3

References EMM_Grid3D::getMagnetizedElementsNumber(), getMesh(), EMM_RealField::getSize(), EMM_RealField::mean(), tReal, tUIndex, and tUSInt.

Referenced by computeLandauLifschitzFields(), and EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeMeanMagnetizationField()

void EMM_LandauLifschitzSystem::computeMeanMagnetizationField ( tReal * meanM ) const

compute the mean of magnetization field with respect of sigma weight at time 0 of time step

Parameters

meanM mean of magnetization field

References getMagnetizationField(), EMM_Grid3D::getMagnetizedElementsNumber(), getMesh(), getSigma(), EMM_RealField::getSize(), M, EMM_RealField::mean(), tReal, tUIndex, and tUSInt.

Referenced by computeLandauLifschitzFields(), and EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeOperatorsFieldsAtTime()

tBoolean EMM_LandauLifschitzSystem::computeOperatorsFieldsAtTime	(	const tReal &	t,
		const tFlag &	order,
		const EMM_RealArray &	sigma,
		const EMM_RealField &	dM_dt,
		const EMM_RealField &	M
	)

protected

compute the fields of all operators at time t

Parameters

t	the time step to compute
order	order of integration of the fields of operator (0\|1\|2) (if 0 take the time integration order by default of the operator)
sigma	the magnetized weight of each cell
dM_dt	the variation of M at time 0 from the current time step
M	: the magnetization field at time 0 from the curent time step

References mOperators, and tBoolean.

Referenced by EMM_LandauLifschitzODE::computeFieldsAtTime(), EMM_LandauLifschitzRelaxation::computeFieldsAtTime(), and getOperator().

Here is the caller graph for this function:

◆ computePartialGradMFunction()

void EMM_LandauLifschitzSystem::computePartialGradMFunction	(	const EMM_RealField &	M,
		const EMM_RealField &	H,
		const EMM_RealField &	D,
		EMM_RealField &	gradF
	)		const

inline

compute the partial gradient with respect to M of landau-lifschitz function at the direction D in M

Parameters

M	: the magnetization field
H	: the total excitation magnetic field
D	: the gradient direction
gradF	: the gradient of the landau-lisfchtiz function at M in the direction D

compute the gradient of the landau lifschitz at M in the direction D: $GradF_M(D)=\alpha.[D \wedge H+\beta (D \wedge (M \wedge H)+M \wedge (D \wedge H))]$

References getSigma().

Here is the call graph for this function:

◆ discretize() [1/2]

tBoolean EMM_LandauLifschitzSystem::discretize ( const tBoolean & isMnormalized )

virtual

discretize the problem

Parameters

[in] isMnormalized : true if M is normalized, false to normalize it

Returns

false if one of the following conditon is fullfilled:

no time descriptor has been set
no network descriptor has been set
the discretization of the time failed
the discretization of the mu field failed and the field init value is set to 0
the discretization of the operators failed

It :

creates the relative magnetization at saturation $\sigma$ and $\beta$ of the landau lifschitz function for each cell if not uniform
allocates the memory for the total magnetic excitation field H
discretizes the associated time see EMM_Stepper::discretize()
initializes the magnetization field M and normalizes it (see EMM_RealField::normalize() ) is isMnomalized is false
discretized all the operators see EMM_Operator::discretize()

References EMM_Matter::ALPHA, EMM_RealField::copy(), EMM_Grid3D::getElementsNumber(), EMM_RealField::getSize(), CORE_Object::getThread(), EMM_RealField::initField(), EMM_Input::loadFieldFromFile(), M, MAX_OPERATORS, mF, mH, mHop, mLLFunction, mM, mMatters, mMesh, mMInitialData, mMInitialDataFile, mOperators, EMM_Matter::Ms, mSigma, EMM_RealField::normalize(), CORE_Thread::startChrono(), CORE_Thread::stopChrono(), tBoolean, tDimension, CORE_Integer::toString(), tReal, tUIndex, and EMM_RealField::unmagnetized().

Referenced by EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ discretize() [2/2]

tBoolean EMM_LandauLifschitzSystem::discretize ( )

inline

discretize the problem

Returns

false if one of the following conditon is fullfilled:

no time descriptor has been set
no network descriptor has been set
the discretization of the time failed
the discretization of the mu field failed and the field init value is set to 0
the discretization of the operators failed

It :

creates the relative magnetization at saturation $\sigma$ and $\beta$ of the landau lifschitz function for each cell if not uniform
allocates the memory for the total magnetic excitation field H
discretizes the associated time see EMM_Stepper::discretize()
initializes the magnetization field M and normalizes it (see EMM_RealField::normalize() )
discretized all the operators see EMM_Operator::discretize()

Referenced by EMM_GaussLegendreRelaxation::discretize(), and getOutputPath().

Here is the caller graph for this function:

◆ getBackupsNumber()

const tUInteger& EMM_LandauLifschitzSystem::getBackupsNumber ( ) const

inline

get the backups number

Returns: the number of backups

References mBackupsNumber.

Referenced by EMM_Input::restoreBackup().

Here is the caller graph for this function:

◆ getBackupStep()

const tUInteger& EMM_LandauLifschitzSystem::getBackupStep ( ) const

inline

get the backup step

Returns: the step for backup

References mBackupStep, toString(), and tString.

Here is the call 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

identityString the 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

◆ getEnergies()

tReal* EMM_LandauLifschitzSystem::getEnergies ( )

inlineprotected

get the energies

Returns: the energies list

References mEs.

◆ getEnergiesNumber()

static tUSInt EMM_LandauLifschitzSystem::getEnergiesNumber ( )

inlinestatic

return the energie number

Returns: the energies number

◆ getEnergy()

const tReal& EMM_LandauLifschitzSystem::getEnergy ( ) const

inline

return the energy

Returns: the energy

References mEs.

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivatives(), EMMH_Hysteresis::run(), and EMM_Output::saveRelaxation().

Here is the caller graph for this function:

◆ getEnergyTimeDerivative() [1/2]

const tReal& EMM_LandauLifschitzSystem::getEnergyTimeDerivative ( tReal & dE_dt ) const

inline

return the energy and its first derivative with respect to time

Parameters

dE_dt the derivative of E with respect of time

Returns: the energy

References mdE_dt, and mEs.

◆ getEnergyTimeDerivative() [2/2]

tReal& EMM_LandauLifschitzSystem::getEnergyTimeDerivative ( )

inlineprotected

get the energgy time derivative

Returns: the energies list

References mdE_dt.

◆ getEpsilon()

template<class T >

static T CORE_Object::getEpsilon ( )

inlinestaticinherited

get the epsilon value for T type

Returns: the epsilon value for T type

◆ getEvolutionScheme()

const tFlag& EMM_LandauLifschitzSystem::getEvolutionScheme ( ) const

inline

return the evolution scheme between M & opertaor fields

Returns

the evolution scheme in {OsM,MOs,M,Os}

MOs : M(t+dt) =F(M(t),Os(t)) and Os(t+dt)=U(M(t+dt),Os(t))
OsM : Os(t+dt)=U(M(t),Os(t)) and Ms(t+dt)=F(M(t),Os(t+dt))
M : M(t+dt) =F(M(t),Os(0))
Os : Os(t+dt)=U(M(0),Os(t))

References mEvolutionScheme.

Referenced by EMM_LandauLifschitzODE::computeFieldsAtTime(), and EMM_LandauLifschitzRelaxation::computeFieldsAtTime().

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

return the identity string of the object of the form className_at_address

Returns: the identity string of the object

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

Referenced by MATH_GaussLegendreIntegration::copy(), EMM_MultiScaleGrid::initialize(), CORE_Object::isInstanceOf(), CORE_Object::printObjectsInMemory(), MATH_Matrix::toString(), EMMG_SLPeriodicMultiScale::toString(), EMM_Stepper::toString(), EMM_AnisotropyDirectionsField::toString(), EMM_BlockMassMatrix::toString(), CORE_Object::toString(), EMM_Tensors::toString(), EMM_MultiScaleGrid::toString(), EMM_MatterField::toString(), EMM_Grid3D::toString(), and toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInfinity()

template<class T >

static T CORE_Object::getInfinity ( )

inlinestaticinherited

get the infinity for T type

Returns: the infinity value for T type

◆ getInformation()

virtual tString EMM_LandauLifschitzSystem::getInformation ( const tUSInt & retCode )

inlinevirtual

return the information relativly to ret code of the integrate method

Parameters

retCode : the return code of the relaxation

Returns: the information relativly to ret code

References MIN_CODE.

◆ 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

◆ getMagneticExcitationField() [1/2]

const EMM_RealField& EMM_LandauLifschitzSystem::getMagneticExcitationField ( ) const

inline

get adimensionized magnetic excitation at time 0 of time step

Returns: H

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivatives(), computeMagneticExcitationField(), EMM_OptimalTimeStep::computeOptimalTimeStep(), EMM_LandauLifschitzODE_RKd::integrateMagnetizationFieldAtTime(), EMM_LandauLifschitzODE_RK::integrateMagnetizationFieldAtTime(), EMMH_Hysteresis::run(), and EMM_Output::saveVTI().

Here is the caller graph for this function:

◆ getMagneticExcitationField() [2/2]

EMM_RealField& EMM_LandauLifschitzSystem::getMagneticExcitationField ( )

inline

get adimensionized magnetic excitation at time 0 of time step

Returns: H

References computeMagneticExcitationField(), and computeMagnetizationExcitationField().

Here is the call graph for this function:

◆ getMagnetizationField() [1/2]

const EMM_RealField& EMM_LandauLifschitzSystem::getMagnetizationField ( ) const

inline

return the adimensionized magnetisation field associated to the problem for reading at time 0 of the current time step

Returns: M

Referenced by computeEnergy(), EMM_LandauLifschitzRelaxation::computeEnergyAtTime(), EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime(), computeMagneticExcitationField(), EMM_LandauLifschitzRelaxation::computeMagnetizationFieldAtTime(), computeMeanMagnetizationField(), EMM_OptimalTimeStep::computeOptimalTimeStep(), EMM_GaussLegendreRelaxation::discretize(), EMM_DisplacementFVMOperator::discretize(), EMM_DisplacementFEMOperator::discretize(), EMM_DisplacementFVMOperator::resetToInitialState(), EMM_DisplacementFEMOperator::resetToInitialState(), EMM_DisplacementOperator::resetToInitialState(), EMM_DisplacementOperator::restore(), EMM_Input::restoreBackup(), EMMH_Hysteresis::run(), EMM_Output::save(), and EMM_Output::saveVTI().

Here is the caller graph for this function:

◆ getMagnetizationField() [2/2]

EMM_RealField& EMM_LandauLifschitzSystem::getMagnetizationField ( )

inline

return the adimensionized magnetizaton field associated to the problem for writing at time 0 of the current time step

Returns: M

◆ getMagnetizationFieldTimeDerivative() [1/2]

const EMM_RealField& EMM_LandauLifschitzSystem::getMagnetizationFieldTimeDerivative ( ) const

inline

get the magnetization variation field with respect to time at time 0 of the current time step

Returns: Ft= $\displaystyle - \left ( M \wedge H + \beta \sigma(x) M \wedge ( M \wedge H ) \right )$ .

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyAtTime(), EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivatives(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime(), EMM_LandauLifschitzRelaxation::computeMagnetizationFieldAtTime(), EMM_OptimalTimeStep::computeOptimalTimeStep(), and EMM_LandauLifschitzRelaxation::integrateMagnetizationFieldAtTime().

Here is the caller graph for this function:

◆ getMagnetizationFieldTimeDerivative() [2/2]

EMM_RealField& EMM_LandauLifschitzSystem::getMagnetizationFieldTimeDerivative ( )

inline

get the magnetization variation field with respect to time at time 0 of the current time step

Returns: F= $\displaystyle - \left ( M\wedge H + \beta \sigma(x) M \wedge ( M \wedge H ) \right )$ .

◆ getMagnetizedElementsNumber()

const tUIndex& EMM_LandauLifschitzSystem::getMagnetizedElementsNumber ( ) const

inline

get the number of mage,ntozed elements

Referenced by EMM_LandauLifschitzODE_RKd::integrateMagnetizationFieldAtTime(), and EMM_LandauLifschitzODE_RK::integrateMagnetizationFieldAtTime().

Here is the caller graph for this function:

◆ getMatterField() [1/2]

const EMM_MatterField& EMM_LandauLifschitzSystem::getMatterField ( ) const

inline

return the matter index for each cell for reading

Returns: the matter indices array

Referenced by EMM_MinimalExchangeOperator::discretize(), EMM_LinearAnisotropyOperator::discretize(), EMM_AnisotropyOperator::discretize(), EMM_DisplacementFVMOperator::discretize(), EMM_DisplacementOperator::discretize(), and EMM_Output::saveVTI().

Here is the caller graph for this function:

◆ getMatterField() [2/2]

EMM_MatterField& EMM_LandauLifschitzSystem::getMatterField ( )

inline

return the matter index for each cell for writing

Returns: the matter indices array

◆ 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:

◆ getMesh() [1/2]

const EMM_Grid3D& EMM_LandauLifschitzSystem::getMesh ( ) const

inline

return the mesh associated to the problem for reading

Returns: the mesh

Here is the caller graph for this function:

◆ getMesh() [2/2]

EMM_Grid3D& EMM_LandauLifschitzSystem::getMesh ( )

inline

return the mesh associated to the problem for writing

Returns: the mesh

◆ 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:

◆ getMinimumEnergyVariation()

const tReal& EMM_LandauLifschitzSystem::getMinimumEnergyVariation ( ) const

inline

get minimum energy variation under which the relaxation is supposed to be reached

Returns: the minimum energy variation

References computeEnergy(), mMinEnergyVariation, and tReal.

Here is the call graph for this function:

◆ getMinimumTimeStep()

const tReal& EMM_LandauLifschitzSystem::getMinimumTimeStep ( ) const

inline

get minimum time step under which the relaxation process is supposed to be reached

Returns: the min time step

References getTime(), getTimeStep(), getTimeStepsNumber(), mMinDt, tReal, and tUInteger.

Here is the call 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:

◆ getOperator() [1/2]

const EMM_Operator& EMM_LandauLifschitzSystem::getOperator ( const tUIndex & index ) const

inline

get the operator at index for reading

Parameters

index index of the operator in [0,getOperatorsNumber()[

Returns: the operator

References null, and CORE_Integer::toString().

Here is the call graph for this function:

◆ getOperator() [2/2]

EMM_Operator& EMM_LandauLifschitzSystem::getOperator ( const tUIndex & index )

inline

get the operator at index for writing

Parameters

index index of the operator in [0,getOperatorsNumber()[

Returns: the operator

References computeOperatorsFieldsAtTime(), initializeOperators(), isAffine(), null, resetOperatorsToInitialState(), resetToInitialState(), tBoolean, tFlag, CORE_Integer::toString(), tReal, and updateOperatorsAtNextTimeStep().

Here is the call graph for this function:

◆ getOperators() [1/2]

const SV::EMM_MagneticExcitationOperator& EMM_LandauLifschitzSystem::getOperators ( ) const

inline

return the operators vector

Returns: the operators

References mOperators.

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyAtTime(), EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime(), EMM_GradGaussLegendreRelaxation::computeMagneticExcitationFieldGradient(), EMM_Input::restoreBackup(), EMMH_Hysteresis::run(), EMM_Output::save(), and EMM_Output::saveVTI().

Here is the caller graph for this function:

◆ getOperators() [2/2]

SV::EMM_MagneticExcitationOperator& EMM_LandauLifschitzSystem::getOperators ( )

inline

return the operators vector

Returns: the operators

References mOperators.

◆ getOperatorsNumber()

tUIndex EMM_LandauLifschitzSystem::getOperatorsNumber ( ) const

inline

return the number of operators

Returns: the operators number

◆ getOut()

static SP::CORE_Out CORE_Object::getOut ( )

inlinestaticinherited

get the output

Returns: the shared pointer to the output stream

References CORE_Object::OUT.

◆ getOutputPath()

const tString& EMM_LandauLifschitzSystem::getOutputPath ( ) const

inline

get the output path in which the files are generated

Returns: the output path

References adimensionize(), discretize(), mOutputPath, and tBoolean.

Here is the call graph for this function:

◆ 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:

◆ getPrefix()

const tString& EMM_LandauLifschitzSystem::getPrefix ( ) const

inline

get the prefix of the generating files

Returns: the prefix of the files

References mPrefix.

◆ 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

get the infinity value

Returns: the inifinity value for the real type

Referenced by BrentFunction::BrentFunction(), EMM_OperatorsTest::compareDiscretizedData(), EMM_IterativeTimeStep::EMM_IterativeTimeStep(), EMM_SLElementaryDemagnetizedMatrix::Kxy(), NRFunction::NRFunction(), EMM_PolynomialInterpolationTimeStep::optimizeTimeFunction(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getSharedPointer() [1/2]

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

inlineinherited

get the shared pointer of this class into p

Parameters

p	: shared pointer of the class This

Referenced by CORE_Map< Key, Value >::getSharedPointer(), CORE_ArrayList< tString >::getSharedPointer(), EMM_Array< tCellFlag >::getSharedPointer(), CORE_Array< tCellFlag >::getSharedPointer(), CORE_MorseArray< tUChar >::getSharedPointer(), CORE_Vector< T >::getSharedPointer(), and CORE_Object::printObjectsInMemory().

Here is the caller graph for this function:

◆ 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

◆ getSigma()

const EMM_RealArray& EMM_LandauLifschitzSystem::getSigma ( ) const

inline

get the sigma parameters

Returns: the sigma parameter $\sigma_i=\displaystyle \frac{M_{s_i}}{M_s}$ for all cell i.

References CORE_Array< T >::get().

Referenced by computeEnergy(), EMM_LandauLifschitzRelaxation::computeEnergyAtTime(), computeEnergyTimeDerivative(), EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivatives(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime(), computeFunction(), computeGradFunction(), computeMagneticExcitationField(), computeMagneticExcitationFieldAndEnergies(), EMM_GradGaussLegendreRelaxation::computeMagneticExcitationFieldGradient(), computeMagnetizationExcitationField(), EMM_LandauLifschitzRelaxation::computeMagnetizationFieldAtTime(), computeMeanMagnetizationField(), EMM_OptimalTimeStep::computeOptimalTimeStep(), computePartialGradMFunction(), EMM_FullExchangeOperator::discretize(), EMM_DisplacementFVMOperator::discretize(), EMM_DisplacementFEMOperator::discretize(), EMM_LandauLifschitzRelaxation::integrateMagnetizationFieldAtTime(), EMM_DisplacementFVMOperator::resetToInitialState(), EMM_DisplacementFEMOperator::resetToInitialState(), EMM_DisplacementOperator::resetToInitialState(), EMM_DisplacementOperator::restore(), and EMM_Output::saveVTI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStepper() [1/2]

const EMM_Stepper& EMM_LandauLifschitzSystem::getStepper ( ) const

inline

get the time descriptor for reading

Returns: the time descriptor class

Referenced by adimensionize(), and EMMH_Hysteresis::run().

Here is the caller graph for this function:

◆ getStepper() [2/2]

EMM_Stepper& EMM_LandauLifschitzSystem::getStepper ( )

inline

get the time descriptor for writing

Returns: the time descriptor class

References integrate(), tBoolean, and tSInt.

Here is the call graph for this function:

◆ getThread()

static CORE_Thread& CORE_Object::getThread ( )

inlinestaticinherited

get the profilier

Returns: the profiler

Here is the caller graph for this function:

◆ getTime()

virtual const tReal& EMM_LandauLifschitzSystem::getTime ( ) const

pure virtual

return the current time

Returns: the current time of the relaxation

Implemented in EMM_LandauLifschitzRelaxation, and EMM_LandauLifschitzODE.

Referenced by getMinimumTimeStep(), and EMM_Output::saveRelaxation().

Here is the caller graph for this function:

◆ getTimeStep()

virtual const tReal& EMM_LandauLifschitzSystem::getTimeStep ( ) const

pure virtual

return the current time step

Returns: the current time step of the relaxation

Implemented in EMM_LandauLifschitzRelaxation, and EMM_LandauLifschitzODE.

Referenced by getMinimumTimeStep(), EMMH_Hysteresis::run(), and EMM_Output::saveRelaxation().

Here is the caller graph for this function:

◆ getTimeStepsNumber()

virtual const tUInteger& EMM_LandauLifschitzSystem::getTimeStepsNumber ( ) const

pure virtual

return the computed time steps

Returns: the number time steps of the relaxation

Implemented in EMM_LandauLifschitzRelaxation, and EMM_LandauLifschitzODE.

Referenced by getMinimumTimeStep(), EMMH_Hysteresis::run(), and EMM_Output::saveRelaxation().

Here is the caller graph for this function:

◆ getTypeName()

template<class T >

static tString CORE_Object::getTypeName ( )

inlinestaticinherited

get type name

Returns: the type name of the class

References tString.

◆ getWorkingMagneticExcitationField()

EMM_RealField& EMM_LandauLifschitzSystem::getWorkingMagneticExcitationField ( ) const

inline

get mutable adimensionized magnetic excitation working field

Returns: H

Referenced by EMM_LandauLifschitzRelaxation::computeEnergyAtTime(), EMM_LandauLifschitzRelaxation::computeEnergyTimeDerivativeAtTime(), EMM_GradGaussLegendreRelaxation::computeEnergyTimeDerivativesAtTime(), and EMM_GradGaussLegendreRelaxation::computeMagneticExcitationFieldGradient().

Here is the caller graph for this function:

◆ initializeOperators()

tBoolean EMM_LandauLifschitzSystem::initializeOperators	(	const EMM_RealArray &	sigma,
		const EMM_RealField &	M
	)

protected

initialize the data of operator field at t=0 from M

Parameters

sigma	weigh of each cell
M	magnetization at t=0

Referenced by getOperator().

Here is the caller graph for this function:

◆ integrate()

virtual void EMM_LandauLifschitzSystem::integrate	(	const tBoolean &	isRestoring,
		tSInt &	retCode
	)

pure virtual

integrate the system over the time

Parameters

isRestoring	if true, compute the integratio of the landau-lifshcitz system over the time from the last backup
retCode	the return code of the method If negative value it failed If positive value , it succeeds

Implemented in EMM_LandauLifschitzRelaxation, and EMM_LandauLifschitzODE.

Referenced by getStepper(), and EMMH_Hysteresis::run().

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:

◆ isAffine()

tBoolean EMM_LandauLifschitzSystem::isAffine ( ) const

return true if the system has only affine operators

Returns: true if the system has only affine operators see EMM_Operator::isAffine()

References mOperators.

Referenced by getOperator().

Here is the caller graph for this function:

◆ isBackupEnabled()

const tBoolean& EMM_LandauLifschitzSystem::isBackupEnabled ( ) const

inline

get if the backup is enabled

Returns: true if the backup is enabled

References mIsBackupEnabled.

◆ 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

name	name 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:

◆ isLogPrinted()

const tBoolean& EMM_LandauLifschitzSystem::isLogPrinted ( ) const

inline

get if the log is printed in log file

Returns: true if the log printing is enabled

References mIsLogPrinted, printLog(), tReal, tUIndex, and tUInteger.

Here is the call graph for this function:

◆ isMagnetizationStatic()

tBoolean EMM_LandauLifschitzSystem::isMagnetizationStatic ( ) const

inline

return true if M is permanent

◆ 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:

◆ 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(), 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:

◆ printLog()

void EMM_LandauLifschitzSystem::printLog	(	const tUInteger &	timeStep,
		const tReal &	t,
		const map< tString, tString > &	stepperData,
		const tUIndex &	nMagnetizedElements,
		const tReal	Es[],
		const tReal &	dE_dt,
		const tReal &	DeltaE_DeltaT,
		const tReal *	meanM,
		const tReal *	meanH
	)		const

print the log

Parameters

timeStep	the iterations number
t	the current time
stepperData	: data of the stepper
nMagnetizedElements	the number of magnetized elements
Es	energies : total energy at 0 + energy for operator at index i in [1,nOperators]
dE_dt	variation of energy with respect to time $\frac{dE}{dt}=-2.\int_\omega \sigma h \frac{\partial m }{\partial t } d\omega$
DeltaE_DeltaT	: the effective variation of energy between 2 succesive iterations
meanM	the man of the magnetization field
meanH	the man of the magnetic excitation field

References mOperators, CORE_Object::out(), CORE_Out::print(), CORE_Out::println(), tFlag, CORE_Real::toString(), CORE_Integer::toString(), and tReal.

Referenced by isLogPrinted().

Here is the call graph for this function:

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:

◆ resetOperatorsToInitialState()

tBoolean EMM_LandauLifschitzSystem::resetOperatorsToInitialState ( )

virtual

initialize the problem

It resets to initial state all the operator data

References CORE_Object::getThread(), mOperators, CORE_Thread::startChrono(), CORE_Thread::stopChrono(), and tBoolean.

Referenced by getOperator(), resetToInitialState(), and EMMH_Hysteresis::run().

Here is the call graph for this function:

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:

◆ resetStepper()

void EMM_LandauLifschitzSystem::resetStepper ( )

inline

reset the reverse time relation

References mStepper, and null.

Referenced by setStepper().

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:

◆ resetToInitialState()

tBoolean EMM_LandauLifschitzSystem::resetToInitialState ( )

reset to initial state

It resets to initial state all the operator data & M

References EMM_RealField::copy(), EMM_Grid3D::getElementsNumber(), EMM_RealField::getSize(), EMM_RealField::initField(), EMM_Input::loadFieldFromFile(), M, mM, mMesh, mMInitialData, mMInitialDataFile, EMM_RealField::normalize(), resetOperatorsToInitialState(), tDimension, and EMM_RealField::unmagnetized().

Referenced by getOperator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBackupsNumber()

void EMM_LandauLifschitzSystem::setBackupsNumber ( const tUInteger & n )

inline

set the backups number

Parameters

n	the number of backups >0

◆ setBackupStep()

void EMM_LandauLifschitzSystem::setBackupStep ( const tUInteger & n )

inline

set the backup steps to save relaxation

Parameters

n	the step for backup

◆ setEvolutionScheme()

void EMM_LandauLifschitzSystem::setEvolutionScheme ( const tFlag & f )

inline

set the evolution scheme

Parameters

f	: evolution flag in MOs : M(t+dt) =F(M(t),Os(t)) and Os(t+dt)=U(M(t+dt),Os(t)) OsM : Os(t+dt)=U(M(t),Os(t)) and Ms(t+dt)=F(M(t),Os(t+dt)) M : M(t+dt) =F(M(t),Os(0)) Os : Os(t+dt)=U(M(0),Os(t))

◆ setInitialMagnetization() [1/4]

void EMM_LandauLifschitzSystem::setInitialMagnetization ( const tString & dataFile )

inline

set the initialization data for magnetization field

Parameters

dataFile the file name of the description field file

Referenced by EMMH_Hysteresis::run(), and EMMH_Hysteresis::setInitialMagnetizationField().

Here is the caller graph for this function:

◆ setInitialMagnetization() [2/4]

void EMM_LandauLifschitzSystem::setInitialMagnetization ( const tReal data[3] )

inline

set the initialization data for magnetization field

Parameters

data	the uniform init magnetization

References EMM_RealField::setValue().

Here is the call graph for this function:

◆ setInitialMagnetization() [3/4]

void EMM_LandauLifschitzSystem::setInitialMagnetization	(	const tReal &	M0,
		const tReal &	M1,
		const tReal &	M2
	)

inline

set the initialization data for magnetization field

Parameters

M0	: x-coordinate of initial magnetization
M1	: y-coordinate of initial magnetization
M2	: z-coordinate of initial magnetization

References EMM_RealField::setValue(), and tDimension.

Here is the call graph for this function:

◆ setInitialMagnetization() [4/4]

void EMM_LandauLifschitzSystem::setInitialMagnetization ( const EMM_RealField & data )

inline

set the initialization data for magnetization field

Parameters

data	the uniform init magnetization

◆ setIsBackupEnabled()

void EMM_LandauLifschitzSystem::setIsBackupEnabled ( const tBoolean & v )

inline

set if the backup is enabled

Parameters

v	true to enable the backup process

Referenced by EMMH_Hysteresis::run().

Here is the caller graph for this function:

◆ setIsLogPrinted()

void EMM_LandauLifschitzSystem::setIsLogPrinted ( const tBoolean & v )

inline

set if the log is printed in log file

Parameters

v	true to enable the log printing

Referenced by EMMH_Hysteresis::run().

Here is the caller graph for this function:

◆ 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:

◆ setMesh()

tBoolean EMM_LandauLifschitzSystem::setMesh ( SP::EMM_Grid3D mesh )

inline

set the mesh

Parameters

mesh	: the mesh to set

Returns: true if the mesh is compatible

References null.

◆ setMinimumEnergyVariation()

void EMM_LandauLifschitzSystem::setMinimumEnergyVariation ( const tReal & v )

inline

set minimum energy variation under which the relaxation is supposed to be reached

Parameters

v	the minimum energy variation

◆ setMinimumTimeStep()

void EMM_LandauLifschitzSystem::setMinimumTimeStep ( const tReal & v )

inline

set minimum time step under which the relaxation process is supposed to be reached

Parameters

v	min time step

◆ 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.

◆ setOutputPath()

void EMM_LandauLifschitzSystem::setOutputPath	(	const tString &	currentPath,
		const tString &	path,
		const tString &	prefix
	)

inline

set the output path

Parameters

currentPath	the curent path from whih the path is defined
path	the output path
prefix	the prefix of the file

References CORE_File::isAbsolutePath(), mOutputPath, and CORE_File::PATH_SEPARATOR.

Here is the call graph for this function:

◆ setStepper()

tBoolean EMM_LandauLifschitzSystem::setStepper ( SP::EMM_Stepper time )

inline

set the reverse time relation

Parameters

time	: the time to set

Returns: true if the time is compatible

References CORE_Object::getThis(), null, and resetStepper().

Here is the call graph for this function:

◆ 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

thread the 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:

◆ SP_OBJECT()

EMM_LandauLifschitzSystem::SP_OBJECT ( EMM_LandauLifschitzSystem )

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_LandauLifschitzSystem::toString ( ) const

virtual

turn the class into a string

Returns: the string representation of the class

Reimplemented from CORE_Object.

References CORE_Object::getIdentityString(), mLLFunction, mM, mMatters, mMesh, mOperators, mStepper, tString, and tUIndex.

Referenced by getBackupStep(), and EMMH_Hysteresis::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateOperatorsAtNextTimeStep()

tBoolean EMM_LandauLifschitzSystem::updateOperatorsAtNextTimeStep	(	const tReal &	dt,
		const EMM_RealArray &	sigma,
		const EMM_RealField &	Mt
	)

protected

update the operator at next time time with respect of the value of the magnetization field at next time

Parameters

dt	the time step
sigma	the magnetized weight of each cell
Mt	the magnetization field at each point at next time step

call the method EMM_MagneticExcitationOperator::updateAtNextTimeStep() for each operator

References mOperators, and tBoolean.

Referenced by getOperator().

Here is the caller graph for this function:

Member Data Documentation

◆ DE_DT_MIN_IS_REACHED

const tSInt EMM_LandauLifschitzSystem::DE_DT_MIN_IS_REACHED =1

static

◆ DT_MIN_IS_REACHED

const tSInt EMM_LandauLifschitzSystem::DT_MIN_IS_REACHED =4

static

◆ E_INCREASING

const tSInt EMM_LandauLifschitzSystem::E_INCREASING =-2

static

◆ E_IS_NAN

const tSInt EMM_LandauLifschitzSystem::E_IS_NAN =-1

static

◆ Gamma

const tReal EMM_Object::Gamma =-1.7e11

staticinherited

Referenced by EMM_MatterField::adimensionize(), EMM_Matter::adimensionize(), EMM_Test::createMatters(), and EMM_MatterTest::testAdimensionize().

◆ M

const tFlag EMM_LandauLifschitzSystem::M =3

static

Referenced by computeEnergy(), EMM_LandauLifschitzODE::computeFieldsAtTime(), EMM_LandauLifschitzRelaxation::computeFieldsAtTime(), computeMeanMagnetizationField(), discretize(), EMM_GaussLegendreRelaxation::getIntermediateMagnetizationTimeDerivativeField(), EMM_GradGaussLegendreRelaxation::getMagnetizationFieldTimeDerivativeGradient(), EMM_TaylorExpansionRelaxation::New(), and resetToInitialState().

◆ M_PARALLEL_H

const tSInt EMM_LandauLifschitzSystem::M_PARALLEL_H =3

static

◆ MAGNETIZATION_FIELD_UPDATE_ERROR

const tSInt EMM_LandauLifschitzSystem::MAGNETIZATION_FIELD_UPDATE_ERROR =-4

static

◆ MAX_OPERATORS

const tFlag EMM_LandauLifschitzSystem::MAX_OPERATORS =5

staticprivate

Referenced by discretize().

◆ MAXIMUM_ITERATION_IS_REACHED

const tSInt EMM_LandauLifschitzSystem::MAXIMUM_ITERATION_IS_REACHED =2

static

◆ mBackupsNumber

tUInteger EMM_LandauLifschitzSystem::mBackupsNumber

private

Referenced by getBackupsNumber().

◆ mBackupStep

tUInteger EMM_LandauLifschitzSystem::mBackupStep

private

Referenced by getBackupStep().

◆ mdE_dt

tReal EMM_LandauLifschitzSystem::mdE_dt

private

Referenced by getEnergyTimeDerivative().

◆ mEs

tReal EMM_LandauLifschitzSystem::mEs[MAX_OPERATORS+1]

private

Referenced by getEnergies(), getEnergy(), and getEnergyTimeDerivative().

◆ mEvolutionScheme

tFlag EMM_LandauLifschitzSystem::mEvolutionScheme

private

Referenced by getEvolutionScheme().

◆ mF

SP::EMM_RealField EMM_LandauLifschitzSystem::mF

private

Referenced by discretize().

◆ mH

SP::EMM_RealField EMM_LandauLifschitzSystem::mH

private

Referenced by discretize().

◆ mHop

SP::EMM_RealField EMM_LandauLifschitzSystem::mHop

mutableprivate

Referenced by computeEnergy(), computeMagneticExcitationField(), computeMagneticExcitationFieldAndEnergies(), and discretize().

◆ MIN_CODE

const tSInt EMM_LandauLifschitzSystem::MIN_CODE =-4

static

Referenced by getInformation().

◆ mIsBackupEnabled

tBoolean EMM_LandauLifschitzSystem::mIsBackupEnabled

private

Referenced by isBackupEnabled().

◆ mIsLogPrinted

tBoolean EMM_LandauLifschitzSystem::mIsLogPrinted

private

Referenced by isLogPrinted().

◆ mLLFunction

SP::EMM_LandauLifschitzFunction EMM_LandauLifschitzSystem::mLLFunction

private

Referenced by discretize(), EMM_LandauLifschitzSystem(), and toString().

◆ mM

SP::EMM_RealField EMM_LandauLifschitzSystem::mM

private

Referenced by discretize(), resetToInitialState(), and toString().

◆ mMatters

SP::EMM_MatterField EMM_LandauLifschitzSystem::mMatters

private

Referenced by adimensionize(), discretize(), and toString().

◆ mMesh

SP::EMM_Grid3D EMM_LandauLifschitzSystem::mMesh

private

Referenced by adimensionize(), discretize(), resetToInitialState(), and toString().

◆ mMinDt

tReal EMM_LandauLifschitzSystem::mMinDt

private

Referenced by getMinimumTimeStep().

◆ mMinEnergyVariation

tReal EMM_LandauLifschitzSystem::mMinEnergyVariation

private

Referenced by getMinimumEnergyVariation().

◆ mMInitialData

SP::EMM_RealField EMM_LandauLifschitzSystem::mMInitialData

private

Referenced by discretize(), and resetToInitialState().

◆ mMInitialDataFile

tString EMM_LandauLifschitzSystem::mMInitialDataFile

private

Referenced by discretize(), and resetToInitialState().

◆ mOperators

SV::EMM_MagneticExcitationOperator EMM_LandauLifschitzSystem::mOperators

private

Referenced by adimensionize(), computeEnergy(), computeMagneticExcitationField(), computeMagneticExcitationFieldAndEnergies(), computeMagnetizationExcitationField(), computeOperatorsFieldsAtTime(), discretize(), getOperators(), isAffine(), printLog(), resetOperatorsToInitialState(), toString(), and updateOperatorsAtNextTimeStep().

◆ MOs

const tFlag EMM_LandauLifschitzSystem::MOs =2

static

Referenced by EMM_LandauLifschitzODE::computeFieldsAtTime(), and EMM_LandauLifschitzRelaxation::computeFieldsAtTime().

◆ mOutputPath

tString EMM_LandauLifschitzSystem::mOutputPath

private

Referenced by getOutputPath(), and setOutputPath().

◆ mPrefix

tString EMM_LandauLifschitzSystem::mPrefix

private

Referenced by getPrefix().

◆ mSigma

SP::EMM_RealArray EMM_LandauLifschitzSystem::mSigma

private

Referenced by discretize().

◆ mStepper

SP::EMM_Stepper EMM_LandauLifschitzSystem::mStepper

private

Referenced by resetStepper(), and toString().

◆ Mu0

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

staticinherited

Referenced by EMM_MatterField::adimensionize(), EMM_MagnetostrictionOperator::adimensionize(), EMM_Matter::adimensionize(), EMM_CubicAnisotropyOperator::ComputeMagneticExcitation(), EMM_CubicAnisotropyOperator::computeMagneticExcitationField(), EMM_CubicAnisotropyOperator::computeMagneticExcitationFieldGradient(), EMM_CubicAnisotropyOperator::ComputeMagneticExcitationGradient(), EMM_Test::createMatters(), EMM_MatterField::getElasticTensorAdimensionizedParameter(), and EMM_MatterTest::testAdimensionize().

◆ NULL_VALUE

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

staticinherited

◆ OPERATORS_FIELDS_UPDATE_ERROR

const tSInt EMM_LandauLifschitzSystem::OPERATORS_FIELDS_UPDATE_ERROR =-3

static

◆ Os

const tFlag EMM_LandauLifschitzSystem::Os =4

static

Referenced by EMM_LandauLifschitzODE::computeFieldsAtTime(), and EMM_LandauLifschitzRelaxation::computeFieldsAtTime().

◆ OsM

const tFlag EMM_LandauLifschitzSystem::OsM =1

static

Referenced by EMM_LandauLifschitzODE::computeFieldsAtTime(), and EMM_LandauLifschitzRelaxation::computeFieldsAtTime().

◆ RELAXATION_IS_REACHED

const tSInt EMM_LandauLifschitzSystem::RELAXATION_IS_REACHED =0

static

◆ RET_STRING

const tString EMM_LandauLifschitzSystem::RET_STRING

staticprivate

Initial value:

={"error on updating magnetization field at next time step",
                                                       "error on updating fields of operators at next time step",
                                                       "impossible to find dt to make decrasing E",
                                                       "E is NAN",
                                                       "Relaxation is reached",
                                                       "Minimum of variation of energy is reached",
                                                       "Maximum iteration is reached",
                                                       "M is parallel to H",
                                                       "minimum time step reached"}

◆ X

const tDimension EMM_Object::X =0

staticinherited

Referenced by EMMG_RealField::fitToSize(), EMM_MassMatrix::getElementVolume(), EMM_CanonicalMassMatrix::isSymmetric(), EMM_BlockMassMatrix::product(), EMM_CondensedMassMatrix::product(), EMM_RealField::setValue(), EMM_BlockMassMatrix::toString(), and EMMG_RealField::wedge().

◆ Y

const tDimension EMM_Object::Y =1

staticinherited

Referenced by EMMG_SLSDXPeriodicMultiScale::computeMultiGridExcitationField(), EMMG_RealField::fitToSize(), EMM_MassMatrix::getElementVolume(), EMM_CanonicalMassMatrix::isSymmetric(), EMM_BlockMassMatrix::product(), EMM_CondensedMassMatrix::product(), EMM_RealField::setValue(), EMM_CanonicalMassMatrix::solve(), EMM_BlockMassMatrix::solve(), EMM_BlockMassMatrix::toString(), and EMMG_RealField::wedge().

◆ Z

const tDimension EMM_Object::Z =2

staticinherited

Referenced by EMM_DisplacementFVM_VIGROperator::initializeEquilibriumSolver(), and EMM_DisplacementOperator::initializeEquilibriumSolver().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EMM_LandauLifschitzSystem()

◆ ~EMM_LandauLifschitzSystem()

Member Function Documentation

◆ addOperator()

◆ adimensionize()

◆ clearOperators()

◆ computeEnergy()

◆ computeEnergyTimeDerivative()

◆ computeEpsilon()

◆ computeFunction()

◆ computeGradFunction()

◆ computeLandauLifschitzFields()

◆ computeMagneticExcitationField() [1/2]

◆ computeMagneticExcitationField() [2/2]

◆ computeMagneticExcitationFieldAndEnergies()

◆ computeMagnetizationExcitationField()

◆ computeMagnetizationFieldTimeDerivative()

◆ computeMeanField()

◆ computeMeanMagnetizationField()

◆ computeOperatorsFieldsAtTime()

◆ computePartialGradMFunction()

◆ discretize() [1/2]

◆ discretize() [2/2]

◆ getBackupsNumber()

◆ getBackupStep()

◆ getClassName() [1/2]

◆ getClassName() [2/2]

◆ getDoubleEpsilon()

◆ getDoubleInfinity()

◆ getEnergies()

◆ getEnergiesNumber()

◆ getEnergy()

◆ getEnergyTimeDerivative() [1/2]

◆ getEnergyTimeDerivative() [2/2]

◆ getEpsilon()

◆ getEvolutionScheme()

◆ getFloatEpsilon()

◆ getFloatInfinity()

◆ getIdentityString()

◆ getInfinity()

◆ getInformation()

◆ getLDoubleEpsilon()

◆ getLDoubleInfinity()

◆ getMagneticExcitationField() [1/2]

◆ getMagneticExcitationField() [2/2]

◆ getMagnetizationField() [1/2]

◆ getMagnetizationField() [2/2]

◆ getMagnetizationFieldTimeDerivative() [1/2]

◆ getMagnetizationFieldTimeDerivative() [2/2]

◆ getMagnetizedElementsNumber()

◆ getMatterField() [1/2]

◆ getMatterField() [2/2]

◆ getMaxChar()

◆ getMaxDouble()

◆ getMaxFlag()

◆ getMaxFloat()

◆ getMaxIndex()

◆ getMaxInt()

◆ getMaxInteger()

◆ getMaxLDouble()

◆ getMaxLInt()

◆ getMaxLLInt()

◆ getMaxReal()

◆ getMaxSInt()

◆ getMaxUChar()

◆ getMaxUIndex()

◆ getMaxUInt()

◆ getMaxUInteger()

◆ getMaxULInt()

◆ getMaxULLInt()

◆ getMaxUSInt()