Namespace that contains classes and structures related to Monte Carlo (MC) simulations. More...

Namespaces
namespace	Distributions
	Kokkos compatible method to draw from specific probability distribution.

Classes
struct	ContribIndexBounds
struct	DomainState
	Structure to store information about domain needed during MC cycle data is likely to change between each iteration. More...
struct	EventContainer
	Use to count events that occurs during Monte-Carlo processing cycles. More...
class	KPRNG
	Utilities and wrap around kokkos random generator. More...
struct	LeavingFlow
	Store position and value of volumic flow at outlet. More...
struct	MonteCarloUnit
	General-purpose Monte Carlo unit to carry out simulations. More...
class	ParticlesContainer
	Main owning object for Monte-Carlo particles. More...
class	ReactorDomain
	Represents the spatial domain where Monte Carlo particles can exist. More...
struct	RuntimeParameters

Typedefs
template<uint64_t Nd, FloatingPointType F>
using	ParticlesModel = Kokkos::View<F* [Nd], Kokkos::LayoutRight>
template<FloatingPointType F>
using	DynParticlesModel = Kokkos::View<F**, Kokkos::LayoutRight>
using	ComputeSpace = Kokkos::DefaultExecutionSpace
using	HostSpace = Kokkos::DefaultHostExecutionSpace
template<typename ExecSpace>
using	gen_pool_type = Kokkos::Random_XorShift1024_Pool<ExecSpace>
using	pool_type = gen_pool_type<Kokkos::DefaultExecutionSpace>
using	generator_type = pool_type::generator_type
using	restrict_mt = Kokkos::MemoryTraits<Kokkos::MemoryTraitsFlags::Restrict>
using	ParticlePositions = Kokkos::View<uint64_t*, ComputeSpace>
using	ParticleStatus = Kokkos::View<Status*, ComputeSpace>
using	ParticleWeigths = Kokkos::View<double*, ComputeSpace>
using	ParticleAges = ParticleAgesBase<ComputeSpace>
using	ParticleSamples
template<typename MemorySpace>
using	ParticlePropertyViewType = Kokkos::View<double**, Kokkos::LayoutRight, MemorySpace>
using	PropertySubViewtype
using	ContributionView
using	KernelConcentrationType
using	LocalConcentration = Kokkos::Subview<KernelConcentrationType, int, decltype(Kokkos::ALL)>
template<class ExecSpace, bool is_const>
using	VolumeView
template<class ExecSpace, bool is_const>
using	DiagonalView
template<bool is_const>
using	LeavingFlowView
template<class ExecSpace, bool is_const>
using	CumulativeProbabilityView
template<class ExecSpace, bool is_const>
using	NeighborsView

Enumerations
enum class	Status : char { Idle = 0 , Division , Exit , Dead }
enum class	EventType : char { NewParticle = 0 , Exit , Move , Death , Overflow , ChangeWeight , __COUNT__ }
	Enumeration that represents events that can occurs during a Monte-Carlo cycle. More...

Functions
template<EventType event>
KOKKOS_INLINE_FUNCTION consteval size_t	event_index ()
	inline getter, converts event to its value in order to be use as array index
void	impl_init (double &total_mass, uint64_t n_particles, MonteCarloUnit &unit, AutoGenerated::ContainerVariant &&container, bool uniform_init)
template<ModelType Model>
std::unique_ptr< MonteCarloUnit >	init (const std::shared_ptr< IO::Logger > &_logger, uint64_t n_particles, std::size_t n_samples, std::span< double > volumes, std::span< const size_t > _neighbors, bool uniform_mc_init, double &total_mass)
	Helper function to initialize a MonteCarloUnit.
void	post_init_weight (std::unique_ptr< MonteCarloUnit > &unit, double x0, double total_mass)
pool_type	get_pool (std::size_t seed=0)
KOKKOS_INLINE_FUNCTION auto	sample_random_variables (const pool_type &pool, auto &&functor)
RuntimeParameters	load_tuning_constant ()

Variables
constexpr size_t	number_event_type

Detailed Description

Namespace that contains classes and structures related to Monte Carlo (MC) simulations.

This namespace encapsulates all the components used in Monte Carlo simulations, including data structures for managing simulation state and results.

Typedef Documentation

◆ ComputeSpace

using MC::ComputeSpace = Kokkos::DefaultExecutionSpace

