This class is describes a Zeman operator with const external magnetism by time and particles. More...

#include <SM_ConstantZeemanOperator.h>

Inheritance diagram for SM_ConstantZeemanOperator:

[legend]

Collaboration diagram for SM_ConstantZeemanOperator:

[legend]

Public Member Functions
virtual CORE_UniquePointer< SM_Operator >	NewInstance () const override
	create a New instance of this @retrun an unique pointer to the instance More...

virtual tMemSize	getMemorySize () const
	return the memory size of the class and the memory size of all its attributes/associations More...

virtual void	discretize (const SM_System &system) override
	discretize the operator : do nothing by default More...

void	setBext (const std::array< tReal, 3 > &values)
	set the Bext value More...

virtual tMemSize	getContentsMemorySize () const
	return nthe memory size of the included associations More...

virtual void	copy (const SM_Operator &op)
	copy More...

const tIndex &	getZeemanParticlesNumber () const
	return the number of particles for the zeeman operatpr More...

const tIndex &	getZeemanTimeStepsNumber () const
	return the number of time steps for the zeeman operatpr More...

const tDimension &	getZeemanDimension () const
	return the dimension of the zeeman operatpr More...

const tReal *	getBext (const tIndex &t) const
	return Bext at time step index t More...

tReal *	getBext (const tIndex &t)
	return Bext at time step index t More...

const tReal *	getBext () const
	return Bext at time 0 More...

tReal *	getBext ()
	return Bext More...

void	setBext (std::initializer_list< tReal > &&values)
	set the Bext value More...

void	setBext (const std::vector< tReal > &values)
	set the Bext value More...

virtual void	computeMagneticField (const tIndex &t, const SM_Network &network, const tReal mu, tReal B) const override
	compute the magnetic field at time t by virtual method More...

void	computeMagneticField (const tIndex &t, const SM_Network &network, const SM_RealField &Mu, SM_RealField &B) const
	compute the magnetic field at time t by virtual method More...

virtual void	computeMagneticFieldAndEnergy (const tIndex &t, const SM_Network &network, const tReal mu, tReal B, tReal &E) const override
	compute the magnetic field at time t by virtual method More...

void	computeTemplatedMagneticField (const tIndex &t, const SM_Network &network, const tReal mu, tReal B) const
	compute the magnetic field More...

void	computeTemplatedMagneticFieldAndEnergy (const tIndex &t, const SM_Network &network, const tReal mu, tReal B, tReal &E) const
	compute the magnetic field More...

void	computeTemplatedMagneticFieldAndEnergy (const tIndex &t, const SM_Network &network, const tReal mu, tReal H, tReal &E)
	compute the magnetic field and energy at time t More...

virtual tReal	computeEnergy (const SM_Network &network, const tReal mu, const tReal H) const override
	compute the energy More...

virtual tReal	computeEnergy (const tIndex &t, const SM_Network &network, const tReal *mu) const override
	compute the energy More...

tReal	computeEnergy (const tIndex &t, const SM_Network &network, const SM_RealField &mu) const
	compute the energy at time t by virtual method More...

tReal	computeTemplatedEnergy (const tIndex &t, const SM_Network &network, const tReal *mu) const
	compute the energy More...

const tString &	getName () const
	return the operator name More...

template<class T >
std::shared_ptr< T >	getSharedPointer ()
	return the shared pointer for this More...

template<class T >
std::shared_ptr< const T >	getConstSharedPointer () const
	return a const shared pointer for this More...

template<class T >
tBoolean	isInstanceOf () const
	test if the clas T is an instance of this class More...

tString	getClassName () const
	return the name of the class More...

tString	getPointerString () const
	retrun the pointer of the class as a string More...

tString	getIdentityString () const
	retrun the string identification of the class More...

virtual tString	toString () const
	return the string representation of the object node More...

Static Public Member Functions
static CORE_UniquePointer< SM_ConstantZeemanOperator >	New ()
	build a new instance of the operator More...

static tBoolean	EnableMemoryStack (const tBoolean &isMemoryChecked)
	enable the memory stack More...

static void	EnableMemoryStack ()
	enable the memory stack More...

static void	DisableMemoryStack ()
	disable the memory stack More...

static tBoolean	IsMemoryStackEnabled ()
	return trur if the memory stack is enabled More...

static tString	MemoryStackToString ()
	get the memory stack in string More...

