source: XIOS/trunk/src/node/grid.hpp @ 890

Last change on this file since 890 was 890, checked in by mhnguyen, 5 years ago

Removing some redundant codes and make some minor improvements

+) Make a check to not do grid generation twice

Test
+) On Curie
+) On test compilation

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