timing Class Reference

#include <time_integration.h>

Public Member Functions
	timing (const double _tf, const double _dtmin, const double _dtmax)
double	get_dt () const
double	get_dt_phys () const
void	set_dt (const double _dt)
bool	is_dt_TooSmall () const
void	inc_t ()
double	get_t () const
double	get_t_phys () const
void	set_t (const double _t)

Public Attributes
const double	tf
const double	DTMIN
const double	DTMAX
const double	TAUR
double	prefactor

Private Attributes
double	t
double	dt

Detailed Description

all timing parameters for integrating in time LLG with adaptative time-step and relaxation corrections throught prefactor=f(dt) All the times (t, dt, tf, DTMIN, DTMAX, TAUR) are reduced times \( \tau = \gamma_0 t \) [m/A]: LLG is solved in reduced time. The physical time \( t = \tau/\gamma_0 \) is only used by the interfaces (settings, applied field expressions, outputs), through get_t_phys() and get_dt_phys().

Constructor & Destructor Documentation

timing()

timing::timing ( const double  _tf, const double  _dtmin, const double  _dtmax  )

inline

constructor : fully initializes the timing parameters, initial time step initialized with geometric average of DTMIN and DTMAX

Member Function Documentation

get_dt()

double timing::get_dt ( ) const

inline

getter for (reduced) time step dt

get_dt_phys()

double timing::get_dt_phys ( ) const

inline

getter for the physical time step [s]

get_t()

double timing::get_t ( ) const

inline

getter for (reduced) time t

get_t_phys()

double timing::get_t_phys ( ) const

inline

getter for the physical time [s]

inc_t()

void timing::inc_t ( )

inline

increment time t with time step dt

is_dt_TooSmall()

bool timing::is_dt_TooSmall ( ) const

inline

basic test to know if dt is too small

set_dt()

void timing::set_dt ( const double  _dt )

inline

setter for time step dt : prefactor is computed from the new dt value to maintain synchronization of dt and prefactor

set_t()

void timing::set_t ( const double  _t )

inline

setter for t

Member Data Documentation

dt

double timing::dt

private

reduced time-step

DTMAX

const double timing::DTMAX

maximum step time for time integrator

DTMIN

const double timing::DTMIN

minimum step time for time integrator

prefactor

double timing::prefactor

this prefactor must be synchronized with dt value

t

double timing::t

private

reduced current time of the simulation

TAUR

const double timing::TAUR

reduced \( \tau_r = 100 DT_{\mathrm{max}} \)

tf

const double timing::tf

final (reduced) time of the simulation

---

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

• src/time_integration.h