Package specific_analyses :: Package relax_disp :: Module optimisation :: Class Disp_memo
[hide private]
[frames] | no frames]

Class Disp_memo

source code


The relaxation dispersion memo class.

Instance Methods [hide private]
 
__init__(self, spins=None, spin_ids=None, sim_index=None, scaling_matrix=None, verbosity=None)
Initialise the relaxation dispersion memo class.
source code

Inherited from multi.memo.Memo: memo_id

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, spins=None, spin_ids=None, sim_index=None, scaling_matrix=None, verbosity=None)
(Constructor)

source code 

Initialise the relaxation dispersion memo class.

This is used for handling the optimisation results returned from a slave processor. It runs on the master processor and is used to store data which is passed to the slave processor and then passed back to the master via the results command.

Parameters:
  • spins (list of SpinContainer instances) - The list of spin data container for the cluster. If this argument is supplied, then the spin_id argument will be ignored.
  • spin_ids (list of str) - The spin ID strings for the cluster.
  • sim_index (int) - The optional MC simulation index.
  • scaling_matrix (numpy diagonal matrix) - The diagonal, square scaling matrix.
  • verbosity (int) - The verbosity level. This is used by the result command returned to the master for printouts.
Overrides: object.__init__