sc::PsiExEnv(3)

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

okay so you're looking at sc::PsiExEnv from the MPQC manual β€” yes, bestie, the sc::PsiExEnv(3) page β€” and it is literally all about specifying a Psi calculation. πŸ’…βœ¨

🌸 NAME 🌸

sc::PsiExEnv β€” PsiExEnv specifies a Psi calculation.

✨ SYNOPSIS ✨

#include <psiexenv.h>

Inherits sc::DescribedClass.

So you include that header, and it inherits from sc::DescribedClass β€” that's the synopsis vibe, periodt. πŸ¦‹

πŸ‘‘ Public Member Functions πŸ‘‘

  • PsiExEnv (const Ref< KeyVal > &) β€” this overload takes a const Ref< KeyVal > &. That's the exact signature shown, no cap. πŸ’–
  • PsiExEnv (char *cwd, char *fileprefix, int nscratch, char **scratch) β€” this overload takes cwd, fileprefix, nscratch, and scratch, all with the exact types in the signature. πŸŽ€
  • Ref< PsiInput > get_psi_input () const β€” returns the PsiInput object which PsiExEnv uses. handing you the PsiInput, iconic behavior. ✨
  • Ref< PsiFile11 > get_psi_file11 () const β€” returns the PsiFile11 object which PsiExEnv uses. yes bestie, the PsiFile11 object. 🫢
  • int run_psi () β€” executes Psi input+driver. that's the whole description, and it's doing the most. πŸ”₯
  • int run_psi_module (char *) β€” executes a Psi module. simple, clean, slay. πŸ’…
  • string get_cwd () const β€” returns current working directory. your cwd, bestie. πŸ“
  • string get_fileprefix () const β€” returns the Psi file prefix. the prefix! for Psi files! 🌸
  • int get_nscratch () const β€” returns the number of scratch locations. counting those scratch spots. πŸ”’
  • string get_scratch (int i) const β€” returns the ith scratch location. give it i, get the scratch location back. 🧚
  • void print (std::ostream &o=ExEnv::out0()) const β€” print the object. yes, with that exact default arg ExEnv::out0(). πŸ’œ

🫢 Additional Inherited Members 🫢

This section is literally just labeled Additional Inherited Members on the page β€” it doesn't spell out a list here, so I'm not gonna invent one. 🫢

πŸ’– Detailed Description πŸ’–

PsiExEnv specifies a Psi calculation.

That's the whole detailed description, no cap. πŸ’€βœ¨

πŸŽ€ Author πŸŽ€

Generated automatically by Doxygen for MPQC from the source code.

so yeah, Doxygen said what it said. πŸŽ€


okay bestie, that's the whole page β€” MPQC version 2.3.1, dated Sun Oct 4 2020. mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from