🎉 Initial commit merged 1D and Hybrid Simulators

python/mmft/hybridsim/bindings.cpp

@@ -23,7 +23,7 @@ PYBIND11_MODULE(pyhybridsim, m) {
       .def("setName", &sim::Fluid<T>::setName, "name"_a)
       .def("getViscosity", &sim::Fluid<T>::getViscosity);
 
-  py::class_<sim::ResistanceModel2DPoiseuille<T>>(m, "ResistanceModel")
+  py::class_<sim::ResistanceModelPoiseuille<T>>(m, "ResistanceModel")
       .def(py::init<T &>());
 
   py::class_<sim::Simulation<T>>(m, "Simulation")

src/CMakeLists.txt

@@ -11,6 +11,7 @@ add_subdirectory(nodalAnalysis)
 add_subdirectory(architecture)
 add_subdirectory(simulation)
 add_subdirectory(porting)
+add_subdirectory(result)
 
 target_sources(${TARGET_NAME} PUBLIC ${SOURCE_LIST} ${HEADER_LIST})
 target_include_directories(${TARGET_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR})

src/architecture/Channel.h

@@ -1,3 +1,7 @@
+/**
+ * @file Channel.h
+ */
+
 #pragma once
 
 #include <memory>

src/architecture/Edge.h

@@ -1,3 +1,7 @@
+/**
+ * @file Edge.h
+ */
+
 #pragma once
 
 #include <string>

src/architecture/FlowRatePump.h

@@ -1,3 +1,7 @@
+/**
+ * @file FlowRatePump.h
+ */
+
 #pragma once
 
 #include "Edge.h"

src/architecture/Module.h

@@ -1,3 +1,7 @@
+/**
+ * @file Module.h
+ */
+
 #pragma once
 
 #include <vector>

src/architecture/Network.h

@@ -1,3 +1,7 @@
+/**
+ * @file Network.h
+ */
+
 #pragma once
 
 #include <memory>

src/architecture/Node.h

@@ -1,3 +1,7 @@
+/**
+ * @file Node.h
+ */
+
 #pragma once
 
 #include <vector>

src/architecture/PressurePump.h

@@ -1,3 +1,7 @@
+/**
+ * @file PressurePump.h
+ */
+
 #pragma once
 
 #include "Edge.h"

src/architecture/lbmModule.h

@@ -1,3 +1,7 @@
+/**
+ * @file lbmModule.h
+ */
+
 #pragma once
 
 #define M_PI 3.14159265358979323846

src/baseSimulator.h

@@ -1,7 +1,17 @@
+/**
+ * @file baseSimulator.h
+ */
+
 #include "simulation/CFDSim.h"
+#include "simulation/Droplet.h"
 #include "simulation/Fluid.h"
+#include "simulation/Injection.h"
 #include "simulation/ResistanceModels.h"
 #include "simulation/Simulation.h"
+#include "simulation/events/BoundaryEvent.h"
+#include "simulation/events/Event.h"
+#include "simulation/events/InjectionEvent.h"
+#include "simulation/events/MergingEvent.h"
 
 #include "nodalAnalysis/NodalAnalysis.h"
 

src/baseSimulator.hh

@@ -1,7 +1,12 @@
 #include "simulation/CFDSim.hh"
+#include "simulation/Droplet.hh"
 #include "simulation/Fluid.hh"
+#include "simulation/Injection.hh"
 #include "simulation/ResistanceModels.hh"
 #include "simulation/Simulation.hh"
+#include "simulation/events/BoundaryEvent.hh"
+#include "simulation/events/InjectionEvent.hh"
+#include "simulation/events/MergingEvent.hh"
 
 #include "nodalAnalysis/NodalAnalysis.hh"
 

src/nodalAnalysis/NodalAnalysis.h

@@ -1,3 +1,7 @@
+/**
+ * @file NodalAnalysis.h
+ */
+
 #pragma once
 
 #include <Network.h>

src/porting/jsonPorter.h

@@ -1,3 +1,7 @@
+/**
+ * @file jsonPorter.h
+ */
+
 #pragma once
 
 #include <memory>
@@ -14,6 +18,8 @@
 
 #include "../simulation/Simulation.h"
 
+#include "../result/Results.h"
+
 #include "nlohmann/json.hpp"
 
 namespace porting {

src/porting/jsonPorter.hh

@@ -93,21 +93,21 @@ namespace porting {
         if (!jsonString["simulation"].contains("fluids") || jsonString["simulation"]["fluids"].empty()) {
             throw std::invalid_argument("No fluids are defined. Please define at least 1 fluid.");
         }
-        std::vector<std::unique_ptr<sim::Fluid<T>>> fluids;
+        std::unordered_map<int, std::unique_ptr<sim::Fluid<T>>> fluids;
         counter = 0;
         for (auto& fluid : jsonString["simulation"]["fluids"]) {
             if (fluid.contains("density") && fluid.contains("viscosity") && fluid.contains("concentration") && fluid.contains("name")) {
                 T density = fluid["density"];
                 T viscosity = fluid["viscosity"];
                 std::string name = fluid["name"];
                 std::unique_ptr<sim::Fluid<T>> newFluid = std::make_unique<sim::Fluid<T>>( counter, density, viscosity, name );
-                fluids.push_back(std::move(newFluid));
+                fluids.try_emplace(counter, std::move(newFluid));
                 counter++;
             } else {
                 throw std::invalid_argument("Wrongly defined fluid. Please provide following information for fluids:\nname\ndensity\nviscosity\nconcentration");
             }
         }
-        simulation.setFluids(fluids);
+        simulation.setFluids(std::move(fluids));
 
         if (platform == sim::Platform::DROPLET) {
             // NOT YET SUPPORTED
@@ -216,7 +216,7 @@ namespace porting {
         }
 
         // Import resistance model
-        sim::ResistanceModel2DPoiseuille<T>* resistanceModel = new sim::ResistanceModel2DPoiseuille<T>(simulation.getContinuousPhase()->getViscosity());
+        sim::ResistanceModelPoiseuille<T>* resistanceModel = new sim::ResistanceModelPoiseuille<T>(simulation.getContinuousPhase()->getViscosity());
         simulation.setResistanceModel(resistanceModel);
 
         simulation.setNetwork(network_);

src/result/CMakeLists.txt

@@ -0,0 +1,11 @@
+set(SOURCE_LIST
+    Results.hh
+)
+
+set(HEADER_LIST
+    Results.h
+)
+
+target_sources(${TARGET_NAME} PUBLIC ${SOURCE_LIST} ${HEADER_LIST})
+target_include_directories(${TARGET_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR})
+target_link_libraries(${TARGET_NAME} PUBLIC lbmLib)

src/result/Results.h

@@ -0,0 +1,128 @@
+/**
+ * @file Results.h
+ */
+
+#pragma once
+
+#include <unordered_map>
+
+#include "../architecture/Network.h"
+#include "../simulation/Droplet.h"
+#include "../simulation/Fluid.h"
+#include "../simulation/Injection.h"
+
+namespace result {
+
+/**
+ * @brief Struct to contain a state specified by time, an unordered map of pressures, an unordered map of flow rates, a vector of clogged channel ids, an unordered map of droplet positions.
+ */
+template<typename T>
+struct State {
+    int id;                                                             ///< Sequential id of the state
+    T time;                                                             ///< Simulation time at which the following values were calculated.
+    std::unordered_map<int, T> pressures;                               ///< Keys are the nodeIds.
+    std::unordered_map<int, T> flowRates;                               ///< Keys are the edgeIds (channels and pumps).
+    std::unordered_map<int, sim::DropletPosition<T>> dropletPositions;  ///< Only contains the position of droplets that are currently inside the network (key is the droplet id).
+
+    /**
+     * @brief Constructs a state, which represent a time step during a simulation.
+     * @param[in] id Id of the state
+     * @param[in] time Value of the current time step.
+     */
+    State(int id, T time);
+
+    /**
+     * @brief Constructs a state, which represent a time step during a simulation.
+     * @param[in] id Id of the state
+     * @param[in] time Value of the current time step.
+     * @param[in] pressures The pressure values at the nodes at the current time step.
+     * @param[in] flowRates The flowRate values at the nodes at the current time step.
+     */
+    State(int id, T time, std::unordered_map<int, T> pressures, std::unordered_map<int, T> flowRates);
+
+    /**
+     * @brief Constructs a state, which represent a time step during a simulation.
+     * @param[in] id Id of the state
+     * @param[in] time Value of the current time step.
+     * @param[in] pressures The pressure values at the nodes at the current time step.
+     * @param[in] flowRates The flowRate values at the nodes at the current time step.
+     */
+    State(int id, T time, std::unordered_map<int, T> pressures, std::unordered_map<int, T> flowRates, std::unordered_map<int, sim::DropletPosition<T>> dropletPositions);
+
+    /**
+     * @brief Function to get pressure at a specific node.
+     * @return Pressures of this state in Pa.
+     */
+    std::unordered_map<int, T>& getPressures() const;
+
+    /**
+     * @brief Function to get flow rate at a specific channel.
+     * @return Flowrates of this state in m^3/s.
+     */
+    std::unordered_map<int, T>& getFlowRates() const;
+
+    /**
+     * @brief Function to get flow rate at a specific channel.
+     * @return Flowrates of this state in m^3/s.
+     */
+    std::unordered_map<int, T>& getDropletPositions() const;
+};
+
+/**
+ * @brief Struct to contain the simulation result specified by a chip, an unordered map of fluids, an unordered map of droplets, an unordered map of injections, a vector of states, a continuous fluid id, the maximal adaptive time step and the id of a resistance model.
+ */
+template<typename T>
+struct SimulationResult {
+    arch::Network<T>* network;                                      /// Contains the chip, with all the channels and pumps.
+    std::unordered_map<int, sim::Fluid<T>>* fluids;                 /// Contains all fluids which were defined (i.e., also the fluids which were created when droplets merged).
+    std::unordered_map<int, sim::Droplet<T>>* droplets;             /// Contains all droplets that occurred during the simulation not only the once that were injected (i.e., also merged and splitted droplets)/
+    std::unordered_map<int, sim::DropletInjection<T>>* injections;  /// Contains all injections that happened during the simulation.
+    std::vector<std::unique_ptr<State<T>>> states;                  /// Contains all states ordered according to their simulation time (beginning at the start of the simulation).    
+
+    int continuousPhaseId;              /// Fluid id which served as the continuous phase.
+    T maximalAdaptiveTimeStep;     /// Value for the maximal adaptive time step that was used.
+    int resistanceModel;                /// Id of the used resistance model.
+
+    SimulationResult(   arch::Network<T>* network, 
+                        std::unordered_map<int, sim::Fluid<T>>* fluids, 
+                        std::unordered_map<int, sim::Droplet<T>>* droplets, 
+                        std::unordered_map<int, sim::DropletInjection<T>>* injections);
+
+    /**
+     * @brief Adds a state to the simulation results.
+     * @param[in] state
+    */
+    void addState(T time, std::unordered_map<int, T> pressures, std::unordered_map<int, T> flowRates);
+
+    /**
+     * @brief Adds a state to the simulation results.
+     * @param[in] state
+    */
+    void addState(T time, std::unordered_map<int, T> pressures, std::unordered_map<int, T> flowRates, std::unordered_map<int, sim::DropletPosition<T>> dropletPositions);
+
+    /**
+     * @brief Get the simulated pressures at the nodes.
+     * @return Vector of pressure values
+     */
+    std::unordered_map<int, T>& getFinalPressures() const;
+
+    /**
+     * @brief Get the simulated flowrates in the channels.
+     * @return Vector of flowrate values
+     */
+    std::unordered_map<int, T>& getFinalFlowRates() const;
+
+    /**
+     * @brief Get the simulated flowrates in the channels.
+     * @return Vector of flowrate values
+     */
+    std::unordered_map<int, T>& getFinalDropletPositions() const;
+
+    /**
+     * @brief Get the simulated states that were stored during simulation.
+     * @return Vector of states
+     */
+    std::vector<std::unique_ptr<State<T>>>& getStates() const;
+};
+
+}   // namespace results

src/result/Results.hh

@@ -0,0 +1,40 @@
+#include "Results.h"
+
+#include <iostream>
+#include <ostream>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include <nlohmann/json.hpp>
+
+namespace result {
+
+template<typename T>
+State<T>::State(int id, T time) : id(id), time(time) { }
+
+template<typename T>
+T State<T>::getPressure(int nodeId) const {
+    return pressures.at(nodeId);
+}
+
+template<typename T>
+T State<T>::getPressureDrop(int node0Id, int node1Id) const {
+    return getPressure(node0Id) - getPressure(node1Id);
+}
+
+template<typename T>
+T State<T>::getFlowRate(int channelId) const {
+    return flowRates.at(channelId);
+}
+
+
+std::unordered_map<int, double> SimulationResult::getPressures() const {
+    return states[0].pressures;
+}
+
+std::unordered_map<int, double> SimulationResult::getFlowRates() const {
+    return states[0].flowRates;
+}
+
+}  // namespace droplet

src/simulation/CFDSim.h

@@ -1,3 +1,7 @@
+/**
+ * @file CFDSim.h
+ */
+
 #pragma once
 
 #include <olb2D.h>

src/simulation/CMakeLists.txt

@@ -1,17 +1,23 @@
 set(SOURCE_LIST
     CFDSim.hh
+    Droplet.hh
     Fluid.hh
+    Injection.hh
     ResistanceModels.hh
     Simulation.hh
 )
 
 set(HEADER_LIST
     CFDSim.h
+    Droplet.h
     Fluid.h
+    Injection.h
     ResistanceModels.h
     Simulation.h
 )
 
 target_sources(${TARGET_NAME} PUBLIC ${SOURCE_LIST} ${HEADER_LIST})
 target_include_directories(${TARGET_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR})
-target_link_libraries(${TARGET_NAME} PUBLIC lbmLib)
+target_link_libraries(${TARGET_NAME} PUBLIC lbmLib)
+
+add_subdirectory(events)