BioCMAMC-ST
global_initaliser.hpp
1#ifndef __CORE_GLOBAL_INITIALLISER_HPP__
2#define __CORE_GLOBAL_INITIALLISER_HPP__
3
4#include "common/logger.hpp"
5#include <array>
6#include <cma_read/flow_iterator.hpp>
7#include <cma_read/neighbors.hpp>
8#include <cmt_common/cma_case.hpp>
9#include <common/execinfo.hpp>
10#include <core/scalar_factory.hpp>
11#include <core/simulation_parameters.hpp>
12#include <cstddef>
13#include <cstdint>
14#include <initializer_list>
15#include <mc/unit.hpp>
16#include <memory>
17#include <optional>
18#include <simulation/feed_descriptor.hpp>
19#include <simulation/mass_transfer.hpp>
20#include <simulation/scalar_initializer.hpp>
21// #include <simulation/simulation.hpp>
22#include <string>
23#include <transitionner/transitionner.hpp>
24#include <vector>
25
26class ILoadBalancer;
27
28namespace Simulation
29{
30 class SimulationUnit;
31}
32
33namespace Core
34{
35
43 {
44 public:
51 template <typename T> using OptionalPtr = std::optional<std::unique_ptr<T>>;
52
60 GlobalInitialiser(const ExecInfo& _info,
61 UserControlParameters _user_params,
62 std::shared_ptr<IO::Logger> = nullptr);
63
70
79 std::optional<bool>
80 init_state(std::unique_ptr<CmaRead::FlowIterator>& flow_handle);
81
90 init_transitionner(std::unique_ptr<CmaRead::FlowIterator>&& flow_handle);
91
99
106 init_simulation(std::optional<Core::ScalarFactory::ScalarVariant> variant);
107
117 init_simulation(std::unique_ptr<MC::MonteCarloUnit> _unit,
118 const Simulation::ScalarInitializer& scalar_init);
119
125 std::optional<Simulation::ScalarInitializer> init_scalar();
126
127 std::optional<Simulation::ScalarInitializer>
129
130 std::optional<bool>
133
139 bool init_feed(
140 std::optional<Simulation::Feed::SimulationFeed> feed = std::nullopt);
141
148
154 [[nodiscard]] bool check_init_terminate() const;
155
156 [[nodiscard]] SimulationParameters get_parameters() const;
157
158 void set_initial_number_particle(uint64_t np) noexcept;
159
160 private:
161 void set_logger(std::shared_ptr<IO::Logger> _logger);
162
187
191 std::array<bool, static_cast<size_t>(InitStep::Count)> validated_steps{};
192
200 template <typename... Args>
201 [[nodiscard]] bool check_steps(InitStep step, Args... args) const
202 {
203 if (!validated_steps[static_cast<size_t>(step)]) // NOLINT
204 {
205 return false;
206 }
207
208 return (... && validated_steps[static_cast<size_t>(args)]);
209 }
210
218 template <typename... Args> void validate_step(InitStep step, Args... args)
219 {
220 validated_steps[static_cast<size_t>(step)] = true; // NOLINT
221 (void)std::initializer_list<int>{
222 (validated_steps[static_cast<size_t>(args)] = true, 0)...};
223 }
224
231 CmtCommons::cma_exported_paths_t
232 get_path_files(const std::string& cma_case_path);
233
237 std::optional<bool>
238 host_init_state(std::unique_ptr<CmaRead::FlowIterator>& flow_handle);
239
245 void mpi_broadcast();
246
249
251
254 std::vector<double> liquid_volume;
255 std::vector<double> gas_volume;
256 CmaRead::Neighbors::Neighbors_const_view_t liquid_neighbors;
258 std::vector<size_t> worker_neighbor_data;
260 std::optional<Simulation::Feed::SimulationFeed> feed;
261 std::shared_ptr<IO::Logger> logger;
262
264
265 bool is_host;
266 };
267
268} // namespace Core
269
270#endif //__CORE_GLOBAL_INITIALLISER_HPP__
OptionalPtr< Simulation::SimulationUnit > init_simulation(std::optional< Core::ScalarFactory::ScalarVariant > variant)
Initializes a simulation unit.
Definition global_initaliser.cpp:223
ExecInfo info
Definition global_initaliser.hpp:247
std::optional< bool > init_state(std::unique_ptr< CmaRead::FlowIterator > &flow_handle)
Initializes the simulation state.
Definition global_initaliser.cpp:192
void set_initial_number_particle(uint64_t np) noexcept
Definition global_initaliser.cpp:530
std::optional< Simulation::Feed::SimulationFeed > feed
Definition global_initaliser.hpp:260
uint64_t particle_per_process
Definition global_initaliser.hpp:253
bool f_init_gas_flow
Definition global_initaliser.hpp:259
double t_per_flowmap
Definition global_initaliser.hpp:257
void validate_step(InitStep step, Args... args)
Validates the specified initialization step and any additional steps.
Definition global_initaliser.hpp:218
bool check_steps(InitStep step, Args... args) const
Checks the validity of specified initialization steps.
Definition global_initaliser.hpp:201
GlobalInitialiser(const ExecInfo &_info, UserControlParameters _user_params, std::shared_ptr< IO::Logger >=nullptr)
Constructs a GlobalInitialiser instance.
Definition global_initaliser.cpp:123
std::vector< double > gas_volume
Definition global_initaliser.hpp:255
std::optional< std::unique_ptr< T > > OptionalPtr
Type alias for an optional unique pointer.
Definition global_initaliser.hpp:51
std::vector< double > liquid_volume
Definition global_initaliser.hpp:254
CmtCommons::cma_exported_paths_t get_path_files(const std::string &cma_case_path)
Retrieves path files based on the provided case path.
Definition global_initaliser.cpp:150
void set_logger(std::shared_ptr< IO::Logger > _logger)
Definition global_initaliser.cpp:139
std::vector< size_t > worker_neighbor_data
Definition global_initaliser.hpp:258
UserControlParameters user_params
Definition global_initaliser.hpp:250
CmaRead::Neighbors::Neighbors_const_view_t liquid_neighbors
Definition global_initaliser.hpp:256
std::optional< bool > init_mtr_model(Simulation::SimulationUnit &unit, Simulation::MassTransfer::Type::MtrTypeVariant &&variant)
Definition global_initaliser.cpp:460
std::array< bool, static_cast< size_t >(InitStep::Count)> validated_steps
Array to track validated initialization steps.
Definition global_initaliser.hpp:191
OptionalPtr< CmaUtils::FlowMapTransitionner > init_transitionner()
Initializes a transitioner without parameters.
Definition global_initaliser.cpp:213
OptionalPtr< CmaRead::FlowIterator > init_flow_iterator()
Initializes a flow iterator.
Definition global_initaliser.cpp:310
OptionalPtr< MC::MonteCarloUnit > init_monte_carlo()
Initializes a Monte Carlo unit.
Definition global_initaliser.cpp:241
void mpi_broadcast()
Performs MPI broadcast for synchronization.
Definition global_initaliser.cpp:622
std::optional< Simulation::ScalarInitializer > init_scalar()
Initializes a scalar component of the simulation.
Definition global_initaliser.cpp:489
std::shared_ptr< IO::Logger > logger
Definition global_initaliser.hpp:261
SimulationParameters params
Definition global_initaliser.hpp:248
bool is_host
Flag indicating if this instance is the host.
Definition global_initaliser.hpp:265
std::optional< bool > host_init_state(std::unique_ptr< CmaRead::FlowIterator > &flow_handle)
Host speciffic state init.
Definition global_initaliser.cpp:563
SimulationParameters get_parameters() const
Definition global_initaliser.cpp:557
InitStep
Enum to define initialization steps.
Definition global_initaliser.hpp:177
@ FlowIterator
Step for initializing the flow iterator.
Definition global_initaliser.hpp:178
@ InitState
Step for initializing the simulation state.
Definition global_initaliser.hpp:180
@ Feed
Step for initializing the simulation feed.
Definition global_initaliser.hpp:182
@ SimulationUnit
Step for initializing the simulation unit.
Definition global_initaliser.hpp:184
@ Count
Total number of steps in the initialization sequence.
Definition global_initaliser.hpp:185
@ Scalar
Step for initializing scalar values.
Definition global_initaliser.hpp:181
@ Transitioner
Step for initializing the transitioner.
Definition global_initaliser.hpp:179
bool init_feed(std::optional< Simulation::Feed::SimulationFeed > feed=std::nullopt)
Initializes a simulation feed.
Definition global_initaliser.cpp:158
bool check_init_terminate() const
Checks if all initialization steps have been validated.
Definition global_initaliser.cpp:535
Definition iload_balancer.hpp:9
Definition simulation.hpp:56
std::variant< Uniform, Local, File, CustomScript, FullCase > ScalarVariant
Path to the custom script used for initializing scalar data.
Definition scalar_factory.hpp:132
Core component to perform simulation.
Definition data_exporter.hpp:19
Namespace that contains classes and structures related to Monte Carlo (MC) simulations.
Definition alias.hpp:9
std::variant< FlowmapTurbulence, FixedKla, FlowmapKla > MtrTypeVariant
Definition mass_transfer.hpp:39
Namespace that contains classes and structures related to simulation handling.
Definition host_specific.hpp:13
Definition simulation_parameters.hpp:59
A structure to hold user-defined control parameters for simulation settings.
Definition simulation_parameters.hpp:24
Definition execinfo.hpp:12
Definition scalar_initializer.hpp:28