SC_TBGRAD(3)

📦
version 2.3.1 · 3 versions
, in fedora 43, fedora 44, ubuntu noble

💖 sc::TBGrad< T > — the manual page, bestie edition 💖

okay so picture this: it's a page from the Library Functions Manual, section 3, and it's all about sc::TBGrad< T >. that's the whole vibe. it's a template, it's a thread, and it's here to do grad things. no cap. ✨

🌸 NAME 🌸

sc::TBGrad< T > — that's literally it, that's the name, she's serving template-class realness and we love her for it 🎀

🦋 SYNOPSIS 🦋

she's a nepo baby of the class hierarchy, and also a parent herself:

  • Inherits sc::Thread 👑
  • Inherited by sc::LocalTBGrad< T > 🍼

✨ Public Member Functions ✨

here's what she can actually do, and yes every single one of these matters:

  • TBGrad (T &t, double ex=1.0) — the constructor, bestie. you hand her a T &t and optionally a double ex, which defaults to 1.0 if you don't feel like specifying it. lowkey generous of her 💅
  • void set_scale (double &coulombscale, double &exchangescale, int i, int j, int k, int l) const — she takes your coulombscale, your exchangescale, and four whole ints (i, j, k, l, in that exact order, don't get cute), and she sets the scale. and she does it const, so she's not touching her own state, just yours. iconic behaviour 🫶

🌈 Public Member Functions inherited from sc::Thread 🌈

she got these from her parent and she's not gonna pretend otherwise:

  • virtual void run ()=0 — pure virtual, so it's giving "figure it out yourself, subclass." and to be clear about when it fires: this is called with the Thread is run from a ThreadGrp. that's the exact wording, we're keeping it 💖

💜 Protected Attributes 💜

the private-ish little stash, protected-style:

  • T & contribution — a reference to a T. it's right there.
  • double exchange_fraction — a double, and it's exactly what it sounds like: the exchange fraction.

🎀 Additional Inherited Members 🎀

more stuff she got from sc::Thread, specifically the static corner:

⭐ Static Public Member Functions inherited from sc::Thread ⭐

  • static void * run_Thread_run (void *thread) — a static function that takes a void *thread and hands you back a void *. static. public. inherited. we move. 🔥

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code.

so like, nobody hand-wrote this, a robot did it, and honestly? slay, robot 🤖✨

and that's the whole page, bestie. no notes. periodt. 💅

this was brought to you by MPQC, Version 2.3.1, and the page itself is sc::TBGrad< T >(3) — k bye, love u, go read your source code 🦋💖

📦 where this page comes from