static tIndex	GetRegisteredClassesNumber ()
	get the memory stack in string More...

Protected Member Functions
	SM_ConstantZeemanOperator (void)
	create a network class More...

virtual	~SM_ConstantZeemanOperator (void)
	destroy More...

void	setZeemanParticlesNumber (const tIndex &p)
	set zeeman particlules number More...

void	setZeemanTimeStepsNumber (const tIndex &n)
	set zeeman time steps More...

const std::valarray< tReal > &	getBextAsArray () const
	return Bext as an array More...

std::valarray< tReal > &	getBextAsArray ()
	return Bext as an array More...

void	setName (const tString &name)
	set the name More...

Private Member Functions
template<class T >
std::shared_ptr< T >	setThis (std::unique_ptr< T, CORE_Object::Delete > &up)
	set the shared pointer from an unique pointer More...

Private Attributes
tIndex	mZeemanTimeStepsNumber

tIndex	mZeemanParticlesNumber

tDimension	mDimension

std::valarray< tReal >	mBext

tString	mName

std::weak_ptr< CORE_Object >	mThis

Detailed Description

This class is describes a Zeman operator with const external magnetism by time and particles.

Author: Stephane Despreaux

Version: 2.0

Constructor & Destructor Documentation

◆ SM_ConstantZeemanOperator()

SM_ConstantZeemanOperator::SM_ConstantZeemanOperator ( void )

inlineprotected

create a network class

References SM_ZeemanOperator::setZeemanParticlesNumber(), and SM_ZeemanOperator::setZeemanTimeStepsNumber().

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~SM_ConstantZeemanOperator()

virtual SM_ConstantZeemanOperator::~SM_ConstantZeemanOperator ( void )

inlineprotectedvirtual

destroy

Member Function Documentation

◆ computeEnergy() [1/3]

virtual tReal SM_ZeemanOperator::computeEnergy	(	const SM_Network &	network,
		const tReal *	mu,
		const tReal *	H
	)		const

inlineoverridevirtualinherited

compute the energy

Parameters

[in]	network	: network
[in]	mu	magnetic moments of size nParticles x dim
[in]	H	magnetic field of size nParticles x dim

Returns: the energy of the operator E=-<H,Mu>

Reimplemented from SM_Operator.

References SM_Network::getDimension(), SM_Network::getParticlesNumber(), tIndex, and tReal.

Here is the call graph for this function:

◆ computeEnergy() [2/3]

tReal SM_Operator::computeEnergy	(	const tIndex &	t,
		const SM_Network &	network,
		const SM_RealField &	mu
	)		const

inlineinherited

compute the energy at time t by virtual method

Parameters

[in]	t	: time step index
[in]	network	: network
[in]	mu	magnetic moments of size nParticles x dim

Returns: the energy of the operator

Referenced by SM_Test::testDerivative().

Here is the caller graph for this function:

◆ computeEnergy() [3/3]

virtual tReal SM_ZeemanOperator::computeEnergy	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu
	)		const

inlineoverridevirtualinherited

compute the energy

Parameters

[in]	t	index of time step for computation
[in]	network	: network of the field
[in]	mu	magnetic moments of size nParticles

Returns: the energy of the operator

Implements SM_Operator.

References SM_ZeemanOperator::computeTemplatedEnergy().

Here is the call graph for this function:

◆ computeMagneticField() [1/2]

void SM_Operator::computeMagneticField	(	const tIndex &	t,
		const SM_Network &	network,
		const SM_RealField &	Mu,
		SM_RealField &	B
	)		const

inlineinherited

compute the magnetic field at time t by virtual method

Parameters

[in]	t	: time step index
[in]	network	: network
[in]	Mu	magnetic moments of size nParticles x dim
[out]	B	magnetic field of size nParticles x dim defined by B=H(mu)

References SM_Operator::computeMagneticField(), CORE_Field< T, K, D, S, I >::getElementsNumber(), CORE_Field< T, K, D, S, I >::setElementsNumber(), and tIndex.

Here is the call graph for this function:

◆ computeMagneticField() [2/2]

virtual void SM_ZeemanOperator::computeMagneticField	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu,
		tReal *	B
	)		const

inlineoverridevirtualinherited

compute the magnetic field at time t by virtual method

Parameters

[in]	t	: time step index
[in]	network	network of points
[in]	mu	magnetic moments of size nParticles x dim
[in,out]	B	magnetic field of size nParticles x dim B+=H(Mu)

