1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
/* Copyright (c) 2020, Dyssol Development Team.
* Copyright (c) 2024, DyssolTEC GmbH.
* All rights reserved. This file is part of Dyssol. See LICENSE file for license information. */
#pragma once
#include "ModelsManager.h"
#include "DyssolTypes.h"
class CMultidimensionalGrid;
class CMaterialsDatabase;
class CH5Handler;
// TODO: rename to CUnit.
/* A container wrapping a unit's model in the flowsheet structure. Is responsible for loading/unloading units and solvers from dynamic libraries.
* This is actually a Unit - an entity of the flowsheet. Each Unit is filled with a Model (CBaseUnit) that represents its structure and functionality. */
class CUnitContainer
{
static constexpr unsigned m_saveVersion{ 2 }; // Current version of the saving procedure.
std::string m_name{ "Unit" }; // Name of the unit container - a unit name displayed in the flowsheet.
std::string m_uniqueID; // The unique identifier of the unit.
CBaseUnit* m_model{ nullptr }; // Pointer to a contained model.
CModelsManager* m_modelsManager{}; // A holder of all accessible models.
////////////////////////////////////////////////////////////////////////////////
// References to flowsheet structural data and settings
//
// TODO: gather them in some global structure.
const CMaterialsDatabase* m_materialsDB{}; // Reference to a database of materials.
const CMultidimensionalGrid* m_grid{}; // Reference to the main distributions grid.
const std::vector<SOverallDescriptor>* m_overall{}; // Reference to overall properties.
const std::vector<SPhaseDescriptor>* m_phases{}; // Reference to phases.
const SCacheSettings* m_cache{}; // Reference to cache settings.
const SToleranceSettings* m_tolerance{}; // Reference to tolerance settings.
const SThermodynamicsSettings* m_thermodynamics{}; // Reference to thermodynamics settings.
public:
CUnitContainer() = default;
// Basic constructor.
CUnitContainer(const std::string& _id, CModelsManager* _modelsManager,
const CMaterialsDatabase* _materialsDB, const CMultidimensionalGrid* _grid, const std::vector<SOverallDescriptor>* _overall,
const std::vector<SPhaseDescriptor>* _phases, const SCacheSettings* _cache, const SToleranceSettings* _tolerance, const SThermodynamicsSettings* _thermodynamics);
CUnitContainer(const CUnitContainer& _other);
CUnitContainer(CUnitContainer&& _other) noexcept;
CUnitContainer& operator=(CUnitContainer _other);
CUnitContainer& operator=(CUnitContainer&& _other) noexcept;
// Basic destructor.
~CUnitContainer();
/**
* \brief Swaps the content of two unit containers.
* \param _first First container.
* \param _second Second container.
*/
friend void swap(CUnitContainer& _first, CUnitContainer& _second) noexcept;
// Returns a name of the unit.
[[nodiscard]] std::string GetName() const;
// Sets a new name of the unit.
void SetName(const std::string& _name);
// Returns a unique key of the unit.
[[nodiscard]] std::string GetKey() const;
// Sets a new unique key of the unit.
void SetKey(const std::string& _id);
// Sets new model with a specified unique ID. If the unit already contains a model, it is removed and a new instance is created.
void SetModel(const std::string& _uniqueID);
// Returns a pointer to a contained model.
const CBaseUnit* GetModel() const;
// Returns a pointer to a contained model.
CBaseUnit* GetModel();
// Sets pointer to a global materials database.
void SetMaterialsDatabase(const CMaterialsDatabase* _materialsDB);
// Initializes all solvers chosen in unit parameters by loading them from corresponding dynamic libraries. Returns an empty string on success, otherwise returns an error description.
std::string InitializeExternalSolvers() const;
// Unloads all solvers from unit parameters.
void ClearExternalSolvers() const;
// Saves unit to HDF5 file.
void SaveToFile(CH5Handler& _h5File, const std::string& _path) const;
// Loads unit from HDF5 file.
void LoadFromFile(CH5Handler& _h5File, const std::string& _path);
// Loads unit from HDF5 file. A compatibility version.
void LoadFromFile_v1(CH5Handler& _h5File, const std::string& _path);
};
|
