SpECTRE  v2024.03.19
Parallel::charmxx::RegisterChare< Chare, CkIndex > Struct Template Reference

Derived class for registering chares. More...

#include <CharmRegistration.hpp>

Public Member Functions

 RegisterChare (const RegisterChare &)=default
 
RegisterChareoperator= (const RegisterChare &)=default
 
 RegisterChare (RegisterChare &&)=default
 
RegisterChareoperator= (RegisterChare &&)=default
 
void register_with_charm () const override
 
bool is_registering_chare () const override
 
std::string name () const override
 
- Public Member Functions inherited from Parallel::charmxx::RegistrationHelper
 RegistrationHelper (const RegistrationHelper &)=default
 
RegistrationHelperoperator= (const RegistrationHelper &)=default
 
 RegistrationHelper (RegistrationHelper &&)=default
 
RegistrationHelperoperator= (RegistrationHelper &&)=default
 
virtual void register_with_charm () const =0
 
virtual std::string name () const =0
 
virtual bool is_registering_chare () const
 

Static Public Attributes

static bool registrar
 

Detailed Description

template<typename Chare, typename CkIndex>
struct Parallel::charmxx::RegisterChare< Chare, CkIndex >

Derived class for registering chares.

Calls the appropriate Charm++ function to register a chare

The chare that is being registered must have the following in the destructor:

CkIndex_ChareName>::registrar;
Derived class for registering chares.
Definition: CharmRegistration.hpp:204

The main chare must also have a constructor that takes a const Parallel::charmxx::MainChareRegistrationConstructor& as its only argument. This constructor is only used to trigger the RegisterChare::registrar code needed for automatic registration. The main chare is set up in Parallel::charmxx::register_main_module<Metavariables>.

Member Function Documentation

◆ is_registering_chare()

template<typename Chare , typename CkIndex >
bool Parallel::charmxx::RegisterChare< Chare, CkIndex >::is_registering_chare ( ) const
inlineoverridevirtual

◆ name()

template<typename Chare , typename CkIndex >
std::string Parallel::charmxx::RegisterChare< Chare, CkIndex >::name ( ) const
inlineoverridevirtual

◆ register_with_charm()

template<typename Chare , typename CkIndex >
void Parallel::charmxx::RegisterChare< Chare, CkIndex >::register_with_charm ( ) const
inlineoverridevirtual

Member Data Documentation

◆ registrar

template<typename Chare , typename CkIndex >
bool Parallel::charmxx::RegisterChare< Chare, CkIndex >::registrar
static
Initial value:
=
RegisterChare<Chare, CkIndex>>()
bool register_func_with_charm()
Function that adds a pointer to a specific derived class to the charm_register_list
Definition: CharmRegistration.hpp:675

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