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

Last change on this file since 687 was 687, checked in by mhnguyen, 9 years ago

Implementing auto-generate rectilinear domain

+) Add a new special transformation to generate (complete) rectilinear domain

Test
+) On Curie
+) test_new_feature passed

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