Core::GlobalInitialiser Class Reference

A class responsible for initializing various components of a simulation framework. More...

#include <global_initaliser.hpp>

Collaboration diagram for Core::GlobalInitialiser:

Classes
struct	inner

Public Types
template<typename T>
using	OptionalPtr = std::optional<std::unique_ptr<T>>
	Type alias for an optional unique pointer.

Public Member Functions
	GlobalInitialiser (const ExecInfo &_info, UserControlParameters _user_params, std::shared_ptr< Mixture::SpecieTable > table, std::shared_ptr< IO::Logger >=nullptr)
	Constructs a GlobalInitialiser instance.
std::optional< bool >	init_state (const CmaUtils::TransitionnerPtrType &transiionner)
	Initializes a flow iterator.
std::optional< CmaUtils::TransitionnerPtrType >	init_transitionner ()
	Initializes a transitioner with the provided flow iterator.
OptionalPtr< Simulation::SimulationUnit >	init_simulation (std::optional< Core::ScalarFactory::ScalarVariant > variant)
	Initializes a simulation unit.
OptionalPtr< Simulation::SimulationUnit >	init_simulation (std::unique_ptr< MC::MonteCarloUnit > _unit, Simulation::ScalarInitializer &&scalar_init)
	Initializes a simulation unit with specified parameters.
std::optional< Simulation::ScalarInitializer >	init_scalar ()
	Initializes a scalar component of the simulation.
std::optional< Simulation::ScalarInitializer >	init_scalar (Core::ScalarFactory::ScalarVariant &&variant)
std::optional< bool >	init_mtr_model (std::optional< Simulation::MassTransfer::Type::MtrTypeVariant > &&variant)
bool	init_feed (std::optional< Simulation::Feed::SimulationFeed > feed=std::nullopt)
	Initializes a simulation feed.
OptionalPtr< MC::MonteCarloUnit >	init_monte_carlo ()
	Initializes a Monte Carlo unit.
bool	check_init_terminate () const
	Checks if all initialization steps have been validated.
SimulationParameters	get_parameters () const
void	set_initial_number_particle (uint64_t np) noexcept
void	set_table (std::shared_ptr< Mixture::SpecieTable > t) noexcept

Private Types
enum class	InitStep : std::size_t {   Transitioner = 0 , InitState , Scalar , Feed ,   MC , SimulationUnit , MTR , Count }
	Enum to define initialization steps. More...

Private Member Functions
void	set_logger (std::shared_ptr< IO::Logger > _logger)
template<typename... Args>
bool	check_steps (InitStep step, Args... args) const
	Checks the validity of specified initialization steps.
template<typename... Args>
void	validate_step (InitStep step, Args... args)
	Validates the specified initialization step and any additional steps.
std::optional< bool >	host_init_state (const CmaUtils::TransitionnerPtrType &transiionner)
	Retrieves path files based on the provided case path.
void	mpi_broadcast ()
	Performs MPI broadcast for synchronization.

Private Attributes
std::shared_ptr< Mixture::SpecieTable >	m_table
Core::SimulationUnitBuilder	m_builder {}
std::array< bool, static_cast< size_t >(InitStep::Count)>	validated_steps {}
	Array to track validated initialization steps.
ExecInfo	info
SimulationParameters	m_params
UserControlParameters	user_params
std::vector< double >	m_liquid_volume
std::vector< double >	m_gas_volume
std::vector< std::size_t >	m_flat_neighobrs
double	t_per_flowmap {}
bool	f_init_gas_flow
std::shared_ptr< IO::Logger >	m_logger
bool	is_host
	Flag indicating if this instance is the host.

Detailed Description

A class responsible for initializing various components of a simulation framework.

Member Typedef Documentation

OptionalPtr

template<typename T>

using Core::GlobalInitialiser::OptionalPtr = std::optional<std::unique_ptr<T>>

Type alias for an optional unique pointer.

This template alias provides a way to represent an optional ownership of a unique pointer of type T.

Member Enumeration Documentation

InitStep

