sc::SCExtrapData(3)

πŸ“¦
version 2.3.1 Β· 5 versions
, in ubuntu jammy

πŸ’… sc::SCExtrapData β€” a vibe check from the MPQC fam

Okay bestie, so this one's straight out of the MPQC manual and it's lowkey iconic: sc::SCExtrapData is the class that literally holds the data to be extrapolated β€” the stuff SelfConsistentExtrapolation needs to do its thing. That's the whole personality, no cap. 🫢


✨ NAME ✨

sc::SCExtrapData β€” holds the data to be extrapolated, the way SelfConsistentExtrapolation needs it. Periodt. πŸ’–


🌸 SYNOPSIS 🌸

#include <scextrap.h>

So it inherits from sc::SavableState (yes, it's part of the savable-state family tree 🌳), and these cuties inherit from it:

  • sc::SymmSCMatrix2SCExtrapData
  • sc::SymmSCMatrix4SCExtrapData
  • sc::SymmSCMatrixNSCExtrapData
  • sc::SymmSCMatrixSCExtrapData

πŸ’… Public Member Functions πŸ’…

  • SCExtrapData() β€” constructs a brand new SCExtrapData. Fresh out the box, main character energy. ✨
  • SCExtrapData(StateIn &) β€” the constructor that restores an SCExtrapData from a StateIn object. It's giving "save file but make it classy". πŸŽ€
  • void save_data_state(StateOut &) β€” saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. Order matters, bestie, don't play with it. πŸ”₯
  • virtual SCExtrapData * copy()=0 β€” returns a copy of this. Pure virtual, so the derived girlies have to bring their own implementation. πŸ’…
  • virtual void zero()=0 β€” sets this to zero. Pure virtual too. Zero thoughts, head empty. 🫧
  • virtual void accumulate_scaled(double scale, const Ref< SCExtrapData > &)=0 β€” the passed SCExtrapData gets accumulated into this after the scaling factor is applied. Pure virtual, so again β€” derived classes, y'all are on your own. 🌈

πŸ¦‹ Additional Inherited Members πŸ¦‹

(Yes, there's more that comes from the parent class β€” it's inherited, it's free, we love that for us. πŸ’œ)


πŸ‘‘ Detailed Description πŸ‘‘

SCExtrapData holds the data to be extrapolated that SelfConsistentExtrapolation needs. That's it, that's the job, and it does it flawlessly. πŸ’–


⭐ Member Function Documentation ⭐

🧚 void sc::SCExtrapData::save_data_state(StateOut &) [virtual]

Okay so this one saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. Like, this is not a suggestion, this is the assignment. πŸ“

Heads up bestie: this must be implemented by the derived class if the class has data. No data, no problem β€” but data? Implement it. Non-negotiable. 😀
  • Reimplemented from sc::SavableState.
  • Reimplemented in sc::SymmSCMatrixNSCExtrapData, sc::SymmSCMatrix4SCExtrapData, sc::SymmSCMatrix2SCExtrapData, and sc::SymmSCMatrixSCExtrapData. Slay, the whole squad showed up. πŸŽ‰

πŸ“ Author πŸ“

Generated automatically by Doxygen for MPQC from the source code. So like, not a human author, but honestly? Still ate. πŸ’€βœ¨


And that's the whole page, bestie β€” Version 2.3.1, dated Sun Oct 4 2020, straight from the MPQC source. Go forth and extrapolate responsibly. πŸ¦‹πŸ’œπŸŽ€

πŸ“¦ where this page comes from