File: CalculationSequence.h

package info (click to toggle)
dyssol 1.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 18,188 kB
  • sloc: cpp: 53,643; sh: 85; python: 55; makefile: 12
file content (172 lines) | stat: -rw-r--r-- 7,711 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/* Copyright (c) 2020, Dyssol Development Team.
 * Copyright (c) 2025, DyssolTEC GmbH.
 * All rights reserved. This file is part of Dyssol. See LICENSE file for license information. */

#pragma once

#include "DyssolDefines.h"
#include <string>
#include <vector>
#include <memory>

#include "DyssolTypes.h"

class CUnitContainer;
class CStream;
class CH5Handler;
struct SCacheSettings;
struct SToleranceSettings;

/** This class contains information about the way how calculations of models should be performed.
 *	Each Partition is the list of units in separate recycle loop. They should be calculated together.
 *	Afterwards, the convergence in the list of corresponding tear streams has to be analyzed.
 *	Additionally, for each partition, it maintains a list a streams, which are used as initials for tear streams.
 */
class CCalculationSequence
{
public:
	// TODO: get rid of this struct and use only keys.
	struct SPartition
	{
		std::vector<CUnitContainer*> models;	// List of pointers to models belonging to this partition.
		std::vector<CStream*> tearStreams;		// List of pointers to tear streams belonging to this partition.
	};

private:
	struct SPartitionKeys
	{
		std::vector<std::string> models;      // List of models' keys for each partition.
		std::vector<std::string> tearStreams; // List of tear streams' keys for each partition.
	};

	static constexpr unsigned m_saveVersion{ 2 };	// Current version of the saving procedure.

	const std::vector<std::unique_ptr<CUnitContainer>>* m_models{ nullptr };	// Non-owning pointer to a vector of existing models.
	const std::vector<std::shared_ptr<CStream>>* m_streams{ nullptr };			// Non-owning pointer to a vector of existing streams.

	std::vector<SPartitionKeys> m_partitions;       // List of defined partitions.

	std::vector<std::vector<std::unique_ptr<CStream>>> m_initialTearStreams;	// Streams needed for initialization of tear streams.

public:
	CCalculationSequence() = default;
	// Sets pointers to all existing models and streams.
	CCalculationSequence(const std::vector<std::unique_ptr<CUnitContainer>>* _allModels, const std::vector<std::shared_ptr<CStream>>* _allStreams);
	CCalculationSequence(const CCalculationSequence& _other);
	CCalculationSequence(CCalculationSequence&& _other) noexcept;
	CCalculationSequence& operator=(CCalculationSequence _other);
	CCalculationSequence& operator=(CCalculationSequence&& _other) noexcept;

	/**
	 * \brief Swaps the content of two sequences.
	 * \param _first First sequence.
	 * \param _second Second sequence.
	 */
	friend void swap(CCalculationSequence& _first, CCalculationSequence& _second) noexcept;

	/**
	 * Sets pointers to all existing models and streams.
	 * \param _allModels Pointer to models.
	 * \param _allStreams Pointer to streams.
	 */
	void SetPointers(const std::vector<std::unique_ptr<CUnitContainer>>* _allModels, const std::vector<std::shared_ptr<CStream>>* _allStreams);

	// Clear calculation sequence and all initial tear streams.
	void Clear();
	/**
	 * Returns models keys defined in each partition.
	 */
	std::vector<std::vector<std::string>> GetModelsKeys() const;
	/**
	 * Returns streams keys defined in each partition.
	 */
	std::vector<std::vector<std::string>> GetStreamsKeys() const;
	// Sets partitions using indices of models and streams for each partition.
	void SetSequence(const std::vector<std::vector<std::string>>& _modelsKeys, const std::vector<std::vector<std::string>>& _streamsKeys);
	// Sets new model key to existing model.
	void SetModel(size_t _iPartition, size_t _iModel, const std::string& _modelKey);
	// Sets new stream key to existing tear stream.
	void SetStream(size_t _iPartition, size_t _iStream, const std::string& _streamKey);

