StochMagnet Core package contains all classes used in the Stoch Magnet module.

It contains the usefull classes:

SM_Types.h : defined the special types used in the module
SM_Object : the base class of all the classes of the module which implements CORE_Object class
SM_Exception : the exception manager of the module which implements CORE_Exception
SM_Constants: the defined physical constants
SM_Field [T,K,D] describes a field with T type of size \( (R^D)^n \) K isthe type od D. The real implementation of the class is SM_RealField
SM_Options : options of the package
SM_Loader : the class loader of the system
SM_ClassFactory : the classes factory of the module to instanciate classes & initialize them form options

The beam simulation classes are SM_Beam to generate the trajectories of a beam which are linked to

SM_MultiStochasticFunctionsInterface to simulate stochastic random normal / uniform distribution whose virtual abstract methods are implemented in SM_MultiStochasticFunctions whose templated abstract methods are defined in Stochastic functions for modeling Brownian perturbation
SM_System : the system class which describes the system to solve which can be either
- a Landau Lifschitz system defined in Landau Lifschitz Systems package or
- a Monte Carlo system defined in Monte Carlo Systems package

A trajectory is simulate by SM_System which are linked to

SM_Network which defined a network of particles implemented in network package of Stoch Magnet module. A network is built as a grid of unit cell of crystal structure SM_CrystalStructure. The interface dedicated to network builder is SM_networkBuilder implemented in stochmagnet_network
SM_Material to defines the material of particles linked to a generic SM_CrystalStructure implment in crystal structures package of Stoch Magnet module
SM_Field to store the evolution of the magnetic moment directions \( S_t\) from initial state \(S_0\).
a list of SM_Operator classes to describe the magnetic operators associated to the system. The opertors are defined in stochmagnet_operators. An operator must implements:
- SM_Operator::computeMagneticField() used in computing the magnetic moment directions time evolution within Laudau Lifschitz system
- SM_Operator::computeSpinEnergy() used in computing the magnetic moment directions evolution within Monte Carlo System

SM_SliceOperator implements the operator methods on a slice of particles of the network. This class is a generic operator classes which is independent from openMP or MPI facilities.

During the trajectory process, stochastic output are computed within the templated SM_StochasticOutput [I] which implements the virtual abstract methods of SM_StochasticOutputComponent thanks to templated abstract methods defined in stochasti cOutput package to define the stochastic data to save during the simulation of beam..

The main program in launch within the packages

main package for running MPI version of Stoch Magnet core
stochmagnet_main_omp
stochmagnet_main_serial

It can run a cycle of beam simulations defined in cycle package to run a cycle of beam of trajectories in the Stoch Magnet code.

The organization of this package is as follow: