File: UnitParameters.h

package info (click to toggle)
dyssol 1.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,184 kB
  • sloc: cpp: 53,870; sh: 85; python: 59; makefile: 11
file content (1413 lines) | stat: -rw-r--r-- 36,799 bytes parent folder | download | duplicates (2)
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
/* Copyright (c) 2020, Dyssol Development Team.
 * Copyright (c) 2023, DyssolTEC GmbH.
 * All rights reserved. This file is part of Dyssol. See LICENSE file for license information. */

#pragma once

#include "DependentValues.h"
#include "DyssolStringConstants.h"
#include "BaseSolver.h"
#include "H5Handler.h"
#include "ChemicalReaction.h"
#include "UnitParametersEnum.h"

// TODO: remove
#define UP_MIN (-std::numeric_limits<double>::max())
#define UP_MAX  (std::numeric_limits<double>::max())

template<typename T>
constexpr EUnitParameter DeduceTypeConst()
{
	if constexpr (std::is_same_v<T, double>)
		return EUnitParameter::CONSTANT_DOUBLE;
	else if constexpr (std::is_same_v<T, int64_t>)
		return EUnitParameter::CONSTANT_INT64;
	else if constexpr (std::is_same_v<T, uint64_t>)
		return EUnitParameter::CONSTANT_UINT64;
	else
		return EUnitParameter::UNKNOWN;
}

template<typename T>
constexpr EUnitParameter DeduceTypeList()
{
	if constexpr (std::is_same_v<T, double>)
		return EUnitParameter::LIST_DOUBLE;
	else if constexpr (std::is_same_v<T, int64_t>)
		return EUnitParameter::LIST_INT64;
	else if constexpr (std::is_same_v<T, uint64_t>)
		return EUnitParameter::LIST_UINT64;
	else
		return EUnitParameter::UNKNOWN;
}

/**
 * \brief Base class for unit parameters.
 */
class CBaseUnitParameter
{
	EUnitParameter m_type;     ///< Type of unit parameter.
	std::string m_name;        ///< Parameter name.
	std::wstring m_units;      ///< Units of measurement.
	std::string m_description; ///< Description of the parameter.

public:
	/**
	 * \private
	 */
	CBaseUnitParameter();
	/**
	 * \private
	 */
	explicit CBaseUnitParameter(EUnitParameter _type);
	/**
	 * \private
	 */
	CBaseUnitParameter(EUnitParameter _type, std::string _name, std::wstring _units, std::string _description);
	/**
	 * \private
	 */
	virtual ~CBaseUnitParameter() = default;

	/**
	 * \private
	 */
	CBaseUnitParameter(const CBaseUnitParameter& _other)            = default;
	/**
	 * \private
	 */
	CBaseUnitParameter(CBaseUnitParameter&& _other)                 = default;
	/**
	 * \private
	 */
	CBaseUnitParameter& operator=(const CBaseUnitParameter& _other) = default;
	/**
	 * \private
	 */
	CBaseUnitParameter& operator=(CBaseUnitParameter&& _other)      = default;

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] virtual CBaseUnitParameter* clone() const = 0;

	/**
	 * \private
	 * \brief Clears all data.
	 */
	virtual void Clear() = 0;

	/**
	 * \brief Returns unit parameter type.
	 * \return Unit parameter type
	 */
	EUnitParameter GetType() const;
	/**
	* \brief Returns unit parameter name.
	* \return Parameter name.
	*/
	std::string GetName() const;
	/**
	 * \brief Returns parameter units.
	 * \return Parameter units.
	 */
	std::wstring GetUnits() const;
	/**
	 * \brief Returns parameter description.
	 * \return Parameter description.
	 */
	std::string GetDescription() const;

	/**
	 * \private
	 * \brief Sets parameter type.
	 * \param _type Parameter type.
	 */
	void SetType(EUnitParameter _type);
	/**
	 * \private
	 * \brief Sets parameter name.
	 * \param _name Parameter name.
	 */
	void SetName(const std::string& _name);
	/**
	 * \private
	 * \brief Sets parameter units.
	 * \param _units Parameter units.
	 */
	void SetUnits(const std::wstring& _units);
	/**
	 * \private
	 * \brief Sets parameter description.
	 * \param _description Parameter description.
	 */
	void SetDescription(const std::string& _description);

	/**
	 * \brief Checks whether all values lay in allowed range.
	 * \return Whether all values lay in allowed range.
	 */
	virtual bool IsInBounds() const;

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	virtual std::ostream& ValueToStream(std::ostream& _s) = 0;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	virtual std::istream& ValueFromStream(std::istream& _s) = 0;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	//virtual void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) = 0;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	//virtual void LoadFromFile(CH5Handler& _h5Loader, const std::string& _path) = 0;
};


