.TH "sc::SelfConsistentExtrapolation" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::SelfConsistentExtrapolation \- The \fBSelfConsistentExtrapolation\fP abstract class is used to iteratively solve equations requiring a self consistent solution, such as,\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <scextrap\&.h>\fP
.PP
Inherits \fBsc::SavableState\fP\&.
.PP
Inherited by \fBsc::DIIS\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSelfConsistentExtrapolation\fP (\fBStateIn\fP &)"
.br
.ti -1c
.RI "\fBSelfConsistentExtrapolation\fP (const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.RI "The only keyword read is #tolerance#, which is usually not needed since the objects using \fBSelfConsistentExtrapolation\fP should set the tolerances as needed\&. "
.ti -1c
.RI "void \fBsave_data_state\fP (\fBStateOut\fP &)"
.br
.RI "Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. "
.ti -1c
.RI "void \fBset_tolerance\fP (double t)"
.br
.ti -1c
.RI "double \fBtolerance\fP ()"
.br
.ti -1c
.RI "double \fBerror\fP ()"
.br
.ti -1c
.RI "int \fBconverged\fP ()"
.br
.ti -1c
.RI "virtual int \fBextrapolate\fP (const \fBRef\fP< \fBSCExtrapData\fP > &data, const \fBRef\fP< \fBSCExtrapError\fP > &error)=0"
.br
.ti -1c
.RI "virtual void \fBstart_extrapolation\fP ()"
.br
.ti -1c
.RI "virtual void \fBreinitialize\fP ()=0"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBset_error\fP (double e)"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSelfConsistentExtrapolation\fP abstract class is used to iteratively solve equations requiring a self consistent solution, such as,\&. 

\[ \bar{x}' = f(\bar{x}) \] 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::SelfConsistentExtrapolation::SelfConsistentExtrapolation (const \fBRef\fP< \fBKeyVal\fP > &)"

.PP
The only keyword read is #tolerance#, which is usually not needed since the objects using \fBSelfConsistentExtrapolation\fP should set the tolerances as needed\&. 
.br
 
.SH "Member Function Documentation"
.PP 
.SS "void sc::SelfConsistentExtrapolation::save_data_state (\fBStateOut\fP &)\fC [virtual]\fP"

.PP
Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. This must be implemented by the derived class if the class has data\&. 
.PP
Reimplemented from \fBsc::SavableState\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.