sc::Shape(3)

💖 NAME 💖

sc::Shape — from the MPQC manual, aka sc::Shape(3) — is a Volume that represents a 3D solid. That's literally the name vibe, bestie. 🫶✨

✨ SYNOPSIS ✨

#include <shape.h>

• Inherits sc::Volume.
• Inherited by sc::ConnollyShape, sc::SphereShape, sc::Uncapped5SphereExclusionShape, sc::UncappedTorusHoleShape, and sc::UnionShape.

💅 Public Member Functions 💅

• Shape (const Ref< KeyVal > &keyval) — constructor signature; the page gives no extra blurb, so we keep it exact. ✨
• virtual double distance_to_surface (const SCVector3 &r, SCVector3 *grad=0) const =0 — pure virtual (=0), and grad defaults to 0.
• virtual int is_outside (const SCVector3 &r) const — signature only on this page.
• void compute () — Recompute at least the results that have compute true and are not already computed.
• void interpolate (const SCVector3 &p1, const SCVector3 &p2, double val, SCVector3 &result) — signature only on this page.
• int value_implemented () const — Information about the availability of values, gradients, and hessians.

🫶 Additional Inherited Members 🫶

Inherited extras live here, bestie — this page doesn't spell them out any further. 💅

🦋 Detailed Description 🦋

Okay so, big picture: a Shape is a Volume that represents a 3D solid. 🧊✨

The value of the Shape at each point in space is the distance to the surface. The distance is negative if the point is inside the solid. For Shape specializations that cannot compute the distance to the surface, the value will be 1.0 outside and -1.0 inside the solid. No cap.

🔥 Member Function Documentation 🔥

🌟 void sc::Shape::compute () [virtual]

compute () recomputes at least the results that have compute true and are not already computed.

This should only be called by Result's members. 👀

It implements sc::Volume. Periodt.

🎀 Author 🎀

Generated automatically by Doxygen for MPQC from the source code. The robots wrote this one, bestie. 🤖💖

---

And that's the tea ☕💖 — version 2.3.1 from MPQC, dated Sun Oct 4 2020, for sc::Shape(3). Bye bestie, go compute some shapes! 💅✨🦋