/**
 * \brief Basic class for constant unit parameters.
 */
template<typename T>
class CConstUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion{ 1 };

	T m_value{}; ///< Const value.
	T m_min{};   ///< Minimum allowed value.
	T m_max{};   ///< Maximum allowed value.

public:
	/**
	 * \private
	 * \brief Type of the underlying value.
	 */
	using value_type = T;

	/**
	 * \private
	 */
	CConstUnitParameter()
		: CBaseUnitParameter(DeduceTypeConst<T>())
	{
	}

	/**
	 * \private
	 */
	CConstUnitParameter(std::string _name, std::wstring _units, std::string _description, T _min, T _max, T _value)
		: CBaseUnitParameter(DeduceTypeConst<T>(), std::move(_name), std::move(_units), std::move(_description))
		, m_value{ _value }
		, m_min{ _min }
		, m_max{ _max }
	{
	}

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CConstUnitParameter* clone() const override { return new CConstUnitParameter{ *this }; }

	/**
	 * \private
	 * \brief Sets value to zero.
	 */
	void Clear() override { m_value = {}; }

	/**
	 * \brief Returns constant unit parameter value.
	 * \return Constant unit parameter value.
	 */
	T GetValue() const { return m_value; }
	/**
	 * \brief Returns minimum allowed value.
	 * \return Minimum allowed value.
	 */
	T GetMin() const{ return m_min; }
	/**
	 * \brief Returns maximum allowed value.
	 * \return Maximum allowed value.
	 */
	T GetMax() const{ return m_max; }

	/**
	 * \private
	 * \brief Sets constant unit parameter value.
	 * \param _value Constant unit parameter value.
	 */
	void SetValue(T _value) { m_value = _value; }
	/**
	 * \private
	 * \brief Sets minimum allowed value.
	 * \param _min Minimum allowed value.
	 */
	void SetMin(T _min){ m_min = _min; }
	/**
	 * \private
	 * \brief Sets maximum allowed value.
	 * \param _max Maximum allowed value.
	 */
	void SetMax(T _max){ m_max = _max; }

	/**
	 * \brief Checks whether m_value lays in range [m_min; m_max].
	 * \return Whether m_value lays in the allowed range.
	 */
	bool IsInBounds() const override { return m_value >= m_min && m_value <= m_max; }

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override { return _s << m_value; }
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override { return _s >> m_value; }

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5File, const std::string& _path) const
	{
		if (!_h5File.IsValid()) return;

		// current version of save procedure
		_h5File.WriteAttribute(_path, StrConst::BUnit_H5AttrSaveVersion, m_cnSaveVersion);

		// save data
		_h5File.WriteData(_path, StrConst::UParam_H5Values, m_value);
	}

	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5File, const std::string& _path)
	{
		if (!_h5File.IsValid()) return;

		// load version of save procedure
		//const int version = _h5File.ReadAttribute(_path, StrConst::BUnit_H5AttrSaveVersion);

		// read data
		_h5File.ReadData(_path, StrConst::UParam_H5Values, m_value);
	}
};

/**
 * \brief Specialization of the class CConstUnitParameter for real constant unit parameters.
 */
using CConstRealUnitParameter = CConstUnitParameter<double>;
/**
 * \brief Specialization of the class CConstUnitParameter for signed integer constant unit parameters.
 */
using CConstIntUnitParameter = CConstUnitParameter<int64_t>;
/**
 * \brief Specialization of the class CConstUnitParameter for unsigned integer constant unit parameters.
 */
using CConstUIntUnitParameter = CConstUnitParameter<uint64_t>;


/**
 * \brief Base class for constant list unit parameters.
 */
template<typename T>
class CListUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_saveVersion{ 0 };

	std::vector<T> m_values{}; ///< Const values.
	T m_min{};                 ///< Minimum allowed value.
	T m_max{};                 ///< Maximum allowed value.

