ScfResult

class ase2sprkkr.outputs.readers.scf.ScfResult(input_parameters, calculator, directory, output_file=None, input_file=None, task_name=None)[source]

Objects of this class holds the results of a self-consistent cycle and its iterations. It also allows to plot the convergence of values during iterations.

Class hierarchy

Inheritance diagram of ase2sprkkr.outputs.readers.scf.ScfResult


Constructor

__init__(input_parameters, calculator, directory, output_file=None, input_file=None, task_name=None)
produces_potential = True

Whether this result produces a new potential usable by later tasks.

property calculator[source]

The calculator that has the new (output) potential assigned - i.e. that can be used for further calculations with the (hopefully) converged wavefunctions etc.

property sfn_filename[source]

Shape-function file reported by SPR-KKR, if any.

property sfn[source]

Shape functions used by a full-potential calculation.

property _sfn_file[source]
property potential_filename
property start_potential_filename
property start_potential[source]

Potential used as input for the SCF calculation.

property any_potential

Return the parsed result potential, falling back to the input one.

property energy

Total energy of the last iteration

property converged

The calculation coverged or not?

iteration_values(name)[source]

Return the array of values of given name from the iterations (i.e. “the column of the table of the values”)

E.g. result.iteration_values((‘energy’, ‘ETOT’)) return list of floats - the total energies computed in each iteration.

Parameters:

name (str) – Name of the parameter

Returns:

values – The values.

Return type:

list

property last_iteration

Return the data of the last iteration

property energies
property _scf_output_values[source]
property output_values
plot(what=['error', ('energy', 'ETOT'), ('energy', 'EMIN')], filename=None, logscale=None, **kwargs)[source]

Plot the development of the given value(s) during iterations.

Parameters:
  • what (list[str]) – Names to be plotted

  • filename (str or None) – If filename is given, the plot is rendered to the file, it is show on the screen otherwise.

  • logscale (collections.abc.Set[str]) – Which values should be rendered in logscale

  • **kwargs (dict) – All other arguments are passed to the matplotlib Axes.plot function