SC_TRIANGULATEDSURFACEINTEGRATOR(3)

πŸ“¦
version 2.3.1 Β· 4 versions
, in fedora 43, ubuntu noble

πŸ’– sc::TriangulatedSurfaceIntegrator(3) πŸ’–

okay so bestie, welcome to the Library Functions Manual page for sc::TriangulatedSurfaceIntegrator. yes that's a whole mouthful, yes it's giving very serious scientific computing energy, and yes we are gonna get through it together. grab a strawberry πŸ“ and let's go.


✨ NAME ✨

sc::TriangulatedSurfaceIntegrator β€” that's the whole name, that's the whole vibe. iconic, concise, no notes. πŸ’…


🌸 SYNOPSIS 🌸

πŸŽ€ Public Member Functions πŸŽ€

this is the group chat roster, bestie. every single one of these is a member of the class, listed in order, and we do not skip anybody:

TriangulatedSurfaceIntegrator (const Ref< TriangulatedSurface > &)
void operator= (const TriangulatedSurfaceIntegrator &)
TriangulatedSurfaceIntegrator (const TriangulatedSurfaceIntegrator &i)
int n ()
void set_surface (const Ref< TriangulatedSurface > &)
int vertex_number (int i)
double r () const
double s () const
double w () const
double surface_element () const
double weight () const
const SCVector3 & dA () const
Ref< Vertex > current ()
int update ()
int operator< (TriangulatedSurfaceIntegrator &i)
void operator++ ()
void operator++ (int)
int operator= (int)
int itri () const
int irs () const
int n_in_tri () const
void distribute (const Ref< MessageGrp > &)
void use_fast_integrator ()
void use_accurate_integrator ()
void use_default_integrator ()

πŸ¦‹ THE FULL BREAKDOWN, ROSTER EDITION πŸ¦‹

lowkey the manpage is a little mysterious and honestly? we respect the mystery. so here's everybody, with exactly the details that are actually there and not one single fact more, because bestie we do not make things up about C++ APIs. πŸ™ˆ

πŸ’œ Constructors & Assignment πŸ’œ

  • TriangulatedSurfaceIntegrator (const Ref< TriangulatedSurface > &) β€” the constructor that takes a const Ref< TriangulatedSurface > &. that's it, that's the whole rΓ©sumΓ©. no cap.
  • void operator= (const TriangulatedSurfaceIntegrator &) β€” assignment operator, returns void, takes a const TriangulatedSurfaceIntegrator &.
  • TriangulatedSurfaceIntegrator (const TriangulatedSurfaceIntegrator &i) β€” the copy constructor, parameter is literally named i. cute. πŸŽ€

🌈 The Ints That Return Ints 🌈

  • int n () β€” no args, returns an int.
  • int vertex_number (int i) β€” takes an int named i, gives you back an int.
  • int update () β€” no args, returns int.
  • int operator< (TriangulatedSurfaceIntegrator &i) β€” the less-than operator, takes a TriangulatedSurfaceIntegrator & named i, hands back an int. note it's not const, so the docs show it taking a non-const reference, fr fr.
  • int operator= (int) β€” yes, another operator=, this one taking a plain int and returning an int. two different assignment operators, two different vibes. we contain multitudes. ✨
  • int itri () const β€” const, no args, returns int.
  • int irs () const β€” const, no args, returns int.
  • int n_in_tri () const β€” const, no args, returns int. the name is giving "number in tri" but we're just reporting the signature, bestie, no extrapolating. 🀫

🧚 The Doubles 🧚

every single one of these is const, takes zero arguments, and returns a double. slay, consistent queen. πŸ‘‘

  • double r () const
  • double s () const
  • double w () const
  • double surface_element () const
  • double weight () const

⭐ The Pointer-Ref Girly Pops ⭐

  • const SCVector3 & dA () const β€” const, no args, returns a const SCVector3 &.
  • Ref< Vertex > current () β€” no args, returns a Ref< Vertex >. not const, okay? noted.
  • void set_surface (const Ref< TriangulatedSurface > &) β€” returns void, takes a const Ref< TriangulatedSurface > &.
  • void distribute (const Ref< MessageGrp > &) β€” returns void, takes a const Ref< MessageGrp > &.

πŸ’… The Increment Era πŸ’…

  • void operator++ () β€” prefix increment, returns void.
  • void operator++ (int) β€” postfix increment (that dummy int parameter is literally just there to signal postfix), also returns void.
both of these return void, bestie, so don't go expecting a value back. the docs say what they say. 🫢

πŸ“ Pick Your Integrator πŸ“

  • void use_fast_integrator () β€” no args, returns void.
  • void use_accurate_integrator () β€” no args, returns void.
  • void use_default_integrator () β€” no args, returns void.

three whole options, three whole vibes, all documented to the exact same level of detail, which is to say: the names. that's the tea. β˜• and honestly? sometimes that's all you need.


πŸ’€ AUTHOR πŸ’€

  • Generated automatically by Doxygen for MPQC from the source code.

yes bestie, a robot wrote this one. Doxygen said "I got it" and we're all just living in its house now. 🏠✨


reminder to my future self: this page lists public member functions and an author note. no options, no environment variables, no exit statuses, no examples, no warnings, no SEE ALSO. if you're looking for more, this page genuinely does not have it. and we did not invent any, because that would be a crime. 😭

and that's the whole page, bestie!! MPQC, Version 2.3.1, and it's from the sc::Triang...eIntegrator(3) manual page β€” go forth, triangulate those surfaces, and remember: the docs are short, but your love for them can be infinite. πŸ¦‹πŸ’– mwah. πŸ’…

πŸ“¦ where this page comes from