◆ ContributionView

using MC::ContributionView

Initial value:

decltype(

Kokkos::Experimental::create_scatter_view(kernelContribution()))

Examples: example_model.cxx.

◆ CumulativeProbabilityView

template<class ExecSpace, bool is_const>

using MC::CumulativeProbabilityView

Initial value:

 std::conditional_t<
      is_const,
      Kokkos::View<const double**,
                   Kokkos::LayoutRight,
                   ExecSpace,
                   Kokkos::MemoryTraits<Kokkos::RandomAccess> >,
      Kokkos::View<double**, Kokkos::LayoutRight, ExecSpace> >

◆ DiagonalView

template<class ExecSpace, bool is_const>

using MC::DiagonalView

Initial value:

 std::conditional_t<
      is_const,
      Kokkos::View<const double*,
                   Kokkos::LayoutLeft,
                   ExecSpace,
                   Kokkos::MemoryTraits<Kokkos::RandomAccess> >,
      Kokkos::View<double*, Kokkos::LayoutLeft, ExecSpace> >

◆ DynParticlesModel

template<FloatingPointType F>

using MC::DynParticlesModel = Kokkos::View<F**, Kokkos::LayoutRight>

◆ gen_pool_type

template<typename ExecSpace>

using MC::gen_pool_type = Kokkos::Random_XorShift1024_Pool<ExecSpace>

◆ generator_type

using MC::generator_type = pool_type::generator_type

◆ HostSpace

using MC::HostSpace = Kokkos::DefaultHostExecutionSpace

◆ KernelConcentrationType

using MC::KernelConcentrationType

Initial value:

 Kokkos::View<const double**,
                     Kokkos::LayoutLeft,
                     ComputeSpace,
                     Kokkos::MemoryTraits<Kokkos::RandomAccess> >

◆ LeavingFlowView

template<bool is_const>

using MC::LeavingFlowView

Initial value:

 std::conditional_t<
      is_const,
      Kokkos::View<const LeavingFlow*, Kokkos::SharedHostPinnedSpace>,
      Kokkos::View<LeavingFlow*, Kokkos::SharedHostPinnedSpace> >

◆ LocalConcentration

using MC::LocalConcentration = Kokkos::Subview<KernelConcentrationType, int, decltype(Kokkos::ALL)>

Examples: example_model.cxx.

◆ NeighborsView

template<class ExecSpace, bool is_const>

using MC::NeighborsView

Initial value:

 std::conditional_t<
      is_const,
      Kokkos::View<const std::size_t**,
                   Kokkos::LayoutRight,
                   ExecSpace,
                   Kokkos::MemoryTraits<Kokkos::RandomAccess> >,
      Kokkos::View<std::size_t**, Kokkos::LayoutRight, ExecSpace> >

◆ ParticleAges

using MC::ParticleAges = ParticleAgesBase<ComputeSpace>

◆ ParticlePositions

using MC::ParticlePositions = Kokkos::View<uint64_t*, ComputeSpace>

◆ ParticlePropertyViewType

template<typename MemorySpace>

using MC::ParticlePropertyViewType = Kokkos::View<double**, Kokkos::LayoutRight, MemorySpace>

◆ ParticleSamples

using MC::ParticleSamples

Initial value:

Kokkos::

View<Kokkos::Experimental::half_t**, Kokkos::LayoutRight, ComputeSpace>

◆ ParticlesModel

template<uint64_t Nd, FloatingPointType F>

using MC::ParticlesModel = Kokkos::View<F* [Nd], Kokkos::LayoutRight>

Examples: example_model.cxx.

◆ ParticleStatus

using MC::ParticleStatus = Kokkos::View<Status*, ComputeSpace>

◆ ParticleWeigths

using MC::ParticleWeigths = Kokkos::View<double*, ComputeSpace>

◆ pool_type

using MC::pool_type = gen_pool_type<Kokkos::DefaultExecutionSpace>

Examples: /home/runner/work/BioCMA-MCST/BioCMA-MCST/apps/libs/mc/public/mc/prng/prng.hpp, and example_model.cxx.

◆ PropertySubViewtype

using MC::PropertySubViewtype

Initial value:

 Kokkos::Subview<ParticlePropertyViewType<ComputeSpace>,
                        decltype(Kokkos::ALL),
                        std::size_t>

◆ restrict_mt