public:
	/**
	 * \private
	 * \brief Type of the underlying value.
	 */
	using value_type = T;

	/**
	 * \private
	 */
	CListUnitParameter()
		: CBaseUnitParameter(DeduceTypeList<T>())
	{
	}
	/**
	 * \private
	 */
	CListUnitParameter(std::string _name, std::wstring _units, std::string _description, T _min, T _max, std::vector<T> _values)
		: CBaseUnitParameter{ DeduceTypeList<T>(), std::move(_name), std::move(_units), std::move(_description) }
		, m_values{ std::move(_values) }
		, m_min{ _min }
		, m_max{ _max }
	{
	}

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CListUnitParameter* clone() const override { return new CListUnitParameter{ *this }; }

	/**
	 * \private
	 * \brief Clears all data.
	 */
	void Clear() override { m_values.clear(); }

	/**
	 * \brief Returns value at the given index of the list.
	 * \details Returns T{} if no value is defined for the given index.
	 * \param _index Index of the value.
	 * \return Value at the given index.
	 */
	[[nodiscard]] T GetValue(size_t _index) const { if (_index >= m_values.size()) return T{}; return m_values[_index]; }
	/**
	 * \private
	 * \brief Adds new value to the list.
	 * \param _value New value.
	 */
	void AddValue(T _value) { m_values.push_back(_value); }
	/**
	 * \private
	 * \brief Sets new value at the given index of the list if it exists.
	 * \details If the value at the given index does not exist, nothing is done.
	 * \param _index Index of the value.
	 * \param _value New value.
	 */
	void SetValue(size_t _index, T _value) { if (_index < m_values.size()) m_values[_index] = _value; }
	/**
	 * \private
	 * \brief Removes value at the given index of the list if it exists.
	 * \details If the value at the given index does not exist, nothing is done.
	 * \param _index Index of the value.
	 */
	void RemoveValue(size_t _index)	{ if (_index < m_values.size()) m_values.erase(m_values.begin() + _index); }
	/**
	 * \brief Returns all defined values.
	 * \return All defined values.
	 */
	[[nodiscard]] std::vector<T> GetValues() const { return m_values; }
	/**
	 * \private
	 * \brief Sets new list of values.
	 * \param _values New list of values.
	 */
	void SetValues(const std::vector<T>& _values) { m_values = _values; }

	/**
	 * \brief Returns minimum allowed value.
	 * \return Minimum allowed value.
	 */
	[[nodiscard]] T GetMin() const { return m_min; }
	/**
	 * \brief Returns maximum allowed value.
	 * \return Maximum allowed value.
	 */
	[[nodiscard]] T GetMax() const { return m_max; }
	/**
	 * \brief Returns allowed interval for the value.
	 * \return Allowed interval for the value.
	 */
	[[nodiscard]] SInterval GetLimits() const { return { (double)m_min , (double)m_max }; }

	/**
	 * \private
	 * \brief Sets minimum allowed value.
	 * \param _min Minimum allowed value.
	 */
	void SetMin(T _min) { m_min = _min; }
	/**
	 * \private
	 * \brief Sets maximum allowed value.
	 * \param _max Maximum allowed value.
	 */
	void SetMax(T _max) { m_max = _max; }

	/**
	 * \brief Returns number of defined values.
	 * \return Number of defined values.
	 */
	[[nodiscard]] size_t Size() const { return m_values.size(); }
	/**
	 * \brief Checks if any value is defined in the list.
	 * \return Whether any value is defined.
	 */
	[[nodiscard]] bool IsEmpty() const { return m_values.empty(); }
	/**
	 * \brief Checks if all values lay in range [min; max].
	 * \return Whether all value lay in the allowed interval.
	 */
	[[nodiscard]] bool IsInBounds() const override { return std::all_of(m_values.begin(), m_values.end(), [&](const auto val) { return val >= m_min && val <= m_max; }); }

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override
	{
		for (const auto& v : m_values)
			_s << " " << v;
		return _s;
	}
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override
	{
		m_values.clear();
		while (!_s.eof())
			m_values.push_back(StringFunctions::GetValueFromStream<T>(_s));
		return _s;
	}

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5File, const std::string& _path) const
	{
		if (!_h5File.IsValid()) return;

		// current version of save procedure
		_h5File.WriteAttribute(_path, StrConst::H5AttrSaveVersion, m_saveVersion);

		// save data
		_h5File.WriteData(_path, StrConst::UParam_H5Values, m_values);
	}
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5File, const std::string& _path)
	{
		if (!_h5File.IsValid()) return;

		// load version of save procedure
		//const int version = _h5File.ReadAttribute(_path, StrConst::H5AttrSaveVersion);

		m_values.clear();

		// read data
		_h5File.ReadData(_path, StrConst::UParam_H5Values, m_values);
	}
};

