qimpy.dft.electrons.SCF
=======================

.. currentmodule:: qimpy.dft.electrons

.. autoclass:: SCF
   :members:
   :show-inheritance:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
      :nosignatures:
   
      ~SCF.__init__
      ~SCF.add_child
      ~SCF.add_child_one_of
      ~SCF.cycle
      ~SCF.metric
      ~SCF.optimize
      ~SCF.precondition
      ~SCF.report
      ~SCF.save_checkpoint
      ~SCF.update
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~SCF.energy
      ~SCF.residual
      ~SCF.variable
      ~SCF.mix_fraction_mag
      ~SCF.q_kerker
      ~SCF.q_metric
      ~SCF.q_kappa
      ~SCF.n_eig_steps
      ~SCF.eig_threshold
      ~SCF.mix_density
      ~SCF.system
      ~SCF.K_kerker
      ~SCF.K_metric
      ~SCF.comm
      ~SCF.name
      ~SCF.n_iterations
      ~SCF.energy_threshold
      ~SCF.residual_threshold
      ~SCF.n_consecutive
      ~SCF.n_history
      ~SCF.mix_fraction
      ~SCF.extra_thresholds
      ~SCF.child_names
      ~SCF.variant_name