sc::IntegrationWeight(3)

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

okay bestie, this is sc::IntegrationWeight(3) from the MPQC manual, and it's giving abstract-base-class royalty πŸ‘‘βœ¨

πŸ’– NAME πŸ’–

sc::IntegrationWeight β€” an abstract base class for computing grid weights. That's the whole vibe: it's the blueprint parent class, not the one doing the actual weight math.


🌸 SYNOPSIS 🌸

#include <integrator.h>

Inherits sc::SavableState.

Inherited by sc::BeckeIntegrationWeight.

πŸŽ€ Public Member Functions πŸŽ€

  • IntegrationWeight (const Ref< KeyVal > &) β€” constructor that takes a const Ref< KeyVal > &. No extra description on the page, just the signature doing its thing.
  • IntegrationWeight (StateIn &) β€” constructor that 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.
  • void test (int icenter, SCVector3 &point) β€” a test function taking an int icenter and an SCVector3 &point.
  • void test () β€” the no-argument test function.
  • virtual void init (const Ref< Molecule > &, double tolerance) β€” initialize the integration weight object.
  • virtual void done () β€” called when finished with the integration weight object.
  • virtual double w (int center, SCVector3 &point, double *grad_w=0)=0 β€” computes the weight for a given center at a given point in space.

πŸ¦‹ Protected Member Functions πŸ¦‹

  • void fd_w (int icenter, SCVector3 &point, double *fd_grad_w) β€” protected member function, listed with this exact signature. The page gives it no extra description, so we're not inventing one πŸ’…

🌈 Protected Attributes 🌈

  • Ref< Molecule > mol_ β€” protected attribute.
  • double tol_ β€” protected attribute.

✨ Additional Inherited Members ✨

The original page leaves this heading empty β€” no extra inherited members are listed under it here. That's the whole section, bestie 🫢


πŸ’œ Detailed Description πŸ’œ

An abstract base class for computing grid weights.

Yep, same energy as the NAME line: it's the abstract base class blueprint for grid-weight computation. Not the final boss weight object itself. Periodt.


πŸ”₯ Member Function Documentation πŸ”₯

void sc::IntegrationWeight::save_data_state (StateOut &) [virtual]

Saves 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.

Reimplemented in sc::BeckeIntegrationWeight.

virtual double sc::IntegrationWeight::w (int center, SCVector3 & point, double * grad_w = 0) [pure virtual]

Computes the weight for a given center at a given point in space.

Derivatives of the weigth with respect to nuclear coordinates are optionally returned in grad_w.

This must be called after init, but before done.

It must also be thread-safe. No cap, that part matters 😭πŸ”₯

Implemented in sc::BeckeIntegrationWeight.


πŸ“ AUTHOR πŸ“

Generated automatically by Doxygen for MPQC from the source code. So not a human author β€” just Doxygen doing its lil automatic thing πŸŽ€


MPQC Β· Version 2.3.1 Β· Sun Oct 4 2020 Β· sc::IntegrationWeight(3) β€” okay that's the page, bye bestie πŸ’…βœ¨πŸ«Ά

πŸ“¦ where this page comes from