source: XIOS/dev/dev_ym/XIOS_COUPLING/src/node/grid.hpp @ 2011

Last change on this file since 2011 was 2011, checked in by ymipsl, 3 years ago
  • bug fix when createing mask on server side when overlapping grid
  • implement axis interpolation on pressure coordinate
  • big cleaning in transformation

YM
  • 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.1 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#include "grid_local_connector.hpp"
19#include "grid_elements.hpp"
20#include "grid_scatterer_connector.hpp"
21#include "grid_gatherer_connector.hpp"
22#include "transformation_path.hpp"
23#include "filter.hpp"
24#include "grid_algorithm.hpp"
25
26
27namespace xios {
28
29   /// ////////////////////// Declarations ////////////////////// ///
30
31   class CGridGroup;
32   class CGridAttributes;
33   class CDomainGroup;
34   class CAxisGroup;
35   class CScalarGroup;
36   class CGrid;
37   class CDistributionClient;
38   class CDistributionServer;
39   class CServerDistributionDescription;
40   class CClientServerMapping;
41 
42   ///--------------------------------------------------------------
43
44   // Declare/Define CGridAttribute
45   BEGIN_DECLARE_ATTRIBUTE_MAP(CGrid)
46#  include "grid_attribute.conf"
47   END_DECLARE_ATTRIBUTE_MAP(CGrid)
48
49   ///--------------------------------------------------------------
50
51   class CGrid
52      : public CObjectTemplate<CGrid>
53      , public CGridAttributes
54   {
55         /// typedef ///
56         typedef CObjectTemplate<CGrid>   SuperClass;
57         typedef CGridAttributes SuperClassAttribute;
58
59      private:
60       
61        // define a structure to store elements (CDomain, CAxis, CScalar) using a void* and a type to cast the pointer
62         enum EElementType { TYPE_SCALAR, TYPE_AXIS, TYPE_DOMAIN } ;
63         struct SElement {void* ptr ; EElementType type ; CScalar* scalar ;  CAxis* axis ; CDomain* domain ; } ;
64         vector<SElement> elements_ ;
65         bool elementsComputed_ = false ; 
66         /** retrieve the vector of elements as a structure containing a void* and the type of pointer */
67         vector<SElement>& getElements(void) { if (!elementsComputed_) computeElements() ; return elements_ ; } 
68         void computeElements(void) ;
69         /** List order of axis and domain in a grid, if there is a domain, it will take value 2, axis 1, scalar 0 */
70         std::vector<int> order_;
71
72      public:
73
74         typedef CGridAttributes RelAttributes;
75         typedef CGridGroup      RelGroup;
76
77         enum EEventId
78         {
79           EVENT_ID_ADD_DOMAIN, EVENT_ID_ADD_AXIS, EVENT_ID_ADD_SCALAR,
80           EVENT_ID_SEND_MASK,
81
82         };
83
84         /// Constructeurs ///
85         CGrid(void);
86         explicit CGrid(const StdString& id);
87         CGrid(const CGrid& grid);       // Not implemented yet.
88         CGrid(const CGrid* const grid); // Not implemented yet.
89
90         /// Traitements ///
91//         void solveReference(void);
92
93         void checkEligibilityForCompressedOutput();
94         
95
96
97         void checkMaskIndex(bool doCalculateIndex);
98
99 //        virtual void toBinary  (StdOStream& os) const;
100//         virtual void fromBinary(StdIStream& is);
101
102         void addRelFileCompressed(const StdString& filename);
103
104         /// Tests ///
105         bool isCompressible(void) const;
106         bool isWrittenCompressed(const StdString& filename) const;
107
108      public:
109
110         /// Accesseurs ///
111         StdSize getDimension(void);
112
113         StdSize  getDataSize(void) ;
114
115         /**
116          * Get the local data grid size, ie the size of the compressed grid (inside the workflow)
117          * \return The size od the compressed grid
118          */
119         StdSize  getLocalDataSize(void) ;
120
121 
122         virtual void parse(xml::CXMLNode& node);
123
124         /// Destructeur ///
125         virtual ~CGrid(void);
126
127      public:
128
129         /// Accesseurs statiques ///
130         static StdString GetName(void);
131         static StdString GetDefName(void);
132
133         static ENodeType GetType(void);
134
135         /// Instanciateurs Statiques ///
136         static CGrid* createGrid(CDomain* domain);
137         static CGrid* createGrid(CDomain* domain, CAxis* axis);
138         static CGrid* createGrid(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
139                                  const CArray<int,1>& axisDomainOrder = CArray<int,1>());
140         static CGrid* createGrid(StdString id, const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
141                                  const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder = CArray<int,1>());
142         static CGrid* createGrid(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
143                                  const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder);
144         static StdString generateId(const std::vector<CDomain*>& domains, const std::vector<CAxis*>& axis,
145                                     const std::vector<CScalar*>& scalars, const CArray<int,1>& axisDomainOrder = CArray<int,1>());
146         static StdString generateId(const CGrid* gridSrc, const CGrid* gridDest);
147         static CGrid* cloneGrid(const StdString& idNewGrid, CGrid* gridSrc);
148
149      public:           
150         void solveDomainAxisRef(bool areAttributesChecked);
151         void checkElementsAttributes(void) ;
152
153         void solveDomainRef(bool checkAtt);
154         void solveAxisRef(bool checkAtt);
155         void solveScalarRef(bool checkAtt);
156         void solveElementsRefInheritance(bool apply = true);
157        // void solveTransformations();
158         void solveDomainAxisBaseRef();
159
160         CDomain* addDomain(const std::string& id=StdString());
161         CAxis* addAxis(const std::string& id=StdString());
162         CScalar* addScalar(const std::string& id=StdString());
163
164      public:
165         void sendGridToFileServer(CContextClient* client) ;
166      private:
167         std::set<CContextClient*> sendGridToFileServer_done_ ;
168     
169      public:
170         void sendGridToCouplerOut(CContextClient* client, const string& fieldId) ;
171      private:
172         std::set<CContextClient*> sendGridToCouplerOut_done_ ;
173
174      public:
175         void makeAliasForCoupling(const string& fieldId) ;
176
177      public:
178         void sendAddDomain(const std::string& id,CContextClient* contextClient);
179         void sendAddAxis(const std::string& id,CContextClient* contextClient);
180         void sendAddScalar(const std::string& id,CContextClient* contextClient);
181       
182         static void recvAddDomain(CEventServer& event);
183         void recvAddDomain(CBufferIn& buffer);
184         static void recvAddAxis(CEventServer& event);
185         void recvAddAxis(CBufferIn& buffer);
186         static void recvAddScalar(CEventServer& event);
187         void recvAddScalar(CBufferIn& buffer);
188
189         static bool dispatchEvent(CEventServer& event);
190       
191       public:
192         void setContextClient(CContextClient* contextClient);
193
194         std::map<int, StdSize> getAttributesBufferSize(CContextClient* client, bool bufferForWriting = false);
195         std::map<int, StdSize> getDataBufferSize(CContextClient* client, const std::string& id = "", bool bufferForWriting = false);
196         std::vector<StdString> getDomainList();
197         std::vector<StdString> getAxisList();
198         std::vector<StdString> getScalarList();
199         std::vector<CDomain*> getDomains();
200         std::vector<CAxis*> getAxis();
201         std::vector<CScalar*> getScalars();
202         CDomain* getDomain(int domainIndex);
203         CAxis* getAxis(int axisIndex);
204         CScalar* getScalar(int scalarIndex);
205         std::vector<int> getAxisOrder();
206         std::vector<int> getGlobalDimension();
207         bool isScalarGrid() const;         
208
209         bool doGridHaveDataToWrite();
210         bool doGridHaveDataDistributed(CContextClient* client = 0);
211
212         ///////////////////////////////////////////
213         ////////    TRANSFORMATIONS           /////
214         ///////////////////////////////////////////
215      public:
216         pair<shared_ptr<CFilter>, shared_ptr<CFilter> > buildTransformationGraph(CGarbageCollector& gc, bool isSource, CGrid* gridSrc, double detectMissingValues,
217                                                                                  double defaultValue, CGrid*& newGrid) ;
218      private:
219        CGridAlgorithm* gridAlgorithm_ = nullptr ;
220      public:
221        void setGridAlgorithm(CGridAlgorithm* gridAlgorithm) {gridAlgorithm_ = gridAlgorithm;}
222        CGridAlgorithm* getGridAlgorithm(void) { return gridAlgorithm_ ;}
223       
224        ///////////////////////////////////////////
225      public:
226
227        size_t getGlobalWrittenSize(void) ;
228         
229         bool isCompleted(void) ;
230         void setCompleted(void) ;
231         void unsetCompleted(void) ;
232
233
234         bool hasMask(void) const;
235        /** get mask pointer stored in mask_1d, or mask_2d, or..., or mask_7d */
236         CArray<bool,1> mask_ ;
237         CArray<bool,1>& getMask(void) ;
238
239      private:
240        /** Client-like distribution calculated based on the knowledge of the entire grid */
241       CDistributionClient* clientDistribution_;
242     public: 
243       void computeClientDistribution(void) ;
244     private:
245       bool computeClientDistribution_done_ = false ;
246     public:
247       CDistributionClient* getClientDistribution(void); 
248
249     private:   
250        void setVirtualDomainGroup(CDomainGroup* newVDomainGroup);
251        void setVirtualAxisGroup(CAxisGroup* newVAxisGroup);
252        void setVirtualScalarGroup(CScalarGroup* newVScalarGroup);
253
254        void setDomainList(const std::vector<CDomain*> domains = std::vector<CDomain*>());
255        void setAxisList(const std::vector<CAxis*> axis = std::vector<CAxis*>());
256        void setScalarList(const std::vector<CScalar*> scalars = std::vector<CScalar*>());
257
258        CDomainGroup* getVirtualDomainGroup() const;
259        CAxisGroup* getVirtualAxisGroup() const;
260        CScalarGroup* getVirtualScalarGroup() const;
261
262        int computeGridGlobalDimension(std::vector<int>& globalDim,
263                                       const std::vector<CDomain*> domains,
264                                       const std::vector<CAxis*> axis,
265                                       const std::vector<CScalar*> scalars,
266                                       const CArray<int,1>& axisDomainOrder);
267        int getDistributedDimension();
268      public:
269
270        bool isDataDistributed(void) ; 
271      private:
272
273/** Clients that have to send a grid. There can be multiple clients in case of secondary server, otherwise only one client. */
274        std::list<CContextClient*> clients;
275        std::set<CContextClient*> clientsSet;
276
277      private:
278        bool isChecked;
279        bool isDomainAxisChecked;
280        bool isIndexSent;
281
282        CDomainGroup* vDomainGroup_;
283        CAxisGroup* vAxisGroup_;
284        CScalarGroup* vScalarGroup_;
285        std::vector<std::string> axisList_, domList_, scalarList_;
286        bool isAxisListSet, isDomListSet, isScalarListSet;
287
288/** Map storing local ranks of connected receivers. Key = size of receiver's intracomm.
289  * It is calculated in computeConnectedClients(). */
290        std::map<int, std::vector<int> > connectedServerRank_;
291
292/** Map storing the size of data to be send. Key = size of receiver's intracomm
293  * It is calculated in computeConnectedClients(). */
294        std::map<int, std::map<int,size_t> > connectedDataSize_;
295
296/** Ranks of connected receivers in case of reading. It is calculated in recvIndex(). */
297        std::vector<int> connectedServerRankRead_;
298
299/** Size of data to be send in case of reading. It is calculated in recvIndex(). */
300        std::map<int,size_t> connectedDataSizeRead_;
301     
302         //! True if and only if the data defined on the grid can be outputted in a compressed way
303        bool isCompressible_;
304        std::set<std::string> relFilesCompressed;
305
306       
307        std::vector<int> axisPositionInGrid_;
308        void computeAxisPositionInGrid(void) ;
309        bool computeAxisPositionInGrid_done_ = false ;
310        std::vector<int>& getAxisPositionInGrid(void) { if (!computeAxisPositionInGrid_done_) computeAxisPositionInGrid() ; return axisPositionInGrid_ ;}
311
312        bool hasDomainAxisBaseRef_;       
313        std::map<CGrid*, std::pair<bool,StdString> > gridSrc_;
314
315     //////////////////////////////////////////////////////////////////////////////////////
316     //  this part is related to distribution, element definition, views and connectors  //
317     //////////////////////////////////////////////////////////////////////////////////////
318      public:
319       CGrid* duplicateSentGrid(void) ;
320      private:
321       static void recvMask(CEventServer& event) ;
322       void receiveMask(CEventServer& event) ;
323
324      private: 
325        CGridLocalElements* gridLocalElements_= nullptr ;
326        void computeGridLocalElements(void) ;
327      public:
328        CGridLocalElements* getGridLocalElements(void) { if (gridLocalElements_==nullptr) computeGridLocalElements() ; return gridLocalElements_ ;}
329
330      private:
331        CGridLocalConnector* modelToWorkflowConnector_ = nullptr ;
332      public:
333        void computeModelToWorkflowConnector(void) ;
334        CGridLocalConnector* getModelToWorkflowConnector(void) { if (modelToWorkflowConnector_==nullptr) computeModelToWorkflowConnector() ; return modelToWorkflowConnector_;}
335
336      private:
337        CGridLocalConnector* workflowToModelConnector_ ;
338      public:
339        void computeWorkflowToModelConnector(void) ;
340        CGridLocalConnector* getWorkflowToModelConnector(void) { if (workflowToModelConnector_==nullptr) computeWorkflowToModelConnector() ; return workflowToModelConnector_;}
341
342      public: //?
343        void distributeGridToFileServer(CContextClient* client);
344     
345           
346      private:
347        CGridLocalConnector* workflowToFullConnector_ = nullptr;
348      public:
349        void computeWorkflowToFullConnector(void) ;
350        CGridLocalConnector* getWorkflowToFullConnector(void) { if (workflowToFullConnector_==nullptr) computeWorkflowToFullConnector() ; return workflowToFullConnector_;}
351
352      private:
353        CGridLocalConnector* fullToWorkflowConnector_ = nullptr;
354      public:
355        void computeFullToWorkflowConnector(void) ;
356        CGridLocalConnector* getFullToWorkflowConnector(void) { if (fullToWorkflowConnector_==nullptr) computeFullToWorkflowConnector() ; return fullToWorkflowConnector_;}
357
358   
359
360      private:
361         CGridGathererConnector* clientFromClientConnector_ = nullptr ;
362      public:
363         CGridGathererConnector* getClientFromClientConnector(void) { if (clientFromClientConnector_==nullptr) computeClientFromClientConnector() ; return clientFromClientConnector_;}
364         void computeClientFromClientConnector(void) ;
365
366      private:
367         map<CContextClient*, CGridScattererConnector*> clientToClientConnector_ ;
368      public:
369         CGridScattererConnector* getClientToClientConnector(CContextClient* client) { return clientToClientConnector_[client] ;} // make some test to see if connector exits for the given client
370 
371
372      private:
373         map<CContextClient*,CGridGathererConnector*> clientFromServerConnector_  ;
374      public:
375         CGridGathererConnector* getClientFromServerConnector(CContextClient* client) { return clientFromServerConnector_[client];}
376         void computeClientFromServerConnector(void) ;
377
378      private:
379         CGridScattererConnector* serverToClientConnector_=nullptr ;
380      public:
381         CGridScattererConnector* getServerToClientConnector(void) { if (serverToClientConnector_==nullptr) computeServerToClientConnector() ; return serverToClientConnector_;}
382         void computeServerToClientConnector(void) ;
383      private:
384         map<CContextClient*, CGridScattererConnector*> clientToServerConnector_ ;
385      public:
386         CGridScattererConnector* getClientToServerConnector(CContextClient* client) { return clientToServerConnector_[client] ;} // make some test to see if connector exits for the given client
387         
388      private:
389         CGridGathererConnector* serverFromClientConnector_ = nullptr ;
390      public:
391         CGridGathererConnector* getServerFromClientConnector(void) { if (serverFromClientConnector_==nullptr) computeServerFromClientConnector() ; return serverFromClientConnector_;}
392         void computeServerFromClientConnector(void) ;
393
394   }; // class CGrid
395
396   // Declare/Define CGridGroup and CGridDefinition
397   DECLARE_GROUP(CGrid);
398
399   ///--------------------------------------------------------------
400
401} // namespace xios
402
403#endif // __XIOS_CGrid__
Note: See TracBrowser for help on using the repository browser.