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

Last change on this file since 821 was 821, checked in by mhnguyen, 7 years ago

Making some improvements of transformation algorithm

+) Correct the way to enlisting transformations in an element (domain, axis)
+) Optimize generic transformation to make sure temporary grid to be created on demand
+) Update some mpi tag to prevent conflict
+) Correct some minor stuffs
+) Update documents

Test
+) On Curie
+) all test 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: 14.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 "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
18namespace 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 createMask(void);
209         void modifyMask(const CArray<int,1>& indexToModify);
210
211         void computeGridGlobalDimension(const std::vector<CDomain*>& domains,
212                                         const std::vector<CAxis*>& axis,
213                                         const CArray<bool,1>& axisDomainOrder);
214
215      private:
216       template<int N>
217       void checkGridMask(CArray<bool,N>& gridMask,
218                          const std::vector<CArray<bool,1>* >& domainMasks,
219                          const std::vector<CArray<bool,1>* >& axisMasks,
220                          const CArray<bool,1>& axisDomainOrder,
221                          bool createMask = false);
222        template<int N>
223        void modifyGridMask(CArray<bool,N>& gridMask, const CArray<int,1>& indexToModify);
224
225        void setVirtualDomainGroup(CDomainGroup* newVDomainGroup);
226        void setVirtualDomainGroup();
227        void setVirtualAxisGroup(CAxisGroup* newVAxisGroup);
228        void setVirtualAxisGroup();
229
230        void setAxisList(const std::vector<CAxis*> axis = std::vector<CAxis*>());
231        void setDomainList(const std::vector<CDomain*> domains = std::vector<CDomain*>());
232
233        CDomain* addDomain(const std::string& id);
234        CAxis* addAxis(const std::string& id);
235
236        CAxisGroup* getVirtualAxisGroup() const;
237        CDomainGroup* getVirtualDomainGroup() const;
238
239        void checkAttributesAfterTransformation();
240
241
242        void setTransformationAlgorithms();
243
244        std::vector<int> globalDim_;
245
246      private:
247        CDomainGroup* vDomainGroup_;
248        CAxisGroup* vAxisGroup_;
249        std::vector<std::string> axisList_, domList_;
250        bool isAxisListSet, isDomListSet;
251
252        CDistributionClient* clientDistribution_;
253        CDistributionServer* serverDistribution_;
254        CClientServerMapping* clientServerMap_;
255        size_t writtenDataSize_;
256        int numberWrittenIndexes_, totalNumberWrittenIndexes_, offsetWrittenIndexes_;
257        std::map<int,size_t> connectedDataSize_;
258        std::vector<int> connectedServerRank_;
259        bool isDataDistributed_;
260        int positionDimensionDistributed_;
261         //! True if and only if the data defined on the grid can be outputted in a compressed way
262        bool isCompressible_;
263        std::set<std::string> relFilesCompressed;
264
265        bool isTransformed_;
266        std::vector<int> axisPositionInGrid_;
267        CGridTransformation* transformations_;
268        bool hasDomainAxisBaseRef_;
269   }; // class CGrid
270
271   ///--------------------------------------------------------------
272
273   template <int n>
274   void CGrid::inputField(const CArray<double,n>& field, CArray<double,1>& stored) const
275   {
276      if (this->getDataSize() != field.numElements())
277         ERROR("void CGrid::inputField(const  CArray<double,n>& field, CArray<double,1>& stored) const",
278                << "[ Awaiting data of size = " << this->getDataSize() << ", "
279                << "Received data size = "      << field.numElements() << " ] "
280                << "The data array does not have the right size!")
281      this->storeField_arr(field.dataFirst(), stored);
282   }
283
284   template <int n>
285   void CGrid::outputField(const CArray<double,1>& stored, CArray<double,n>& field) const
286   {
287      if (this->getDataSize() != field.numElements())
288         ERROR("void CGrid::outputField(const CArray<double,1>& stored, CArray<double,n>& field) const",
289                << "[ Size of the data = " << this->getDataSize() << ", "
290                << "Output data size = "   << field.numElements() << " ] "
291                << "The ouput array does not have the right size!")
292      this->restoreField_arr(stored, field.dataFirst());
293   }
294
295   template<int N>
296   void CGrid::checkGridMask(CArray<bool,N>& gridMask,
297                             const std::vector<CArray<bool,1>* >& domainMasks,
298                             const std::vector<CArray<bool,1>* >& axisMasks,
299                             const CArray<bool,1>& axisDomainOrder,
300                             bool createMask)
301   {
302     int idx = 0;
303     int numElement = axisDomainOrder.numElements();
304     int dim = domainMasks.size() * 2 + axisMasks.size();
305     std::vector<CDomain*> domainP = this->getDomains();
306
307     std::vector<int> idxLoop(dim,0), indexMap(numElement), eachDimSize(dim);
308     std::vector<int> currentIndex(dim);
309     int idxDomain = 0, idxAxis = 0;
310    for (int i = 0; i < numElement; ++i)
311    {
312      indexMap[i] = idx;
313      if (true == axisDomainOrder(i)) {
314          eachDimSize[indexMap[i]]   = domainP[idxDomain]->ni;
315          eachDimSize[indexMap[i]+1] = domainP[idxDomain]->nj;
316          idx += 2; ++idxDomain;
317      }
318      else {
319        eachDimSize[indexMap[i]] = axisMasks[idxAxis]->numElements();
320        ++idx; ++idxAxis;
321      }
322    }
323
324    if (!gridMask.isEmpty() && !createMask)
325    {
326      for (int i = 0; i < dim; ++i)
327      {
328        if (gridMask.extent(i) != eachDimSize[i])
329          ERROR("CGrid::checkMask(void)",
330                << "The mask has one dimension whose size is different from the one of the local grid." << std::endl
331                << "Local size of dimension " << i << " is " << eachDimSize[i] << "." << std::endl
332                << "Mask size for dimension " << i << " is " << gridMask.extent(i) << ".");
333      }
334    }
335    else {
336        CArrayBoolTraits<CArray<bool,N> >::resizeArray(gridMask,eachDimSize);
337        gridMask = true;
338    }
339
340    int ssize = gridMask.numElements();
341    idx = 0;
342    while (idx < ssize)
343    {
344      for (int i = 0; i < dim-1; ++i)
345      {
346        if (idxLoop[i] == eachDimSize[i])
347        {
348          idxLoop[i] = 0;
349          ++idxLoop[i+1];
350        }
351      }
352
353      // Find out outer index
354      idxDomain = idxAxis = 0;
355      bool maskValue = true;
356      for (int i = 0; i < numElement; ++i)
357      {
358        if (axisDomainOrder(i))
359        {
360          maskValue = maskValue && (*domainMasks[idxDomain])(idxLoop[indexMap[i]] + idxLoop[indexMap[i]+1] * eachDimSize[indexMap[i]]);
361          ++idxDomain;
362        }
363        else
364        {
365          maskValue = maskValue && (*axisMasks[idxAxis])(idxLoop[indexMap[i]]);
366          ++idxAxis;
367        }
368      }
369
370      int maskIndex = idxLoop[0];
371      int mulDim = 1;
372      for (int k = 1; k < dim; ++k)
373      {
374        mulDim *= eachDimSize[k-1];
375        maskIndex += idxLoop[k]*mulDim;
376      }
377      *(gridMask.dataFirst()+maskIndex) &= maskValue;
378
379      ++idxLoop[0];
380      ++idx;
381    }
382
383   }
384
385   /*!
386     Modify the current mask of grid, the local index to be modified will take value false
387     \param [in/out] gridMask current mask of grid
388     \param [in] indexToModify local index to modify
389   */
390   template<int N>
391   void CGrid::modifyGridMask(CArray<bool,N>& gridMask, const CArray<int,1>& indexToModify)
392   {
393     bool valueToModify = false;
394     int num = indexToModify.numElements();
395     for (int idx = 0; idx < num; ++idx)
396     {
397       *(gridMask.dataFirst()+indexToModify(idx)) = valueToModify;
398     }
399   }
400   ///--------------------------------------------------------------
401
402   // Declare/Define CGridGroup and CGridDefinition
403   DECLARE_GROUP(CGrid);
404
405   ///--------------------------------------------------------------
406
407} // namespace xios
408
409#endif // __XIOS_CGrid__
Note: See TracBrowser for help on using the repository browser.