using MC::restrict_mt = Kokkos::MemoryTraits<Kokkos::MemoryTraitsFlags::Restrict>

◆ VolumeView

template<class ExecSpace, bool is_const>

using MC::VolumeView

Initial value:

 std::conditional_t<
      is_const,
      Kokkos::View<const double*,
                   ExecSpace,
                   Kokkos::MemoryTraits<Kokkos::RandomAccess> >,
      Kokkos::View<double*, ExecSpace> >

Enumeration Type Documentation

◆ EventType

enum class MC::EventType : char

strong

Enumeration that represents events that can occurs during a Monte-Carlo cycle.

Enumerator
NewParticle	Spawn new particle.
Exit	Remove particle from list due to move in domain.
Move	Move in domain.
Death	Remove particle from list.
Overflow
ChangeWeight	Update in weight.
__COUNT__

◆ Status

enum class MC::Status : char

strong

Enumerator
Idle
Division
Exit
Dead

Examples: example_model.cxx.

Function Documentation

◆ event_index()

template<EventType event>

KOKKOS_INLINE_FUNCTION consteval size_t MC::event_index ( )

consteval

inline getter, converts event to its value in order to be use as array index

Here is the caller graph for this function:

◆ get_pool()

pool_type MC::get_pool ( std::size_t seed = 0 )

Examples: /home/runner/work/BioCMA-MCST/BioCMA-MCST/apps/libs/mc/public/mc/prng/prng.hpp.

Here is the caller graph for this function:

◆ impl_init()

void MC::impl_init	(	double &	total_mass,
		uint64_t	n_particles,
		MonteCarloUnit &	unit,
		AutoGenerated::ContainerVariant &&	container,
		bool	uniform_init )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

template<ModelType Model>

std::unique_ptr< MonteCarloUnit > MC::init	(	const std::shared_ptr< IO::Logger > &	_logger,
		uint64_t	n_particles,
		std::size_t	n_samples,
		std::span< double >	volumes,
		std::span< const size_t >	_neighbors,
		bool	uniform_mc_init,
		double &	total_mass )

Helper function to initialize a MonteCarloUnit.

Since MonteCarloUnit is not a generic type and the model type is resolved at runtime, no constructors are defined to avoid carrying template functions when using the unit. This function wraps the constructor externally, providing a convenient way to initialize a MonteCarloUnit with the appropriate model type and parameters.

Template Parameters

Model The particle model type, specified at compile time.

Returns: A unique pointer to the initialized MonteCarloUnit.

Here is the call graph for this function:

◆ load_tuning_constant()

RuntimeParameters MC::load_tuning_constant ( )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ post_init_weight()

void MC::post_init_weight	(	std::unique_ptr< MonteCarloUnit > &	unit,
		double	x0,
		double	total_mass )

Here is the caller graph for this function:

◆ sample_random_variables()

KOKKOS_INLINE_FUNCTION auto MC::sample_random_variables	(	const pool_type &	pool,
		auto &&	functor )

Examples: /home/runner/work/BioCMA-MCST/BioCMA-MCST/apps/libs/mc/public/mc/prng/prng.hpp.

Here is the caller graph for this function:

Variable Documentation

◆ number_event_type

size_t MC::number_event_type

constexpr

Initial value:

= static_cast<std::size_t>(

EventType::__COUNT__)

MC::EventType::__COUNT__

@ __COUNT__

Definition events.hpp:24

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ ComputeSpace

◆ ContributionView

◆ CumulativeProbabilityView

◆ DiagonalView

◆ DynParticlesModel

◆ gen_pool_type

◆ generator_type

◆ HostSpace

◆ KernelConcentrationType

◆ LeavingFlowView

◆ LocalConcentration

◆ NeighborsView

◆ ParticleAges

◆ ParticlePositions

◆ ParticlePropertyViewType

◆ ParticleSamples

◆ ParticlesModel

◆ ParticleStatus

◆ ParticleWeigths

◆ pool_type

◆ PropertySubViewtype

◆ restrict_mt

◆ VolumeView

Enumeration Type Documentation

◆ EventType

◆ Status

Function Documentation

◆ event_index()

◆ get_pool()

◆ impl_init()

◆ init()

◆ load_tuning_constant()

◆ post_init_weight()

◆ sample_random_variables()

Variable Documentation

◆ number_event_type