Implements SM_Operator.

References SM_ZeemanOperator::computeTemplatedMagneticField().

Here is the call graph for this function:

◆ computeMagneticFieldAndEnergy()

virtual void SM_ZeemanOperator::computeMagneticFieldAndEnergy	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu,
		tReal *	B,
		tReal &	E
	)		const

inlineoverridevirtualinherited

compute the magnetic field at time t by virtual method

Parameters

[in]	t	: time step index
[in]	network	: network of the field
[in]	mu	magnetic moments of size nParticles x dim
[in,out]	B	magnetic field of size nParticles x dim
[out]	E	Energy of the operator

Implements SM_Operator.

References SM_ZeemanOperator::computeTemplatedMagneticFieldAndEnergy().

Here is the call graph for this function:

◆ computeTemplatedEnergy()

tReal SM_ZeemanOperator::computeTemplatedEnergy	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu
	)		const

inlineinherited

compute the energy

Parameters

[in]	t	index of time step for computation
[in]	network	: network of the field
[in]	mu	magnetic moments of size nParticles x dim

Returns: the Zeeman energy E : \( E(t)= - <Mu,Bext(t)> \)

References SM_ZeemanOperator::getBext(), SM_Network::getDimension(), SM_Network::getParticlesNumber(), SM_ZeemanOperator::mZeemanParticlesNumber, tBoolean, tIndex, and tReal.

Referenced by SM_ZeemanOperator::computeEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeTemplatedMagneticField()

void SM_ZeemanOperator::computeTemplatedMagneticField	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu,
		tReal *	B
	)		const

inlineinherited

compute the magnetic field

Parameters

[in]	t	index of time step for computation
[in]	network	: network of the field
[in]	mu	magnetic moments of size nParticles x dim
[in,out]	B	magnetic field of size nParticles x dim

Returns: B+=Bext

References SM_ZeemanOperator::computeTemplatedMagneticFieldAndEnergy(), and tReal.

Referenced by SM_ZeemanOperator::computeMagneticField(), and SM_TemplatedSystem< SystemImpl >::computeTemplatedMagneticField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeTemplatedMagneticFieldAndEnergy() [1/2]

void SM_ZeemanOperator::computeTemplatedMagneticFieldAndEnergy	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu,
		tReal *	B,
		tReal &	E
	)		const

inlineinherited

compute the magnetic field

Parameters

[in]	t	index of time step for computation
[in]	network	: network of
[in]	mu	magnetic moments of size nParticles x dim
[in,out]	B	magnetic field of size nParticles x dim
[out]	E	energy of the operator return B+=Bext

References SM_ZeemanOperator::getBext(), SM_Network::getDimension(), SM_Network::getParticlesNumber(), SM_ZeemanOperator::mZeemanParticlesNumber, tBoolean, tIndex, and tReal.

Referenced by SM_ZeemanOperator::computeMagneticFieldAndEnergy(), SM_ZeemanOperator::computeTemplatedMagneticField(), and SM_TemplatedSystem< SystemImpl >::computeTemplatedMagneticFieldAndEnergies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeTemplatedMagneticFieldAndEnergy() [2/2]

void SM_TemplatedOperator< SM_ZeemanOperator >::computeTemplatedMagneticFieldAndEnergy	(	const tIndex &	t,
		const SM_Network &	network,
		const tReal *	mu,
		tReal *	H,
		tReal &	E
	)

inlineinherited

compute the magnetic field and energy at time t

Parameters

[in]	t	index of time step for computation
[in]	network	: network of the field
[in]	mu	magnetic moments of size nParticles x dim
[in,out]	H	magnetic field of size nParticles x dim
[out]	E	energy of the operator

◆ copy()

virtual void SM_ZeemanOperator::copy ( const SM_Operator & op )

inlinevirtualinherited

copy

Parameters

[in] op : operator to copy

Reimplemented from SM_Operator.

References SM_Operator::copy(), SM_ZeemanOperator::getBextAsArray(), SM_ZeemanOperator::getZeemanDimension(), SM_ZeemanOperator::getZeemanParticlesNumber(), SM_ZeemanOperator::getZeemanTimeStepsNumber(), SM_ZeemanOperator::mBext, SM_ZeemanOperator::mDimension, SM_ZeemanOperator::mZeemanParticlesNumber, and SM_ZeemanOperator::mZeemanTimeStepsNumber.

