model.h

Go to the documentation of this file.

#ifndef PSIM_MODEL_H
#define PSIM_MODEL_H
 
#include "cell.h"// for Cell
#include "material.h"// for Material
#include "modelSimulator.h"// for ModelSimulator
#include "outputManager.h"// for OutputManager
#include "psim/geometry.h"// for Point, Triangle (ptr only)
#include "psim/sensor.h"// for Sensor, Sensor::SimulationType
#include "sensorInterpreter.h"// for SensorInterpreter
#include <cstddef>// for size_t
#include <filesystem>// for path
#include <memory>// for unique_ptr
#include <mutex>// for mutex
#include <optional>// for optional
#include <string>// for string, basic_string
#include <unordered_map>// for unordered_map
#include <utility>// for pair
#include <vector>// for vector
 
 
class Model {
public:
    using Point = Geometry::Point;
    using SimulationType = Sensor::SimulationType;
 
    Model(std::size_t num_cells,
        std::size_t num_sensors,
        std::size_t measurement_steps,
        std::size_t num_phonons,
        double simulation_time,
        double t_eq,
        bool phasor_sim = false);
    void setSimulationType(SimulationType type, std::size_t step_interval = 0);
    void addMaterial(const std::string& material_name, const Material& material);
    void addSensor(std::size_t ID,
        const std::string& material_name,
        double t_init,
        Sensor::SimulationType type);// NOLINT
    void addCell(Geometry::Triangle&& triangle, std::size_t sensor_ID, double spec = 1.);
    void addCell(Point&& p1, Point&& p2, std::size_t sensor_ID, double spec = 1.);// NOLINT
    [[nodiscard]] bool
        setEmitSurface(const Point& p1, const Point& p2, double temp, double duration, double start_time);// NOLINT
 
    void runSimulation();
    void exportResults(const fs::path& filepath, double time) const;
 
private:
    SimulationType sim_type_{ SimulationType::SteadyState };
    std::size_t num_cells_;
    std::size_t measurement_steps_;
    double simulation_time_;
    std::size_t num_phonons_;
    double t_eq_{ 0. };// Changes as the system evolves between runs
    bool phasor_sim_;
    std::size_t start_step_{ 0 };// 0 for SS simulations -> measurements vectors are scaled down in the sensors
 
    ModelSimulator simulator_;
    OutputManager outputManager_;
    SensorInterpreter interpreter_;
    std::unique_ptr<std::mutex> addMeasurementMutex_;
 
    std::vector<Cell> cells_;
    std::vector<Sensor> sensors_;
    std::unordered_map<std::string, Material> materials_;
 
    [[nodiscard]] Sensor& getSensor(std::size_t ID);// NOLINT
    [[nodiscard]] double getTotalInitialEnergy() const noexcept;
    [[nodiscard]] std::pair<double, double> setTemperatureBounds() noexcept;
    void initializeMaterialTables(double low_temp, double high_temp);
    [[nodiscard]] double avgTemp() const;
    void storeResults() noexcept;
    [[nodiscard]] std::optional<double> resetRequired() noexcept;
    void reset() noexcept;
};
 
 
#endif// PSIM_MODEL_H