MC::EventContainer Struct Reference

Use to count events that occurs during Monte-Carlo processing cycles. More...

#include <events.hpp>

Public Member Functions
	EventContainer ()
	Default container, initalise counter.
std::span< std::size_t >	get_span () const
	Get std const view of _events counter.
KOKKOS_INLINE_FUNCTION void	clear () const
	Reset counters.
template<EventType event>
constexpr std::size_t	get () const
	Getter to specific event counter.
template<EventType event>
KOKKOS_FORCEINLINE_FUNCTION constexpr void	incr () const
	Increment specific event counter.
template<EventType event>
KOKKOS_FORCEINLINE_FUNCTION constexpr void	add (size_t val) const
template<EventType event>
KOKKOS_FORCEINLINE_FUNCTION constexpr void	wrap_incr () const
template<class Archive>
void	save (Archive &ar) const
template<class Archive>
void	load (Archive &ar)

Static Public Member Functions
static EventContainer	reduce (std::span< std::size_t > _data)
	Transform a linear contiguous counter data obtained via MPI gather into EventContainer object.

Public Attributes
Kokkos::View< std::size_t[number_event_type], Kokkos::SharedSpace >	_events

Detailed Description

Use to count events that occurs during Monte-Carlo processing cycles.

Constructor & Destructor Documentation

EventContainer()

MC::EventContainer::EventContainer ( )

inline

Default container, initalise counter.

Here is the caller graph for this function:

Member Function Documentation

add()

template<EventType event>

KOKKOS_FORCEINLINE_FUNCTION constexpr void MC::EventContainer::add ( size_t val ) const

inlineconstexpr

Here is the call graph for this function:

clear()

KOKKOS_INLINE_FUNCTION void MC::EventContainer::clear ( ) const

inline

Reset counters.

get()

template<EventType event>

std::size_t MC::EventContainer::get ( ) const

inlinenodiscardconstexpr

Getter to specific event counter.

Template Parameters

Event

to get

Warning

This function is thread_safe because we get a copy of the current counter

Here is the call graph for this function:

get_span()

std::span< std::size_t > MC::EventContainer::get_span ( ) const

inlinenodiscard

Get std const view of _events counter.

incr()

template<EventType event>

KOKKOS_FORCEINLINE_FUNCTION constexpr void MC::EventContainer::incr ( ) const

inlineconstexpr

Increment specific event counter.

Warning

This function is thread_safe and can be use in kernel

Template Parameters

Event

to get

Here is the call graph for this function:

Here is the caller graph for this function:

load()

template<class Archive>

void MC::EventContainer::load ( Archive & ar )

inline

reduce()

EventContainer MC::EventContainer::reduce ( std::span< std::size_t > _data )

static

Transform a linear contiguous counter data obtained via MPI gather into EventContainer object.

Parameters

_data

obtained via multiple EventContainer merged together

Warning

_data size has to be a multiple of number_event_type

Here is the call graph for this function:

save()

template<class Archive>

void MC::EventContainer::save ( Archive & ar ) const

inline

wrap_incr()

template<EventType event>

KOKKOS_FORCEINLINE_FUNCTION constexpr void MC::EventContainer::wrap_incr ( ) const

inlineconstexpr

Here is the call graph for this function:

Member Data Documentation

_events

Kokkos::View<std::size_t[number_event_type], Kokkos::SharedSpace> MC::EventContainer::_events

---

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

• apps/libs/mc/public/mc/events.hpp
• apps/libs/mc/src/events.cpp