	// Add new partition to the sequence.
	void AddPartition(const std::vector<std::string>& _modelsKeys, const std::vector<std::string>& _tearStreamsKeys);
	// Add new model to a partition.
	void AddModel(size_t _iPartition, const std::string& _modelKey);
	// Add new tear stream to a partition.
	void AddStream(size_t _iPartition, const std::string& _streamKey);
	// Remove a partition from the sequence.
	void DeletePartition(size_t _iPartition);
	// Remove a model with the key _modelKey from the sequence.
	void DeleteModel(const std::string& _modelKey);
	// Remove the model _iModel from the partition _iPartition.
	void DeleteModel(size_t _iPartition, size_t _iModel);
	// Remove a stream with the key _streamKey from the sequence.
	void DeleteStream(const std::string& _streamKey);
	// Remove the stream _iStream from the partition _iPartition.
	void DeleteStream(size_t _iPartition, size_t _iStream);

	// Shift selected partition upwards in partitions list.
	void ShiftPartitionUp(size_t _iPartition);
	// Shift selected partition downwards in partitions list.
	void ShiftPartitionDown(size_t _iPartition);
	// Shift selected model in partition upwards in models list.
	void ShiftModelUp(size_t _iPartition, size_t _iModel);
	// Shift selected model in partition downwards in models list.
	void ShiftModelDown(size_t _iPartition, size_t _iModel);
	// Shift selected tear stream in partition upwards in tear streams list.
	void ShiftStreamUp(size_t _iPartition, size_t _iStream);
	// Shift selected tear stream in partition downwards in tear streams list.
	void ShiftStreamDown(size_t _iPartition, size_t _iStream);

	// Get pointers to models from the specified partition.
	std::vector<CUnitContainer*> PartitionModels(size_t _iPartition) const;
	// Get pointers to tear streams from the specified partition.
	std::vector<CStream*> PartitionTearStreams(size_t _iPartition) const;
	// Get the specified partitions.
	SPartition Partition(size_t _iPartition) const;
	// Get all defined partitions.
	std::vector<SPartition> Partitions() const;

	// Number of defined partitions.
	size_t PartitionsNumber() const;
	// Number of models in a partition with index _iPartition.
	size_t ModelsNumber(size_t _iPartition) const;
	// Number of tear streams in a partition with index _iPartition.
	size_t TearStreamsNumber(size_t _iPartition) const;

	// Check if any partition is defined.
	bool IsEmpty() const;
	// Check for errors in the sequence.
	std::string Check() const;

	// Creates the required number of initial streams according to a current calculation sequence and configures their structure, preparing for simulation start.
	void UpdateInitialStreams();
	// Clears all time points in initial tear streams.
	void ClearInitialStreamsData();
	// Copies initial streams to tear streams to initialize them.
	void CopyInitToTearStreams(double _timeWindow);
	// Copies current data of tear streams to initial streams.
	void CopyTearToInitStreams(double _timeWindow);

	// Returns all initial tear streams.
	std::vector<std::vector<const CStream*>> GetAllInitialStreams() const;
	// Returns all initial tear streams.
	std::vector<std::vector<CStream*>> GetAllInitialStreams();

	// Updates cache settings in all initial tear streams.
	void UpdateCacheSettings(const SCacheSettings& _cache);
	// Updates tolerance settings in all initial tear streams.
	void UpdateToleranceSettings(const SToleranceSettings& _tolerance);
	// Updates thermodynamics settings in all initial tear streams.
	void UpdateThermodynamicsSettings(const SThermodynamicsSettings& _settings);

	void SaveToFile(CH5Handler& _h5Saver, const std::string& _path);
	void LoadFromFile(CH5Handler& _h5Loader, const std::string& _path);
	void LoadFromFile_v1(CH5Handler& _h5Loader, const std::string& _path);
	void LoadFromFile_v0(CH5Handler& _h5Loader, const std::string& _path);

private:
	// Check whether a model with the key _modelKey is presented in the sequence.
	bool IsModelInSequence(const std::string& _modelKey) const;
};