sc::TwoBodyGrid(3)

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

πŸ’– NAME πŸ’–

sc::TwoBodyGrid β€” okay so this is the sc::TwoBodyGrid(3) page from the MPQC manual, and the vibe is: class TwoBodyGrid describes a set of coordinates of 2 particles. That's the name tea, bestie, and the manual name is MPQC 🫢.

🌸 SYNOPSIS 🌸

Here's the include and the inheritance situation β€” exactly as the page says, no cap:

#include <twobodygrid.h>

Inherits sc::SavableState.

πŸŽ€ Public Member Functions πŸŽ€

These are the public member functions, and I'm keeping every signature exactly as given, bestie. Slay. πŸ’…

  • TwoBodyGrid (StateIn &) β€” constructor with a StateIn &; the page gives it no extra description. 🧚
  • TwoBodyGrid (const Ref< KeyVal > &) β€” the KeyVal constructor. πŸ‘‘
  • void save_data_state (StateOut &) β€” Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. πŸ’Ύ
  • const std::string & name () const β€” the page just gives this signature; no extra description. πŸŽ€
  • int nelem () const β€” same situation: signature only, no extra description. 🌸
  • const SCVector3 & origin () const β€” signature only on the page. πŸ¦‹
  • SCVector3 xyz1 (int i, const SCVector3 &O=SCVector3(0.0)) const β€” Cartesian coordinates of particle 1 at grid point i with respect to origin O. ✨
  • SCVector3 xyz2 (int i, const SCVector3 &O=SCVector3(0.0)) const β€” Cartesian coordinates of particle 2 at grid point i with respect to origin O. ✨
  • SCVector3 rtp1 (int i, const SCVector3 &O=SCVector3(0.0)) const β€” Spherical polar coordinates of particle 1 at grid point i with respect to origin O. 🌈
  • SCVector3 rtp2 (int i, const SCVector3 &O=SCVector3(0.0)) const β€” Spherical polar coordinates of particle 2 at grid point i with respect to origin O. 🌈
  • void print (std::ostream &o=ExEnv::out0()) const β€” Prints out this. πŸ–¨οΈ

πŸ¦‹ Additional Inherited Members πŸ¦‹

There are additional inherited members too β€” the page labels them under this heading, and that's the whole note. The class inherits from sc::SavableState, so those inherited goodies are in the mix 🫢.

🌈 Detailed Description 🌈

Class TwoBodyGrid describes a set of coordinates of 2 particles. That's the detailed description in full, and it's giving concise main character energy ⭐.

πŸ”₯ Member Function Documentation πŸ”₯

πŸ’Ύ void sc::TwoBodyGrid::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.

Reimplemented from sc::SavableState.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. Doxygen really handled the author credit, and we thank it for its service πŸŽ€.


Version 2.3.1 β€’ Sun Oct 4 2020 β€’ sc::TwoBodyGrid(3) from MPQC β€” that's the footer tea, and we're done, bestie πŸ’–βœ¨

πŸ“¦ where this page comes from