ActionLauncher.hh File Reference

#include <utility>
#include "corecel/Config.hh"
#include "corecel/Assert.hh"
#include "corecel/Types.hh"
#include "corecel/sys/MultiExceptionHandler.hh"
#include "corecel/sys/ThreadId.hh"
#include "ActionInterface.hh"
#include "CoreParams.hh"
#include "CoreState.hh"
#include "KernelContextException.hh"

Functions
template<class F >
void	celeritas::launch_core (size_type num_threads, std::string_view label, celeritas::CoreParams const &params, celeritas::CoreState< MemSpace::host > &state, F &&execute_thread)
	Helper function to run an executor in parallel on CPU.
template<class F >
void	celeritas::launch_core (std::string_view label, celeritas::CoreParams const &params, celeritas::CoreState< MemSpace::host > &state, F &&execute_thread)
	Helper function to run an executor in parallel on CPU over all states.
template<class F >
void	celeritas::launch_action (CoreStepActionInterface const &action, size_type num_threads, celeritas::CoreParams const &params, celeritas::CoreState< MemSpace::host > &state, F &&execute_thread)
	Helper function to run an action in parallel on CPU.
template<class F >
void	celeritas::launch_action (CoreStepActionInterface const &action, celeritas::CoreParams const &params, celeritas::CoreState< MemSpace::host > &state, F &&execute_thread)
	Helper function to run an action in parallel on CPU over all states.

Function Documentation

launch_action() [1/2]

template<class F >

void celeritas::launch_action	(	CoreStepActionInterface const &	action,
		celeritas::CoreParams const &	params,
		celeritas::CoreState< MemSpace::host > &	state,
		F &&	execute_thread
	)

Helper function to run an action in parallel on CPU over all states.

Example:

void FooAction::step(CoreParams const& params,
                        CoreStateHost& state) const
{
   launch_action(*this, params, state, make_blah_executor(blah));
}

launch_action() [2/2]

template<class F >

void celeritas::launch_action	(	CoreStepActionInterface const &	action,
		size_type	num_threads,
		celeritas::CoreParams const &	params,
		celeritas::CoreState< MemSpace::host > &	state,
		F &&	execute_thread
	)

Helper function to run an action in parallel on CPU.

This allows using a custom number of threads rather than the state size.

launch_core() [1/2]

template<class F >

void celeritas::launch_core	(	size_type	num_threads,
		std::string_view	label,
		celeritas::CoreParams const &	params,
		celeritas::CoreState< MemSpace::host > &	state,
		F &&	execute_thread
	)

Helper function to run an executor in parallel on CPU.

This allows using a custom number of threads rather than the state size.

launch_core() [2/2]

template<class F >

void celeritas::launch_core	(	std::string_view	label,
		celeritas::CoreParams const &	params,
		celeritas::CoreState< MemSpace::host > &	state,
		F &&	execute_thread
	)

Helper function to run an executor in parallel on CPU over all states.

Example:

void FooHelper::step(CoreParams const& params,
                        CoreStateHost& state) const
{
   launch_core(params, state, "foo-helper", make_blah_executor(blah));
}