/**
 * \brief Specialization of the class CListUnitParameter for real constant unit parameters.
 */
using CListRealUnitParameter = CListUnitParameter<double>;
/**
 * \brief Specialization of the class CListUnitParameter for signed integer constant unit parameters.
 */
using CListIntUnitParameter  = CListUnitParameter<int64_t>;
/**
 * \brief Specialization of the class CListUnitParameter for unsigned integer constant unit parameters.
 */
using CListUIntUnitParameter = CListUnitParameter<uint64_t>;


/**
 * \brief Class for dependent unit parameters.
 */
class CDependentUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion{ 2 };

	CDependentValues m_data;  ///< Dependent values.
	double m_valueMin{};      ///< Minimum allowed value.
	double m_valueMax{};      ///< Maximum allowed value.
	double m_paramMin{};      ///< Minimum allowed parameter.
	double m_paramMax{};      ///< Maximum allowed parameter.
	std::string m_paramName;  ///< Parameter name.
	std::wstring m_paramUnits; ///< Parameter units.

public:
	/**
	 * \private
	 */
	CDependentUnitParameter();
	/**
	 * \private
	 */
	CDependentUnitParameter(std::string _valueName, double _valueInit, std::wstring _valueUnits, std::string _paramName, double _paramInit, std::wstring _paramUnits, std::string _description, double _valueMin, double _valueMax, double _paramMin, double _paramMax);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CDependentUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Removes all values
	 */
	void Clear() override;

	/**
	 * \brief Returns dependent parameter name.
	 * \return Dependent parameter name.
	 */
	std::string GetParamName() const;
	/**
	 * \private
	 * \brief Sets dependent parameter name.
	 * \param _paramName Dependent parameter name.
	 */
	void SetParamName(const std::string& _paramName);

	/**
	 * \brief Returns dependent parameter units.
	 * \return Dependent parameter units.
	 */
	std::wstring GetParamUnits() const;
	/**
	 * \private
	 * \brief Sets dependent parameter units.
	 * \param _paramUnits Dependent parameter units.
	 */
	void SetParamUnits(const std::wstring& _paramUnits);

	/**
	 * \brief Returns minimum allowed value.
	 * \return Minimum allowed value.
	 */
	double GetValueMin() const;
	/**
	 * \brief Returns maximum allowed value.
	 * \return Maximum allowed value.
	 */
	double GetValueMax() const;
	/**
	 * \brief Returns allowed interval for the value.
	 * \return Allowed interval for the value.
	 */
	[[nodiscard]] SInterval GetValueLimits() const;

	/**
	 * \private
	 * \brief Sets minimum allowed value.
	 * \param _valueMin Minimum allowed value.
	 */
	void SetValueMin(double _valueMin);
	/**
	 * \private
	 * \brief Sets maximum allowed value.
	 * \param _valueMax Maximum allowed value.
	 */
	void SetValueMax(double _valueMax);

	/**
	 * \brief Returns minimum allowed dependent parameter.
	 * \return Minimum allowed dependent parameter.
	 */
	double GetParamMin() const;
	/**
	 * \brief Returns maximum allowed dependent parameter.
	 * \return Maximum allowed dependent parameter.
	 */
	double GetParamMax() const;
	/**
	 * \brief Returns allowed interval for the dependent parameter.
	 * \return Allowed interval for the dependent parameter.
	 */
	[[nodiscard]] SInterval GetParamLimits() const;

	/**
	 * \private
	 * \brief Sets minimum allowed dependent parameter.
	 * \param _paramMin Minimum allowed dependent parameter.
	 */
	void SetParamMin(double _paramMin);
	/**
	 * \private
	 * \brief Sets maximum allowed dependent parameter.
	 * \param _paramMax Maximum allowed dependent parameter.
	 */
	void SetParamMax(double _paramMax);

	/**
	 * \brief Returns unit parameter value at given dependent parameter.
	 * \details Applies data interpolation if necessary.
	 * \param _param Dependent parameter.
	 * \return Value at current dependent parameter.
	 */
	double GetValue(double _param) const;
	/**
	 * \private
	 * \brief Sets new unit parameter value at given dependent parameter.
	 * \details If the given dependent parameter already exists, changes its value. If the given dependent parameter does not yet exists, adds a new parameter-value pair.
	 * \param _param Dependent parameter.
	 * \param _value Value at current dependent parameter.
	 */
	void SetValue(double _param, double _value);
	/**
	 * \private
	 * \brief Removes unit parameter value at given dependent parameter.
	 * \details If the value at the given parameter does not exist, nothing is done.
	 * \param _param Dependent parameter.
	 */
	void RemoveValue(double _param);

	/**
	 * \brief Returns list of all defined dependent parameters.
	 * \return List of all defined dependent parameters.
	 */
	std::vector<double> GetParams() const;
	/**
	 * \brief Returns list of all defined values.
	 * \return List of all defined values.
	 */
	std::vector<double> GetValues() const;
	/**
	 * \private
	 * \brief Sets new lists of dependent parameters and values.
	 * \param _params List of dependent parameters.
	 * \param _values List of values.
	 */
	void SetValues(const std::vector<double>& _params, const std::vector<double>& _values);
	/**
	 * \brief Returns all defined data as parameter-value pairs.
	 * \return All defined data.
	 */
	[[nodiscard]] std::vector<std::pair<double, double>> GetParamValuePairs() const;
	/**
	 * \private
	 * \brief Returns the dependent data itself.
	 * \return Reference to dependent data.
	 */
	const CDependentValues& GetDependentData() const;

	/**
	 * \brief Returns number of defined dependent values.
	 * \return Number of defined dependent values.
	 */
	size_t Size() const;
	/**
	 * \brief Checks whether any dependent value is defined.
	 * \return Whether any dependent value is defined.
	 */
	bool IsEmpty() const;
	/**
	 * \brief Checks whether all values lay in range [m_valueMin; m_valueMax] and parameters lay in range [m_paramMin; m_paramMax].
	 * \return Whether all values and all parameters lay in the allowed interval.
	 */
	bool IsInBounds() const override;
	/**
	 * \brief Checks if a specific parameter is included in data without interpolation.
	 * \param _param Parameter.
	 * \return Dependent parameter.
	 */
	bool HasParam(double _param) const;

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5File, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5File, const std::string& _path);
};

