sc::PsiCCSD(3)

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

πŸ’… sc::PsiCCSD β€” the MPQC manual, bestie edition πŸŽ€

okay so this is a page from the MPQC manual set, and it's all about sc::PsiCCSD. buckle up, it's actually not that deep, i promise 🫢


✨ NAME ✨

sc::PsiCCSD β€” PsiCCSD is a concrete implementation of Psi CCSD wave function. that's it, that's the vibe. πŸ’–


🌸 SYNOPSIS 🌸

#include <psiwfn.h>

so like, first things first, you gotta include that header. no cap. πŸ“Ž

Inherits sc::PsiWavefunction. yes she comes from a long line of wavefunction girlies, it's giving legacy πŸ‘‘


πŸ¦‹ Public Member Functions πŸ¦‹

  • PsiCCSD (const Ref< KeyVal > &) β€” one constructor, and it eats a Ref< KeyVal > &. that's the whole thing ✨
  • PsiCCSD (StateIn &) β€” the other constructor, this one takes a StateIn &. two ways in, pick your fighter πŸ’…
  • 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. like, the exact same order, do not mess with the order, i'm serious πŸ™ˆ
  • int spin_polarized () β€” returns 1 if the alpha density is not equal to the beta density. returns not-1 otherwise, obviously. lowkey obsessed with this little guy πŸ“
  • int gradient_implemented () const β€” returns an int, it's const, and that's genuinely all the info this page gives us. iconic minimalism πŸ’€

🧚 Protected Member Functions 🧚

  • void write_input (int conv) β€” prepares a complete Psi input file. the input file is assumed to have been opened already, so like... don't come to her with a closed file, bestie, she will not be opening it for you 😭 takes an int conv too, just so you know. πŸŽ€

🌈 Additional Inherited Members 🌈

there's more stuff inherited, but it lives on other pages. this page is being mysterious about it and honestly? respect. 🫢


πŸ‘‘ Detailed Description πŸ‘‘

PsiCCSD is a concrete implementation of Psi CCSD wave function. (yes, it's the same sentence as the NAME section. she said it once, she said it twice, and honestly she ate both times πŸ”₯)


πŸ’œ Member Function Documentation πŸ’œ

⭐ void sc::PsiCCSD::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. like, mandatory, not optional, no skipping, fr fr 🚨

Reimplemented from sc::PsiWavefunction.


πŸ’– Author πŸ’–

Generated automatically by Doxygen for MPQC from the source code. not a human, a robot, and honestly the robot is doing great πŸ’…βœ¨


that's the whole page!! you made it!! πŸŽ‰πŸ¦‹πŸŒΈ and just so we're clear on the paperwork: this is Version 2.3.1, dated Sun Oct 4 2020, and the manual is sc::PsiCCSD(3) β€” go forth and wavefunction responsibly, bestie πŸ’–πŸŽ€πŸ‘‘

πŸ“¦ where this page comes from