sc::SelfConsistentExtrapolation(3)

🦋 sc::SelfConsistentExtrapolation — MPQC manual page (3)

Hey bestie, welcome to the MPQC manual page for sc::SelfConsistentExtrapolation. It’s giving abstract-base-class main character energy, and we are keeping every tiny detail. 💅

---

🌸 NAME

sc::SelfConsistentExtrapolation is the abstract class used to iteratively solve equations requiring a self consistent solution, such as,. That trailing such as,. is exactly how the page ends that sentence — no cap, we’re preserving it. 💀

---

✨ SYNOPSIS

#include <scextrap.h>

• Inherits sc::SavableState.
• Inherited by sc::DIIS.

👑 Public Member Functions

• SelfConsistentExtrapolation (StateIn &)
• SelfConsistentExtrapolation (const Ref< KeyVal > &) — The only keyword read is #tolerance#, which is usually not needed since the objects using SelfConsistentExtrapolation should set the tolerances as needed.
• void save_data_state (StateOut &) — Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
• void set_tolerance (double t)
• double tolerance ()
• double error ()
• int converged ()
• virtual int extrapolate (const Ref< SCExtrapData > &data, const Ref< SCExtrapError > &error)=0
• virtual void start_extrapolation ()
• virtual void reinitialize ()=0

🛡️ Protected Member Functions

• void set_error (double e)

🫶 Additional Inherited Members

The source page has this heading but doesn’t list anything under it here.

---

💀 Detailer Description

The heading is literally Detailer Description — typo included, bestie. The text under it is this gloriously corrupted block, so here it is verbatim so nothing gets lost:

       {he SelfConsistentExtrapolation abstract class is used to iteratively
       xolve equations requiring a self consistent solution, such as,.
       }
       '
       =

It’s giving Doxygen glitch core, but we keep it. 🫶

---

🧸 Constructor & Destructor Documentation

sc::SelfConsistentExtrapolation::SelfConsistentExtrapolation (const Ref< KeyVal > &)

The only keyword read is #tolerance#, which is usually not needed since the objects using SelfConsistentExtrapolation should set the tolerances as needed.

---

🌟 Member Function Documentation

void sc::SelfConsistentExtrapolation::save_data_state (StateOut &) [virtual]

Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. This must be implemented by the derived class if the class has data.

Reimplemented from sc::SavableState.

---

🌈 AUTHOR

Generated automatically by Doxygen for MPQC from the source code.

---

Big cute sign-off: this is the MPQC manual, version 2.3.1, dated Sun Oct 4 — and the footer’s tail is literally garbled as 20sc::SelfConsistentExtrapolation(3) in the source, so I’m preserving that chaotic energy too. Bye bestie 💖🎀