Hamiltonian_Set_Field()
Hamiltonian_Get_Field()
Hamiltonian_Set_Anisotropy()
Hamiltonian_Get_Anisotropy()
Hamiltonian_Set_Biaxial_Anisotropy()
Hamiltonian_Get_Biaxial_Anisotropy()
SPIRIT_CHIRALITY_BLOCH
SPIRIT_CHIRALITY_NEEL
SPIRIT_CHIRALITY_BLOCH_INVERSE
SPIRIT_CHIRALITY_NEEL_INVERSE
Hamiltonian_Set_DMI()
Hamiltonian_Get_DMI_Shells()
Hamiltonian_Get_DMI_N_Pairs()
Hamiltonian_Set_Exchange()
Hamiltonian_Get_Exchange_Shells()
Hamiltonian_Get_Exchange_N_Pairs()
Hamiltonian_Get_Exchange_Pairs()
SPIRIT_DDI_METHOD_NONE
SPIRIT_DDI_METHOD_FFT
SPIRIT_DDI_METHOD_CUTOFF
Hamiltonian_Set_DDI()
Hamiltonian_Get_DDI()
Installation
C API
Chain_Get_NOI()
Chain_next_Image()
Chain_prev_Image()
Chain_Jump_To_Image()
Chain_Set_Length()
Chain_Image_to_Clipboard()
Chain_Replace_Image()
Chain_Insert_Image_Before()
Chain_Insert_Image_After()
Chain_Push_Back()
Chain_Delete_Image()
Chain_Pop_Back()
Chain_Get_Rx()
Chain_Get_Rx_Interpolated()
Chain_Get_Energy()
Chain_Get_Energy_Interpolated()
Chain_Update_Data()
Chain_Setup_Data()
Configuration_To_Clipboard()
Configuration_From_Clipboard()
Configuration_From_Clipboard_Shift()
Configuration_Domain()
Configuration_PlusZ()
Configuration_MinusZ()
Configuration_Random()
Configuration_SpinSpiral()
Configuration_SpinSpiral_2q()
Configuration_Add_Noise_Temperature()
Configuration_Displace_Eigenmode()
Configuration_Skyrmion()
Configuration_DW_Skyrmion()
Configuration_Hopfion()
Configuration_Set_Pinned()
Configuration_Set_Atom_Type()
defaultPos
defaultRect
defaultNormal
Constants_mu_B()
Constants_mu_0()
Constants_k_B()
Constants_hbar()
Constants_mRy()
Constants_gamma()
Constants_g_e()
Constants_Pi()
Bravais_Lattice_Type
Geometry_Set_Boundary_Conditions()
Geometry_Set_Bravais_Lattice_Type()
Geometry_Set_N_Cells()
Geometry_Set_Cell_Atoms()
Geometry_Set_mu_s()
Geometry_Set_spin_qn()
Geometry_Set_Cell_Atom_Types()
Geometry_Set_Bravais_Vectors()
Geometry_Set_Lattice_Constant()
Geometry_Get_Boundary_Conditions()
Geometry_Get_NOS()
Geometry_Get_Center()
Geometry_Get_Bravais_Vectors()
Geometry_Get_Dimensionality()
Geometry_Get_mu_s()
Geometry_Get_spin_qn()
Geometry_Get_N_Cells()
Geometry_Get_N_Cell_Atoms()
Geometry_Get_Cell_Bounds()
Geometry_Get_Cell_Atoms()
Geometry_Get_Triangulation()
Geometry_Get_Triangulation_Ranged()
Geometry_Get_Tetrahedra()
Geometry_Get_Tetrahedra_Ranged()
SPIRIT_DDI_METHOD_FMM
SPIRIT_HAMILTONIAN_CLASS_GENERIC
SPIRIT_HAMILTONIAN_CLASS_GAUSSIAN
SPIRIT_HAMILTONIAN_CLASS_HEISENBERG
Hamiltonian_Set_Boundary_Conditions()
Hamiltonian_Get_Boundary_Conditions()
Hamiltonian_Get_Biaxial_Anisotropy_N_Atoms()
Hamiltonian_Get_Biaxial_Anisotropy_N_Terms()
Hamiltonian_Write_Hessian()
HTST_Calculate()
HTST_Get_Info()
HTST_Get_Eigenvalues_Min()
HTST_Get_Eigenvectors_Min()
HTST_Get_Eigenvalues_SP()
HTST_Get_Eigenvectors_SP()
HTST_Get_Velocities()
IO_Fileformat_OVF_bin
IO_Fileformat_OVF_bin4
IO_Fileformat_OVF_bin8
IO_Fileformat_OVF_text
IO_Fileformat_OVF_csv
IO_Fileformat_VTK_hdf
IO_Fileformat_VTK_XML_bin
IO_Fileformat_VTK_XML_text
IO_System_From_Config()
IO_Positions_Write()
IO_N_Images_In_File()
IO_Image_Read()
IO_Image_Write()
IO_Image_Append()
IO_Chain_Read()
IO_Chain_Write()
IO_Chain_Append()
IO_Image_Write_Neighbours_Exchange()
IO_Image_Write_Neighbours_DMI()
IO_Image_Write_Energy_per_Spin()
IO_Image_Write_Energy()
IO_Chain_Write_Energies()
IO_Chain_Write_Energies_Interpolated()
IO_Eigenmodes_Read()
IO_Eigenmodes_Write()
Spirit_Log_Level
Spirit_Log_Sender
Log_Send()
Log_Append()
Log_Get_N_Entries()
Log_Get_N_Errors()
Log_Get_N_Warnings()
Log_Get_Output_File_Tag()
Log_Get_Output_Folder()
Log_Get_Output_To_Console()
Log_Get_Output_To_File()
Log_Set_Output_File_Tag()
Log_Set_Output_Folder()
Log_Set_Output_To_Console()
Log_Set_Output_To_File()
MC_Metropolis_Step_Spin_Sphere
MC_Metropolis_Step_Spin_Cone
MC_Metropolis_Step_Spin_Semi_Classical
Parameters_MC_Metropolis_Parameters
step
use_adaptive_cone
target_acceptance_ratio
cone_angle
Parameters_MC_Set_Output_Tag()
Parameters_MC_Set_Output_Folder()
Parameters_MC_Set_Output_General()
Parameters_MC_Set_Output_Energy()
Parameters_MC_Set_Output_Configuration()
Parameters_MC_Set_N_Iterations()
Parameters_MC_Set_Temperature()
Parameters_MC_Set_Metropolis_Parameters()
Parameters_MC_Set_Metropolis_Cone()
Parameters_MC_Set_Random_Sample()
Parameters_MC_Get_Output_Tag()
Parameters_MC_Get_Output_Folder()
Parameters_MC_Get_Output_General()
Parameters_MC_Get_Output_Energy()
Parameters_MC_Get_Output_Configuration()
Parameters_MC_Get_N_Iterations()
Parameters_MC_Get_Temperature()
Parameters_MC_Get_Metropolis_Cone()
Parameters_MC_Get_Metropolis_Parameters()
Parameters_MC_Get_Random_Sample()
Parameters_LLG_Set_Output_Tag()
Parameters_LLG_Set_Output_Folder()
Parameters_LLG_Set_Output_General()
Parameters_LLG_Set_Output_Energy()
Parameters_LLG_Set_Output_Configuration()
Parameters_LLG_Set_N_Iterations()
Parameters_LLG_Set_Direct_Minimization()
Parameters_LLG_Set_Convergence()
Parameters_LLG_Set_Time_Step()
Parameters_LLG_Set_Damping()
Parameters_LLG_Set_Non_Adiabatic_Damping()
Parameters_LLG_Set_STT()
Parameters_LLG_Set_Temperature()
Parameters_LLG_Set_Temperature_Gradient()
Parameters_LLG_Get_Output_Tag()
Parameters_LLG_Get_Output_Folder()
Parameters_LLG_Get_Output_General()
Parameters_LLG_Get_Output_Energy()
Parameters_LLG_Get_Output_Configuration()
Parameters_LLG_Get_N_Iterations()
Parameters_LLG_Get_Direct_Minimization()
Parameters_LLG_Get_Convergence()
Parameters_LLG_Get_Time_Step()
Parameters_LLG_Get_Damping()
Parameters_LLG_Get_Non_Adiabatic_Damping()
Parameters_LLG_Get_Temperature()
Parameters_LLG_Get_Temperature_Gradient()
Parameters_LLG_Get_STT()
GNEB_IMAGE_NORMAL
GNEB_IMAGE_CLIMBING
GNEB_IMAGE_FALLING
GNEB_IMAGE_STATIONARY
Parameters_GNEB_Set_Output_Tag()
Parameters_GNEB_Set_Output_Folder()
Parameters_GNEB_Set_Output_General()
Parameters_GNEB_Set_Output_Energies()
Parameters_GNEB_Set_Output_Chain()
Parameters_GNEB_Set_N_Iterations()
Parameters_GNEB_Set_Convergence()
Parameters_GNEB_Set_Spring_Constant()
Parameters_GNEB_Set_Spring_Force_Ratio()
Parameters_GNEB_Set_Path_Shortening_Constant()
Parameters_GNEB_Set_Moving_Endpoints()
Parameters_GNEB_Set_Translating_Endpoints()
Parameters_GNEB_Set_Equilibrium_Delta_Rx()
Parameters_GNEB_Set_Climbing_Falling()
Parameters_GNEB_Set_Image_Type_Automatically()
Parameters_GNEB_Set_N_Energy_Interpolations()
Parameters_GNEB_Get_Output_Tag()
Parameters_GNEB_Get_Output_Folder()
Parameters_GNEB_Get_Output_General()
Parameters_GNEB_Get_Output_Energies()
Parameters_GNEB_Get_Output_Chain()
Parameters_GNEB_Get_N_Iterations()
Parameters_GNEB_Get_Convergence()
Parameters_GNEB_Get_Spring_Constant()
Parameters_GNEB_Get_Spring_Force_Ratio()
Parameters_GNEB_Get_Path_Shortening_Constant()
Parameters_GNEB_Get_Moving_Endpoints()
Parameters_GNEB_Get_Translating_Endpoints()
Parameters_GNEB_Get_Equilibrium_Delta_Rx()
Parameters_GNEB_Get_Climbing_Falling()
Parameters_GNEB_Get_N_Energy_Interpolations()
Parameters_EMA_Clear_Modes()
Parameters_EMA_Set_N_Modes()
Parameters_EMA_Set_N_Mode_Follow()
Parameters_EMA_Set_Frequency()
Parameters_EMA_Set_Amplitude()
Parameters_EMA_Set_Snapshot()
Parameters_EMA_Set_Sparse()
Parameters_EMA_Get_N_Modes()
Parameters_EMA_Get_N_Mode_Follow()
Parameters_EMA_Get_Frequency()
Parameters_EMA_Get_Amplitude()
Parameters_EMA_Get_Snapshot()
Parameters_EMA_Get_Sparse()
Parameters_MMF_Set_Output_Tag()
Parameters_MMF_Set_Output_Folder()
Parameters_MMF_Set_Output_General()
Parameters_MMF_Set_Output_Energy()
Parameters_MMF_Set_Output_Configuration()
Parameters_MMF_Set_N_Iterations()
Parameters_MMF_Set_N_Modes()
Parameters_MMF_Set_N_Mode_Follow()
Parameters_MMF_Get_Output_Tag()
Parameters_MMF_Get_Output_Folder()
Parameters_MMF_Get_Output_General()
Parameters_MMF_Get_Output_Energy()
Parameters_MMF_Get_Output_Configuration()
Parameters_MMF_Get_N_Iterations()
Parameters_MMF_Get_N_Modes()
Parameters_MMF_Get_N_Mode_Follow()
Quantity_Get_Average_Spin()
Quantity_Get_Magnetization()
Quantity_Get_Topological_Charge()
Quantity_Get_Topological_Charge_Density()
Quantity_Get_Grad_Force_MinimumMode()
Solver_VP
Solver_SIB
Solver_Depondt
Solver_Heun
Solver_RungeKutta4
Solver_LBFGS_OSO
Solver_LBFGS_Atlas
Solver_VP_OSO
MC_Algorithm_Metropolis
MC_Algorithm_Metropolis_MDC
Simulation_Run_Info
free_run_info()
Simulation_MC_Start()
Simulation_LLG_Start()
Simulation_GNEB_Start()
Simulation_MMF_Start()
Simulation_EMA_Start()
Simulation_SingleShot()
Simulation_N_Shot()
Simulation_Stop()
Simulation_Stop_All()
Simulation_Get_MaxTorqueNorm()
Simulation_Get_Chain_MaxTorqueNorms()
Simulation_Get_IterationsPerSecond()
Simulation_Get_Iteration()
Simulation_Get_Time()
Simulation_Get_Wall_Time()
Simulation_Running_On_Image()
Simulation_Running_On_Chain()
Simulation_Running_Anywhere_On_Chain()
State
State_Setup()
State_Delete()
State_Update()
State_To_Config()
State_DateTime()
System_Get_Index()
System_Get_NOS()
System_Get_Spin_Directions()
System_Get_Effective_Field()
System_Get_Eigenmode()
System_Get_Rx()
System_Get_Energy()
System_Get_Energy_Array_Names()
System_Get_Energy_Array()
System_Get_Eigenvalues()
System_Print_Energy_Array()
System_Update_Energy()
System_Update_Magnetization()
System_Update_Effective_Field()
System_Update_Data()
System_Update_Eigenmodes()
Transition_Homogeneous()
Transition_Homogeneous_Insert_Interpolated()
Transition_Add_Noise_Temperature()
Legacy_Convert_Config_to_TOML()
Python API
delete_image()
get_energy()
get_energy_interpolated()
get_noi()
get_reaction_coordinate()
get_reaction_coordinate_interpolated()
image_to_clipboard()
insert_image_after()
insert_image_before()
jump_to_image()
next_image()
pop_back()
prev_image()
push_back()
replace_image()
set_length()
setup_data()
update_data()
add_noise()
domain()
dw_skyrmion()
hopfion()
minus_z()
plus_z()
random()
set_atom_type()
set_pinned()
skyrmion()
spin_spiral()
g_e
gamma
hbar
k_B
mRy
mu_0
mu_B
pi
BRAVAIS_LATTICE_BCC
BRAVAIS_LATTICE_FCC
BRAVAIS_LATTICE_HCP
BRAVAIS_LATTICE_HEX2D
BRAVAIS_LATTICE_HEX2D_120
BRAVAIS_LATTICE_HEX2D_60
BRAVAIS_LATTICE_IRREGULAR
BRAVAIS_LATTICE_RECTILINEAR
BRAVAIS_LATTICE_SC
get_atom_types()
get_boundary_conditions()
get_bounds()
get_bravais_lattice_type()
get_bravais_vectors()
get_center()
get_dimensionality()
get_n_cell_atoms()
get_n_cells()
get_positions()
set_boundary_conditions()
set_bravais_lattice_type()
set_bravais_vectors()
set_cell_atom_types()
set_lattice_constant()
set_mu_s()
set_n_cells()
BiaxialAnisotropyData
BiaxialAnisotropyData.exponents
BiaxialAnisotropyData.indices
BiaxialAnisotropyData.magnitude
BiaxialAnisotropyData.primary
BiaxialAnisotropyData.secondary
BiaxialAnisotropyData.site_p
CHIRALITY_BLOCH
CHIRALITY_BLOCH_INVERSE
CHIRALITY_NEEL
CHIRALITY_NEEL_INVERSE
DDI_METHOD_CUTOFF
DDI_METHOD_FFT
DDI_METHOD_FMM
DDI_METHOD_NONE
get_anisotropy()
get_biaxial_anisotropy()
get_biaxial_anisotropy_n_atoms()
get_biaxial_anisotropy_n_terms()
get_cubic_anisotropy()
get_ddi()
get_field()
get_name()
set_anisotropy()
set_biaxial_anisotropy()
set_cubic_anisotropy()
set_ddi()
set_dmi()
set_exchange()
set_field()
write_hessian()
calculate()
get_eigenvalues_min()
get_eigenvalues_sp()
get_eigenvectors_min()
get_eigenvectors_sp()
get_info()
get_info_dict()
get_velocities()
FILEFORMAT_OVF_BIN
FILEFORMAT_OVF_BIN4
FILEFORMAT_OVF_BIN8
FILEFORMAT_OVF_CSV
FILEFORMAT_OVF_TEXT
FILEFORMAT_VTK_HDF
FILEFORMAT_VTK_XML_BIN
FILEFORMAT_VTK_XML_TEXT
chain_append()
chain_read()
chain_write()
eigenmodes_read()
eigenmodes_write()
image_append()
image_read()
image_write()
image_write_energy_per_spin()
n_images_in_file()
LEVEL_ALL
LEVEL_DEBUG
LEVEL_ERROR
LEVEL_INFO
LEVEL_PARAMETER
LEVEL_SEVERE
LEVEL_WARNING
SENDER_ALL
SENDER_API
SENDER_GNEB
SENDER_IO
SENDER_LLG
SENDER_MC
SENDER_MMF
SENDER_UI
append()
get_n_entries()
get_n_errors()
get_n_warnings()
get_output_console_level()
get_output_file_level()
get_output_to_console()
get_output_to_file()
send()
set_output_file_tag()
set_output_folder()
set_output_to_console()
set_output_to_file()
get_magnetization()
get_mmf_info()
get_topological_charge()
get_topological_charge_density()
MC_ALGORITHM_METROPOLIS
MC_ALGORITHM_METROPOLIS_MDC
METHOD_EMA
METHOD_GNEB
METHOD_LLG
METHOD_MC
METHOD_MMF
SOLVER_DEPONDT
SOLVER_HEUN
SOLVER_LBFGS_Atlas
SOLVER_LBFGS_OSO
SOLVER_RK4
SOLVER_SIB
SOLVER_VP
SOLVER_VP_OSO
get_iterations_per_second()
get_max_torque_norm()
get_time()
get_wall_time()
n_shot()
running_anywhere_on_chain()
running_on_chain()
running_on_image()
simulation_run_info
simulation_run_info.history_energy()
simulation_run_info.history_iteration()
simulation_run_info.history_max_torque()
simulation_run_info.max_torque
simulation_run_info.total_ips
simulation_run_info.total_iterations
simulation_run_info.total_walltime
single_shot()
start()
stop()
stop_all()
date_time()
delete()
setup()
to_config()
get_effective_field()
get_eigenmode()
get_eigenvalues()
get_energy_contributions()
get_index()
get_nos()
get_spin_directions()
print_energy_array()
update_effective_field()
update_eigenmodes()
update_energy()
update_magnetization()
homogeneous()
homogeneous_insert_interpolated()
convert_config_to_toml()
deprecated
Further Information
Contributing
Contributors
How to Reference this code
Desktop GUI description
See the Core reference section for further information on the core library.