enum class Core::GlobalInitialiser::InitStep : std::size_t

strongprivate

Enum to define initialization steps.

Each member represents a distinct step in the initialization process, except for the last member, Count, which signifies the total number of initialization steps.

Note

This enum class leverages a C++ feature where if the first member is initialized to 0, the subsequent members are automatically assigned incrementing integer values. Thus, the Count member effectively represents the total number of steps (n), minus one for zero-based indexing.

Enumerator
Transitioner	Step for initializing the transitioner.
InitState	Step for initializing the simulation state.
Scalar	Step for initializing scalar values.
Feed	Step for initializing the simulation feed.
MC	Step for initializing the Monte Carlo unit.
SimulationUnit	Step for initializing the simulation unit.
MTR
Count	Total number of steps in the initialization sequence.

Constructor & Destructor Documentation

GlobalInitialiser()

Core::GlobalInitialiser::GlobalInitialiser	(	const ExecInfo &	_info,
		UserControlParameters	_user_params,
		std::shared_ptr< Mixture::SpecieTable >	table,
		std::shared_ptr< IO::Logger >	_logger = nullptr )

Constructs a GlobalInitialiser instance.

Parameters

_info	Execution information containing context for the simulation.
_params	Simulation parameters that configure the simulation behavior.

Here is the call graph for this function:

Member Function Documentation

check_init_terminate()

bool Core::GlobalInitialiser::check_init_terminate ( ) const

nodiscard

Checks if all initialization steps have been validated.

Returns

A boolean indicating whether initialization can be terminated.

Here is the call graph for this function:

check_steps()

template<typename... Args>

bool Core::GlobalInitialiser::check_steps ( InitStep step, Args... args ) const

inlinenodiscardprivate

Checks the validity of specified initialization steps.

Parameters

step	The current initialization step to check.
args	Additional steps to check.

Returns

A boolean indicating whether all specified steps are validated.

Here is the caller graph for this function:

get_parameters()

SimulationParameters Core::GlobalInitialiser::get_parameters ( ) const

nodiscard

host_init_state()

std::optional< bool > Core::GlobalInitialiser::host_init_state ( const CmaUtils::TransitionnerPtrType & transiionner )

private

Retrieves path files based on the provided case path.

Parameters

cma_case_path

The path for the CMA case.

Returns

A structure containing exported paths.

Host speciffic state init

Here is the caller graph for this function:

init_feed()

bool Core::GlobalInitialiser::init_feed

(

std::optional< Simulation::Feed::SimulationFeed >

feed = std::nullopt

)

Initializes a simulation feed.

Returns

An optional simulation feed.

Here is the call graph for this function:

init_monte_carlo()

OptionalPtr< MC::MonteCarloUnit > Core::GlobalInitialiser::init_monte_carlo

(

)

Initializes a Monte Carlo unit.

Returns

An optional unique pointer to the initialized Monte Carlo unit.

Here is the call graph for this function:

Here is the caller graph for this function:

init_mtr_model()

std::optional< bool > Core::GlobalInitialiser::init_mtr_model

(

std::optional< Simulation::MassTransfer::Type::MtrTypeVariant > &&

variant

)

Here is the call graph for this function:

init_scalar() [1/2]

std::optional< Simulation::ScalarInitializer > Core::GlobalInitialiser::init_scalar

(

)

Initializes a scalar component of the simulation.

Returns

An optional scalar initializer.

Here is the call graph for this function:

Here is the caller graph for this function:

init_scalar() [2/2]

std::optional< Simulation::ScalarInitializer > Core::GlobalInitialiser::init_scalar

(

Core::ScalarFactory::ScalarVariant &&

variant

)

Here is the call graph for this function:

init_simulation() [1/2]

OptionalPtr< Simulation::SimulationUnit > Core::GlobalInitialiser::init_simulation

(

std::optional< Core::ScalarFactory::ScalarVariant >

variant

)

Initializes a simulation unit.

Returns

An optional unique pointer to the initialized simulation unit.

