Encapsulate auto-update accumulators

[jngrad]

Accumulators registered via system.auto_update_accumulators are currently stored in a global variable in the C++ core. To help with multi-system simulations, the auto-update accumulators container needs to become a member of the core System class.

Procedure:

1. get familiar with the design patterns used in the core System class: opaque pointers, composite pattern (chapter System class design in the Doxygen documentation)
2. create an Accumulators::AutoUpdateAccumulators class
   1. rewrite the functions in src/core/accumulators.hpp as methods of class Accumulators::AutoUpdateAccumulators
      • rename the auto_update() function to an operator()() method
      • rename all auto_update_*() functions to *() methods
      • rename all auto_update_*() function calls to auto_update.*() function calls
   2. add an extern Accumulators auto_update; in src/core/accumulators.hpp
   3. add an Accumulators auto_update = {}; in src/core/accumulators.cpp
   4. make the auto_update_accumulators static global a member of the Accumulators class
   5. make all necessary adjustments until the C++ compiler is happy
   6. the testsuite should pass
3. rewrite src/script_interface/accumulators/AutoUpdateAccumulators.hpp as a leaf container class
   1. the class should publicly inherit from ObjectList<AccumulatorBase, AutoParameters<ObjectList<AccumulatorBase, System::Leaf>, System::Leaf>>
   2. the class should manage a std::shared_ptr<::Accumulators::AutoUpdateAccumulators> m_handle; that gets initialized inside on_bind_system() via a m_params handle that was initialized inside do_construct() (use src/script_interface/electrostatics/Container.hpp as a guide)
   3. the testsuite should pass
4. move the auto_update global to a member of the core System class
   1. add a std::shared_ptr<Accumulators::AutoUpdateAccumulators> auto_update; to the core System class, right after bond_breakage
   2. forward-declare Accumulators::AutoUpdateAccumulators at the top of src/core/system/System.hpp
   3. remove the auto_update global variable and adapt all function calls using the -> dereference operator
   4. in the script interface, the current system's auto_update member is copied into m_handle inside on_bind_system()

[1234somesh]

On 2023-11-21 15:34, Jean-Noël Grad wrote: Assigned #4821 [1] to @1234somesh [2]. -- Reply to this email directly, view it on GitHub [3], or unsubscribe [4]. You are receiving this because you were assigned.Message ID: ***@***.***> Links: ------ [1] #4821 [2] https://github.com/1234somesh [3] #4821 (comment) [4] https://github.com/notifications/unsubscribe-auth/A53UXCF45MEPBWBLJFY3MDLYFS3YBAVCNFSM6AAAAAA7UV7DWOVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJRGAZDKMRWGAZTGNY

Hi, Thanks for assigning me the task. regards, Somesh

[jngrad]

The opaque pointer technique is detailed in More C++ Idioms book, chapter Pointer to Implementation. Since we are only interested in breaking a circular dependency, we use the pointer to incomplete type method. The void pointer method is far less common, and for this specific scenario it has no advantages.