FleCSI Core API Version: 2.3.2
 
Loading...
Searching...
No Matches
core< P > Struct Template Reference

An example core topology that is not really implemented. More...

Classes

struct  access
 Default-constructible base for topology accessors. More...
 

Public Member Functions

Color colors () const
 Return the number of colors over which the topology is partitioned.
 
 core (coloring)
 A topology can be constructed from its coloring type.
 
template<typename P::index_space >
data::partitionget_partition ()
 Find the partition for an index space.
 
template<typename P::index_space >
data::region & get_region ()
 Find the region for an index space.
 
template<class T , data::layout L, typename P::index_space S>
const data::copy_planghost_copy (data::field_reference< T, L, P, S > const &f)
 Prepare a ghost copy.
 

Additional Inherited Members

- Public Types inherited from core_base
using coloring
 The type, independent of specialization, from which the corresponding core topology type is constructed.
 

Detailed Description

template<class P>
struct flecsi::topo::core< P >

An example core topology that is not really implemented.

Template Parameters
Ptopology specialization, used here as a policy

Constructor & Destructor Documentation

◆ core()

template<class P >
core ( coloring )
explicit

A topology can be constructed from its coloring type.

Member Function Documentation

◆ colors()

template<class P >
Color colors ( ) const

Return the number of colors over which the topology is partitioned.

◆ get_region()

template<class P >
template<typename P::index_space >
data::region & get_region ( )

Find the region for an index space.

◆ get_partition()

template<class P >
template<typename P::index_space >
data::partition & get_partition ( )

Find the partition for an index space.

Returns
a repartition if appropriate
Note
As a special case, the global topology does not define this.

◆ ghost_copy()

template<class P >
template<class T , data::layout L, typename P::index_space S>
const data::copy_plan * ghost_copy ( data::field_reference< T, L, P, S > const & f)
nodiscard

Prepare a ghost copy.

Required only if multiple privileges are used.

Template Parameters
Tdata type
Luse to trigger special copies for dynamic fields
Suse to identify relevant copy plan
Parameters
fto deduce the above as well as for the field ID
Returns
the copy plan to use, if any