TBTK
TBTK::Solver::Diagonalizer::SelfConsistencyCallback Class Referenceabstract

#include <Diagonalizer.h>

Public Member Functions

virtual bool selfConsistencyCallback (Diagonalizer &diagonalizer)=0
 

Detailed Description

Abstract base class for self-consistency callbacks.

Member Function Documentation

◆ selfConsistencyCallback()

virtual bool TBTK::Solver::Diagonalizer::SelfConsistencyCallback::selfConsistencyCallback ( Diagonalizer diagonalizer)
pure virtual

Function that is called after the Hamiltonian have been diagonalized and is responsible for carrying out the self-consistency step. The function should return true if the result has converged and false otherwise.

Parameters
diagonalizerThe solver that calls the self-consistency callback-
Returns
True if the solution has converged, otherwise false.

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