Parallel::Algorithms::Group Struct Reference

A struct that stores the charm++ types relevant for a particular group component. More...

#include <AlgorithmGroupDeclarations.hpp>

Public Types
template<typename ParallelComponent, typename SpectreArrayIndex>
using	cproxy
template<typename ParallelComponent, typename SpectreArrayIndex>
using	cbase
template<typename ParallelComponent, typename SpectreArrayIndex>
using	algorithm_type
template<typename ParallelComponent, typename SpectreArrayIndex>
using	ckindex
template<typename ParallelComponent, typename SpectreArrayIndex>
using	cproxy_section
using	component_type = Group

Detailed Description

A struct that stores the charm++ types relevant for a particular group 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 (AlgorithmGroup) for the group 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
• cproxy_section: The charm++ section proxy class. See https://charm.readthedocs.io/en/latest/charm++/manual.html?#sections-subsets-of-a-chare-array-group
• component_type: this object. Serves to allow checking the component type in both source code and the testing framework.

Member Typedef Documentation

algorithm_type

template<typename ParallelComponent, typename SpectreArrayIndex>

using Parallel::Algorithms::Group::algorithm_type

Initial value:

 AlgorithmGroup<ParallelComponent,
                                        SpectreArrayIndex>

cbase

template<typename ParallelComponent, typename SpectreArrayIndex>

using Parallel::Algorithms::Group::cbase

Initial value:

 CBase_AlgorithmGroup<ParallelComponent,
                                     SpectreArrayIndex>

ckindex

template<typename ParallelComponent, typename SpectreArrayIndex>

using Parallel::Algorithms::Group::ckindex

Initial value:

 CkIndex_AlgorithmGroup<ParallelComponent,
                                         SpectreArrayIndex>

cproxy

template<typename ParallelComponent, typename SpectreArrayIndex>

using Parallel::Algorithms::Group::cproxy

Initial value:

 CProxy_AlgorithmGroup<ParallelComponent,
                                       SpectreArrayIndex>

cproxy_section

template<typename ParallelComponent, typename SpectreArrayIndex>

using Parallel::Algorithms::Group::cproxy_section

Initial value:

 
      CProxySection_AlgorithmGroup<ParallelComponent, SpectreArrayIndex>

---

The documentation for this struct was generated from the following file:

• src/Parallel/Algorithms/AlgorithmGroupDeclarations.hpp