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_utils/alias.hpp>
7#include <common/execinfo.hpp>
8#include <core/scalar_factory.hpp>
9#include <core/simulation_parameters.hpp>
10#include <cstddef>
11#include <cstdint>
12#include <initializer_list>
13#include <mc/unit.hpp>
14#include <memory>
15#include <optional>
16#include <simulation/feed_descriptor.hpp>
17#include <simulation/mass_transfer.hpp>
18#include <simulation/scalar_initializer.hpp>
19// #include <simulation/simulation.hpp>
20#include <string>
21// #include <transitionner/transitionner.hpp>
22#include <vector>
23
24class ILoadBalancer;
25
26namespace Simulation
27{
28 class SimulationUnit;
29}
30
31namespace Core
32{
33
41 {
42 public:
49 template <typename T> using OptionalPtr = std::optional<std::unique_ptr<T>>;
50
58 GlobalInitialiser(const ExecInfo& _info,
59 UserControlParameters _user_params,
60 std::shared_ptr<IO::Logger> = nullptr);
61
67 // OptionalPtr<CmaRead::FlowIterator> init_flow_iterator();
68
77 std::optional<bool>
78 init_state(const CmaUtils::TransitionnerPtrType& transiionner);
79
80 // /**
81 // * @brief Initializes a transitioner with the provided flow iterator.
82 // *
83 // * @param flow_handle A unique pointer to the flow iterator.
84 // * @return An optional unique pointer to the initialized flow map
85 // * transitioner.
86 // */
87 // std::optional<CmaUtils::TransitionnerPtrType>
88 // init_transitionner(std::unique_ptr<CmaRead::FlowIterator>&& flow_handle);
89
96 std::optional<CmaUtils::TransitionnerPtrType> init_transitionner();
97
104 init_simulation(std::optional<Core::ScalarFactory::ScalarVariant> variant);
105
115 init_simulation(std::unique_ptr<MC::MonteCarloUnit> _unit,
116 const Simulation::ScalarInitializer& scalar_init);
117
123 std::optional<Simulation::ScalarInitializer> init_scalar();
124
125 std::optional<Simulation::ScalarInitializer>
127
128 // Use optional bcause we need to validate step even if theres no mtr
129 std::optional<bool> init_mtr_model(
131 std::optional<Simulation::MassTransfer::Type::MtrTypeVariant>&&
132 variant);
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
176 enum class InitStep : std::size_t
177 {
178 // FlowIterator = 0, ///< Step for initializing the flow iterator.
187 };
188
192 std::array<bool, static_cast<size_t>(InitStep::Count)> validated_steps{};
193
201 template <typename... Args>
202 [[nodiscard]] bool check_steps(InitStep step, Args... args) const
203 {
204 if (!validated_steps[static_cast<size_t>(step)]) // NOLINT
205 {
206 return false;
207 }
208
209 return (... && validated_steps[static_cast<size_t>(args)]);
210 }
211
219 template <typename... Args> void validate_step(InitStep step, Args... args)
220 {
221 validated_steps[static_cast<size_t>(step)] = true; // NOLINT
222 (void)std::initializer_list<int>{
223 (validated_steps[static_cast<size_t>(args)] = true, 0)...};
224 }
225
232 // CmtCommons::cma_exported_paths_t
233 // get_path_files(const std::string& cma_case_path);
234
238 std::optional<bool>
240
246 void mpi_broadcast();
247
250
252
253 struct inner
254 {
255 };
256
258 std::vector<double> liquid_volume;
259 std::vector<double> gas_volume;
260 // CmaRead::Neighbors::Neighbors_const_view_t liquid_neighbors;
261
262 std::vector<std::size_t> flat_neighobrs;
263
265 // std::vector<size_t> worker_neighbor_data;
267 std::optional<Simulation::Feed::SimulationFeed> feed;
268 std::shared_ptr<IO::Logger> logger;
269
271
272 bool is_host;
273 };
274
275} // namespace Core
276
277#endif //__CORE_GLOBAL_INITIALLISER_HPP__
OptionalPtr< Simulation::SimulationUnit > init_simulation(std::optional< Core::ScalarFactory::ScalarVariant > variant)
Initializes a simulation unit.
Definition global_initaliser.cpp:225
ExecInfo info
Definition global_initaliser.hpp:248
std::optional< CmaUtils::TransitionnerPtrType > init_transitionner()
Initializes a transitioner with the provided flow iterator.
Definition global_initaliser.cpp:180
void set_initial_number_particle(uint64_t np) noexcept
Definition global_initaliser.cpp:438
std::optional< Simulation::Feed::SimulationFeed > feed
Definition global_initaliser.hpp:267
uint64_t particle_per_process
Definition global_initaliser.hpp:257
bool f_init_gas_flow
Definition global_initaliser.hpp:266
double t_per_flowmap
Definition global_initaliser.hpp:264
std::optional< bool > host_init_state(const CmaUtils::TransitionnerPtrType &transiionner)
Retrieves path files based on the provided case path.
Definition global_initaliser.cpp:471
void validate_step(InitStep step, Args... args)
Validates the specified initialization step and any additional steps.
Definition global_initaliser.hpp:219
std::vector< std::size_t > flat_neighobrs
Definition global_initaliser.hpp:262
bool check_steps(InitStep step, Args... args) const
Checks the validity of specified initialization steps.
Definition global_initaliser.hpp:202
GlobalInitialiser(const ExecInfo &_info, UserControlParameters _user_params, std::shared_ptr< IO::Logger >=nullptr)
Constructs a GlobalInitialiser instance.
Definition global_initaliser.cpp:90
std::vector< double > gas_volume
Definition global_initaliser.hpp:259
std::optional< std::unique_ptr< T > > OptionalPtr
Type alias for an optional unique pointer.
Definition global_initaliser.hpp:49
std::vector< double > liquid_volume
Definition global_initaliser.hpp:258
void set_logger(std::shared_ptr< IO::Logger > _logger)
Definition global_initaliser.cpp:105
UserControlParameters user_params
Definition global_initaliser.hpp:251
std::array< bool, static_cast< size_t >(InitStep::Count)> validated_steps
Array to track validated initialization steps.
Definition global_initaliser.hpp:192
std::optional< bool > init_state(const CmaUtils::TransitionnerPtrType &transiionner)
Initializes a flow iterator.
Definition global_initaliser.cpp:159
OptionalPtr< MC::MonteCarloUnit > init_monte_carlo()
Initializes a Monte Carlo unit.
Definition global_initaliser.cpp:243
void mpi_broadcast()
Performs MPI broadcast for synchronization.
Definition global_initaliser.cpp:538
std::optional< Simulation::ScalarInitializer > init_scalar()
Initializes a scalar component of the simulation.
Definition global_initaliser.cpp:397
std::shared_ptr< IO::Logger > logger
Definition global_initaliser.hpp:268
SimulationParameters params
Definition global_initaliser.hpp:249
bool is_host
Flag indicating if this instance is the host.
Definition global_initaliser.hpp:272
std::optional< bool > init_mtr_model(Simulation::SimulationUnit &unit, std::optional< Simulation::MassTransfer::Type::MtrTypeVariant > &&variant)
Definition global_initaliser.cpp:364
SimulationParameters get_parameters() const
Definition global_initaliser.cpp:465
InitStep
Enum to define initialization steps.
Definition global_initaliser.hpp:177
@ InitState
Step for initializing the simulation state.
Definition global_initaliser.hpp:180
@ MTR
Definition global_initaliser.hpp:185
@ 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:186
@ 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:125
bool check_init_terminate() const
Checks if all initialization steps have been validated.
Definition global_initaliser.cpp:443
Definition iload_balancer.hpp:9
Definition simulation.hpp:55
rust::Box< TransitionerWrapper > TransitionnerPtrType
Opaque type for flowmap transitioner.
Definition alias.hpp:14
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:14
Namespace that contains classes and structures related to simulation handling.
Definition host_specific.hpp:14
Definition global_initaliser.hpp:254
Definition simulation_parameters.hpp:58
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