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 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
|
/* 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 "UnitParametersManager.h"
#include "AgglomerationSolver.h"
#include "PBMSolver.h"
#include "PlotManager.h"
#include "UnitPorts.h"
#include "StateVariable.h"
#include "StreamManager.h"
#include "DyssolUtilities.h"
#include <mutex>
#ifdef _DEBUG
#define DYSSOL_CREATE_MODEL_FUN CreateDYSSOLUnitV5_DEBUG
#else
#define DYSSOL_CREATE_MODEL_FUN CreateDYSSOLUnitV5
#endif
#define DYSSOL_CREATE_MODEL_FUN_NAME MACRO_STRINGIFY(DYSSOL_CREATE_MODEL_FUN)
// TODO: move it somewhere
////////////////////////////////////////////////////////////////////////////////
/// Deprecated defines for compatibility
///
/**
* \private
*/
#define m_sUnitName GetNameRef()
/**
* \private
*/
#define m_sAuthorName GetAuthorRef()
/**
* \private
*/
#define m_dUnitVersion GetVersionRef()
/**
* \private
*/
#define m_sUniqueID GetKeyRef()
/**
* \private
*/
#define m_pMaterialsDB GetMaterialsDBRef()
class CStream;
class CH5Handler;
// TODO: rename to CBaseModel and create a type alias to CBaseUnit.
/**
* \brief Basic class for dynamic and steady-state models.
* \details It describes a mathematical model. A somewhat misleading name of the class is kept for compatibility reasons.
*/
class CBaseUnit
{
static constexpr unsigned m_saveVersion{ 4 }; // Current version of the saving procedure.
protected:
////////////////////////////////////////////////////////////////////////////////
// Basic unit information
//
/**
* \private
* Name of the unit.
*/
std::string m_unitName{};
/**
* \private
* Unique identifier of the unit.
*/
std::string m_uniqueID{};
/**
* \private
* Name of the unit's author.
*/
std::string m_authorName{};
/**
* \private
* Link to help file for unit.
*/
std::string m_helpLink{};
/**
* \private
* Version of the unit.
*/
size_t m_version{ 0 };
private:
////////////////////////////////////////////////////////////////////////////////
// References to flowsheet structural data and settings
//
CMultidimensionalGrid m_grid; // Defined distribution grid.
// TODO: gather them in some global structure.
const CMaterialsDatabase* m_materialsDB{ nullptr }; // Reference to a database of materials.
const std::vector<SOverallDescriptor>* m_overall{ nullptr }; // Reference to overall properties.
const std::vector<SPhaseDescriptor>* m_phases{ nullptr }; // Reference to phases.
const SCacheSettings* m_cache{ nullptr }; // Reference to cache settings.
const SToleranceSettings* m_tolerances{ nullptr }; // Reference to tolerance settings.
const SThermodynamicsSettings* m_thermodynamics{ nullptr }; // Reference to thermodynamics settings.
////////////////////////////////////////////////////////////////////////////////
// Structural unit data
//
CPortsManager m_ports; // Ports of the unit.
CUnitParametersManager m_unitParameters; // Handler of unit parameters.
CStateVariablesManager m_stateVariables; // State variables of the unit.
CStreamManager m_streams; // Feeds, holdups and internal streams.
CPlotManager m_plots; // Plots.
mutable std::unique_ptr<CMixtureEnthalpyLookup> m_enthalpyCalculator; // Lookup table to calculate temperature<->enthalpy.
////////////////////////////////////////////////////////////////////////////////
// Generated messages
//
bool m_hasError{ false }; // Contains true if an error was detected.
bool m_hasWarning{ false }; // Contains true if a warning was detected.
bool m_hasInfo{ false }; // Contains true if an info tag was detected.
std::string m_errorMessage; // Description of the last detected error.
std::string m_warningMessage; // Description of the last detected warning.
std::string m_infoMessage; // Description of the last info.
mutable std::mutex m_messageMutex; // Mutex for thread-safe work with messages.
public:
// TODO: initialize all pointers in constructor and make them references.
/**
* \private
* \brief Default constructor.
*/
CBaseUnit() = default;
/**
* \private
* \brief Copy constructor.
*/
CBaseUnit(const CBaseUnit& _other);
/**
* \private
* \brief Move constructor.
*/
CBaseUnit(CBaseUnit&& _other) noexcept;
/**
* \private
* \brief Copy assignment operator.
*/
CBaseUnit& operator=(CBaseUnit _other);
/**
* \private
* \brief Move assignment operator.
*/
CBaseUnit& operator=(CBaseUnit&& _other) noexcept;
/**
* \private
* \brief Destructor.
*/
virtual ~CBaseUnit() = default;
/**
* \brief Swaps the content of two units.
* \param _first First unit.
* \param _second Second unit.
*/
friend void swap(CBaseUnit& _first, CBaseUnit& _second) noexcept;
/**
* \private
* \brief Sets pointers and values of all required internal data.
* \param _materialsDB Pointer to global materials database.
* \param _grid Const reference to global multidimensional grid.
* \param _overall Pointer to a vector of global overall stream parameters.
* \param _phases Pointer to a vector of global phases.
* \param _cache Pointer to global cache settings.
* \param _tolerance Pointer to global tolerance settings.
* \param _thermodynamics Pointer to global thermodynamics settings.
*/
void ConfigureUnitStructures(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);
/**
* \brief Sets pointers and values of all required internal data.
* \param _other Pointer to an existing unit.
*/
void ConfigureUnitStructures(const CBaseUnit* _other);
/**
* \private
* \brief Sets new pointer to global materials database.
* \param _materialsDB Pointer to global materials database.
*/
void SetMaterialsDatabase(const CMaterialsDatabase* _materialsDB);
////////////////////////////////////////////////////////////////////////////////
/// Basic unit information
///
// TODO: rename to ModelName() and add an alias to GetUnitName().
/**
* \brief Returns the name of the unit.
* \return Name of the unit.
*/
[[nodiscard]] std::string GetUnitName() const;
/**
* \brief Returns the name of unit's author.
* \return Name of unit's author.
*/
[[nodiscard]] std::string GetAuthorName() const;
/**
* \brief Returns the version of the unit.
* \return Version of the unit.
*/
[[nodiscard]] size_t GetVersion() const;
/**
* \brief Returns the unique identifier of the unit.
* \return Unique identifier of the unit.
*/
[[nodiscard]] std::string GetUniqueID() const;
/**
* \brief Returns the help link of the unit.
* \return Help link of the unit.
*/
[[nodiscard]] std::string GetHelpLink() const;
// TODO: rename to SetModelName() and add an alias to SetUnitName().
/**
* \brief Sets the name of the unit.
* \details Should be used in CBaseUnit::CreateBasicInfo() function only.
* \param _name Name of the unit.
*/
void SetUnitName(const std::string& _name);
/**
* \brief Sets the name of unit's author.
* \details Should be used in CBaseUnit::CreateBasicInfo() function only.
* \param _author Author's name
*/
void SetAuthorName(const std::string& _author);
/**
* \brief Sets the version of the unit.
* \details Should be used in CBaseUnit::CreateBasicInfo() function only.
* \param _version Unit's version.
*/
void SetVersion(size_t _version);
/**
* \brief Sets the unique identifier of the unit.
* \details Should be used in CBaseUnit::CreateBasicInfo() function only.
* \param _id Identifier of the unit. Must be unique among all units in the library.
*/
void SetUniqueID(const std::string& _id);
/**
* \brief Sets the help link of the unit.
* \param _helpLink Help link of the unit.
*/
void SetHelpLink(const std::string& _helpLink);
////////////////////////////////////////////////////////////////////////////////
// Ports
//
/**
* \brief Returns a const reference to ports manager.
* \details Can be used for centralized access to ports.
* \return Const reference to ports manager.
*/
const CPortsManager& GetPortsManager() const;
/**
* \private
* Returns a reference to ports manager.
*/
CPortsManager& GetPortsManager();
/**
* \brief Adds a port to the unit.
* \details Should be used in CBaseUnit::CreateBasicInfo() function only.
* If the unit already has a port with the same name, a logic_error exception is thrown.
* \param _portName Name of the port. Must be unique within the unit.
* \param _type Type of the port.
* \return Pointer to the created port.
* */
CUnitPort* AddPort(const std::string& _portName, EUnitPort _type);
/**
* \brief Returns a const pointer to the specified port of the unit.
* \details If no such port exists, a logic_error exception is thrown.
* \param _portName Name of the port.
* \return Const pointer to the port.
*/
const CUnitPort* GetPort(const std::string& _portName) const;
/**
* \brief Returns a pointer to the specified port of the unit.
* \details If no such port exists, a logic_error exception is thrown.
* \param _portName Name of the port.
* \return Pointer to the port.
*/
CUnitPort* GetPort(const std::string& _portName);
/**
* \brief Returns a pointer to the stream connected to this port.
* \details If such port does not exist or empty, a logic_error exception is thrown.
* \param _portName Name of the port.
* \return Pointer to the connected stream.
*/
CStream* GetPortStream(const std::string& _portName) const;
////////////////////////////////////////////////////////////////////////////////
// Internal feeds, holdups and streams
//
/**
* \private
* Returns a const reference to streams manager.
*/
const CStreamManager& GetStreamsManager() const;
/**
* \private
* Returns a reference to streams manager.
*/
CStreamManager& GetStreamsManager();
/**
* \brief Adds a new feed to the unit.
* \details Adds a new feed with the specified name to the unit.
* The structure of the feed will be the same as the global streams structure (MD dimensions, phases, grids, compounds etc.).
* Name should be unique within the unit. If a feed with the given name already exists in the unit, a logic_error exception is thrown.
* Should be used in the CBaseUnit::CreateStructure() function; then the feed will be automatically handled by the simulation system
* (saved and loaded during the simulation, cleared and removed after use).
* However, it is allowed to add feed outside CBaseUnit::CreateStructure() for temporal purposes, but you have to
* save, load (in the functions CBaseUnit::SaveState(), CBaseUnit::LoadState()) and remove this feed (by calling CBaseUnit::RemoveFeed()) manually.
* Otherwise, all such feeds will be removed at the end of the simulation.
* This function returns the pointer to a created feed. This pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the feed made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the feed.
* \return Pointer to the added feed.
*/
CStream* AddFeed(const std::string& _name);
/**
* \brief Returns a const pointer to the feed with the specified name.
* \details If such feed does not exist, a logic_error exception is thrown.
* The returned pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the feed made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the feed.
* \return Const pointer to the feed.
*/
const CStream* GetFeed(const std::string & _name) const;
/**
* \brief Returns a pointer to the feed with the specified name.
* \details If such feed does not exist, a logic_error exception is thrown.
* The returned pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the feed made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the feed.
* \return Pointer to the feed.
*/
CStream* GetFeed(const std::string& _name);
/**
* \brief Removes the feed with the specified name from the unit.
* \details If such feed does not exist, a logic_error exception is thrown.
* Should be used only for those feeds, which have been added to the unit outside the CBaseUnit::CreateStructure().
* \param _name Name of the feed.
*/
void RemoveFeed(const std::string& _name);
/**
* \brief Adds a new holdup to the unit.
* \details Adds a new holdup with the specified name to the unit.
* The structure of the holdup will be the same as the global streams structure (MD dimensions, phases, grids, compounds etc.).
* Name should be unique within the unit. If a holdup with the given name already exists in the unit, a logic_error exception is thrown.
* Should be used in the CBaseUnit::CreateStructure() function; then the holdup will be automatically handled by the simulation system
* (saved and loaded during the simulation, cleared and removed after use).
* However, it is allowed to add holdup outside CBaseUnit::CreateStructure() for temporal purposes, but you have to
* save, load (in the functions CBaseUnit::SaveState(), CBaseUnit::LoadState()) and remove this holdup (by calling CBaseUnit::RemoveFeed()) manually.
* Otherwise, all such holdups will be removed at the end of the simulation.
* This function returns the pointer to a created holdup. This pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the holdup made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the holdup.
* \return Pointer to the added holdup.
*/
CHoldup* AddHoldup(const std::string& _name);
/**
* \brief Returns a const pointer to the holdup with the specified name.
* \details If such holdup does not exist, a logic_error exception is thrown.
* The returned pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the holdup made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the holdup.
* \return Const pointer to the holdup.
*/
const CHoldup* GetHoldup(const std::string & _name) const;
/**
* \brief Returns a pointer to the holdup with the specified name.
* \details If such holdup does not exist, a logic_error exception is thrown.
* The returned pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the holdup made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the holdup.
* \return Pointer to the holdup.
*/
CHoldup* GetHoldup(const std::string& _name);
/**
* \brief Removes the holdup with the specified name from the unit.
* \details If such holdup does not exist, a logic_error exception is thrown.
* Should be used only for those holdups, which have been added to the unit outside the CBaseUnit::CreateStructure().
* \param _name Name of the holdup.
*/
void RemoveHoldup(const std::string& _name);
/**
* \brief Adds a new stream to the unit.
* \details Adds a new stream with the specified name to the unit.
* The structure of the stream will be the same as the global streams structure (MD dimensions, phases, grids, compounds etc.).
* Name should be unique within the unit. If a stream with the given name already exists in the unit, a logic_error exception is thrown.
* Should be used in the CBaseUnit::CreateStructure() function; then the stream will be automatically handled by the simulation system
* (saved and loaded during the simulation, cleared and removed after use).
* However, it is allowed to add stream outside CBaseUnit::CreateStructure() for temporal purposes, but you have to
* save, load (in the functions CBaseUnit::SaveState(), CBaseUnit::LoadState()) and remove this stream (by calling CBaseUnit::RemoveFeed()) manually.
* Otherwise, all such streams will be removed at the end of the simulation.
* This function returns the pointer to a created stream. This pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the stream made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the stream.
* \return Pointer to the added stream.
*/
CStream* AddStream(const std::string& _name);
/**
* \brief Returns a const pointer to the stream with the specified name.
* \details If such stream does not exist, a logic_error exception is thrown.
* The returned pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the stream made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the stream.
* \return Const pointer to the stream.
*/
const CStream* GetStream(const std::string & _name) const;
/**
* \brief Returns a pointer to the stream with the specified name.
* \details If such stream does not exist, a logic_error exception is thrown.
* The returned pointer should not be used inside the CBaseUnit::CreateStructure() function,
* since all changes of the stream made through this pointer will be discarded during the initialization of the unit.
* \param _name Name of the stream.
* \return Pointer to the stream.
*/
CStream* GetStream(const std::string& _name);
/**
* \brief Removes the stream with the specified name from the unit.
* \details If such stream does not exist, a logic_error exception is thrown.
* Should be used only for those streams, which have been added to the unit outside the CBaseUnit::CreateStructure().
* \param _name Name of the stream.
*/
void RemoveStream(const std::string& _name);
/**
* \private
* Sets up the stream structure (MD dimensions, phases, materials, etc.) the same as it is configured in the unit. Removes all existing data.
*/
void SetupStream(CBaseStream* _stream) const;
////////////////////////////////////////////////////////////////////////////////
// Unit parameters
//
/**
* \brief Returns a const reference to unit parameters manager.
* \details Can be used for centralized access to unit parameters.
* \return Const reference to unit parameters manager.
*/
const CUnitParametersManager& GetUnitParametersManager() const;
/**
* \private
* Returns a reference to unit parameters manager.
*/
CUnitParametersManager& GetUnitParametersManager();
/**
* \brief Adds a new real constant unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify one real value as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CConstRealUnitParameter* AddConstRealParameter(const std::string& _name, double _initValue, const std::string& _units, const std::string& _description, double _minValue = std::numeric_limits<double>::lowest(), double _maxValue = std::numeric_limits<double>::max());
/**
* \brief Adds a new signed integer constant unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify one signed integer value as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CConstIntUnitParameter* AddConstIntParameter(const std::string& _name, int64_t _initValue, const std::string& _units, const std::string& _description, int64_t _minValue = std::numeric_limits<int64_t>::lowest(), int64_t _maxValue = std::numeric_limits<int64_t>::max());
/**
* \brief Adds a new unsigned integer constant unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify one unsigned integer value as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CConstUIntUnitParameter* AddConstUIntParameter(const std::string& _name, uint64_t _initValue, const std::string& _units, const std::string& _description, uint64_t _minValue = std::numeric_limits<uint64_t>::lowest(), uint64_t _maxValue = std::numeric_limits<uint64_t>::max());
/**
* \brief Adds a new dependent unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify dependency between two values.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _valueName Name of the value and the unit parameter.
* \param _valueInit Initial value.
* \param _valueUnits Units of measurement of values.
* \param _paramName Name of the parameter.
* \param _paramInit Initial value of the parameter.
* \param _paramUnits Units of measurement of parameters.
* \param _description Extended parameter description.
* \param _valueMin Minimum boundary of the value.
* \param _valueMax Maximum boundary of the value.
* \param _paramMin Minimum boundary of the parameter.
* \param _paramMax Maximum boundary of the parameter.
* \return Pointer to the added unit parameter.
*/
CDependentUnitParameter* AddDependentParameter(const std::string& _valueName, double _valueInit, const std::string& _valueUnits, const std::string& _paramName, double _paramInit, const std::string& _paramUnits, const std::string& _description, double _valueMin = std::numeric_limits<double>::lowest(), double _valueMax = std::numeric_limits<double>::max(), double _paramMin = std::numeric_limits<double>::lowest(), double _paramMax = std::numeric_limits<double>::max());
/**
* \brief Adds a new real time-dependent unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify multiple values at different time points as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CTDUnitParameter* AddTDParameter(const std::string& _name, double _initValue, const std::string& _units, const std::string& _description, double _minValue = std::numeric_limits<double>::lowest(), double _maxValue = std::numeric_limits<double>::max());
/**
* \brief Adds a new string unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify one string value as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CStringUnitParameter* AddStringParameter(const std::string& _name, const std::string& _initValue, const std::string& _description);
/**
* \brief Adds a new two-positional checkbox unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify one two-positional (yes/no) parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CCheckBoxUnitParameter* AddCheckBoxParameter(const std::string& _name, bool _initValue, const std::string& _description);
/**
* \brief Adds a new combobox unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to select a single value from the list.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _items List of selectable items.
* \param _itemsNames List of names for each selectable item.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CComboUnitParameter* AddComboParameter(const std::string& _name, size_t _initValue, const std::vector<size_t>& _items, const std::vector<std::string>& _itemsNames, const std::string& _description);
/**
* \brief Adds a new combobox unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to select a single value from the list.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _items List of selectable items.
* \param _itemsNames List of names for each selectable item.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
template <typename T, typename = std::enable_if_t<std::is_enum_v<T>>>
CComboUnitParameter* AddComboParameter(const std::string& _name, T _initValue, const std::vector<T>& _items, const std::vector<std::string>& _itemsNames, const std::string& _description);
/**
* \brief Adds a new compound combobox unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to select a single compound from the list of active compounds.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CCompoundUnitParameter* AddCompoundParameter(const std::string& _name, const std::string& _description);
/**
* \brief Adds a new MDB compound combobox unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to select a single compound from the materials database.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CMDBCompoundUnitParameter* AddMDBCompoundParameter(const std::string& _name, const std::string& _description);
/**
* \brief Adds a new reaction unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify one or several reactions.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* \param _name Name of the unit parameter.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CReactionUnitParameter* AddReactionParameter(const std::string& _name, const std::string& _description);
/**
* \brief Adds a new real list unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify multiple real values as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CListRealUnitParameter* AddListRealParameter(const std::string& _name, double _initValue, const std::string& _units, const std::string& _description, double _minValue = std::numeric_limits<double>::lowest(), double _maxValue = std::numeric_limits<double>::max());
/**
* \brief Adds a new signed integer list unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify multiple signed integer values as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CListIntUnitParameter* AddListIntParameter(const std::string& _name, int64_t _initValue, const std::string& _units, const std::string& _description, int64_t _minValue = std::numeric_limits<int64_t>::lowest(), int64_t _maxValue = std::numeric_limits<int64_t>::max());
/**
* \brief Adds a new unsigned integer list unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to specify multiple unsigned integer values as a parameter.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _initValue Initial value.
* \param _units Units of measurement.
* \param _description Extended parameter description.
* \param _minValue Minimum boundary value of the parameter.
* \param _maxValue Maximum boundary value of the parameter.
* \return Pointer to the added unit parameter.
*/
CListUIntUnitParameter* AddListUIntParameter(const std::string& _name, uint64_t _initValue, const std::string& _units, const std::string& _description, uint64_t _minValue = std::numeric_limits<uint64_t>::lowest(), uint64_t _maxValue = std::numeric_limits<uint64_t>::max());
/**
* \brief Adds a new agglomeration solver unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to choose one of the available agglomeration solvers of this type.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CSolverUnitParameter* AddSolverAgglomeration(const std::string& _name, const std::string& _description);
/**
* \private
* \brief Adds a new PBM solver unit parameter to the unit.
* \details Should be used in the CBaseUnit::CreateStructure() function.
* Adds the possibility to choose one of the available PBM solvers of this type.
* The name of the parameter should be unique within the unit. If the unit already has a parameter with the same name, logic_error exception is thrown.
* Boundary values are only a recommendation to the user, and going beyond them will only result in a warning to the user.
* Boundary values are optional; if they are not specified, the limits do not apply.
* \param _name Name of the unit parameter.
* \param _description Extended parameter description.
* \return Pointer to the added unit parameter.
*/
CSolverUnitParameter* AddSolverPBM(const std::string& _name, const std::string& _description);
/**
* \brief Groups the specified unit parameters.
* \details Allows to hide some parameters depending on the selected value of a combobox unit parameter.
* The parameter, its value and all the adding parameters must already exist. If something does not exist, logic_error exception is thrown.
* \param _unitParamNameSelector Name of the target combobox unit parameter.
* \param _unitParamSelectedValueName Selected value of the target combobox unit parameter.
* \param _groupedParamNames Names of other unit parameters that will be shown if \p _unitParamSelectedValueName is selected.
*/
void AddParametersToGroup(const std::string& _unitParamNameSelector, const std::string& _unitParamSelectedValueName, const std::vector<std::string>& _groupedParamNames);
/**
* \brief Groups the specified unit parameters.
* \details Allows to hide some parameters depending on the selected value of a combobox unit parameter.
* The parameter, its value and all the adding parameters must already exist. If something does not exist, logic_error exception is thrown.
* \param _unitParamNameSelector Name of the target combobox unit parameter.
* \param _unitParamSelectedValueName Selected value of the target combobox unit parameter.
* \param _groupedParamNames Names of other unit parameters that will be shown if \p _unitParamSelectedValueName is selected.
*/
void AddParametersToGroup(const std::string& _unitParamNameSelector, const char* _unitParamSelectedValueName, const std::vector<std::string>& _groupedParamNames);
/**
* \brief Groups the specified unit parameters.
* \details Allows to hide some parameters depending on the selected value of a checkbox unit parameter.
* The parameter, its value and all the adding parameters must already exist. If something does not exist, logic_error exception is thrown.
* \param _unitParamNameSelector Name of the target checkbox unit parameter.
* \param _unitParamSelectedValue Selected value of the target checkbox unit parameter.
* \param _groupedParamNames Names of other unit parameters that will be shown if \p _unitParamSelectedValue is selected.
*/
void AddParametersToGroup(const std::string& _unitParamNameSelector, bool _unitParamSelectedValue, const std::vector<std::string>& _groupedParamNames);
/**
* \brief Groups the specified unit parameters.
* \details Allows to hide some parameters depending on the selected value of a combobox unit parameter.
* The parameter, its value and all the adding parameters must already exist. If something does not exist, logic_error exception is thrown.
* \param _selector Pointer to the target combobox unit parameter.
* \param _selectedValue Selected value of the target combobox unit parameter.
* \param _groupedParams Other unit parameters that will be shown if \p _selectedValue is selected.
*/
void AddParametersToGroup(const CComboUnitParameter* _selector, size_t _selectedValue, const std::vector<CBaseUnitParameter*>& _groupedParams);
/**
* \brief Groups the specified unit parameters.
* \details Allows to hide some parameters depending on the selected value of a combobox unit parameter.
* The parameter, its value and all the adding parameters must already exist. If something does not exist, logic_error exception is thrown.
* \param _selector Pointer to the target combobox unit parameter.
* \param _selectedValue Selected value of the target combobox unit parameter.
* \param _groupedParams Other unit parameters that will be shown if \p _selectedValue is selected.
*/
template <typename T, typename = std::enable_if_t<std::is_enum_v<T>>>
void AddParametersToGroup(const CComboUnitParameter* _selector, T _selectedValue, const std::vector<CBaseUnitParameter*>& _groupedParams);
/**
* \brief Groups the specified unit parameters.
* \details Allows to hide some parameters depending on the selected value of a checkbox unit parameter.
* The parameter, its value and all the adding parameters must already exist. If something does not exist, logic_error exception is thrown.
* \param _selector Pointer to the target checkbox unit parameter.
* \param _selectedValue Selected value of the target checkbox unit parameter.
* \param _groupedParams Other unit parameters that will be shown if \p _selectedValue is selected.
*/
void AddParametersToGroup(const CCheckBoxUnitParameter* _selector, bool _selectedValue, const std::vector<CBaseUnitParameter*>& _groupedParams);
/**
* \brief Returns value of the real constant unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Current value of the unit parameter.
*/
double GetConstRealParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the signed integer constant unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Current value of the unit parameter.
*/
int64_t GetConstIntParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the unsigned integer constant unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Current value of the unit parameter.
*/
uint64_t GetConstUIntParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the dependent unit parameter at the given value of the parameter.
* \details If the selected parameter value has not been defined, linear interpolation or nearest-neighbor extrapolation will be performed.
* Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \param _param Target parameter value.
* \return Current value of the unit parameter at the given parameter value.
*/
double GetDependentParameterValue(const std::string& _name, double _param) const;
/**
* \brief Returns value of the real time-dependent unit parameter at the given time point.
* \details If the selected time point has not been defined, linear interpolation or nearest-neighbor extrapolation will be performed.
* Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \param _time Target time point.
* \return Current value of the unit parameter at the given time point.
*/
double GetTDParameterValue(const std::string& _name, double _time) const;
/**
* \brief Returns value of the string unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Current value of the unit parameter.
*/
std::string GetStringParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the checkbox unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Current value of the unit parameter.
*/
bool GetCheckboxParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the combobox unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Current value of the unit parameter.
*/
size_t GetComboParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the compound combobox unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Unique key of the selected compound.
*/
std::string GetCompoundParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the MDB compound combobox unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Unique key of the selected compound.
*/
std::string GetMDBCompoundParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the reaction unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return List of defined reactions.
*/
std::vector<CChemicalReaction> GetReactionParameterValue(const std::string& _name) const;
/**
* \brief Returns value of the real list unit parameter at the given index.
* \details If the selected index has not been defined, 0 is returned.
* Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \param _index Target index.
* \return Current value of the unit parameter at the given time point.
*/
double GetListRealParameterValue(const std::string& _name, size_t _index) const;
/**
* \brief Returns value of the signed integer list unit parameter at the given index.
* \details If the selected index has not been defined, 0 is returned.
* Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \param _index Target index.
* \return Current value of the unit parameter at the given time point.
*/
int64_t GetListIntParameterValue(const std::string& _name, size_t _index) const;
/**
* \brief Returns value of the unsigned integer list unit parameter at the given index.
* \details If the selected index has not been defined, 0 is returned.
* Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \param _index Target index.
* \return Current value of the unit parameter at the given time point.
*/
uint64_t GetListUIntParameterValue(const std::string& _name, size_t _index) const;
/**
* \brief Returns value of the agglomeration solver unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Pointer to the selected agglomeration solver.
*/
CAgglomerationSolver* GetSolverAgglomeration(const std::string& _name) const;
/**
* \brief Returns value of the agglomeration solver unit parameter.
* \details Throws logic_error exception if the provided pointer to the unit parameter is of the wrong type.
* \param _param Pointer to the agglomeration solver unit parameter.
* \return Pointer to the selected agglomeration solver.
*/
CAgglomerationSolver* GetSolverAgglomeration(const CSolverUnitParameter* _param) const;
/**
* \private
* \brief Returns value of the PBM solver unit parameter.
* \details Throws logic_error exception if a unit parameter with the given name and type does not exist.
* \param _name Name of the unit parameter.
* \return Pointer to the selected PBM solver.
*/
CPBMSolver* GetSolverPBM(const std::string& _name) const;
/**
* \private
* \brief Returns value of the PBM solver unit parameter.
* \details Throws logic_error exception if the provided pointer to the unit parameter is of the wrong type.
* \param _param Pointer to the PBM solver unit parameter.
* \return Pointer to the selected PBM solver.
*/
CPBMSolver* GetSolverPBM(const CSolverUnitParameter* _param) const;
////////////////////////////////////////////////////////////////////////////////
// State variables
//
/**
* \brief Returns a const reference to state variables manager.
* \details Can be used for centralized access to state variables.
* \return Const reference to state variables manager.
*/
const CStateVariablesManager& GetStateVariablesManager() const;
/**
* \private
* Returns a reference to state variables manager.
*/
CStateVariablesManager& GetStateVariablesManager();
/**
* \brief Adds a new state variable.
* \details Can be used to handle state-dependent values: all variables added with this function will be automatically saved and restored during the simulation.
* Can also store the history of changes during the simulation for further post-processing.
* The name must by unique within the unit. If the unit already has a state variable with the same name, logic_error exception is thrown.
* Should be used in the CBaseUnit::CreateStructure() function.
* \param _name Name of the variable.
* \param _initValue Initial value of the variable.
* \return Pointer to the added state variable.
*/
CStateVariable* AddStateVariable(const std::string& _name, double _initValue);
/**
* \brief Returns current value of the state variable.
* \details If a state variable with the given name does not exist in this unit, logic_error exception is thrown.
* \param _name Name of the variable.
* \return Current value of the state variable.
*/
double GetStateVariable(const std::string& _name) const;
/**
* \brief Sets a new value of the state variable.
* \details If a state variable with the given name does not exist in this unit, logic_error exception is thrown.
* \param _name Name of the variable.
* \param _value Name value of the variable.
*/
void SetStateVariable(const std::string& _name, double _value);
/**
* \brief Sets a new value of the state variable and adds its value to the history.
* \details If a state variable with the given name does not exist in this unit, logic_error exception is thrown.
* \param _name Name of the variable.
* \param _value Name value of the variable.
* \param _time Time point for which new value is added to the history.
*/
void SetStateVariable(const std::string& _name, double _value, double _time);
////////////////////////////////////////////////////////////////////////////////
// Plots
//
/**
* \private
* Returns a const reference to plots manager.
*/
const CPlotManager& GetPlotsManager() const;
/**
* \private
* Returns a reference to plots manager.
*/
CPlotManager& GetPlotsManager();
/**
* \brief Adds a new 2-dimensional plot to the unit.
* \details Adds a plot with the specified name and axes labels to the unit and returns a pointer to it.
* If the unit already has a plot with the same name, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _labelX Text label of the X-axis.
* \param _labelY Text label of the Y-axis.
* \return Pointer to the added plot.
*/
CPlot* AddPlot(const std::string& _plotName, const std::string& _labelX, const std::string& _labelY);
/**
* \brief Adds a new 3-dimensional plot to the unit.
* \details Adds a plot with the specified name and axes labels to the unit and returns a pointer to it.
* If the unit already has a plot with the same name, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _labelX Text label of the X-axis.
* \param _labelY Text label of the Y-axis.
* \param _labelZ Text label of the Z-axis.
* \return Pointer to the added plot.
*/
CPlot* AddPlot(const std::string& _plotName, const std::string& _labelX, const std::string& _labelY, const std::string& _labelZ);
/**
* \brief Adds a new curve to a 2-dimensional plot.
* \details Adds a new curve with the specified name to the 2-dimensional plot with the given name and returns a pointer to it.
* If a plot with this name does not exist or it already contains a curve with the given name, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _curveName Name of the new curve.
* \return Pointer to the added curve.
*/
CCurve* AddCurveOnPlot(const std::string& _plotName, const std::string& _curveName);
/**
* \brief Adds a new curve to a 3-dimensional plot.
* \details Adds a new curve with the specified Z-value to the 3-dimensional plot with the given name and returns a pointer to it.
* If a plot with this name does not exist or it already contains a curve with the given Z-value, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _valueZ Z-value of the new curve.
* \return Pointer to the added curve.
*/
CCurve* AddCurveOnPlot(const std::string& _plotName, double _valueZ);
/**
* \brief Adds a new point to the curve on the 2-dimensional plot.
* \details Adds a new point to the specified curve on the 2-dimensional plot.
* If a plot or a curve with these names do not exist, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _curveName Name of the curve on plot.
* \param _x X-value of the new point.
* \param _y Y-value of the new point.
*/
void AddPointOnCurve(const std::string& _plotName, const std::string& _curveName, double _x, double _y);
/**
* \brief Adds a new point to the curve on the 3-dimensional plot.
* \details Adds a new point to the specified curve on the 2-dimensional plot.
* If a plot with this name or a curve with this Z-value do not exist, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _valueZ Z-value of the curve.
* \param _x X-value of the new point.
* \param _y Y-value of the new point.
*/
void AddPointOnCurve(const std::string& _plotName, double _valueZ, double _x, double _y);
/**
* \brief Adds new points to the curve on the 2-dimensional plot.
* \details Adds new points to the specified curve on the 2-dimensional plot.
* If a plot or a curve with these names do not exist, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _curveName Name of the curve on plot.
* \param _x X-values of the new points.
* \param _y Y-values of the new points.
*/
void AddPointsOnCurve(const std::string& _plotName, const std::string& _curveName, const std::vector<double>& _x, const std::vector<double>& _y);
/**
* \brief Adds new points to the curve on the 3-dimensional plot.
* \details Adds new points to the specified curve on the 2-dimensional plot.
* If a plot with this name or a curve with this Z-value do not exist, logic_error exception is thrown.
* \param _plotName Name of the plot.
* \param _valueZ Z-value of the curve.
* \param _x X-values of the new points.
* \param _y Y-values of the new points.
*/
void AddPointsOnCurve(const std::string& _plotName, double _valueZ, const std::vector<double>& _x, const std::vector<double>& _y);
////////////////////////////////////////////////////////////////////////////////
// Stream manipulations
//
/**
* \brief Copies all stream data from one stream to another at the given time point.
* \details All data after the time point are removed from the destination stream.
* \param _time Time point to copy.
* \param _srcStream Source stream.
* \param _dstStream Destination stream.
*/
static void CopyStreamToStream(double _time, const CStream* _srcStream, CStream* _dstStream);
/**
* \brief Copies all stream data from one stream to another at the given time interval.
* \details All data after the end time point are removed from the destination stream.
* \param _timeBeg Begin of the time interval to copy.
* \param _timeEnd End of the time interval to copy.
* \param _srcStream Source stream.
* \param _dstStream Destination stream.
*/
static void CopyStreamToStream(double _timeBeg, double _timeEnd, const CStream* _srcStream, CStream* _dstStream);
/**
* \brief Copies all stream data from the given stream to the stream connected to the selected output port at the given time point.
* \details All data after the time point are removed from the destination stream. Throws logic_error exception on error.
* \param _time Time point to copy.
* \param _stream Source stream.
* \param _port Destination port.
*/
void CopyStreamToPort(double _time, const CStream* _stream, CUnitPort* _port) const;
/**
* \brief Copies all stream data from the given stream to the stream connected to the selected output port at the given time point.
* \details All data after the time point are removed from the destination stream. Throws logic_error exception on error.
* \param _time Time point to copy.
* \param _stream Source stream.
* \param _portName Name of the destination port.
*/
void CopyStreamToPort(double _time, const CStream* _stream, const std::string& _portName);
/**
* \brief Copies all stream data from the given stream to the stream connected to the selected output port at the given time interval.
* \details All data after the end time point are removed from the destination stream. Throws logic_error exception on error.
* \param _timeBeg Begin of the time interval to copy.
* \param _timeEnd End of the time interval to copy.
* \param _stream Source stream.
* \param _port Destination port.
*/
void CopyStreamToPort(double _timeBeg, double _timeEnd, const CStream* _stream, CUnitPort* _port) const;
/**
* \brief Copies all stream data from the given stream to the stream connected to the selected output port at the given time interval.
* \details All data after the end time point are removed from the destination stream. Throws logic_error exception on error.
* \param _timeBeg Begin of the time interval to copy.
* \param _timeEnd End of the time interval to copy.
* \param _stream Source stream.
* \param _portName Name of the destination port.
*/
void CopyStreamToPort(double _timeBeg, double _timeEnd, const CStream* _stream, const std::string& _portName);
/**
* \brief Copies all stream data from the stream connected to the selected input port to the given stream at the given time point.
* \details All data after the time point are removed from the destination stream. Throws logic_error exception on error.
* \param _time Time point to copy.
* \param _port Source port.
* \param _stream Destination stream.
*/
void CopyPortToStream(double _time, const CUnitPort* _port, CStream* _stream) const;
/**
* \brief Copies all stream data from the stream connected to the selected input port to the given stream at the given time point.
* \details All data after the time point are removed from the destination stream. Throws logic_error exception on error.
* \param _time Time point to copy.
* \param _portName Name of the source port.
* \param _stream Destination stream.
*/
void CopyPortToStream(double _time, const std::string& _portName, CStream* _stream);
/**
* \brief Copies all stream data from the stream connected to the selected input port to the given stream at the given time interval.
* \details All data after the end time point are removed from the destination stream. Throws logic_error exception on error.
* \param _timeBeg Begin of the time interval to copy.
* \param _timeEnd End of the time interval to copy.
* \param _port Source port.
* \param _stream Destination stream.
*/
void CopyPortToStream(double _timeBeg, double _timeEnd, const CUnitPort* _port, CStream* _stream) const;
/**
* \brief Copies all stream data from the stream connected to the selected input port to the given stream at the given time interval.
* \details All data after the end time point are removed from the destination stream. Throws logic_error exception on error.
* \param _timeBeg Begin of the time interval to copy.
* \param _timeEnd End of the time interval to copy.
* \param _portName Name of the source port.
* \param _stream Destination stream.
*/
void CopyPortToStream(double _timeBeg, double _timeEnd, const std::string& _portName, CStream* _stream);
////////////////////////////////////////////////////////////////////////////////
// Time points
//
/**
* \brief Returns all time points at which input streams and time-dependent parameters are defined.
* \return Sorted vector of time points.
*/
std::vector<double> GetAllTimePoints() const;
/**
* \brief Returns all time points in the specified time interval at which input streams and time-dependent parameters are defined.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \return Sorted vector of time points.
*/
std::vector<double> GetAllTimePoints(double _timeBeg, double _timeEnd) const;
/**
* \brief Returns all time points in the specified time interval at which input streams and time-dependent parameters are defined.
* \details Boundary time points are unconditionally included into result.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \return Sorted vector of time points.
*/
std::vector<double> GetAllTimePointsClosed(double _timeBeg, double _timeEnd) const;
/**
* \brief Returns all time points at which input streams are defined.
* \return Sorted vector of time points.
*/
std::vector<double> GetInputTimePoints() const;
/**
* \brief Returns all time points in the specified time interval at which input streams are defined.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \return Sorted vector of time points.
*/
std::vector<double> GetInputTimePoints(double _timeBeg, double _timeEnd) const;
/**
* \brief Returns all time points in the specified time interval at which input streams are defined.
* \details Boundary time points are unconditionally included into result.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \return Sorted vector of time points.
*/
std::vector<double> GetInputTimePointsClosed(double _timeBeg, double _timeEnd) const;
/**
* \brief Returns all time points at which given streams are defined.
* \param _streams List of streams.
* \return Sorted vector of time points.
*/
std::vector<double> GetStreamsTimePoints(const std::vector<CStream*>& _streams) const;
/**
* \brief Returns all time points in the specified time interval at which given streams are defined.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \param _streams List of streams.
* \return Sorted vector of time points.
*/
std::vector<double> GetStreamsTimePoints(double _timeBeg, double _timeEnd, const std::vector<CStream*>& _streams) const;
/**
* \brief Returns all time points in the specified time interval at which given streams are defined.
* \details Boundary time points are unconditionally included into result.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \param _streams List of streams.
* \return Sorted vector of time points.
*/
std::vector<double> GetStreamsTimePointsClosed(double _timeBeg, double _timeEnd, const std::vector<CStream*>& _streams) const;
/**
* \brief Returns all time points in the time interval at which holdups and streams are defined.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \param _holdups List of holdups.
* \param _streams List of streams.
* \return Sorted vector of time points.
*/
std::vector<double> GetTimePoints(double _timeBeg, double _timeEnd, const std::vector<CHoldup*>& _holdups, const std::vector<CStream*>& _streams) const;
/**
* \private
* \brief Removes time points within the specified interval [timeBeg; timeEnd) that are closer together than the step.
* \param _timeBeg Begin of the time interval.
* \param _timeEnd End of the time interval.
* \param _step Time step.
*/
void ReduceTimePoints(double _timeBeg, double _timeEnd, double _step);
////////////////////////////////////////////////////////////////////////////////
// Compounds
//
/**
* \private
* Adds a compound with the specified unique key to all feeds, holdups and streams in the unit, if it does not exist yet.
*/
void AddCompound(const std::string& _compoundKey);
/**
* \private
* Removes a compound with the specified unique key from all feeds, holdups and streams in the unit.
*/
void RemoveCompound(const std::string& _compoundKey);
/**
* \brief Returns the name of the compound with the specified unique key.
* \details Returns empty string if such compound does not exist in the list of active compounds.
* \param _compoundKey Unique key of the compound.
* \return Name of the compound.
*/
std::string GetCompoundName(const std::string& _compoundKey) const;
/**
* \brief Returns the name of the compound with the specified index.
* \details Indexing is done in the list of active compounds.
* Returns empty string if such compound does not exist.
* \param _index Index of the compound in the list of active compounds.
* \return Name of the compound.
*/
std::string GetCompoundName(size_t _index) const;
/**
* \brief Returns the unique key of the compound with the specified name.
* \details Returns empty string if such compound does not exist in the list of active compounds.
* \param _compoundName Name of the compound.
* \return Unique key of the compound.
*/
std::string GetCompoundKey(const std::string& _compoundName) const;
/**
* \brief Returns the unique key of the compound with the specified index.
* \details Returns empty string if such compound does not exist in the list of active compounds.
* \param _index Index of the compound in the list of active compounds.
* \return Unique key of the compound.
*/
std::string GetCompoundKey(size_t _index) const;
/**
* \brief Returns index of the compound with the specified key.
* \details Returns -1 if such compound does not exist in the list of active compounds.
* \param _compoundKey Unique key of the compound.
* \return Index of the compound in the list of active compounds.
*/
size_t GetCompoundIndex(const std::string& _compoundKey) const;
/**
* \brief Returns index of the compound with the specified name.
* \details Returns -1 if such compound does not exist in the list of active compounds.
* \param _compoundName Name of the compound.
* \return Index of the compound in the list of active compounds.
*/
size_t GetCompoundIndexByName(const std::string& _compoundName) const;
/**
* \brief Returns unique keys of all active compounds.
* \return Unique keys of all active compounds.
*/
std::vector<std::string> GetAllCompounds() const;
/**
* \brief Returns names of all active compounds.
* \return Unique keys of all active compounds.
*/
std::vector<std::string> GetAllCompoundsNames() const;
/**
* \brief Returns the number of active compounds.
* \return Number of active compounds.
*/
size_t GetCompoundsNumber() const;
/**
* \brief Checks if a compound with the specified unique key is defined.
* \param _compoundKey Unique key of the compound.
* \return Whether a compound with the specified unique key is defined.
*/
bool IsCompoundDefined(const std::string& _compoundKey) const;
/**
* \brief Checks if a compound with the specified name is defined.
* \param _compoundName Name of the compound.
* \return Whether a compound with the specified unique name is defined.
*/
bool IsCompoundNameDefined(const std::string& _compoundName) const;
////////////////////////////////////////////////////////////////////////////////
// Overall properties
//
/**
* \brief Returns keys of all overall properties.
* \return Keys of all active overall properties.
*/
std::vector<EOverall> GetAllOverallProperties() const;
/**
* \private
* Adds new overall property to all feeds, holdups and streams in the unit, if it does not exist yet.
*/
void AddOverallProperty(EOverall _property, const std::string& _name, const std::string& _units);
/**
* \private
* Removes an overall property from all feeds, holdups and streams in the unit.
*/
void RemoveOverallProperty(EOverall _property);
////////////////////////////////////////////////////////////////////////////////
// Phases
//
/**
* \private
* Adds the specified phase to all feeds, holdups and streams in the unit, if it does not exist yet.
*/
void AddPhase(EPhase _phase, const std::string& _name);
/**
* \private
* Removes the specified phase from all feeds, holdups and streams in the unit.
*/
void RemovePhase(EPhase _phase);
/**
* \brief Returns the name of the specified phase.
* \details Returns empty string if such phase does not exist in the list of active phases.
* \param _phase Phase type.
* \return Name of the phase.
*/
std::string GetPhaseName(EPhase _phase) const;
/**
* \brief Returns the type of the phase with the specified index.
* \details Returns #EPhase::UNDEFINED if the phase with the given index does not exist.
* \param _index Index of the phase in the list of active phases.
* \return Phase type.
*/
EPhase GetPhaseType(size_t _index) const;
/**
* \brief Returns types of all active phases.
* \return Types of all active phases.
*/
std::vector<EPhase> GetAllPhases() const;
/**
* \brief Returns the number of active phases.
* \return Number of active phases.
*/
size_t GetPhasesNumber() const;
/**
* \brief Checks if a phase of the specified type is in the list of active phases.
* \return Whether a phase of the specified type is defined.
*/
bool IsPhaseDefined(EPhase _phase) const;
////////////////////////////////////////////////////////////////////////////////
// Distributed properties
//
/**
* \private
* Updates grids of distributed properties and compounds.
*/
void SetGrid(const CMultidimensionalGrid& _grid);
/**
* \brief Returns number of defined distributed properties of the solid phase.
* \return Number of distributed properties.
*/
size_t GetDistributionsNumber() const;
/**
* \brief Returns types of all defined distributed properties of the solid phase.
* \return Types of all distributed properties.
*/
std::vector<EDistrTypes> GetDistributionsTypes() const;
/**
* \brief Returns numbers of classes of all defined distributed properties of the solid phase.
* \return Number of classes of all distributed properties.
*/
std::vector<size_t> GetDistributionsClasses() const;
/**
* \brief Returns type of grid entries of the given distributed property of the solid phase.
* \details Returns EGridEntry::GRID_UNDEFINED if the given distributed property is not defined.
* \param _distribution Type of the distributed property.
* \return Type of the grid entries.
*/
EGridEntry GetDistributionGridType(EDistrTypes _distribution) const;
/**
* \brief Returns number of classes defined for the specified distributed property of the solid phase.
* \details Returns 0 if the given distributed property is not defined.
* \param _distribution Type of the distributed property.
* \return Number of classes.
*/
size_t GetClassesNumber(EDistrTypes _distribution) const;
/**
* \brief Returns a numeric grid defined for the specified distributed property of the solid phase.
* \details Returns an empty vector if the distribution is not of numeric type.
* \param _distribution Type of the distributed property.
* \return Numeric grid.
*/
std::vector<double> GetNumericGrid(EDistrTypes _distribution) const;
/**
* \brief Returns a symbolic grid defined for the specified distributed property of the solid phase.
* \details Returns empty vector if the distribution is not of symbolic type.
* \param _distribution Type of the distributed property.
* \return Symbolic grid.
*/
std::vector<std::string> GetSymbolicGrid(EDistrTypes _distribution) const;
/**
* \brief Returns the sizes of classes defined in the grid of the specified distributed property of the solid phase.
* \details Returns an empty vector if the distribution is not of numeric type.
* \param _distribution Type of the distributed property.
* \return Sizes of classes.
*/
std::vector<double> GetClassesSizes(EDistrTypes _distribution) const;
/**
* \brief Returns the mean values of classes defined in the grid of the specified distributed property of the solid phase.
* \details Returns an empty vector if the distribution is not of numeric type.
* \param _distribution Type of the distributed property.
* \return Mean values of classes.
*/
std::vector<double> GetClassesMeans(EDistrTypes _distribution) const;
/**
* \brief Returns a grid defined for the particle size distribution in terms of particle diameters.
* \details Returns an empty vector if ::DISTR_SIZE distribution has not been defined.
* \return Particle size grid as diameters.
*/
std::vector<double> GetPSDGridDiameters() const;
/**
* \brief Returns a grid defined for the particle size distribution in terms of particle surfaces.
* \details Returns an empty vector if ::DISTR_SIZE distribution has not been defined.
* \return Particle size grid as surfaces.
*/
std::vector<double> GetPSDGridSurfaces() const;
/**
* \brief Returns a grid defined for the particle size distribution in terms of particle volumes.
* \details Returns an empty vector if ::DISTR_SIZE distribution has not been defined.
* \return Particle size grid as volumes.
*/
std::vector<double> GetPSDGridVolumes() const;
/**
* \brief Returns mean values of classes defined for the particle size distribution in terms of particle diameters.
* \details Returns an empty vector if ::DISTR_SIZE distribution has not been defined.
* \return Particle mean diameters.
*/
std::vector<double> GetPSDMeanDiameters() const;
/**
* \brief Returns mean values of classes defined for the particle size distribution in terms of particle surfaces.
* \details Returns an empty vector if ::DISTR_SIZE distribution has not been defined.
* \return Particle mean surfaces.
*/
std::vector<double> GetPSDMeanSurfaces() const;
/**
* \brief Returns mean values of classes defined for the particle size distribution in terms of particle volumes.
* \details Returns an empty vector if ::DISTR_SIZE distribution has not been defined.
* \return Particle mean volumes.
*/
std::vector<double> GetPSDMeanVolumes() const;
/**
* \brief Checks if the specified distributed property is defined.
* \param _distribution Type of the distributed property.
* \return Whether the distributed property is defined.
*/
bool IsDistributionDefined(EDistrTypes _distribution) const;
// TODO: return by value.
/**
* \brief Calculates a transformation matrix needed to obtain the output distribution from the input one.
* \details Calculates a transformation matrix for one-dimensional distribution according to input and output distributions.
* Obtained matrix can be applied to the stream instead of direct setting of distribution to retain secondary dimensions in multidimensional distribution.
* Following algorithm is applied to setup transformation matrix:
* 1. Go through the classes of source and target distributions from left to right.
* 2. The most left not empty class of the input distribution proceeds to the most left not empty class of the output distribution.
* 3. Transition to the next class of the input distribution is performed if the current class is completely transferred to the output distribution.
* 4. Transition to the next class of the output distribution is performed if the current class is already full.
* \param _distribution Type of the distributed property.
* \param _inValue Input distribution.
* \param _outValue Output distribution.
* \param _matrix Resulting transformation matrix.
*/
static void CalculateTM(EDistrTypes _distribution, const std::vector<double>& _inValue, const std::vector<double>& _outValue, CTransformMatrix& _matrix);
////////////////////////////////////////////////////////////////////////////////
// Global flowsheet data and settings
//
/**
* \private
* Returns a pointer to the current materials database.
*/
const CMaterialsDatabase* GetMaterialsDatabase() const;
/**
* \private
* Returns current grid of distributed parameters.
*/
const CMultidimensionalGrid& GetGrid() const;
/**
* \private
* Returns current tolerance settings.
*/
SToleranceSettings GetToleranceSettings() const;
/**
* \brief Returns global absolute tolerance.
* \details See also: \verbatim embed:rst:inline :ref:`sec.theory.convergence` \endverbatim
* \return Absolute tolerance.
*/
double GetAbsTolerance() const;
/**
* \brief Returns global relative tolerance.
* \details See also: \verbatim embed:rst:inline :ref:`sec.theory.convergence` \endverbatim
* \return Relative tolerance.
*/
double GetRelTolerance() const;
/**
* \private
* Returns current thermodynamics settings.
*/
SThermodynamicsSettings GetThermodynamicsSettings() const;
/**
* \private
* Updates tolerance settings in all units and streams.
*/
void UpdateToleranceSettings();
/**
* \private
* Updates cache settings in all streams.
*/
void UpdateCacheSettings();
/**
* \private
* Updates thermodynamics settings in all streams.
*/
void UpdateThermodynamicsSettings();
////////////////////////////////////////////////////////////////////////////////
// Materials database
//
/**
* \brief Returns the value of the constant physical property of the specified compound.
* \details Gets data directly from the materials database.
* See also: \verbatim embed:rst:inline :ref:`sec.mdb.const` \endverbatim
* \param _compoundKey Unique key of the compound.
* \param _property Identifier of the constant material property.
* \return Property value.
*/
double GetCompoundProperty(const std::string& _compoundKey, ECompoundConstProperties _property) const;
/**
* \brief Returns the value of the temperature/pressure-dependent physical property of the specified compound.
* \details Gets data directly from the materials database and calculates them for the given temperature [K] and pressure [Pa].
* See also: \verbatim embed:rst:inline :ref:`sec.mdb.tpd` \endverbatim
* \param _compoundKey Unique key of the compound.
* \param _property Identifier of the temperature/pressure-dependent material property.
* \param _temperature Temperature [K] for which the property should be calculated.
* \param _pressure Pressure [Pa] for which the property should be calculated.
* \return Property value.
*/
double GetCompoundProperty(const std::string& _compoundKey, ECompoundTPProperties _property, double _temperature = STANDARD_CONDITION_T, double _pressure = STANDARD_CONDITION_P) const;
/**
* \brief Returns the value of the interaction physical property between the specified compounds.
* \details Gets data directly from the materials database and calculates them for the given temperature [K] and pressure [Pa].
* See also: \verbatim embed:rst:inline :ref:`sec.mdb.interactions` \endverbatim
* \param _compoundKey1 Unique key of the first compound.
* \param _compoundKey2 Unique key of the second compound.
* \param _property Identifier of the temperature/pressure-dependent material property.
* \param _temperature Temperature [K] for which the property should be calculated.
* \param _pressure Pressure [Pa] for which the property should be calculated.
* \return Property value.
*/
double GetCompoundProperty(const std::string& _compoundKey1, const std::string& _compoundKey2, EInteractionProperties _property, double _temperature = STANDARD_CONDITION_T, double _pressure = STANDARD_CONDITION_P) const;
/**
* \brief Checks if a constant physical property with the specified key is present in the materials database.
* \param _property Identifier of the constant material property.
* \return Whether the property is defined.
*/
bool IsPropertyDefined(ECompoundConstProperties _property) const;
/**
* \brief Checks if a temperature/pressure-dependent physical property with the specified key is present in the materials database.
* \param _property Identifier of the temperature/pressure-dependent material property.
* \return Whether the property is defined.
*/
bool IsPropertyDefined(ECompoundTPProperties _property) const;
/**
* \brief Checks if an interaction physical property with the specified key is present in the materials database.
* \param _property Identifier of the temperature/pressure-dependent material property.
* \return Whether the property is defined.
*/
bool IsPropertyDefined(EInteractionProperties _property) const;
////////////////////////////////////////////////////////////////////////////////
// Thermodynamics
//
/**
* \brief Returns a pointer to a unit-specific enthalpy calculator.
* \return Pointer to an enthalpy calculator.
*/
[[nodiscard]] CMixtureEnthalpyLookup* GetEnthalpyCalculator() const;
/**
* \brief Calculates enthalpy of the mixture for the given temperature.
* \details Calculates enthalpy of the mixture of all defined compounds for the given temperature and compound fractions using a lookup table.
* Uses the values of enthalpy defined in the materials database.
* \param _temperature Temperature [K].
* \param _fractions Mass fraction of all defined compounds.
* \return Enthalpy [J/kg].
*/
[[nodiscard]] double CalculateEnthalpyFromTemperature(double _temperature, const std::vector<double>& _fractions) const;
/**
* \brief Calculates temperature of the mixture for the given enthalpy.
* \details Calculates temperature of the mixture of all defined compounds for the given enthalpy and compound fractions using a lookup table.
* Uses the values of enthalpy defined in the materials database.
* \param _enthalpy Enthalpy [J/kg].
* \param _fractions Mass fraction of all defined compounds.
* \return Temperature [K].
*/
[[nodiscard]] double CalculateTemperatureFromEnthalpy(double _enthalpy, const std::vector<double>& _fractions) const;
/**
* \brief Performs a heat exchange between two streams.
* \details Performs a heat exchange between two streams at the specified time point with a specified efficiency.
* \param _time Time point for which heat exchange is done.
* \param _stream1 Pointer to the first stream.
* \param _stream2 Pointer to the second stream.
* \param _efficiency Heat exchange efficiency (0..1].
*/
void HeatExchange(double _time, CBaseStream* _stream1, CBaseStream* _stream2, double _efficiency) const;
////////////////////////////////////////////////////////////////////////////////
// Errors and warnings
//
/**
* \brief Sets an error state of the unit, prints the message to the simulation log, and requests to stop simulation.
* \param _message Message to show in the simulation log.
*/
void RaiseError(const std::string& _message = "");
/**
* \brief Sets a warning state of the unit, and prints the message to the simulation log.
* \param _message Message to show in the simulation log.
*/
void RaiseWarning(const std::string& _message = "");
/**
* \brief Prints the message to the simulation log.
* \param _message Message to show in the simulation log.
*/
void ShowInfo(const std::string& _message);
/**
* \brief Checks if an error state is requested.
* \return Whether an error has occurred.
*/
bool HasError() const;
/**
* \brief Checks if a warning state is requested.
* \return Whether a warning has occurred.
*/
bool HasWarning() const;
/**
* \brief Checks if an info output is requested.
* \return Whether an info output is requested.
*/
bool HasInfo() const;
/**
* \brief Returns a textual description of the last error.
* \return Actual error message.
*/
std::string GetErrorMessage() const;
/**
* \brief Returns a textual description of the last warning.
* \return Actual warning message.
*/
std::string GetWarningMessage() const;
/**
* \brief Returns a textual description of the last info.
* \return Actual info message.
*/
std::string GetInfoMessage() const;
/**
* \private
* Clears an error state.
*/
void ClearError();
/**
* \private
* Clears a warning state.
*/
void ClearWarning();
/**
* \private
* Clears an info state.
*/
void ClearInfo();
/**
* \private
* Returns a textual description of the last error if any and clears the error state.
*/
std::string PopErrorMessage();
/**
* \private
* Returns a textual description of the last warning if any and clears the warning state.
*/
std::string PopWarningMessage();
/**
* \private
* Returns a textual description of the last info if any and clears the info state.
*/
std::string PopInfoMessage();
////////////////////////////////////////////////////////////////////////////////
// Simulation-time operations
//
/**
* \private
* Setup the structure of the unit (ports, unit parameters, holdups, internal streams).
*/
void DoCreateStructure();
/**
* \private
* Performs initialization of unit before starting the simulation.
*/
void DoInitializeUnit();
/**
* \private
* Performs finalization of unit after the simulation is finished.
*/
void DoFinalizeUnit();
/**
* \private
* Stores current state of the unit on specified time interval.
*/
void DoSaveStateUnit(double _timeBeg, double _timeEnd);
/**
* \private
* Restores previously saved state of the unit.
*/
void DoLoadStateUnit();
/**
* \private
* Removes all data produced during simulation.
*/
void ClearSimulationResults();
////////////////////////////////////////////////////////////////////////////////
// User-overloaded functions
//
/**
* \brief Setup basic parameters of the unit (name, author, key, version).
* \details This function must be defined in each unit.
* No information on the flowsheet structure and connected streams is available at this point.
*/
virtual void CreateBasicInfo() {}
/**
* \brief Setup the structure of the unit (ports, unit parameters, holdups, internal streams).
* \details This function must be defined in each unit. Here, all GUI-relevant parts of the unit are described.
* No information on the flowsheet structure and connected streams is available at this point.
*/
virtual void CreateStructure() {}
/**
* \brief Initialize unit for at time point 0 before starting the simulation.
* \details This function can be defined in each unit. It is called once for each simulation.
* Here, some additional objects can be initialized (for example holdups, material streams or state variables).
*/
virtual void Initialize(double _time) {}
/**
* \brief Calculate the unit on the given time point.
* \details This function must be defined in each steady-state unit.
* Is called by the simulator iteratively for all time points for which this unit should be calculated. Should implement all main calculations of the model.
* \param _time Time point for which the model is calculated.
*/
virtual void Simulate(double _time) {}
/**
* \brief Calculate the unit on the given time interval.
* \details This function must be defined in each dynamic unit.
* Is called by the simulator iteratively for all time points for which this unit should be calculated. Should implement all main calculations of the model.
* \param _timeBeg Start of the time interval for which the model is calculated.
* \param _timeEnd End of the time interval for which the model is calculated.
*/
virtual void Simulate(double _timeBeg, double _timeEnd) {}
/**
* \brief Finalize the unit after the calculation finishes.
* \details This function can be defined in each unit. It is called once at the end of the simulation.
* Here, closing and cleaning operations can be performed.
*/
virtual void Finalize() {}
/**
* \brief Save the current state of the unit.
* \details This function can be defined in each unit.
* Save the current state of all time-dependent parameters for a possible restart of the simulation from this time point.
* For flowsheets with recycled streams, it is called when the convergence on the current time window is reached.
*/
virtual void SaveState() {}
/**
* \brief Load the stored state of the unit.
* \details This function can be defined in each unit.
* Load the current state of all time-dependent parameters before a restart of the simulation from that time point.
* For flowsheets with recycled streams, it is called each time before the Simulate() function
*/
virtual void LoadState() {}
////////////////////////////////////////////////////////////////////////////////
// Saving/loading
//
/**
* \private
* Saves unit to HDF5 file.
*/
void SaveToFile(CH5Handler& _h5File, const std::string& _path);
/**
* \private
* Loads unit from HDF5 file.
*/
void LoadFromFile(CH5Handler& _h5File, const std::string& _path);
/**
* \private
* Loads unit from HDF5 file. A compatibility version.
*/
void LoadFromFile_v2(const CH5Handler& _h5File, const std::string& _path);
/**
* \private
* Loads unit from HDF5 file. A compatibility version.
*/
void LoadFromFile_v1(const CH5Handler& _h5File, const std::string& _path);
private:
/**
* \private
* Clears enthalpy calculator.
*/
void ClearEnthalpyCalculator() const;
public:
// TODO: move it somewhere
////////////////////////////////////////////////////////////////////////////////
// Deprecated functions
/**
* \private
*/
[[deprecated("WARNING! m_sUnitName is deprecated. Use SetUnitName(const std::string&) instead.")]]
std::string& GetNameRef();
/**
* \private
*/
[[deprecated("WARNING! m_sAuthorName is deprecated. Use SetAuthorName(const std::string&) instead.")]]
std::string& GetAuthorRef();
/**
* \private
*/
[[deprecated("WARNING! m_dUnitVersion is deprecated. Use SetVersion(size_t) instead.")]]
size_t& GetVersionRef();
/**
* \private
*/
[[deprecated("WARNING! m_sUniqueID is deprecated. Use SetUniqueID(const std::string&) instead.")]]
std::string& GetKeyRef();
/**
* \private
*/
[[deprecated("WARNING! m_pMaterialsDB is deprecated. Use GetMaterialsDatabase() instead.")]]
const CMaterialsDatabase* GetMaterialsDBRef() const;
/**
* \private
*/
[[deprecated("WARNING! SetDynamicUnit(bool) is deprecated and not needed anymore.")]]
static void SetDynamicUnit(bool _flag) {}
/**
* \private
*/
[[deprecated("WARNING! AddPort(const std::string&, EPortType) is deprecated. Use AddPort(const std::string&, EUnitPort) instead.")]]
unsigned AddPort(const std::string& _name, unsigned _type);
/**
* \private
*/
[[deprecated("WARNING! GetPortStream(unsigned) is deprecated. Use GetPortStream(const std::string&) or CUnitPort::GetStream() instead.")]]
CStream* GetPortStream(unsigned _index) const;
/**
* \private
*/
[[deprecated("WARNING! AddFeed(const std::string&, const std::string&) is deprecated. Use AddFeed(const std::string&) instead.")]]
CStream* AddFeed(const std::string& _name, const std::string& _key);
/**
* \private
*/
[[deprecated("WARNING! AddHoldup(const std::string&, const std::string&) is deprecated. Use AddHoldup(const std::string&) instead.")]]
CHoldup* AddHoldup(const std::string& _name, const std::string& _key);
/**
* \private
*/
[[deprecated("WARNING! AddMaterialStream(const std::string&, const std::string&) is deprecated. Use AddStream(const std::string&) instead.")]]
CStream* AddMaterialStream(const std::string& _name, const std::string& key = "");
/**
* \private
*/
[[deprecated("WARNING! GetMaterialStream(const std::string&) is deprecated. Use GetStream(const std::string&) instead.")]]
CStream* GetMaterialStream(const std::string& _name);
/**
* \private
*/
[[deprecated("WARNING! AddConstParameter(const std::string&, double, double, double, const std::string&, const std::string&) is deprecated. Use AddConstRealParameter(const std::string&, double, const std::string&, const std::string& _description, double, double), AddConstIntParameter(const std::string&, int64_t, const std::string&, const std::string& _description, int64_t, int64_t), or AddConstUIntParameter(const std::string&, uint64_t, const std::string&, const std::string& _description, uint64_t, uint64_t) instead.")]]
void AddConstParameter(const std::string& _name, double _minValue, double _maxValue, double _initValue, const std::string& _units, const std::string& _description);
/**
* \private
*/
[[deprecated("WARNING! AddTDParameter(const std::string&, double, double, double, const std::string&, const std::string&) is deprecated. Use AddTDParameter(const std::string&, double, const std::string&, const std::string&, double, double) instead.")]]
void AddTDParameter(const std::string& _name, double _minValue, double _maxValue, double _initValue, const std::string& _units, const std::string& _description);
/**
* \private
*/
[[deprecated("WARNING! AddGroupParameter(const std::string&, size_t, sonct std::vector<size_t>&, const std::vector<std::string>&, const std::string&) is deprecated. Use AddComboParameter(const std::string&, size_t, const std::vector<size_t>&, const std::vector<std::string>&, const std::string&) instead.")]]
void AddGroupParameter(const std::string& _name, size_t _initValue, const std::vector<size_t>& _values, const std::vector<std::string>& _valuesNames, const std::string& _description);
/**
* \private
*/
[[deprecated("WARNING! GetConstParameterValue(const std::string&) is deprecated. Use GetConstRealParameterValue(const std::string&), GetConstIntParameterValue(const std::string&), or GetConstUIntParameterValue(const std::string&) instead.")]]
double GetConstParameterValue(const std::string& _name) const;
/**
* \private
*/
[[deprecated("WARNING! GetGroupParameterValue(const std::string&) is deprecated. Use GetComboParameterValue(const std::string&) instead.")]]
size_t GetGroupParameterValue(const std::string& _name) const;
/**
* \private
*/
[[deprecated("WARNING! AddStateVariable(const std::string&, double, bool) is deprecated. Use AddStateVariable(const std::string&, double) instead.")]]
unsigned AddStateVariable(const std::string& _name, double _initValue, bool _saveHistory);
/**
* \private
*/
[[deprecated("WARNING! SetStateVariable(unsigned, double) is deprecated. Use SetStateVariable(const std::string&, double, double) or SetStateVariable(const std::string&, double) instead.")]]
void SetStateVariable(unsigned _index, double _value);
/**
* \private
*/
[[deprecated("WARNING! SaveStateVariables(double) is deprecated. Use SetStateVariable(const std::string&, double, double) instead when setting a value.")]]
void SaveStateVariables(double _time);
/**
* \private
*/
[[deprecated("WARNING! AddPointOnCurve(const std::string&, const std::string&, const std::vector<double>&, const std::vector<double>&) is deprecated. Use AddPointsOnCurve(const std::string&, const std::string&, const std::vector<double>&, const std::vector<double>&) instead.")]]
void AddPointOnCurve(const std::string& _plotName, const std::string& _curveName, const std::vector<double>& _x, const std::vector<double>& _y);
/**
* \private
*/
[[deprecated("WARNING! AddPointOnCurve(const std::string&, _valueZ, const std::vector<double>&, const std::vector<double>&) is deprecated. Use AddPointsOnCurve(const std::string&, _valueZ, const std::vector<double>&, const std::vector<double>&) instead.")]]
void AddPointOnCurve(const std::string& _plotName, double _valueZ, const std::vector<double>& _x, const std::vector<double>& _y);
/**
* \private
*/
[[deprecated("WARNING! GetPlotsNumber() is deprecated. Use GetPlotsManager().GetPlotsNumber() instead.")]]
unsigned GetPlotsNumber() const;
/**
* \private
*/
[[deprecated("WARNING! GetCurvesNumber(size_t) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetCurvesNumber() instead.")]]
unsigned GetCurvesNumber(size_t _iPlot) const;
/**
* \private
*/
[[deprecated("WARNING! GetPlotName(size_t) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetName() instead.")]]
std::string GetPlotName(size_t _iPlot) const;
/**
* \private
*/
[[deprecated("WARNING! GetPlotXAxisName(unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetLabelX() instead.")]]
std::string GetPlotXAxisName(unsigned _iPlot) const;
/**
* \private
*/
[[deprecated("WARNING! GetPlotYAxisName(unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetLabelY() instead.")]]
std::string GetPlotYAxisName(unsigned _iPlot) const;
/**
* \private
*/
[[deprecated("WARNING! GetPlotZAxisName(unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetLabelZ() instead.")]]
std::string GetPlotZAxisName(unsigned _iPlot) const;
/**
* \private
*/
[[deprecated("WARNING! GetCurveName(unsigned, unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetCurve(const std::string&)->GetName() or GetPlotsManager().GetPlot(const std::string&)->GetCurve(double)->GetName() instead.")]]
std::string GetCurveName(unsigned _iPlot, unsigned _iCurve) const;
/**
* \private
*/
[[deprecated("WARNING! GetCurveX(unsigned, unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetCurve(const std::string&)->GetXValues() or GetPlotsManager().GetPlot(const std::string&)->GetCurve(double)->GetXValues() instead.")]]
std::vector<double> GetCurveX(unsigned _iPlot, unsigned _iCurve) const;
/**
* \private
*/
[[deprecated("WARNING! GetCurveY(unsigned, unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetCurve(const std::string&)->GetYValues() or GetPlotsManager().GetPlot(const std::string&)->GetCurve(double)->GetYValues() instead.")]]
std::vector<double> GetCurveY(unsigned _iPlot, unsigned _iCurve) const;
/**
* \private
*/
[[deprecated("WARNING! GetCurveZ(size_t, size_t) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->GetCurve(const std::string&)->GetZValue() or GetPlotsManager().GetPlot(const std::string&)->GetCurve(double)->GetZValue() instead.")]]
double GetCurveZ(size_t _iPlot, size_t _iCurve) const;
/**
* \private
*/
[[deprecated("WARNING! IsPlot2D(unsigned) is deprecated. Use GetPlotsManager().GetPlot(const std::string&)->Is2D() instead.")]]
bool IsPlot2D(unsigned _iPlot);
/**
* \private
*/
[[deprecated("WARNING! GetAllDefinedTimePoints(double, double, bool, bool) is deprecated. Use GetAllTimePoints(double, double) or GetAllTimePointsClosed(double, double) instead.")]]
std::vector<double> GetAllDefinedTimePoints(double _timeBeg, double _timeEnd, bool _forceStartBoundary = false, bool _forceEndBoundary = false) const;
/**
* \private
*/
[[deprecated("WARNING! GetAllInputTimePoints(double, double, bool, bool) is deprecated. Use GetInputTimePoints(double, double) or GetInputTimePointsClosed(double, double) instead.")]]
std::vector<double> GetAllInputTimePoints(double _timeBeg, double _timeEnd, bool _forceStartBoundary = false, bool _forceEndBoundary = false) const;
/**
* \private
*/
[[deprecated("WARNING! GetAllStreamsTimePoints(const std::vector<CStream*>&, double, double) is deprecated. Use GetStreamsTimePoints(double, double, const std::vector<CStream*>&) or GetStreamsTimePointsClosed(double, double, const std::vector<CStream*>&) instead.")]]
std::vector<double> GetAllStreamsTimePoints(const std::vector<CStream*>& _srteams, double _timeBeg, double _timeEnd) const;
/**
* \private
*/
[[deprecated("WARNING! GetCompoundsList() is deprecated. Use GetAllCompounds() instead.")]]
std::vector<std::string> GetCompoundsList() const;
/**
* \private
*/
[[deprecated("WARNING! GetCompoundsNames() is deprecated. Use GetAllCompoundsNames(), GetCompoundName(const std::string&) or GetCompoundName(size_t) instead.")]]
std::vector<std::string> GetCompoundsNames() const;
/**
* \private
*/
[[deprecated("WARNING! IsCompoundKeyDefined(const std::string&) is deprecated. Use IsCompoundDefined(const std::string&) instead.")]]
bool IsCompoundKeyDefined(const std::string& _compoundKey) const;
/**
* \private
*/
[[deprecated("WARNING! GetPhaseIndex(EPhaseTypes) is deprecated. Access phases by their type.")]]
unsigned GetPhaseIndex(unsigned _soa) const;
/**
* \private
*/
[[deprecated("WARNING! GetPhaseSOA(unsigned) is deprecated. Use GetPhaseType(size_t) instead.")]]
unsigned GetPhaseSOA(unsigned _index) const;
/**
* \private
*/
[[deprecated("WARNING! IsPhaseDefined(EPhaseTypes) is deprecated. Use IsPhaseDefined(EPhase) instead.")]]
bool IsPhaseDefined(unsigned _soa) const;
/**
* \private
*/
[[deprecated("WARNING! GetCompoundConstant(const std::string&, ECompoundConstProperties) is deprecated. Use GetCompoundProperty(const std::string&, ECompoundConstProperties) instead.")]]
double GetCompoundConstant(const std::string& _compoundKey, unsigned _property) const;
/**
* \private
*/
[[deprecated("WARNING! GetCompoundTPDProp(const std::string&, ECompoundTPProperties) is deprecated. Use GetCompoundProperty(const std::string&, ECompoundTPProperties, double, double) instead.")]]
double GetCompoundTPDProp(const std::string& _compoundKey, unsigned _property, double _temperature, double _pressure) const;
/**
* \private
*/
[[deprecated("WARNING! GetCompoundsInteractionProp(const std::string&, const std::string&, EInteractionProperties, double, double) is deprecated. Use GetCompoundProperty(const std::string&, const std::string&, EInteractionProperties, double, double) instead.")]]
double GetCompoundsInteractionProp(const std::string& _compoundKey1, const std::string& _compoundKey2, unsigned _property, double _temperature = STANDARD_CONDITION_T, double _pressure = STANDARD_CONDITION_P) const;
/**
* \private
*/
[[deprecated("WARNING! CalcTemperatureFromProperty(ECompoundTPProperties, const std::vector<double>&, double) is deprecated. Use CalculateTemperatureFromEnthalpy(double, const std::vector<double>&) or CMixtureLookup class instead.")]]
double CalcTemperatureFromProperty(ECompoundTPProperties _property, const std::vector<double>& _fractions, double _value) const;
/**
* \private
*/
[[deprecated("WARNING! CalcPressureFromProperty(ECompoundTPProperties, const std::vector<double>&, double) is deprecated. Use CMixtureLookup class instead.")]]
double CalcPressureFromProperty(ECompoundTPProperties _property, const std::vector<double>& _fractions, double _value) const;
/**
* \private
*/
[[deprecated("WARNING! HeatExchange(CMaterialStream*, CMaterialStream*, double, double) is deprecated. Use HeatExchange(double, CBaseStream*, CBaseStream*, double) instead.")]]
void HeatExchange(CStream* _stream1, CStream* _stream2, double _time, double _efficiency) const;
/**
* \private
*/
[[deprecated("WARNING! CheckError() is deprecated. Use HasError() instead.")]]
bool CheckError() const;
private:
static EPhase SOA2EPhase(unsigned _soa);
static unsigned EPhase2SOA(EPhase _phase);
};
template <typename T, typename>
CComboUnitParameter* CBaseUnit::AddComboParameter(const std::string& _name, T _initValue, const std::vector<T>& _items, const std::vector<std::string>& _itemsNames, const std::string& _description)
{
return AddComboParameter(_name, static_cast<size_t>(_initValue), vector_cast<size_t>(_items), _itemsNames, _description);
}
template <typename T, typename>
void CBaseUnit::AddParametersToGroup(const CComboUnitParameter* _selector, T _selectedValue, const std::vector<CBaseUnitParameter*>& _groupedParams)
{
return AddParametersToGroup(_selector, static_cast<size_t>(_selectedValue), _groupedParams);
}
typedef DECLDIR CBaseUnit* (*CreateUnit2)();
|