sc::RadialIntegrator(3)

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

πŸ’… sc::RadialIntegrator β€” like, the mother of all radial integrators (MPQC manual, bestie)

okay so picture this: it's sc::RadialIntegrator(3), it lives in the MPQC manual, and it's the blueprint every radial integrator wishes it could be. literally the abstract base class of the whole friend group. πŸŽ€


✨ NAME ✨

sc::RadialIntegrator β€” an abstract base class for radial integrators. no cap, that's the whole job description. it's giving "I define the vibe, you do the math." πŸ’…


🌸 SYNOPSIS 🌸

#include <integrator.h>

Inherits sc::SavableState. 🫢

Inherited by sc::EulerMaclaurinRadialIntegrator. (yes bestie, it has descendants, main character energy fr fr πŸ‘‘)

πŸ’– Public Member Functions πŸ’–

  • RadialIntegrator(const Ref< KeyVal > &) β€” constructor that takes a Ref< KeyVal >. that's it, that's the whole sentence, i'm not gonna invent lore about it. πŸ™ˆ
  • RadialIntegrator(StateIn &) β€” the other constructor, this one takes a StateIn &.
  • 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. the order matters, okay?? don't be chaotic about it. 😭
  • virtual int nr() const =0 β€” pure virtual, =0, meaning you have to implement it. it's literally in the syllabus and you can't skip it. ✨
  • virtual double radial_value(int ir, int nr, double radii, double &multiplier)=0 β€” also pure virtual (=0), also your problem now. note that multiplier is a double & β€” a reference, so it's an out-param vibe. πŸ¦‹

🌈 Protected Attributes 🌈

  • int nr_ β€” a protected int named nr_. iconic underscore. ⭐

🫢 Additional Inherited Members 🫢

yep, there's an "Additional Inherited Members" section too β€” it just means stuff comes down from the parent class, sc::SavableState. inheritance slay.


πŸ¦‹ Detailed Description πŸ¦‹

An abstract base class for radial integrators.

like... that's it. that's the description. and honestly? it ate. πŸ’€ abstract means you can't instantiate it directly β€” it's a concept, a mood, a vibe check for its subclasses. πŸ”₯


πŸ’œ Member Function Documentation πŸ’œ

πŸŽ€ void sc::RadialIntegrator::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.

⚠️ bestie listen: this must be implemented by the derived class if the class has data. not optional. not "later". must. 😀

Reimplemented from sc::SavableState.

Reimplemented in sc::EulerMaclaurinRadialIntegrator.


🌟 Author 🌟

Generated automatically by Doxygen for MPQC from the source code. (so nobody wrote this prose, a robot did β€” respect the robot 🧚)


and that's the whole page, periodt. πŸ’–

πŸ“ cute little sign-off: this manual page is from MPQC version 2.3.1, dated Sun Oct 4 2020, and the page title is sc::RadialIntegrator(3) β€” iykyk. bye bestie, go implement nr() and radial_value() before you forget. 🌸🫢
πŸ“¦ where this page comes from