/**
 * \brief Class for time-dependent unit parameters.
 */
class CTDUnitParameter : public CDependentUnitParameter
{
	static const unsigned m_cnSaveVersion{ 2 };

public:
	/**
	 * \private
	 */
	CTDUnitParameter();
	/**
	 * \private
	 */
	CTDUnitParameter(std::string _name, std::wstring _units, std::string _description, double _min, double _max, double _value);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CTDUnitParameter* clone() const override;

	/**
	* \brief Returns list of all defined time points.
	* \details Refer to function CDependentUnitParameter::GetParams() const.
	* \return List of all defined time points.
	*/
	std::vector<double> GetTimes() const;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5File, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5File Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5File, const std::string& _path);
};


/**
 * \brief Class for string unit parameters.
 */
class CStringUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion;

	std::string m_value; ///< String parameter value.

public:
	/**
	 * \private
	 */
	CStringUnitParameter();
	/**
	 * \private
	 */
	CStringUnitParameter(std::string _name, std::string _description, std::string _value);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CStringUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Resets value.
	 */
	void Clear() override;

	/**
	 * \brief Returns string unit parameter value.
	 * \return String unit parameter value.
	 */
	std::string GetValue() const;
	/**
	 * \private
	 * \brief Sets string unit parameter value.
	 * \param _value String unit parameter value.
	 */
	void SetValue(const std::string& _value);

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5Saver Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5Loader Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5Loader, const std::string& _path);
};


/**
 * \brief Class for check box unit parameters.
 */
class CCheckBoxUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion;

	bool m_checked; ///< Check box parameter value: checked/unchecked.

