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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/* 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 "DyssolTypes.h"
#include <vector>
#include <memory>
class CH5Handler;
/*
* Base for grid dimensions.
*/
class CGridDimension
{
static constexpr unsigned m_saveVersion{ 1 }; // Current version of the saving procedure.
EDistrTypes m_type{ DISTR_SIZE }; // Distribution type.
EGridEntry m_entry{ EGridEntry::GRID_NUMERIC }; // Entry type.
public:
CGridDimension() = default;
explicit CGridDimension(EGridEntry _entry);
explicit CGridDimension(EDistrTypes _type, EGridEntry _entry);
CGridDimension(const CGridDimension& _other) = default;
CGridDimension(CGridDimension&& _other) = default;
CGridDimension& operator=(const CGridDimension& _other) = default;
CGridDimension& operator=(CGridDimension&& _other) = default;
virtual ~CGridDimension() = default;
// Returns a non-managed pointer to a copy of this.
[[nodiscard]] virtual CGridDimension* Clone() const;
// Compares two objects.
friend bool operator==(const CGridDimension& _lhs, const CGridDimension& _rhs);
// Compares two objects.
friend bool operator!=(const CGridDimension& _lhs, const CGridDimension& _rhs);
// Returns the type of the dimension.
[[nodiscard]] EDistrTypes DimensionType() const;
// Returns the type of the grid for this dimension.
[[nodiscard]] EGridEntry GridType() const;
// Returns the number of classes defined in this grid dimension.
[[nodiscard]] virtual size_t ClassesNumber() const;
// Sets new distribution type.
void SetType(EDistrTypes _type);
protected:
// Compares for equality with another object.
[[nodiscard]] virtual bool Equal(const CGridDimension& _other) const;
};
/*
* Numeric grid.
*/
class CGridDimensionNumeric : public CGridDimension
{
static constexpr unsigned m_saveVersion{ 1 }; // Current version of the saving procedure.
std::vector<double> m_grid{ 0 , 1 }; // Grid itself.
public:
CGridDimensionNumeric();
explicit CGridDimensionNumeric(EDistrTypes _type);
CGridDimensionNumeric(EDistrTypes _type, std::vector<double> _grid);
// Returns a non-managed pointer to a copy of this.
[[nodiscard]] CGridDimensionNumeric* Clone() const override;
// Returns the number of classes defined in this grid dimension.
[[nodiscard]] size_t ClassesNumber() const override;
// Returns current numerical grid.
[[nodiscard]] std::vector<double> Grid() const;
// Sets new grid.
void SetGrid(const std::vector<double>& _grid);
// Returns mean values for each class.
[[nodiscard]] std::vector<double> GetClassesMeans() const;
// Returns sizes of classes.
[[nodiscard]] std::vector<double> GetClassesSizes() const;
// Saves grid to a HDF5 file.
void SaveToFile(const CH5Handler& _h5File, const std::string& _path) const;
// Loads grid from a HDF5 file.
void LoadFromFile(const CH5Handler& _h5File, const std::string& _path);
private:
// Compares for equality with another object.
[[nodiscard]] bool Equal(const CGridDimension& _other) const override;
};
/*
* Symbolic grid.
*/
class CGridDimensionSymbolic : public CGridDimension
{
static constexpr unsigned m_saveVersion{ 1 }; // Current version of the saving procedure.
std::vector<std::string> m_grid; // Grid itself.
public:
CGridDimensionSymbolic();
explicit CGridDimensionSymbolic(EDistrTypes _type);
CGridDimensionSymbolic(EDistrTypes _type, std::vector<std::string> _grid);
// Returns a non-managed pointer to a copy of this.
[[nodiscard]] CGridDimensionSymbolic* Clone() const override;
// Returns the number of classes defined in this grid dimension.
[[nodiscard]] size_t ClassesNumber() const override;
// Returns current symbolic grid.
[[nodiscard]] std::vector<std::string> Grid() const;
// Sets new grid.
void SetGrid(const std::vector<std::string>& _grid);
// Adds new class to the grid.
void AddClass(const std::string& _entry);
// Removes the class from the grid.
void RemoveClass(const std::string& _entry);
// Saves grid to a HDF5 file.
void SaveToFile(const CH5Handler& _h5File, const std::string& _path) const;
// Loads grid from a HDF5 file.
void LoadFromFile(const CH5Handler& _h5File, const std::string& _path);
private:
// Compares for equality with another object.
[[nodiscard]] bool Equal(const CGridDimension& _other) const override;
};
/*
* Describes a multidimensional grid consisting of numeric and symbolic grids.
* There is always a main grid defined in the flowsheet, it is used for all new units.
* Each unit obtains a copy of the main grid, and can modify it if required.
*/
class CMultidimensionalGrid
{
static constexpr unsigned m_saveVersion{ 3 }; // Current version of the saving procedure.
std::vector<std::unique_ptr<CGridDimension>> m_grids; // All defined dimensions.
public:
CMultidimensionalGrid() = default;
CMultidimensionalGrid(const CMultidimensionalGrid& _other);
CMultidimensionalGrid(CMultidimensionalGrid&& _other) noexcept;
CMultidimensionalGrid& operator=(CMultidimensionalGrid _other);
CMultidimensionalGrid& operator=(CMultidimensionalGrid&& _other) noexcept;
~CMultidimensionalGrid() = default;
/**
* \brief Swaps the content of two grids.
* \param _first First grid.
* \param _second Second grid.
*/
friend void swap(CMultidimensionalGrid& _first, CMultidimensionalGrid& _second) noexcept;
// Removes all.
void Clear();
// Returns number of classes for each defined dimension.
[[nodiscard]] std::vector<size_t> GetClassesNumbers() const;
// Returns types of each defined dimension.
[[nodiscard]] std::vector<EDistrTypes> GetDimensionsTypes() const;
// Returns types of the grids of each defined dimension.
[[nodiscard]] std::vector<EGridEntry> GetGridsTypes() const;
// Returns the number of defined dimensions in the grid.
[[nodiscard]] size_t GetDimensionsNumber() const;
// Adds a new dimension with the given parameters to the grid if it does not exist yet.
void AddDimension(const CGridDimension& _gridDimension);
// Adds a new numerical dimension to the grid if it does not exist yet.
CGridDimensionNumeric* AddNumericDimension(EDistrTypes _type = DISTR_UNDEFINED);
// Adds a new numerical dimension to the grid if it does not exist yet.
CGridDimensionNumeric* AddNumericDimension(EDistrTypes _type, const std::vector<double>& _grid);
// Adds a new numerical dimension with the given parameters to the grid if it does not exist yet.
CGridDimensionNumeric* AddNumericDimension(const CGridDimensionNumeric& _gridDimension);
// Adds a new symbolic dimension to the grid if it does not exist yet.
CGridDimensionSymbolic* AddSymbolicDimension(EDistrTypes _type = DISTR_UNDEFINED);
// Adds a new symbolic dimension to the grid if it does not exist yet.
CGridDimensionSymbolic* AddSymbolicDimension(EDistrTypes _type, const std::vector<std::string>& _grid);
// Adds a new numerical dimension with the given parameters to the grid if it does not exist yet.
CGridDimensionSymbolic* AddSymbolicDimension(const CGridDimensionSymbolic& _gridDimension);
// Returns grid dimension by its type. Returns nullptr if such dimension does not exist.
[[nodiscard]] const CGridDimension* GetGridDimension(EDistrTypes _type) const;
// Returns grid dimension by its type. Returns nullptr if such dimension does not exist.
[[nodiscard]] CGridDimension* GetGridDimension(EDistrTypes _type);
// Returns numeric grid dimension by its type. Returns nullptr if such dimension does not exist.
[[nodiscard]] const CGridDimensionNumeric* GetGridDimensionNumeric(EDistrTypes _type) const;
// Returns numeric grid dimension by its type. Returns nullptr if such dimension does not exist.
[[nodiscard]] CGridDimensionNumeric* GetGridDimensionNumeric(EDistrTypes _type);
// Returns symbolic grid dimension by its type. Returns nullptr if such dimension does not exist.
[[nodiscard]] const CGridDimensionSymbolic* GetGridDimensionSymbolic(EDistrTypes _type) const;
// Returns symbolic grid dimension by its type. Returns nullptr if such dimension does not exist.
[[nodiscard]] CGridDimensionSymbolic* GetGridDimensionSymbolic(EDistrTypes _type);
// Removes the specified dimension form the grid.
void RemoveDimension(EDistrTypes _type);
// Returns all defined grid dimensions.
[[nodiscard]] std::vector<const CGridDimension*> GetGridDimensions() const;
// Returns all defined grid dimensions.
[[nodiscard]] std::vector<CGridDimension*> GetGridDimensions();
// Returns a numeric grid defined for the given distribution type if the distribution with such grid type exists.
[[nodiscard]] std::vector<double> GetNumericGrid(EDistrTypes _type) const;
// Returns a symbolic grid defined for the given distribution type if the distribution with such grid type exists.
[[nodiscard]] std::vector<std::string> GetSymbolicGrid(EDistrTypes _type) const;
// Returns a grid defined for PSD if it exists.
[[nodiscard]] std::vector<double> GetPSDGrid(EPSDGridType _type = EPSDGridType::DIAMETER) const;
// Returns mean values of each class of the grid defined for PSD if it exists.
[[nodiscard]] std::vector<double> GetPSDMeans(EPSDGridType _type = EPSDGridType::DIAMETER) const;
// Checks if the grid for this dimension is already defined.
[[nodiscard]] bool HasDimension(EDistrTypes _type) const;
// Equality operator
bool operator==(const CMultidimensionalGrid& _other) const;
// Inequality operator
bool operator!=(const CMultidimensionalGrid& _other) const;
// Saves grid to a HDF5 file.
void SaveToFile(const CH5Handler& _h5File, const std::string& _path);
// Loads grid from a HDF5 file.
void LoadFromFile(const CH5Handler& _h5File, const std::string& _path);
// Loads grid from a HDF5 file. Compatibility version.
void LoadFromFile_v2(const CH5Handler& _h5File, const std::string& _path);
// Loads grid from a HDF5 file. Compatibility version.
void LoadFromFile_v1(const CH5Handler& _h5File, const std::string& _path);
};
|
