AlgorithmSingletonDeclarations.hpp

// Distributed under the MIT License.
// See LICENSE.txt for details.
 
#pragma once
 
#include "Parallel/ArrayIndex.hpp"
 
#include "Parallel/Algorithms/AlgorithmSingleton.decl.h"
 
namespace Parallel {
namespace Algorithms {
 
/*!
 * \ingroup ParallelGroup
 * \brief A struct that stores the charm++ types relevant for a particular
 * singleton component
 *
 * \details The type traits are:
 * - `cproxy`: the charm++ proxy.
 *   See https://charm.readthedocs.io/en/latest/faq/manual.html#what-is-a-proxy
 * - `cbase`: the charm++ base class. See
 *   https://charm.readthedocs.io/en/latest/charm++/manual.html#chare-objects
 * - `algorithm_type`: the chare type (`AlgorithmSingleton`) for the singleton
 *   component.
 * - `ckindex`: A charm++ chare index object. Useful for obtaining entry
 *   method indices that are needed for creating callbacks. See
 *   https://charm.readthedocs.io/en/latest/charm++/manual.html#creating-a-ckcallback-object
 */
struct Singleton {
  template <typename ParallelComponent,
            typename SpectreArrayIndex>
  using cproxy = CProxy_AlgorithmSingleton<ParallelComponent,
                                           SpectreArrayIndex>;
 
  template <typename ParallelComponent,
            typename SpectreArrayIndex>
  using cbase = CBase_AlgorithmSingleton<ParallelComponent,
                                         SpectreArrayIndex>;
 
  template <typename ParallelComponent,
            typename SpectreArrayIndex>
  using algorithm_type = AlgorithmSingleton<ParallelComponent,
                                            SpectreArrayIndex>;
 
  template <typename ParallelComponent,
            typename SpectreArrayIndex>
  using ckindex = CkIndex_AlgorithmSingleton<ParallelComponent,
                                             SpectreArrayIndex>;
};
}  // namespace Algorithms
}  // namespace Parallel