sc::BendSimpleCo(3)

๐Ÿ“ฆ
version 2.3.1 ยท 5 versions
, in ubuntu jammy

๐Ÿ’… sc::BendSimpleCo โ€” a page from the MPQC manual (section 3, bestie) ๐ŸŽ€

okay so before we even start: this whole page lives in the MPQC manual, and it's about the sc::BendSimpleCo class. buckle up, it's a short one but the vibes are immaculate.


โœจ NAME โœจ

sc::BendSimpleCo โ€” the class that describes a bend internal coordinate of a molecule. that's it, that's the whole name section. slay.


๐ŸŒธ SYNOPSIS ๐ŸŒธ

#include <simple.h>

Inherits sc::SimpleCo. yes bestie, it's giving nepo baby โ€” it inherits from SimpleCo and it's proud of it. ๐Ÿซถ

๐Ÿ‘‘ Public Member Functions

  • BendSimpleCo (const BendSimpleCo &) โ€” the copy constructor. it copies. iconic behaviour, no notes.
  • BendSimpleCo (const char *, int, int, int) โ€” this constructor takes a string containing a label, and three integers a, b, and c which give the indices of the atoms involved in the angle abc. three ints, one label, one angle โ€” the whole friend group is here ๐Ÿ’–
  • BendSimpleCo (const Ref< KeyVal > &) โ€” the KeyVal constructor. (more on it below, keep reading, don't scroll past me ๐Ÿ™ˆ)
  • const char * ctype () const โ€” always returns the string 'BEND'. always. no cap. it does not have another mood.
  • double radians () const โ€” returns the value of the angle abc in radians. math era ๐Ÿงฎ
  • double degrees () const โ€” returns the value of the angle abc in degrees. same angle, different outfit ๐Ÿ’…
  • double preferred_value () const โ€” returns the value of the angle abc in degrees. yes, degrees again โ€” that's what it says, don't come for me.

๐Ÿฆ‹ Additional Inherited Members

there's a whole "Additional Inherited Members" section on this page too โ€” that's the stuff it gets from sc::SimpleCo. inheritance really said "what's mine is yours" โœจ


๐Ÿ’œ Detailed Description ๐Ÿ’œ

The BendSimpleCo class describes a bend internal coordinate of a molecule. that's the elevator pitch, and honestly it ate.

nnn then there's this next bit, and I need you to know that I am showing you exactly how it renders on the page, formula and all. the source doc goes full abstract art in the middle. not me, not my fault, blame the generator โ€” I'm just the messenger ๐Ÿซถ

       The BendSimpleCo class describes a bend internal coordinate of a
       molecule.               r
                               {
       The input is descrired ir the documentation of its parent class
       SimpleCo.          {    }
                    rr    r    _
       resignating t{{ thr}e atcms as $a$, $b$, and $c$ and their cartesian
       {ositionsras rr$, $_nd $$lue of the coordinate, $heta$, is given by
       u        {   }}    b    ,
       }b} = ac{r - __    $    t
       _        }   b     ,    h

okay so reading through the chaos: the input is described in the documentation of its parent class SimpleCo, and it's designating the three atoms as $a$, $b$, and $c$ and their cartesian positions, and the value of the coordinate, $\theta$, is given by the formula that got absolutely mangled up there. the formula is genuinely scrambled in the source, so I'm not going to pretend I can un-scramble it for you ๐Ÿ˜ญ go read the SimpleCo page if you want the readable version, iykyk.


๐Ÿงš Constructor & Destructor Documentation ๐Ÿงš

๐Ÿ’– sc::BendSimpleCo::BendSimpleCo (const char *, int, int, int)

This constructor takes a string containing a label, and three integers a, b, and c which give the indices of the atoms involved in the angle abc.

warning bestie: atom numbering begins at atom 1, not atom 0. do NOT come in here with your zero-indexed little programmer brain, it will not go well ๐Ÿ’€

๐Ÿ’– sc::BendSimpleCo::BendSimpleCo (const Ref< KeyVal > &)

The KeyVal constructor. This calls the SimpleCo keyval constructor with an integer argument of 3. three atoms, three arguments โ€” the math is mathing โญ


๐ŸŒˆ Author ๐ŸŒˆ

Generated automatically by Doxygen for MPQC from the source code. so nobody hand-wrote this one, a robot did it, and the robot was having a day ๐Ÿ™ˆ


and that's the page!! Version 2.3.1, dated Sun Oct 4 2020 โ€” go forth and bend those coordinates, bestie, you've got this ๐Ÿ’…โœจ๐Ÿ’–

๐Ÿ“ฆ where this page comes from