Here is the call graph for this function:

Here is the caller graph for this function:

init_simulation() [2/2]

OptionalPtr< Simulation::SimulationUnit > Core::GlobalInitialiser::init_simulation	(	std::unique_ptr< MC::MonteCarloUnit >	_unit,
		Simulation::ScalarInitializer &&	scalar_init )

Initializes a simulation unit with specified parameters.

Parameters

_unit	A unique pointer to the Monte Carlo unit initialized.
scalar_init	A scalar initializer for the simulation.
_feed	An optional simulation feed for initialization.

Returns

An optional unique pointer to the initialized simulation unit.

Here is the call graph for this function:

init_state()

std::optional< bool > Core::GlobalInitialiser::init_state

(

const CmaUtils::TransitionnerPtrType &

transiionner

)

Initializes a flow iterator.

Returns

An optional unique pointer to the initialized flow iterator.

Initializes the simulation state.

Parameters

flow_handle

A unique pointer to the flow iterator used for state initialization.

Returns

An optional boolean indicating success or failure of the initialization.

Here is the call graph for this function:

Here is the caller graph for this function:

init_transitionner()

std::optional< CmaUtils::TransitionnerPtrType > Core::GlobalInitialiser::init_transitionner

(

)

Initializes a transitioner with the provided flow iterator.

Parameters

flow_handle

A unique pointer to the flow iterator.

Returns

An optional unique pointer to the initialized flow map transitioner.

Initializes a transitioner without parameters.

Returns

An optional unique pointer to the initialized flow map transitioner.

Here is the call graph for this function:

mpi_broadcast()

void Core::GlobalInitialiser::mpi_broadcast ( )

private

Performs MPI broadcast for synchronization.

Note

: this function compiles and doesn't throw error even if no_mpi is not defined Method for handling MPI broadcast communication.

Here is the call graph for this function:

Here is the caller graph for this function:

set_initial_number_particle()

void Core::GlobalInitialiser::set_initial_number_particle ( uint64_t np )

noexcept

set_logger()

void Core::GlobalInitialiser::set_logger ( std::shared_ptr< IO::Logger > _logger )

private

Here is the caller graph for this function:

set_table()

void Core::GlobalInitialiser::set_table ( std::shared_ptr< Mixture::SpecieTable > t )

noexcept

validate_step()

template<typename... Args>

void Core::GlobalInitialiser::validate_step ( InitStep step, Args... args )

inlineprivate

Validates the specified initialization step and any additional steps.

Parameters

step	The current initialization step to validate.
args	Additional steps to validate.

Here is the caller graph for this function:

Member Data Documentation

f_init_gas_flow

bool Core::GlobalInitialiser::f_init_gas_flow

private

info

ExecInfo Core::GlobalInitialiser::info

private

is_host

bool Core::GlobalInitialiser::is_host

private

Flag indicating if this instance is the host.

m_builder

Core::SimulationUnitBuilder Core::GlobalInitialiser::m_builder {}

private

m_flat_neighobrs

std::vector<std::size_t> Core::GlobalInitialiser::m_flat_neighobrs

private

m_gas_volume

std::vector<double> Core::GlobalInitialiser::m_gas_volume

private

m_liquid_volume

std::vector<double> Core::GlobalInitialiser::m_liquid_volume

private

m_logger

std::shared_ptr<IO::Logger> Core::GlobalInitialiser::m_logger

private

m_params

SimulationParameters Core::GlobalInitialiser::m_params

private

m_table

std::shared_ptr<Mixture::SpecieTable> Core::GlobalInitialiser::m_table

private

t_per_flowmap

double Core::GlobalInitialiser::t_per_flowmap {}

private

user_params

UserControlParameters Core::GlobalInitialiser::user_params

private

validated_steps

std::array<bool, static_cast<size_t>(InitStep::Count)> Core::GlobalInitialiser::validated_steps {}

private

Array to track validated initialization steps.

---

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

• apps/core/public/core/global_initaliser.hpp
• apps/core/src/global_initaliser.cpp