public:
	/**
	 * \private
	 */
	CCheckBoxUnitParameter();
	/**
	 * \private
	 */
	CCheckBoxUnitParameter(std::string _name, std::string _description, bool _checked);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CCheckBoxUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Resets value to unchecked.
	 */
	void Clear() override;

	/**
	 * \brief Returns check box unit parameter value.
	 * \return Whether checkbox is checked.
	 */
	bool IsChecked() const;
	/**
	 * \private
	 * \brief Sets check box unit parameter value.
	 * \param _checked Flag.
	 */
	void SetChecked(bool _checked);
	/**
	 * \brief Returns check box unit parameter value.
	 * \return Whether checkbox is checked.
	 */
	[[nodiscard]] bool GetValue() const;
	/**
	 * \private
	 * \brief Sets check box unit parameter value.
	 * \param _checked Flag.
	 */
	void SetValue(bool _checked);

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5Saver Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5Loader Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5Loader, const std::string& _path);
};


/**
 * \brief Class for solver unit parameters.
 */
class CSolverUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion;

	std::string m_key;                ///< Solver's key.
	ESolverTypes m_solverType;        ///< Solver's type.
	CBaseSolver* m_solver{ nullptr }; ///< Pointer to a selected solver.

public:
	/**
	 * \private
	 */
	CSolverUnitParameter();
	/**
	 * \private
	 */
	CSolverUnitParameter(std::string _name, std::string _description, ESolverTypes _type);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CSolverUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Resets solver's key and type.
	 */
	void Clear() override;

	/**
	 * \brief Returns solver's key.
	 * \return Solver's key.
	 */
	std::string GetKey() const;
	/**
	 * \brief Returns solver's type.
	 * \return Solver's type.
	 */
	ESolverTypes GetSolverType() const;
	/**
	 * \brief Returns pointer to a solver.
	 * \return Pointer to a solver.
	 */
	CBaseSolver* GetSolver() const;

	/**
	 * \private
	 * \brief Sets solver's key.
	 * \param _key Solver's key.
	 */
	void SetKey(const std::string& _key);
	/**
	 * \private
	 * \brief Sets solver's type.
	 * \param _type Solver's type.
	 */
	void SetSolverType(ESolverTypes _type);
	/**
	 * \private
	 * \brief Sets pointer to a solver.
	 * \param _solver Pointer to a solver.
	 */
	void SetSolver(CBaseSolver* _solver);

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5Saver Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5Loader Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5Loader, const std::string& _path);
};


/**
 * \brief Class for combobox unit parameters.
 */
class CComboUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion;

	std::map<size_t, std::string> m_items; ///< List of possible items to select (value:name).
	size_t m_selected = -1;                ///< Selected item.

public:
	/**
	 * \private
	 */
	CComboUnitParameter();
	/**
	 * \private
	 */
	CComboUnitParameter(std::string _name, std::string _description, size_t _itemDefault, const std::vector<size_t>& _items, const std::vector<std::string>& _itemsNames);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CComboUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Resets selected key.
	 */
	void Clear() override;

	/**
	 * \brief Returns currently selected item.
	 * \return Currently selected item.
	 */
	size_t GetValue() const;
	/**
	 * \private
	 * \brief Sets new selected item.
	 * \param _item New selected item.
	 */
	void SetValue(size_t _item);

	/**
	 * \brief Returns all items.
	 * \return All items.
	 */
	std::vector<size_t> GetItems() const;
	/**
	 * \brief Returns all items' names.
	 * \return All items' names.
	 */
	std::vector<std::string> GetNames() const;
	/**
	 * \brief Returns item by its name.
	 * \param _name Name of the item.
	 * \return Item value.
	 */
	size_t GetItemByName(const std::string& _name) const;
	/**
	 * \brief Returns name of the item.
	 * \param _item Item value.
	 * \return Name of the item.
	 */
	std::string GetNameByItem(size_t _item) const;

	/**
	 * \brief Returns true if the combobox contains the given item.
	 * \param _item Item value.
	 * \return Whether combobox contains the given item.
	 */
	bool HasItem(size_t _item) const;
	/**
	 * \brief Returns true if the combobox contains an item with the given name.
	 * \param _name Name of the item.
	 * \return Whether combobox contains an item with the given name.
	 */
	bool HasName(const std::string& _name) const;
	/**
	 * \brief Checks whether the selected item is one of the allowed items.
	 * \return Whether the selected item is in allowed bounds.
	 */
	bool IsInBounds() const override;

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5Saver Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5Loader Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5Loader, const std::string& _path);
};


/**
 * \brief Class for material compound unit parameters.
 */
class CCompoundUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion;

	std::string m_key; ///< Unique key of selected compound.

