Parameters_EMA

#include "Spirit/Parameters_EMA.h"

This method, if needed, calculates modes (they can also be read in from a file) and perturbs the spin system periodically in the direction of the eigenmode.

void Parameters_EMA_Clear_Modes(State *state, int idx_image = -1, int idx_chain = -1): Clears all the previously calculated modes from memory.

Set Parameters

void Parameters_EMA_Set_N_Modes(State *state, int n_modes, int idx_image = -1, int idx_chain = -1): Set the number of modes to calculate or use.

void Parameters_EMA_Set_N_Mode_Follow(State *state, int n_mode_follow, int idx_image = -1, int idx_chain = -1): Set the index of the mode to use.

void Parameters_EMA_Set_Frequency(State *state, scalar frequency, int idx_image = -1, int idx_chain = -1): Set the frequency with which the mode is applied.

void Parameters_EMA_Set_Amplitude(State *state, scalar amplitude, int idx_image = -1, int idx_chain = -1): Set the amplitude with which the mode is applied.

void Parameters_EMA_Set_Snapshot(State *state, bool snapshot, int idx_image = -1, int idx_chain = -1): Set whether to displace the system statically instead of periodically.

void Parameters_EMA_Set_Sparse(State *state, bool sparse, int idx_image = -1, int idx_chain = -1): Set whether to use sparse matrices.

Get Parameters

int Parameters_EMA_Get_N_Modes(State *state, int idx_image = -1, int idx_chain = -1): Returns the number of modes to calculate or use.

int Parameters_EMA_Get_N_Mode_Follow(State *state, int idx_image = -1, int idx_chain = -1): Returns the index of the mode to use.

scalar Parameters_EMA_Get_Frequency(State *state, int idx_image = -1, int idx_chain = -1): Returns the frequency with which the mode is applied.

scalar Parameters_EMA_Get_Amplitude(State *state, int idx_image = -1, int idx_chain = -1): Returns the amplitude with which the mode is applied.

bool Parameters_EMA_Get_Snapshot(State *state, int idx_image = -1, int idx_chain = -1): Returns whether to displace the system statically instead of periodically.

bool Parameters_EMA_Get_Sparse(State *state, int idx_image = -1, int idx_chain = -1): Returns whether to use sparse matrices.