Here is the call graph for this function:

◆ DisableMemoryStack()

static void CORE_Object::DisableMemoryStack ( )

inlinestaticinherited

disable the memory stack

Referenced by CORE_Object::EnableMemoryStack().

Here is the caller graph for this function:

◆ discretize()

virtual void SM_ConstantZeemanOperator::discretize ( const SM_System & system )

inlineoverridevirtual

discretize the operator : do nothing by default

Parameters

[in] system : system of the operator

Reimplemented from SM_ZeemanOperator.

References SM_ZeemanOperator::setZeemanParticlesNumber(), and SM_ZeemanOperator::setZeemanTimeStepsNumber().

Here is the call graph for this function:

◆ EnableMemoryStack() [1/2]

static void CORE_Object::EnableMemoryStack ( )

inlinestaticinherited

enable the memory stack

Referenced by CORE_Object::EnableMemoryStack(), and CORE_Run::SetDebugOptions().

Here is the caller graph for this function:

◆ EnableMemoryStack() [2/2]

static tBoolean CORE_Object::EnableMemoryStack ( const tBoolean & isMemoryChecked )

inlinestaticinherited

enable the memory stack

Parameters

[in] isMemoryChecked : true to verify memory allocation of CORE_Object classes

Returns: true if the memroy is checked

References CORE_Object::DisableMemoryStack(), CORE_Object::EnableMemoryStack(), and CORE_Object::IsMemoryStackEnabled().

Here is the call graph for this function:

◆ getBext() [1/4]

tReal* SM_ZeemanOperator::getBext ( )

inlineinherited

return Bext

Returns: the external magnetic field for writing

References SM_ZeemanOperator::mBext.

◆ getBext() [2/4]

const tReal* SM_ZeemanOperator::getBext ( ) const

inlineinherited

return Bext at time 0

Returns: the external magnetic field for reading

References SM_ZeemanOperator::mBext.

Referenced by SM_ZeemanOperator::computeTemplatedEnergy(), and SM_ZeemanOperator::computeTemplatedMagneticFieldAndEnergy().

Here is the caller graph for this function:

◆ getBext() [3/4]

tReal* SM_ZeemanOperator::getBext ( const tIndex & t )

inlineinherited

return Bext at time step index t

Parameters

