sc::MOIntsTransformFactory(3)

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

Bestie, welcome to the sc::MOIntsTransformFactory(3) page from the MPQC manual πŸ’– This page is giving factory-core energy and I'm obsessed.

🌸 NAME 🌸

sc::MOIntsTransformFactory β€” okay so MOIntsTransformFactory is a factory that produces MOIntsTransform objects. That's the whole NAME-section vibe, and honestly it ate. πŸ‘‘

✨ SYNOPSIS ✨

Here's the include and inheritance tea:

#include <transform_factory.h>

Inherits sc::SavableState.

πŸŽ€ Public Types πŸŽ€

enum StoreMethod { mem_posix = 0, posix = 1, mem_mpi = 2, mpi = 3,
    mem_only = 4 }

Describes the method of storing transformed MO integrals. The values are exactly mem_posix = 0, posix = 1, mem_mpi = 2, mpi = 3, and mem_only = 4, no cap. πŸ’…

πŸ’… Public Member Functions πŸ’…

  • MOIntsTransformFactory (StateIn &) β€” this constructor takes a StateIn &; that's all the page says about it.
  • MOIntsTransformFactory (const Ref< Integral > &integral, const Ref< MOIndexSpace > &space1, const Ref< MOIndexSpace > &space2=0, const Ref< MOIndexSpace > &space3=0, const Ref< MOIndexSpace > &space4=0) β€” this constructor takes an Integral ref plus MOIndexSpace refs, and the signature shows space2=0, space3=0, and space4=0. 🫢
  • 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 set_spaces (const Ref< MOIndexSpace > &space1, const Ref< MOIndexSpace > &space2=0, const Ref< MOIndexSpace > &space3=0, const Ref< MOIndexSpace > &space4=0) β€” sets the orbital spaces.
  • void set_top_mole (const Ref< MolecularEnergy > &top_mole) β€” specifies the top-level MolecularEnergy object to use for checkpointing.
  • void set_ints_method (const StoreMethod method) β€” sets the method of storing transformed MO integrals. Default method is mem_posix.
  • void set_file_prefix (const std::string &prefix) β€” sets the name of the file to hold the integrals.
  • void set_debug (int debug) β€” signature only on this page; no extra description.
  • void set_dynamic (bool dynamic) β€” signature only on this page; no extra description.
  • void set_print_percent (double print_percent) β€” signature only on this page; no extra description.
  • void set_memory (size_t nbytes) β€” signature only on this page; no extra description.
  • Ref< Integral > integral () const β€” returns the Integral factory.
  • const StoreMethod ints_method () const β€” returns the method of storing transformed MO integrals.
  • const std::string file_prefix () const β€” the page's description says "Sets the name of the file to hold the integrals." Yes, even for this const std::string function β€” I'm not fixing the manpage, bestie, I'm just reporting it πŸ™ˆ.
  • const int debug () const β€” signature only on this page; no extra description.
  • const bool dynamic () const β€” signature only on this page; no extra description.
  • const double print_percent () const β€” signature only on this page; no extra description.
  • const size_t memory () const β€” signature only on this page; no extra description.
  • Ref< MOIndexSpace > space1 () const β€” returns MOIndexSpace object 1.
  • Ref< MOIndexSpace > space2 () const β€” returns MOIndexSpace object 2.
  • Ref< MOIndexSpace > space3 () const β€” returns MOIndexSpace object 3.
  • Ref< MOIndexSpace > space4 () const β€” returns MOIndexSpace object 4.
  • Ref< TwoBodyMOIntsTransform > twobody_transform_13 (const std::string &id) β€” creates an TwoBodyMOIntsTransform object that will compute (pq|rs) integrals stored in qs blocks for each pr.
  • Ref< TwoBodyMOIntsTransform > twobody_transform_12 (const std::string &id) β€” creates an TwoBodyMOIntsTransform object that will compute (pq|rs) integrals stored in rs blocks for each pq.

🌈 Additional Inherited Members 🌈

Yep, this section is here. The page just drops the heading and doesn't give us a list, so that's all I can tell you without making stuff up.

🌼 Detailed Description 🌼

MOIntsTransformFactory is a factory that produces MOIntsTransform objects. That's the whole detailed description β€” short, sweet, factory-coded. ✨

πŸ’– Member Function Documentation πŸ’–

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

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

πŸ¦‹ Author πŸ¦‹

Generated automatically by Doxygen for MPQC from the source code. That's the author-section tea, fr fr.


Okay bestie, that's the whole page: Version 2.3.1, Sun Oct 4 2020, page sc::MOIntsTransformFactory(3) β€” source/version/date sign-off complete, mwah πŸ’‹πŸ«Ά

πŸ“¦ where this page comes from