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
|
/* Copyright (c) 2020, Dyssol Development Team. All rights reserved. This file is part of Dyssol. See LICENSE file for license information. */
#pragma once
#include "SimulatorLog.h"
#include "CalculationSequence.h"
#include "DenseMDMatrix.h"
#include "LogUpdater.h"
#include <map>
class CFlowsheet;
class CParametersHolder;
class CUnitContainer;
class CStream;
enum class ESimulatorState
{
IDLE = 0,
RUNNING = 1,
TO_BE_STOPPED = 2
};
class CSimulator
{
friend class CSimulatorTab;
private:
struct SPartitionStatus
{
double dTWStart{ 0 }; // Current time window start.
double dTWStartPrev{ 0 }; // Start time of the previous time window.
double dTWEnd{ 0 }; // Current time window end.
double dTWLength{ 0 }; // Current time window length.
unsigned iTWIterationFull{ 0 }; // Iteration number within a current time window [m_dTWStart .. ]. Does not reset if the size of current TW is reduced.
unsigned iTWIterationCurr{ 0 }; // Iteration number within a current time window [m_dTWStart .. m_dTWEnd]. Reset if the size of current TW is reduced.
unsigned iWindowNumber{ 0 }; // Current time window within a partition.
bool bTearStreamsFromInit{ false };
std::vector<CStream*> vRecyclesPrev{}; // previous state of recycles
std::vector<CStream*> vRecyclesPrevPrev{}; // pre-previous state of recycles
};
CFlowsheet* m_pFlowsheet;
const CCalculationSequence* m_pSequence; // Calculation sequence.
CParametersHolder* m_pParams;
ESimulatorState m_nCurrentStatus;
std::map<std::string, bool> m_vInitialized;
/// Data for logging
CSimulatorLog m_log; // Log itself.
CLogUpdater m_logUpdater{ &m_log }; // Log updater.
// TODO: join m_partitionsStatus, m_iCurrentPartition, m_unitName into a simulation status variable
std::vector<SPartitionStatus> m_partitionsStatus{};
size_t m_iCurrentPartition{};
std::string m_unitName; // Name of the currently calculated unit.
//// parameters of convergence methods
bool m_bSteffensenTrigger;
bool m_hasError{ false }; // Current simulation finished with error.
public:
CSimulator();
/// Sets pointer to a flowsheet.
void SetFlowsheet(CFlowsheet* _pFlowsheet);
// Change status of simulator.
void SetCurrentStatus(ESimulatorState _nStatus);
// Returns current status of the simulator.
ESimulatorState GetCurrentStatus() const;
/**
* Checks if current simulation finished with error.
* \return Whether current simulation finished with error.
*/
[[nodiscard]] bool HasError() const;
// Returns information about currently calculated partition.
SPartitionStatus GetCurrentPartitionStatus() const;
/// Perform simulation.
void Simulate();
/// Stop Simulation
void Stop();
private:
/// Initialize status for each partition.
void InitializePartitionsStatus();
/// Perform simulation partition until end simulation time
void SimulateUntilEndSimulationTime(size_t _iPartition, const CCalculationSequence::SPartition& _partition);
/// Performs simulation of a given partition with waveform relaxation method.
void SimulateUnitsWithRecycles(size_t _iPartition, const CCalculationSequence::SPartition& _partition, double _t1, double _t2);
/// Simulate all units of a given partition on specified time interval.
void SimulateUnits(const CCalculationSequence::SPartition& _partition, double _t1, double _t2);
/// Simulate specified steady-state or dynamic unit on a given time or interval.
void SimulateUnit(CUnitContainer& _unit, double _t1, double _t2 = -1);
/// Initialize the specified steady-state or dynamic unit at the given time.
void InitializeUnit(CUnitContainer& _unit, double _t);
/// Checks convergence comparing all values from _vStreams1 and _vStreams2 in pairs on the specified time interval. The length of _vStreams1 and _vStreams2 must be the same.
bool CheckConvergence(const std::vector<CStream*>& _vStreams1, const std::vector<CStream*>& _vStreams2, double _t1, double _t2) const;
/// Compares all values of two streams on a specified time interval. Returns true if streams are equal to within tolerance.
bool CompareStreams(const CStream& _str1, const CStream& _str2, double _t1, double _t2) const;
/// Sets error's description into log, stops simulation.
void RaiseError(const std::string& _sError);
/// clears log information about current state (TimeStart, TimeEnd, WindowNumber, etc.)
void ClearLogState();
/// Calculates and sets estimated values to initialize tear _streams up to the _tExtra time point, applying selected extrapolation method on the time interval [_t1, _t2].
void ApplyExtrapolationMethod(const std::vector<CStream*>& _streams, double _t1, double _t2, double _tExtra) const;
/// Setup chosen convergence method.
void SetupConvergenceMethod();
/// Applies selected convergence method to calculate new values _s3 using previous values _s2 and _s1 on the specified time interval.
void ApplyConvergenceMethod(const std::vector<CStream*>& _s3, std::vector<CStream*>& _s2, std::vector<CStream*>& _s1, double _t1, double _t2);
double PredictValues(double _d3, double _d2, double _d1) const;
std::vector<double> PredictValues( const std::vector<double>& _v3, const std::vector<double>& _v2, const std::vector<double>& _v1) const;
CDenseMDMatrix PredictValues(const CDenseMDMatrix& _m3, const CDenseMDMatrix& _m2, const CDenseMDMatrix& _m1) const;
void PredictValues(size_t _len, const double* _v3, const double* _v2, const double* _v1, double* _res) const;
double PredictRelaxation(double F2, double F1) const;
double PredictWegstein(double F2, double F1, double X2, double X1) const;
double PredictSteffensen(double F3, double F2, double F1) const;
// Removes excessive data from streams of the selected partition on the time interval.
void ReduceData(const CCalculationSequence::SPartition& _partition, double _t1, double _t2) const;
static EPhase PhaseSOA2EPhase(unsigned _soa);
};
|