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

Last change on this file since 823 was 823, checked in by mhnguyen, 6 years ago

Implementing grid destination clone in case of two grid source

+) Clone attributes of grid destination as well as its transformation
+) Clean some redundant codes

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