[in] t time step index of Bext in [0,SM_TimeStepper::GetMaximimumTimeStepsNumber()[

Returns: the external magnetic field for writing

References SM_ZeemanOperator::mBext, SM_ZeemanOperator::mDimension, SM_ZeemanOperator::mZeemanParticlesNumber, and SM_ZeemanOperator::mZeemanTimeStepsNumber.

◆ getBext() [4/4]

const tReal* SM_ZeemanOperator::getBext ( const tIndex & t ) const

inlineinherited

return Bext at time step index t

Parameters

[in] t time step index of Bext in [0,SM_TimeStepper::GetMaximimumTimeStepsNumber()[

Returns: the external magnetic field for reading

References SM_ZeemanOperator::mBext, SM_ZeemanOperator::mDimension, SM_ZeemanOperator::mZeemanParticlesNumber, and SM_ZeemanOperator::mZeemanTimeStepsNumber.

Referenced by SM_Beam::computeL2Convergence().

Here is the caller graph for this function:

◆ getBextAsArray() [1/2]

std::valarray<tReal>& SM_ZeemanOperator::getBextAsArray ( )

inlineprotectedinherited

return Bext as an array

Returns: the external magnetic field for writing

References SM_ZeemanOperator::mBext.

◆ getBextAsArray() [2/2]

const std::valarray<tReal>& SM_ZeemanOperator::getBextAsArray ( ) const

inlineprotectedinherited

return Bext as an array

Returns: the external magnetic field for reading

References SM_ZeemanOperator::mBext.

Referenced by SM_ZeemanOperator::copy(), and setBext().

Here is the caller graph for this function:

◆ getClassName()

tString CORE_Object::getClassName ( ) const

inlineinherited

return the name of the class

Returns: the string name of the class

Referenced by CORE_Object::getIdentityString(), and CORE_Test::testTypes().

Here is the caller graph for this function:

◆ getConstSharedPointer()

template<class T >

std::shared_ptr<const T> CORE_Object::getConstSharedPointer ( ) const

inlineinherited

return a const shared pointer for this

Returns: the shared pointer as a type T

References CORE_Object::mThis.

◆ getContentsMemorySize()

virtual tMemSize SM_ZeemanOperator::getContentsMemorySize ( ) const

inlinevirtualinherited

return nthe memory size of the included associations

Returns: the memory size of the storage in bytes 1 Kb = 1024 bytes 1 Mb = 1024 Kb 1 Gb = 1024 Mb 1 Tb = 1024 Gb 1 Hb = 1024 Tb

Reimplemented from SM_Operator.

References SM_Operator::getContentsMemorySize(), SM_ZeemanOperator::mBext, tMemSize, and tReal.

Referenced by getMemorySize(), SM_PermanentZeemanOperator::getMemorySize(), and SM_ZeemanOperator::getMemorySize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const

inlineinherited

retrun the string identification of the class

Returns: the string identity of the class

References CORE_Object::getClassName(), and core_functions::pointerToString().

Referenced by CORE_Test::testArray(), CORE_Test::testField(), CORE_Test::testTypes(), CORE_Object::toString(), CORE_ClassFactory::toString(), and CORE_Field< T, K, D, S, I >::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMemorySize()

virtual tMemSize SM_ConstantZeemanOperator::getMemorySize ( ) const

inlinevirtual

return the memory size of the class and the memory size of all its attributes/associations

Returns

the memory size of the class and the memory size of its attributes/associations in bytes The mamory size is :

the added size of the base classes which contains:
- the primary attributes size depends on the order: (first delare the smallest attributes size
- all virtual functions costs <pointer-size> (4 32xor 8 64x) bytes by virtual function
- virtual inherihtance will increase of (4 or 8) bytes
we add the size of the contains values of the attributes : for example the size of a string is the length of the string 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from SM_ZeemanOperator.

References SM_ZeemanOperator::getContentsMemorySize().

Here is the call graph for this function:

◆ getName()

const tString& SM_Operator::getName ( ) const

inlineinherited

return the operator name

Returns: the name of the operator

References SM_Operator::mName.

Referenced by SM_Operator::copy(), and SM_TemplatedSystem< SystemImpl >::getOperatorNames().

Here is the caller graph for this function:

◆ getPointerString()

tString CORE_Object::getPointerString ( ) const

inlineinherited

retrun the pointer of the class as a string

Returns: the pointer of the calss as a string

References core_functions::pointerToString().

Here is the call graph for this function:

◆ GetRegisteredClassesNumber()

static tIndex CORE_Object::GetRegisteredClassesNumber ( )

inlinestaticinherited

get the memory stack in string

Returns: the string representation of the memory stack

◆ getSharedPointer()

template<class T >

std::shared_ptr<T> CORE_Object::getSharedPointer ( )

inlineinherited

return the shared pointer for this

Returns: the shared pointer as a type T

References CORE_Object::mThis.

◆ getZeemanDimension()

const tDimension& SM_ZeemanOperator::getZeemanDimension ( ) const

inlineinherited

return the dimension of the zeeman operatpr

Returns: the dimension of the zeeman operator

References SM_ZeemanOperator::mDimension.

Referenced by SM_ZeemanOperator::copy().

Here is the caller graph for this function:

◆ getZeemanParticlesNumber()

const tIndex& SM_ZeemanOperator::getZeemanParticlesNumber ( ) const

inlineinherited

return the number of particles for the zeeman operatpr

Returns: the number of particles for the zeeman operator

References SM_ZeemanOperator::mZeemanParticlesNumber.

Referenced by SM_ZeemanOperator::copy().

Here is the caller graph for this function:

◆ getZeemanTimeStepsNumber()

const tIndex& SM_ZeemanOperator::getZeemanTimeStepsNumber ( ) const

inlineinherited

return the number of time steps for the zeeman operatpr

Returns: the number of time steps for the zeeman operator

References SM_ZeemanOperator::mZeemanTimeStepsNumber.

Referenced by SM_ZeemanOperator::copy().

Here is the caller graph for this function:

◆ isInstanceOf()

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

Referenced by SM_Beam::templatedSimulate().

Here is the caller graph for this function:

◆ IsMemoryStackEnabled()

static tBoolean CORE_Object::IsMemoryStackEnabled ( )

inlinestaticinherited

return trur if the memory stack is enabled

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

Here is the caller graph for this function:

◆ MemoryStackToString()

static tString CORE_Object::MemoryStackToString ( )

inlinestaticinherited

get the memory stack in string

Returns: the string representation of the memory stack

Referenced by main().

Here is the caller graph for this function:

◆ New()

static CORE_UniquePointer<SM_ConstantZeemanOperator> SM_ConstantZeemanOperator::New ( )

inlinestatic

build a new instance of the operator

Returns: an unique pointer of the operator

References SM_ConstantZeemanOperator().

Referenced by NewInstance(), and SM_ClassFactory::NewInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NewInstance()

virtual CORE_UniquePointer<SM_Operator> SM_ConstantZeemanOperator::NewInstance ( ) const

inlineoverridevirtual

create a New instance of this @retrun an unique pointer to the instance

Reimplemented from SM_ZeemanOperator.

References New().

Here is the call graph for this function:

◆ setBext() [1/3]

void SM_ConstantZeemanOperator::setBext ( const std::array< tReal, 3 > & values )

inline

set the Bext value

Parameters

[in] values init value

References SM_ZeemanOperator::getBextAsArray(), SM_ZeemanOperator::setZeemanParticlesNumber(), SM_ZeemanOperator::setZeemanTimeStepsNumber(), and tReal.

Referenced by SM_Test::linedParticlesTestCase(), and SM_Test::testOperators().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBext() [2/3]

void SM_ZeemanOperator::setBext ( const std::vector< tReal > & values )

inlineinherited

set the Bext value

Parameters

[in] values iniializer list of the values of Bext

References SM_ZeemanOperator::mBext, and tReal.

◆ setBext() [3/3]

void SM_ZeemanOperator::setBext ( std::initializer_list< tReal > && values )

inlineinherited

set the Bext value

Parameters

[in] values iniializer list of the values of Bext

References SM_ZeemanOperator::mBext.

Referenced by SM_Run::loadOperatorsFromOptions().

Here is the caller graph for this function:

◆ setName()

void SM_Operator::setName ( const tString & name )

inlineprotectedinherited

set the name

Parameters

[in] name name of the operator

References SM_Operator::mName.

Referenced by SM_DemagnetizedOperator::SM_DemagnetizedOperator(), SM_HeissenbergOperator::SM_HeissenbergOperator(), and SM_ZeemanOperator::SM_ZeemanOperator().

Here is the caller graph for this function:

◆ setThis()

template<class T >

std::shared_ptr<T> CORE_Object::setThis ( std::unique_ptr< T, CORE_Object::Delete > & up )

inlineprivateinherited

set the shared pointer from an unique pointer

Parameters

[in,out] up unique pointer of the class at input, points to null pointer at output

Returns: the shared pointer of the class

Method only calledby the friend class CORE_ClassFactory::NewSharedInstance()

References CORE_Object::mThis.

◆ setZeemanParticlesNumber()

void SM_ZeemanOperator::setZeemanParticlesNumber ( const tIndex & p )

inlineprotectedinherited

set zeeman particlules number

Parameters

[in] p : the number of Zeeman particules number

References SM_ZeemanOperator::mZeemanParticlesNumber.

Referenced by discretize(), SM_PermanentZeemanOperator::discretize(), SM_ZeemanOperator::discretize(), setBext(), and SM_ConstantZeemanOperator().

Here is the caller graph for this function:

◆ setZeemanTimeStepsNumber()

void SM_ZeemanOperator::setZeemanTimeStepsNumber ( const tIndex & n )

inlineprotectedinherited

set zeeman time steps

Parameters

[in] n : the number of Zeeman times steps

References SM_ZeemanOperator::mZeemanTimeStepsNumber.

Referenced by discretize(), SM_PermanentZeemanOperator::discretize(), SM_ZeemanOperator::discretize(), setBext(), SM_ConstantZeemanOperator(), and SM_PermanentZeemanOperator::SM_PermanentZeemanOperator().

Here is the caller graph for this function:

◆ toString()

virtual tString CORE_Object::toString ( ) const

inlinevirtualinherited

return the string representation of the object node

Returns: the string representation of the object node

Reimplemented in SM_TimeStepper, SM_System, SM_StochasticFunction, SM_Network, SM_LandauLifschitzFunction, SM_Beam, CORE_Field< T, K, D, S, I >, CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >, CORE_Field< T, K, D, CORE_StdValArray< T >, CORE_StdValField< T, K, D > >, CORE_Collection< T, I >, CORE_ClassFactory, and SM_NoiseRateFunction.

References CORE_Object::getIdentityString().

Referenced by SM_Run::run(), CORE_Collection< T, I >::toString(), SM_Beam::toString(), SM_Network::toString(), SM_StochasticFunction::toString(), SM_System::toString(), and SM_TimeStepper::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mBext

std::valarray<tReal> SM_ZeemanOperator::mBext

privateinherited

Referenced by SM_ZeemanOperator::copy(), SM_ZeemanOperator::getBext(), SM_ZeemanOperator::getBextAsArray(), SM_ZeemanOperator::getContentsMemorySize(), and SM_ZeemanOperator::setBext().

◆ mDimension

tDimension SM_ZeemanOperator::mDimension

privateinherited

Referenced by SM_ZeemanOperator::copy(), SM_ZeemanOperator::getBext(), SM_ZeemanOperator::getZeemanDimension(), and SM_ZeemanOperator::SM_ZeemanOperator().

◆ mName

tString SM_Operator::mName

privateinherited

Referenced by SM_Operator::copy(), SM_Operator::getContentsMemorySize(), SM_Operator::getName(), SM_Operator::setName(), and SM_Operator::SM_Operator().

◆ mThis

std::weak_ptr<CORE_Object> CORE_Object::mThis

privateinherited

Referenced by CORE_Object::getConstSharedPointer(), CORE_Object::getSharedPointer(), and CORE_Object::setThis().

◆ mZeemanParticlesNumber

tIndex SM_ZeemanOperator::mZeemanParticlesNumber

privateinherited

Referenced by SM_ZeemanOperator::computeTemplatedEnergy(), SM_ZeemanOperator::computeTemplatedMagneticFieldAndEnergy(), SM_ZeemanOperator::copy(), SM_ZeemanOperator::getBext(), SM_ZeemanOperator::getZeemanParticlesNumber(), SM_ZeemanOperator::setZeemanParticlesNumber(), and SM_ZeemanOperator::SM_ZeemanOperator().

◆ mZeemanTimeStepsNumber

tIndex SM_ZeemanOperator::mZeemanTimeStepsNumber

privateinherited

Referenced by SM_ZeemanOperator::copy(), SM_ZeemanOperator::getBext(), SM_ZeemanOperator::getZeemanTimeStepsNumber(), SM_ZeemanOperator::setZeemanTimeStepsNumber(), and SM_ZeemanOperator::SM_ZeemanOperator().

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

SM_ConstantZeemanOperator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SM_ConstantZeemanOperator()

◆ ~SM_ConstantZeemanOperator()

Member Function Documentation

◆ computeEnergy() [1/3]

◆ computeEnergy() [2/3]

◆ computeEnergy() [3/3]

◆ computeMagneticField() [1/2]

◆ computeMagneticField() [2/2]

◆ computeMagneticFieldAndEnergy()

◆ computeTemplatedEnergy()

◆ computeTemplatedMagneticField()

◆ computeTemplatedMagneticFieldAndEnergy() [1/2]

◆ computeTemplatedMagneticFieldAndEnergy() [2/2]

◆ copy()

◆ DisableMemoryStack()

◆ discretize()

◆ EnableMemoryStack() [1/2]

◆ EnableMemoryStack() [2/2]

◆ getBext() [1/4]

◆ getBext() [2/4]

◆ getBext() [3/4]

◆ getBext() [4/4]

◆ getBextAsArray() [1/2]

◆ getBextAsArray() [2/2]

◆ getClassName()

◆ getConstSharedPointer()

◆ getContentsMemorySize()

◆ getIdentityString()

◆ getMemorySize()

◆ getName()

◆ getPointerString()

◆ GetRegisteredClassesNumber()

◆ getSharedPointer()

◆ getZeemanDimension()

◆ getZeemanParticlesNumber()

◆ getZeemanTimeStepsNumber()

◆ isInstanceOf()

◆ IsMemoryStackEnabled()

◆ MemoryStackToString()

◆ New()

◆ NewInstance()

◆ setBext() [1/3]

◆ setBext() [2/3]

◆ setBext() [3/3]

◆ setName()

◆ setThis()

◆ setZeemanParticlesNumber()

◆ setZeemanTimeStepsNumber()

◆ toString()

Member Data Documentation

◆ mBext

◆ mDimension

◆ mName

◆ mThis

◆ mZeemanParticlesNumber

◆ mZeemanTimeStepsNumber