sc::SphericalTransformComponent(3)

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

πŸ¦‹ sc::SphericalTransformComponent β€” MPQC manual page, section 3, bestie edition πŸ’…

πŸŽ€ NAME πŸŽ€

sc::SphericalTransformComponent β€” this is a base class for a container for a component of a sparse Cartesian to solid harmonic basis function transformation. She’s the blueprint for one little piece of the transform, and yes, that name is a whole sentence. πŸ’–

✨ SYNOPSIS ✨

#include <transform.h>

Inherited by sc::SphericalTransformComponentCCA, sc::SphericalTransformComponentCints, and sc::SphericalTransformComponentV3.

🌸 Public Member Functions 🌸

  • int a () const β€” returns the exponent of x. The x-exponent, bestie. πŸ’…
  • int b () const β€” returns the exponent of y. Y-exponent, slay. ✨
  • int c () const β€” returns the exponent of z. Z-exponent, periodt. πŸ’–
  • int cartindex () const β€” returns the index of the Cartesian basis function. That’s the Cartesian one, iykyk. πŸ¦‹
  • int pureindex () const β€” returns the index solid harmonic basis function. Yes, that’s the exact phrasing β€” pure-index main character energy. πŸ‘‘
  • double coef () const β€” returns the coefficient of this component of the transformation. The coefficient is literally right there. πŸŽ€
  • virtual void init (int a, int b, int c, double coef, int pureindex)=0 β€” initialize this object. Pure virtual, so every specialization has to show up and implement it. No cap. πŸ”₯

🧚 Protected Attributes 🧚

  • double coef_
  • int a_
  • int b_
  • int c_
  • int cartindex_
  • int pureindex_

🫢 DETAILED DESCRIPTION 🫢

Okay so this is a base class for a container for a component of a sparse Cartesian to solid harmonic basis function transformation. It’s giving β€œsmall but crucial piece of the basis-function transformation” energy, and honestly? Obsessed. ✨

πŸ“š MEMBER FUNCTION DOCUMENTATION πŸ“š

πŸ‘‘ init β€” the pure virtual one

virtual void sc::SphericalTransformComponent::init (int a, int b, int c, double coef, int pureindex) [pure virtual]

Initialize this object. This must be provided in all specializations of this class to establish the ordering between a, b and c and the index of the Cartesian basis function. Other things such as adjustment of the coefficient to account for normalization differences can be done as well. The default SphericalTransform::init() implementation requires that only the xl, yl and zl basis functions are normalized to unity.

Heads up, bestie: init is pure virtual, so all the specializations have to bring their own implementation. That’s not a vibe you can skip. πŸ’€

Implemented in sc::SphericalTransformComponentV3, sc::SphericalTransformComponentCints, and sc::SphericalTransformComponentCCA.

🌈 AUTHOR 🌈

Generated automatically by Doxygen for MPQC from the source code.


And that’s the footer tea, bestie: this is from the MPQC source, version 2.3.1, dated Sun Oct 4 20. 🫢✨

πŸ“¦ where this page comes from