1 | #ifndef __XIOS_CGrid__ |
---|
2 | #define __XIOS_CGrid__ |
---|
3 | |
---|
4 | /// XIOS headers /// |
---|
5 | #include "xios_spl.hpp" |
---|
6 | #include "group_factory.hpp" |
---|
7 | |
---|
8 | #include "declare_group.hpp" |
---|
9 | #include "domain.hpp" |
---|
10 | #include "axis.hpp" |
---|
11 | #include "array_new.hpp" |
---|
12 | #include "attribute_array.hpp" |
---|
13 | #include "distribution_server.hpp" |
---|
14 | #include "client_server_mapping.hpp" |
---|
15 | #include "utils.hpp" |
---|
16 | #include "transformation_enum.hpp" |
---|
17 | |
---|
18 | namespace xios { |
---|
19 | |
---|
20 | /// ////////////////////// Déclarations ////////////////////// /// |
---|
21 | |
---|
22 | class CGridGroup; |
---|
23 | class CGridAttributes; |
---|
24 | class CDomainGroup; |
---|
25 | class CAxisGroup; |
---|
26 | class CGrid; |
---|
27 | class CDistributionClient; |
---|
28 | class CDistributionServer; |
---|
29 | class CServerDistributionDescription; |
---|
30 | class CClientServerMapping; |
---|
31 | class CGridTransformation; |
---|
32 | |
---|
33 | ///-------------------------------------------------------------- |
---|
34 | |
---|
35 | // Declare/Define CGridAttribute |
---|
36 | BEGIN_DECLARE_ATTRIBUTE_MAP(CGrid) |
---|
37 | # include "grid_attribute.conf" |
---|
38 | END_DECLARE_ATTRIBUTE_MAP(CGrid) |
---|
39 | |
---|
40 | ///-------------------------------------------------------------- |
---|
41 | |
---|
42 | class CGrid |
---|
43 | : public CObjectTemplate<CGrid> |
---|
44 | , public CGridAttributes |
---|
45 | { |
---|
46 | /// typedef /// |
---|
47 | typedef CObjectTemplate<CGrid> SuperClass; |
---|
48 | typedef CGridAttributes SuperClassAttribute; |
---|
49 | |
---|
50 | public: |
---|
51 | |
---|
52 | typedef CGridAttributes RelAttributes; |
---|
53 | typedef CGridGroup RelGroup; |
---|
54 | |
---|
55 | enum EEventId |
---|
56 | { |
---|
57 | EVENT_ID_INDEX, EVENT_ID_ADD_DOMAIN, EVENT_ID_ADD_AXIS |
---|
58 | }; |
---|
59 | |
---|
60 | enum EElementType |
---|
61 | { |
---|
62 | GRID_ONLY_AXIS, GRID_ONLY_DOMAIN, GRID_AXIS_DOMAIN |
---|
63 | }; |
---|
64 | |
---|
65 | /// Constructeurs /// |
---|
66 | CGrid(void); |
---|
67 | explicit CGrid(const StdString& id); |
---|
68 | CGrid(const CGrid& grid); // Not implemented yet. |
---|
69 | CGrid(const CGrid* const grid); // Not implemented yet. |
---|
70 | |
---|
71 | /// Traitements /// |
---|
72 | // void solveReference(void); |
---|
73 | |
---|
74 | void checkEligibilityForCompressedOutput(); |
---|
75 | |
---|
76 | void solveDomainAxisRef(bool areAttributesChecked); |
---|
77 | |
---|
78 | void checkMaskIndex(bool doCalculateIndex); |
---|
79 | |
---|
80 | // virtual void toBinary (StdOStream& os) const; |
---|
81 | // virtual void fromBinary(StdIStream& is); |
---|
82 | |
---|
83 | void addRelFileCompressed(const StdString& filename); |
---|
84 | |
---|
85 | /// Tests /// |
---|
86 | bool isCompressible(void) const; |
---|
87 | bool isWrittenCompressed(const StdString& filename) const; |
---|
88 | |
---|
89 | public: |
---|
90 | |
---|
91 | /// Accesseurs /// |
---|
92 | StdSize getDimension(void) const; |
---|
93 | |
---|
94 | StdSize getDataSize(void) const; |
---|
95 | |
---|
96 | /// Entrées-sorties de champs /// |
---|
97 | template <int n> |
---|
98 | void inputField(const CArray<double,n>& field, CArray<double,1>& stored) const; |
---|
99 | template <int n> |
---|
100 | void outputField(const CArray<double,1>& stored, CArray<double,n>& field) const; |
---|
101 | |
---|
102 | void outputField(int rank, const CArray<double,1>& stored, double* field); |
---|
103 | void inputField(int rank, const double* const field, CArray<double,1>& stored); |
---|
104 | |
---|
105 | void outputCompressedField(int rank, const CArray<double,1>& stored, double* field); |
---|
106 | |
---|
107 | virtual void parse(xml::CXMLNode& node); |
---|
108 | |
---|
109 | /// Destructeur /// |
---|
110 | virtual ~CGrid(void); |
---|
111 | |
---|
112 | public: |
---|
113 | |
---|
114 | /// Accesseurs statiques /// |
---|
115 | static StdString GetName(void); |
---|
116 | static StdString GetDefName(void); |
---|
117 | |
---|
118 | static ENodeType GetType(void); |
---|
119 | |
---|
120 | /// Instanciateurs Statiques /// |
---|
121 | static CGrid* createGrid(CDomain* domain); |
---|
122 | static CGrid* createGrid(CDomain* domain, CAxis* axis); |
---|
123 | static CGrid* createGrid(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis, |
---|
124 | const CArray<bool,1>& axisDomainOrder = CArray<bool,1>()); |
---|
125 | static CGrid* createGrid(StdString id, const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis, |
---|
126 | const CArray<bool,1>& axisDomainOrder = CArray<bool,1>()); |
---|
127 | static StdString generateId(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis, |
---|
128 | const CArray<bool,1>& axisDomainOrder = CArray<bool,1>()); |
---|
129 | |
---|
130 | public: |
---|
131 | |
---|
132 | /// Entrées-sorties de champs (interne) /// |
---|
133 | void storeField_arr(const double* const data, CArray<double,1>& stored) const; |
---|
134 | void restoreField_arr(const CArray<double,1>& stored, double* const data) const; |
---|
135 | |
---|
136 | /// Traitements protégés /// |
---|
137 | void computeIndexServer(void); |
---|
138 | void computeIndex(void); |
---|
139 | void computeIndexScalarGrid(); |
---|
140 | void computeCompressedIndex(); |
---|
141 | |
---|
142 | void solveDomainRef(bool checkAtt); |
---|
143 | void solveAxisRef(bool checkAtt); |
---|
144 | void solveDomainAxisRefInheritance(bool apply = true); |
---|
145 | void solveTransformations(); |
---|
146 | void solveDomainAxisBaseRef(); |
---|
147 | |
---|
148 | void sendAddDomain(const std::string& id=""); |
---|
149 | void sendAddAxis(const std::string& id=""); |
---|
150 | void sendAllDomains(); |
---|
151 | void sendAllAxis(); |
---|
152 | |
---|
153 | static void recvAddDomain(CEventServer& event); |
---|
154 | void recvAddDomain(CBufferIn& buffer); |
---|
155 | static void recvAddAxis(CEventServer& event); |
---|
156 | void recvAddAxis(CBufferIn& buffer); |
---|
157 | |
---|
158 | static bool dispatchEvent(CEventServer& event); |
---|
159 | static void recvIndex(CEventServer& event); |
---|
160 | void recvIndex(vector<int> ranks, vector<CBufferIn*> buffers); |
---|
161 | void sendIndex(void); |
---|
162 | void sendIndexScalarGrid(); |
---|
163 | |
---|
164 | void computeDomConServer(); |
---|
165 | std::map<int, int> getDomConServerSide(); |
---|
166 | std::map<int, StdSize> getAttributesBufferSize(); |
---|
167 | std::map<int, StdSize> getDataBufferSize(const std::string& id = ""); |
---|
168 | std::vector<StdString> getDomainList(); |
---|
169 | std::vector<StdString> getAxisList(); |
---|
170 | std::vector<CDomain*> getDomains(); |
---|
171 | std::vector<CAxis*> getAxis(); |
---|
172 | std::vector<int> getAxisOrder(); |
---|
173 | std::vector<int> getGlobalDimension(); |
---|
174 | bool isScalarGrid() const; |
---|
175 | std::vector<int> getAxisPositionInGrid() const; |
---|
176 | |
---|
177 | bool doGridHaveDataToWrite(); |
---|
178 | bool doGridHaveDataDistributed(); |
---|
179 | size_t getWrittenDataSize() const; |
---|
180 | int getNumberWrittenIndexes() const; |
---|
181 | int getTotalNumberWrittenIndexes() const; |
---|
182 | int getOffsetWrittenIndexes() const; |
---|
183 | |
---|
184 | const CDistributionServer* getDistributionServer() const; |
---|
185 | const CDistributionClient* getDistributionClient() const; |
---|
186 | CGridTransformation* getTransformations(); |
---|
187 | |
---|
188 | void transformGrid(CGrid* transformGridSrc); |
---|
189 | void completeGrid(CGrid* transformGridSrc = 0); |
---|
190 | void doAutoDistribution(CGrid* transformGridSrc); |
---|
191 | bool isTransformed(); |
---|
192 | void setTransformed(); |
---|
193 | |
---|
194 | public: |
---|
195 | |
---|
196 | /// Propriétés privées /// |
---|
197 | bool isChecked; |
---|
198 | bool isDomainAxisChecked; |
---|
199 | bool isIndexSent; |
---|
200 | |
---|
201 | CArray<int, 1> storeIndex_client; |
---|
202 | |
---|
203 | map<int, CArray<int, 1> > storeIndex_toSrv; |
---|
204 | map<int,int> nbSenders; |
---|
205 | |
---|
206 | map<int, CArray<size_t, 1> > outIndexFromClient, compressedOutIndexFromClient; |
---|
207 | void checkMask(void); |
---|
208 | void modifyMask(const CArray<int,1>& indexToModify); |
---|
209 | |
---|
210 | void computeGridGlobalDimension(const std::vector<CDomain*>& domains, |
---|
211 | const std::vector<CAxis*>& axis, |
---|
212 | const CArray<bool,1>& axisDomainOrder); |
---|
213 | |
---|
214 | private: |
---|
215 | template<int N> |
---|
216 | void checkGridMask(CArray<bool,N>& gridMask, |
---|
217 | const std::vector<CArray<bool,1>* >& domainMasks, |
---|
218 | const std::vector<CArray<bool,1>* >& axisMasks, |
---|
219 | const CArray<bool,1>& axisDomainOrder); |
---|
220 | template<int N> |
---|
221 | void modifyGridMask(CArray<bool,N>& gridMask, const CArray<int,1>& indexToModify); |
---|
222 | |
---|
223 | void setVirtualDomainGroup(CDomainGroup* newVDomainGroup); |
---|
224 | void setVirtualDomainGroup(); |
---|
225 | void setVirtualAxisGroup(CAxisGroup* newVAxisGroup); |
---|
226 | void setVirtualAxisGroup(); |
---|
227 | |
---|
228 | void setAxisList(const std::vector<CAxis*> axis = std::vector<CAxis*>()); |
---|
229 | void setDomainList(const std::vector<CDomain*> domains = std::vector<CDomain*>()); |
---|
230 | |
---|
231 | CDomain* addDomain(const std::string& id); |
---|
232 | CAxis* addAxis(const std::string& id); |
---|
233 | |
---|
234 | CAxisGroup* getVirtualAxisGroup() const; |
---|
235 | CDomainGroup* getVirtualDomainGroup() const; |
---|
236 | |
---|
237 | void checkAttributesAfterTransformation(); |
---|
238 | |
---|
239 | |
---|
240 | void setTransformationAlgorithms(); |
---|
241 | |
---|
242 | std::vector<int> globalDim_; |
---|
243 | |
---|
244 | private: |
---|
245 | CDomainGroup* vDomainGroup_; |
---|
246 | CAxisGroup* vAxisGroup_; |
---|
247 | std::vector<std::string> axisList_, domList_; |
---|
248 | bool isAxisListSet, isDomListSet; |
---|
249 | |
---|
250 | CDistributionClient* clientDistribution_; |
---|
251 | CDistributionServer* serverDistribution_; |
---|
252 | CClientServerMapping* clientServerMap_; |
---|
253 | size_t writtenDataSize_; |
---|
254 | int numberWrittenIndexes_, totalNumberWrittenIndexes_, offsetWrittenIndexes_; |
---|
255 | std::map<int,size_t> connectedDataSize_; |
---|
256 | std::vector<int> connectedServerRank_; |
---|
257 | bool isDataDistributed_; |
---|
258 | int positionDimensionDistributed_; |
---|
259 | //! True if and only if the data defined on the grid can be outputted in a compressed way |
---|
260 | bool isCompressible_; |
---|
261 | std::set<std::string> relFilesCompressed; |
---|
262 | |
---|
263 | bool isTransformed_; |
---|
264 | std::vector<int> axisPositionInGrid_; |
---|
265 | CGridTransformation* transformations_; |
---|
266 | bool hasDomainAxisBaseRef_; |
---|
267 | }; // class CGrid |
---|
268 | |
---|
269 | ///-------------------------------------------------------------- |
---|
270 | |
---|
271 | template <int n> |
---|
272 | void CGrid::inputField(const CArray<double,n>& field, CArray<double,1>& stored) const |
---|
273 | { |
---|
274 | if (this->getDataSize() != field.numElements()) |
---|
275 | ERROR("void CGrid::inputField(const CArray<double,n>& field, CArray<double,1>& stored) const", |
---|
276 | << "[ Awaiting data of size = " << this->getDataSize() << ", " |
---|
277 | << "Received data size = " << field.numElements() << " ] " |
---|
278 | << "The data array does not have the right size!") |
---|
279 | this->storeField_arr(field.dataFirst(), stored); |
---|
280 | } |
---|
281 | |
---|
282 | template <int n> |
---|
283 | void CGrid::outputField(const CArray<double,1>& stored, CArray<double,n>& field) const |
---|
284 | { |
---|
285 | if (this->getDataSize() != field.numElements()) |
---|
286 | ERROR("void CGrid::outputField(const CArray<double,1>& stored, CArray<double,n>& field) const", |
---|
287 | << "[ Size of the data = " << this->getDataSize() << ", " |
---|
288 | << "Output data size = " << field.numElements() << " ] " |
---|
289 | << "The ouput array does not have the right size!") |
---|
290 | this->restoreField_arr(stored, field.dataFirst()); |
---|
291 | } |
---|
292 | |
---|
293 | template<int N> |
---|
294 | void CGrid::checkGridMask(CArray<bool,N>& gridMask, |
---|
295 | const std::vector<CArray<bool,1>* >& domainMasks, |
---|
296 | const std::vector<CArray<bool,1>* >& axisMasks, |
---|
297 | const CArray<bool,1>& axisDomainOrder) |
---|
298 | { |
---|
299 | int idx = 0; |
---|
300 | int numElement = axisDomainOrder.numElements(); |
---|
301 | int dim = domainMasks.size() * 2 + axisMasks.size(); |
---|
302 | std::vector<CDomain*> domainP = this->getDomains(); |
---|
303 | |
---|
304 | std::vector<int> idxLoop(dim,0), indexMap(numElement), eachDimSize(dim); |
---|
305 | std::vector<int> currentIndex(dim); |
---|
306 | int idxDomain = 0, idxAxis = 0; |
---|
307 | for (int i = 0; i < numElement; ++i) |
---|
308 | { |
---|
309 | indexMap[i] = idx; |
---|
310 | if (true == axisDomainOrder(i)) { |
---|
311 | eachDimSize[indexMap[i]] = domainP[idxDomain]->ni; |
---|
312 | eachDimSize[indexMap[i]+1] = domainP[idxDomain]->nj; |
---|
313 | idx += 2; ++idxDomain; |
---|
314 | } |
---|
315 | else { |
---|
316 | eachDimSize[indexMap[i]] = axisMasks[idxAxis]->numElements(); |
---|
317 | ++idx; ++idxAxis; |
---|
318 | } |
---|
319 | } |
---|
320 | |
---|
321 | if (!gridMask.isEmpty()) |
---|
322 | { |
---|
323 | for (int i = 0; i < dim; ++i) |
---|
324 | { |
---|
325 | if (gridMask.extent(i) != eachDimSize[i]) |
---|
326 | ERROR("CGrid::checkMask(void)", |
---|
327 | << "The mask has one dimension whose size is different from the one of the local grid." << std::endl |
---|
328 | << "Local size of dimension " << i << " is " << eachDimSize[i] << "." << std::endl |
---|
329 | << "Mask size for dimension " << i << " is " << gridMask.extent(i) << "."); |
---|
330 | } |
---|
331 | } |
---|
332 | else { |
---|
333 | CArrayBoolTraits<CArray<bool,N> >::resizeArray(gridMask,eachDimSize); |
---|
334 | gridMask = true; |
---|
335 | } |
---|
336 | |
---|
337 | int ssize = gridMask.numElements(); |
---|
338 | idx = 0; |
---|
339 | while (idx < ssize) |
---|
340 | { |
---|
341 | for (int i = 0; i < dim-1; ++i) |
---|
342 | { |
---|
343 | if (idxLoop[i] == eachDimSize[i]) |
---|
344 | { |
---|
345 | idxLoop[i] = 0; |
---|
346 | ++idxLoop[i+1]; |
---|
347 | } |
---|
348 | } |
---|
349 | |
---|
350 | // Find out outer index |
---|
351 | idxDomain = idxAxis = 0; |
---|
352 | bool maskValue = true; |
---|
353 | for (int i = 0; i < numElement; ++i) |
---|
354 | { |
---|
355 | if (axisDomainOrder(i)) |
---|
356 | { |
---|
357 | maskValue = maskValue && (*domainMasks[idxDomain])(idxLoop[indexMap[i]] + idxLoop[indexMap[i]+1] * eachDimSize[indexMap[i]]); |
---|
358 | ++idxDomain; |
---|
359 | } |
---|
360 | else |
---|
361 | { |
---|
362 | maskValue = maskValue && (*axisMasks[idxAxis])(idxLoop[indexMap[i]]); |
---|
363 | ++idxAxis; |
---|
364 | } |
---|
365 | } |
---|
366 | |
---|
367 | int maskIndex = idxLoop[0]; |
---|
368 | int mulDim = 1; |
---|
369 | for (int k = 1; k < dim; ++k) |
---|
370 | { |
---|
371 | mulDim *= eachDimSize[k-1]; |
---|
372 | maskIndex += idxLoop[k]*mulDim; |
---|
373 | } |
---|
374 | *(gridMask.dataFirst()+maskIndex) &= maskValue; |
---|
375 | |
---|
376 | ++idxLoop[0]; |
---|
377 | ++idx; |
---|
378 | } |
---|
379 | |
---|
380 | } |
---|
381 | |
---|
382 | /*! |
---|
383 | Modify the current mask of grid, the local index to be modified will take value false |
---|
384 | \param [in/out] gridMask current mask of grid |
---|
385 | \param [in] indexToModify local index to modify |
---|
386 | */ |
---|
387 | template<int N> |
---|
388 | void CGrid::modifyGridMask(CArray<bool,N>& gridMask, const CArray<int,1>& indexToModify) |
---|
389 | { |
---|
390 | bool valueToModify = false; |
---|
391 | int num = indexToModify.numElements(); |
---|
392 | for (int idx = 0; idx < num; ++idx) |
---|
393 | { |
---|
394 | *(gridMask.dataFirst()+indexToModify(idx)) = valueToModify; |
---|
395 | } |
---|
396 | } |
---|
397 | ///-------------------------------------------------------------- |
---|
398 | |
---|
399 | // Declare/Define CGridGroup and CGridDefinition |
---|
400 | DECLARE_GROUP(CGrid); |
---|
401 | |
---|
402 | ///-------------------------------------------------------------- |
---|
403 | |
---|
404 | } // namespace xios |
---|
405 | |
---|
406 | #endif // __XIOS_CGrid__ |
---|