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

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

Adding a new type of element into grid: Scalar

+) Add a new node Scalar for xml
+) Make some change on writing scalar value
+) Reorganize some codes
+) Remove some redundant codes

Test
+) On Curie
+) All tests pass

  • 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.3 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 CArray<int,1>& axisDomainOrder = CArray<int,1>());
124         static CGrid* createGrid(StdString id, const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
125                                  const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder = CArray<int,1>());
126         static CGrid* createGrid(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
127                                  const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder);
128//         static StdString generateId(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
129//                                     const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder = CArray<int,1>());
130         static StdString generateId(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
131                                     const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder = CArray<int,1>());
132         static StdString generateId(const CGrid* gridSrc, const CGrid* gridDest);
133         static CGrid* cloneGrid(const StdString& idNewGrid, CGrid* gridSrc);
134
135      public:
136
137         /// Entrées-sorties de champs (interne) ///
138         void storeField_arr(const double* const data, CArray<double,1>& stored) const;
139         void restoreField_arr(const CArray<double,1>& stored, double* const data) const;
140
141         /// Traitements protégés ///
142         void computeIndexServer(void);
143         void computeIndex(void);
144         void computeIndexScalarGrid();
145         void computeCompressedIndex();
146
147         void solveDomainRef(bool checkAtt);
148         void solveAxisRef(bool checkAtt);
149         void solveScalarRef(bool checkAtt);
150         void solveDomainAxisRefInheritance(bool apply = true);
151         void solveTransformations();
152         void solveDomainAxisBaseRef();
153
154         CDomain* addDomain(const std::string& id=StdString());
155         CAxis* addAxis(const std::string& id=StdString());
156         CScalar* addScalar(const std::string& id=StdString());
157         void sendAddDomain(const std::string& id="");
158         void sendAddAxis(const std::string& id="");
159         void sendAddScalar(const std::string& id="");
160         void sendAllDomains();
161         void sendAllAxis();
162         void sendAllScalars();
163
164         static void recvAddDomain(CEventServer& event);
165         void recvAddDomain(CBufferIn& buffer);
166         static void recvAddAxis(CEventServer& event);
167         void recvAddAxis(CBufferIn& buffer);
168         static void recvAddScalar(CEventServer& event);
169         void recvAddScalar(CBufferIn& buffer);
170
171         static bool dispatchEvent(CEventServer& event);
172         static void recvIndex(CEventServer& event);
173         void recvIndex(vector<int> ranks, vector<CBufferIn*> buffers);
174         void sendIndex(void);
175         void sendIndexScalarGrid();
176
177         void computeDomConServer();
178         std::map<int, int> getDomConServerSide();
179         std::map<int, StdSize> getAttributesBufferSize();
180         std::map<int, StdSize> getDataBufferSize(const std::string& id = "");
181         std::vector<StdString> getDomainList();
182         std::vector<StdString> getAxisList();
183         std::vector<StdString> getScalarList();
184         std::vector<CDomain*> getDomains();
185         std::vector<CAxis*> getAxis();
186         std::vector<CScalar*> getScalars();
187         std::vector<int> getAxisOrder();
188         std::vector<int> getGlobalDimension();
189         bool isScalarGrid() const;
190         std::vector<int> getAxisPositionInGrid() const;
191
192         bool doGridHaveDataToWrite();
193         bool doGridHaveDataDistributed();
194         size_t getWrittenDataSize() const;
195         int getNumberWrittenIndexes() const;
196         int getTotalNumberWrittenIndexes() const;
197         int getOffsetWrittenIndexes() const;
198
199         CDistributionServer* getDistributionServer();
200         CDistributionClient* getDistributionClient();
201         CGridTransformation* getTransformations();
202
203         void transformGrid(CGrid* transformGridSrc);
204         void completeGrid(CGrid* transformGridSrc = 0);
205         void doAutoDistribution(CGrid* transformGridSrc);
206         bool isTransformed();
207         void setTransformed();
208         void addTransGridSource(CGrid* gridSrc);
209         std::map<CGrid*, std::pair<bool,StdString> >& getTransGridSource();
210         bool hasTransform();
211
212      public:
213
214         /// Propriétés privées ///
215         bool isChecked;
216         bool isDomainAxisChecked;
217         bool isIndexSent;
218
219         CArray<int, 1> storeIndex_client;
220
221         map<int, CArray<int, 1> > storeIndex_toSrv;
222         map<int,int> nbSenders;
223
224         map<int, CArray<size_t, 1> > outIndexFromClient, compressedOutIndexFromClient;
225         void checkMask(void);
226         void createMask(void);
227         void modifyMask(const CArray<int,1>& indexToModify);
228
229         void computeGridGlobalDimension(const std::vector<CDomain*>& domains,
230                                         const std::vector<CAxis*>& axis,
231                                         const std::vector<CScalar*>& scalars,
232                                         const CArray<int,1>& axisDomainOrder);
233
234      private:
235       template<int N>
236       void checkGridMask(CArray<bool,N>& gridMask,
237                          const std::vector<CArray<bool,1>* >& domainMasks,
238                          const std::vector<CArray<bool,1>* >& axisMasks,
239                          const CArray<int,1>& axisDomainOrder,
240                          bool createMask = false);
241        template<int N>
242        void modifyGridMask(CArray<bool,N>& gridMask, const CArray<int,1>& indexToModify);
243
244        void setVirtualDomainGroup(CDomainGroup* newVDomainGroup);
245        void setVirtualDomainGroup();
246        void setVirtualAxisGroup(CAxisGroup* newVAxisGroup);
247        void setVirtualAxisGroup();
248        void setVirtualScalarGroup(CScalarGroup* newVScalarGroup);
249        void setVirtualScalarGroup();
250
251        void setDomainList(const std::vector<CDomain*> domains = std::vector<CDomain*>());
252        void setAxisList(const std::vector<CAxis*> axis = std::vector<CAxis*>());
253        void setScalarList(const std::vector<CScalar*> scalars = std::vector<CScalar*>());
254
255        CDomainGroup* getVirtualDomainGroup() const;
256        CAxisGroup* getVirtualAxisGroup() const;
257        CScalarGroup* getVirtualScalarGroup() const;
258
259        void checkAttributesAfterTransformation();
260        void setTransformationAlgorithms();
261        void computeIndexByElement(const std::vector<boost::unordered_map<size_t,std::vector<int> > >& indexServerOnElement,
262                                   CClientServerMapping::GlobalIndexMap& globalIndexOnServer);
263
264      private:
265        CDomainGroup* vDomainGroup_;
266        CAxisGroup* vAxisGroup_;
267        CScalarGroup* vScalarGroup_;
268        std::vector<std::string> axisList_, domList_, scalarList_;
269        bool isAxisListSet, isDomListSet, isScalarListSet;
270
271        CDistributionClient* clientDistribution_;
272        CDistributionServer* serverDistribution_;
273        CClientServerMapping* clientServerMap_;
274        size_t writtenDataSize_;
275        int numberWrittenIndexes_, totalNumberWrittenIndexes_, offsetWrittenIndexes_;
276        std::map<int,size_t> connectedDataSize_;
277        std::vector<int> connectedServerRank_;
278        bool isDataDistributed_;
279        int positionDimensionDistributed_;
280         //! True if and only if the data defined on the grid can be outputted in a compressed way
281        bool isCompressible_;
282        std::set<std::string> relFilesCompressed;
283
284        bool isTransformed_;
285        std::vector<int> axisPositionInGrid_;
286        CGridTransformation* transformations_;
287        bool hasDomainAxisBaseRef_;
288        std::vector<int> globalDim_;
289        std::map<CGrid*, std::pair<bool,StdString> > gridSrc_;
290        bool hasTransform_;
291        CClientServerMapping::GlobalIndexMap globalIndexOnServer_;
292            // List order of axis and domain in a grid, if there is a domain, it will take value 1 (true), axis 0 (false)
293        std::vector<int> order_;
294   }; // class CGrid
295
296   ///--------------------------------------------------------------
297
298   template <int n>
299   void CGrid::inputField(const CArray<double,n>& field, CArray<double,1>& stored) const
300   {
301      if (this->getDataSize() != field.numElements())
302         ERROR("void CGrid::inputField(const  CArray<double,n>& field, CArray<double,1>& stored) const",
303                << "[ Awaiting data of size = " << this->getDataSize() << ", "
304                << "Received data size = "      << field.numElements() << " ] "
305                << "The data array does not have the right size!")
306      this->storeField_arr(field.dataFirst(), stored);
307   }
308
309   template <int n>
310   void CGrid::outputField(const CArray<double,1>& stored, CArray<double,n>& field) const
311   {
312      if (this->getDataSize() != field.numElements())
313         ERROR("void CGrid::outputField(const CArray<double,1>& stored, CArray<double,n>& field) const",
314                << "[ Size of the data = " << this->getDataSize() << ", "
315                << "Output data size = "   << field.numElements() << " ] "
316                << "The ouput array does not have the right size!")
317      this->restoreField_arr(stored, field.dataFirst());
318   }
319
320   template<int N>
321   void CGrid::checkGridMask(CArray<bool,N>& gridMask,
322                             const std::vector<CArray<bool,1>* >& domainMasks,
323                             const std::vector<CArray<bool,1>* >& axisMasks,
324                             const CArray<int,1>& axisDomainOrder,
325                             bool createMask)
326   {
327     int idx = 0;
328     int numElement = axisDomainOrder.numElements();
329     int dim = domainMasks.size() * 2 + axisMasks.size();
330     std::vector<CDomain*> domainP = this->getDomains();
331
332     std::vector<int> idxLoop(dim,0), indexMap(numElement), eachDimSize(dim);
333     std::vector<int> currentIndex(dim);
334     int idxDomain = 0, idxAxis = 0;
335    for (int i = 0; i < numElement; ++i)
336    {
337      indexMap[i] = idx;
338      if (2 == axisDomainOrder(i)) {
339          eachDimSize[indexMap[i]]   = domainP[idxDomain]->ni;
340          eachDimSize[indexMap[i]+1] = domainP[idxDomain]->nj;
341          idx += 2; ++idxDomain;
342      }
343      else if (1 == axisDomainOrder(i)) {
344        eachDimSize[indexMap[i]] = axisMasks[idxAxis]->numElements();
345        ++idx; ++idxAxis;
346      }
347      else ++idx;
348    }
349
350    if (!gridMask.isEmpty() && !createMask)
351    {
352      for (int i = 0; i < dim; ++i)
353      {
354        if (gridMask.extent(i) != eachDimSize[i])
355          ERROR("CGrid::checkMask(void)",
356                << "The mask has one dimension whose size is different from the one of the local grid." << std::endl
357                << "Local size of dimension " << i << " is " << eachDimSize[i] << "." << std::endl
358                << "Mask size for dimension " << i << " is " << gridMask.extent(i) << ".");
359      }
360    }
361    else {
362        CArrayBoolTraits<CArray<bool,N> >::resizeArray(gridMask,eachDimSize);
363        gridMask = true;
364    }
365
366    int ssize = gridMask.numElements();
367    idx = 0;
368    while (idx < ssize)
369    {
370      for (int i = 0; i < dim-1; ++i)
371      {
372        if (idxLoop[i] == eachDimSize[i])
373        {
374          idxLoop[i] = 0;
375          ++idxLoop[i+1];
376        }
377      }
378
379      // Find out outer index
380      idxDomain = idxAxis = 0;
381      bool maskValue = true;
382      for (int i = 0; i < numElement; ++i)
383      {
384        if (2 == axisDomainOrder(i))
385        {
386          maskValue = maskValue && (*domainMasks[idxDomain])(idxLoop[indexMap[i]] + idxLoop[indexMap[i]+1] * eachDimSize[indexMap[i]]);
387          ++idxDomain;
388        }
389        else if (1 == axisDomainOrder(i))
390        {
391          maskValue = maskValue && (*axisMasks[idxAxis])(idxLoop[indexMap[i]]);
392          ++idxAxis;
393        }
394      }
395
396      int maskIndex = idxLoop[0];
397      int mulDim = 1;
398      for (int k = 1; k < dim; ++k)
399      {
400        mulDim *= eachDimSize[k-1];
401        maskIndex += idxLoop[k]*mulDim;
402      }
403      *(gridMask.dataFirst()+maskIndex) &= maskValue;
404
405      ++idxLoop[0];
406      ++idx;
407    }
408
409   }
410
411   /*!
412     Modify the current mask of grid, the local index to be modified will take value false
413     \param [in/out] gridMask current mask of grid
414     \param [in] indexToModify local index to modify
415   */
416   template<int N>
417   void CGrid::modifyGridMask(CArray<bool,N>& gridMask, const CArray<int,1>& indexToModify)
418   {
419     bool valueToModify = false;
420     int num = indexToModify.numElements();
421     for (int idx = 0; idx < num; ++idx)
422     {
423       *(gridMask.dataFirst()+indexToModify(idx)) = valueToModify;
424     }
425   }
426   ///--------------------------------------------------------------
427
428   // Declare/Define CGridGroup and CGridDefinition
429   DECLARE_GROUP(CGrid);
430
431   ///--------------------------------------------------------------
432
433} // namespace xios
434
435#endif // __XIOS_CGrid__
Note: See TracBrowser for help on using the repository browser.