public:
	/**
	 * \private
	 */
	CCompoundUnitParameter();
	/**
	 * \private
	 */
	CCompoundUnitParameter(std::string _name, std::string _description);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CCompoundUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Resets compound's key.
	 */
	void Clear() override;

	/**
	 * \brief Returns key of currently selected compound.
	 * \return Key of currently selected compound.
	 */
	std::string GetCompound() const;
	/**
	 * \private
	 * \brief Sets new compound's key.
	 * \param _key Compound's key.
	 */
	void SetCompound(const std::string& _key);

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5Saver Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5Loader Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5Loader, const std::string& _path);
};

/**
 * \brief Class for material compound from MDB unit parameters.
 */
class CMDBCompoundUnitParameter : public CCompoundUnitParameter
{
	static const unsigned m_cnSaveVersion;

public:
	/**
	 * \private
	 */
	CMDBCompoundUnitParameter();
	/**
	 * \private
	 */
	CMDBCompoundUnitParameter(std::string _name, std::string _description);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CMDBCompoundUnitParameter* clone() const override;
};


/**
 * \brief Class for chemical reaction unit parameters.
 */
class CReactionUnitParameter : public CBaseUnitParameter
{
	static const unsigned m_cnSaveVersion;

	std::vector<CChemicalReaction> m_reactions; ///< Defined reactions.

public:
	/**
	 * \private
	 */
	CReactionUnitParameter();
	/**
	 * \private
	 */
	CReactionUnitParameter(std::string _name, std::string _description);

	/**
	 * \private
	 * \brief Returns a non-managed pointer to a copy of this.
	 */
	[[nodiscard]] CReactionUnitParameter* clone() const override;

	/**
	 * \private
	 * \brief Clears all reactions.
	 */
	void Clear() override;

	/**
	 * \brief Returns all defined chemical reactions.
	 * \return All defined chemical reactions.
	 */
	[[nodiscard]] std::vector<CChemicalReaction> GetReactions() const;
	/**
	 * \brief Returns pointers to all defined chemical reactions.
	 * \return Pointers to all defined chemical reactions.
	 */
	std::vector<CChemicalReaction*> GetReactionsPtr();
	/**
	 * \brief Returns const pointer to reaction with the given index.
	 * \details If such reaction does not exist, returns nullptr.
	 * \param _index Index of the reaction.
	 * \return Const pointer to reaction.
	 */
	[[nodiscard]] const CChemicalReaction* GetReaction(size_t _index) const;
	/**
	 * \brief Returns pointer to reaction with the given index.
	 * \details If such reaction does not exist, returns nullptr.
	 * \param _index Index of the reaction.
	 * \return Pointer to reaction.
	 */
	CChemicalReaction* GetReaction(size_t _index);
	/**
	 * \brief Returns the number of defined reactions.
	 * \return Number of defined reactions.
	 */
	[[nodiscard]] size_t GetReactionsNumber() const;

	/**
	 * \private
	 * \brief Adds new empty reaction.
	 */
	void AddReaction();
	/**
	 * \private
	 * \brief Adds new reaction.
	 * \param _reaction Reaction.
	 */
	void AddReaction(const CChemicalReaction& _reaction);
	/**
	 * \private
	 * \brief Sets new reactions replacing existing.
	 * \param _reactions New reactions.
	 */
	void SetReactions(const std::vector<CChemicalReaction>& _reactions);

	/**
	 * \private
	 * \brief Removes the selected reaction.
	 * \param _index Index of the reaction.
	 */
	void RemoveReaction(size_t _index);

	/**
	 * \private
	 * \brief Outputs user-specified values of the parameter to a stream.
	 * \param _s Output stream.
	 * \return Output stream.
	 */
	std::ostream& ValueToStream(std::ostream& _s) override;
	/**
	 * \private
	 * \brief Reads user-specified values of the parameter from a stream.
	 * \param _s Input stream.
	 * \return Input stream.
	 */
	std::istream& ValueFromStream(std::istream& _s) override;

	/**
	 * \private
	 * \brief Saves data to file.
	 * \param _h5Saver Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path) const;
	/**
	 * \private
	 * \brief Loads data from file.
	 * \param _h5Loader Reference to the file handler.
	 * \param _path Path to data in the file.
	 */
	void LoadFromFile(const CH5Handler& _h5Loader, const std::string& _path);
};