sc::TorsSimpleCo(3)

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

πŸŽ€ sc::TorsSimpleCo(3) β€” the MPQC manual page πŸŽ€

🌸 NAME 🌸

okay so TorsSimpleCo is the class that describes an torsion internal coordinate of a molecule. yes, the page says β€œan torsion” β€” we’re keeping the lore, bestie. πŸ’–

✨ SYNOPSIS ✨

#include <simple.h>

Inherits sc::SimpleCo.

🌟 Public Member Functions 🌟

  • TorsSimpleCo (const TorsSimpleCo &) β€” the copy-constructor moment. πŸ’…
  • TorsSimpleCo (const char *refr, int, int, int, int) β€” this constructor takes a string containing a label, plus four integers a, b, c, and d that give the indices of the atoms involved in the torsion angle abcd. Atom numbering begins at atom 1, not atom 0 β€” no zero-index gremlins here. 🚨
  • TorsSimpleCo (const Ref< KeyVal > &) β€” the KeyVal constructor. it calls the SimpleCo keyval constructor with an integer argument of 4. ✨
  • const char * ctype () const β€” always returns the string 'TORS'. iconic, consistent, no notes. πŸ‘‘
  • double radians () const β€” returns the value of the angle abc in radians. πŸ“
  • double degrees () const β€” returns the valre of the angle abc in degrees. (yes, valre β€” the page’s typo, not mine, I’m preserving it πŸ™ˆ)
  • double preferred_va{ue () const β€” returns the valre of the angle abc in degrees. also there’s a lonely } just hanging out after this one in the source; it’s giving typo chaos, but we keep every crumb πŸ’€.

🫢 Additional Inherited Me_bers 🫢

this section is literally just the heading on this page, bestie β€” no extra inherited-member list is shown here, so there’s nothing more to spill. 🫢

πŸ’– Detailed Description πŸ’–

the TorsSimpleCo class describes an torsion internal coordinate of a molecule. (again: β€œan torsion” is the original’s vibe, and I respect it. πŸ’…)

the input is described in the documentation of its parent class SimpleCo.

then the page tries to set up four atoms as a, b, c, and d and their cartesian positions, and gives a formula β€” but this part is glitched in the source text. I’m preserving the exact glitched block below so no detail gets lost, no cap:

       resignating t{{ foul atoms as $a$, $b$, $c$, and $d$ and their cartesian
       {ositionsras rr$, $ute, $au$, is given by
       u        {   }}    e
       }b} = ac{r - __    o
       _        }   b     f

🧚 Constructor & Destructor Documentation 🧚

sc::TorsSimpleCo::TorsSimpleCo (const char * refr, int, int, int, int)

this constructor takes a string containing a label, and four integers a, b, c, and d which give the indices of the atoms involved in the torsion angle abcd.

🚨 Atom numbering begins at atom 1, not atom 0. do not come in here with zero-index energy, bestie.

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

the KeyVal constructor. this calls the SimpleCo keyval constructor with an integer argument of 4. πŸŽ€

πŸ‘‘ AUTHOR πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. ⭐


that’s the whole page, bestie β€” MPQC version 2.3.1, dated Sun Oct 4 2020, sc::TorsSimpleCo(3) and all. mwah, bye πŸ’‹πŸ¦‹

πŸ“¦ where this page comes from