source: XIOS/dev/dev_trunk_graph/src/node/grid.hpp @ 2027

Last change on this file since 2027 was 2027, checked in by yushan, 3 years ago

Graph intermediate commit to a tmp branch. Integrate latest modifications of branch coupling
  • 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.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 "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         string getCouplingAlias(const string& fieldId) ;
177
178      public:
179         void sendAddDomain(const std::string& id,CContextClient* contextClient);
180         void sendAddAxis(const std::string& id,CContextClient* contextClient);
181         void sendAddScalar(const std::string& id,CContextClient* contextClient);
182       
183         static void recvAddDomain(CEventServer& event);
184         void recvAddDomain(CBufferIn& buffer);
185         static void recvAddAxis(CEventServer& event);
186         void recvAddAxis(CBufferIn& buffer);
187         static void recvAddScalar(CEventServer& event);
188         void recvAddScalar(CBufferIn& buffer);
189
190         static bool dispatchEvent(CEventServer& event);
191       
192       public:
193         void setContextClient(CContextClient* contextClient);
194
195         std::map<int, StdSize> getAttributesBufferSize(CContextClient* client, bool bufferForWriting = false);
196         std::map<int, StdSize> getDataBufferSize(CContextClient* client, const std::string& id = "", bool bufferForWriting = false);
197         std::vector<StdString> getDomainList();
198         std::vector<StdString> getAxisList();
199         std::vector<StdString> getScalarList();
200         std::vector<CDomain*> getDomains();
201         std::vector<CAxis*> getAxis();
202         std::vector<CScalar*> getScalars();
203         CDomain* getDomain(int domainIndex);
204         CAxis* getAxis(int axisIndex);
205         CScalar* getScalar(int scalarIndex);
206         std::vector<int> getAxisOrder();
207         std::vector<int> getGlobalDimension();
208         bool isScalarGrid() const;         
209
210         bool doGridHaveDataToWrite();
211         bool doGridHaveDataDistributed(CContextClient* client = 0);
212
213         ///////////////////////////////////////////
214         ////////    TRANSFORMATIONS           /////
215         ///////////////////////////////////////////
216      public:
217         pair<shared_ptr<CFilter>, shared_ptr<CFilter> > buildTransformationGraph(CGarbageCollector& gc, bool isSource, CGrid* gridSrc, double detectMissingValues,
218                                                                                  double defaultValue, CGrid*& newGrid, bool graphEnabled=false, CField* field=0) ;
219      private:
220        CGridAlgorithm* gridAlgorithm_ = nullptr ;
221      public:
222        void setGridAlgorithm(CGridAlgorithm* gridAlgorithm) {gridAlgorithm_ = gridAlgorithm;}
223        CGridAlgorithm* getGridAlgorithm(void) { return gridAlgorithm_ ;}
224       
225        ///////////////////////////////////////////
226      public:
227
228        size_t getGlobalWrittenSize(void) ;
229         
230         bool isCompleted(void) ;
231         void setCompleted(void) ;
232         void unsetCompleted(void) ;
233
234
235         bool hasMask(void) const;
236        /** get mask pointer stored in mask_1d, or mask_2d, or..., or mask_7d */
237         CArray<bool,1> mask_ ;
238         CArray<bool,1>& getMask(void) ;
239
240      private:
241        /** Client-like distribution calculated based on the knowledge of the entire grid */
242       CDistributionClient* clientDistribution_;
243     public: 
244       void computeClientDistribution(void) ;
245     private:
246       bool computeClientDistribution_done_ = false ;
247     public:
248       CDistributionClient* getClientDistribution(void); 
249
250     private:   
251        void setVirtualDomainGroup(CDomainGroup* newVDomainGroup);
252        void setVirtualAxisGroup(CAxisGroup* newVAxisGroup);
253        void setVirtualScalarGroup(CScalarGroup* newVScalarGroup);
254
255        void setDomainList(const std::vector<CDomain*> domains = std::vector<CDomain*>());
256        void setAxisList(const std::vector<CAxis*> axis = std::vector<CAxis*>());
257        void setScalarList(const std::vector<CScalar*> scalars = std::vector<CScalar*>());
258
259        CDomainGroup* getVirtualDomainGroup() const;
260        CAxisGroup* getVirtualAxisGroup() const;
261        CScalarGroup* getVirtualScalarGroup() const;
262
263        int computeGridGlobalDimension(std::vector<int>& globalDim,
264                                       const std::vector<CDomain*> domains,
265                                       const std::vector<CAxis*> axis,
266                                       const std::vector<CScalar*> scalars,
267                                       const CArray<int,1>& axisDomainOrder);
268        int getDistributedDimension();
269      public:
270
271        bool isDataDistributed(void) ; 
272      private:
273
274/** Clients that have to send a grid. There can be multiple clients in case of secondary server, otherwise only one client. */
275        std::list<CContextClient*> clients;
276        std::set<CContextClient*> clientsSet;
277
278      private:
279        bool isChecked;
280        bool isDomainAxisChecked;
281        bool isIndexSent;
282
283        CDomainGroup* vDomainGroup_;
284        CAxisGroup* vAxisGroup_;
285        CScalarGroup* vScalarGroup_;
286        std::vector<std::string> axisList_, domList_, scalarList_;
287        bool isAxisListSet, isDomListSet, isScalarListSet;
288
289/** Map storing local ranks of connected receivers. Key = size of receiver's intracomm.
290  * It is calculated in computeConnectedClients(). */
291        std::map<int, std::vector<int> > connectedServerRank_;
292
293/** Map storing the size of data to be send. Key = size of receiver's intracomm
294  * It is calculated in computeConnectedClients(). */
295        std::map<int, std::map<int,size_t> > connectedDataSize_;
296
297/** Ranks of connected receivers in case of reading. It is calculated in recvIndex(). */
298        std::vector<int> connectedServerRankRead_;
299
300/** Size of data to be send in case of reading. It is calculated in recvIndex(). */
301        std::map<int,size_t> connectedDataSizeRead_;
302     
303         //! True if and only if the data defined on the grid can be outputted in a compressed way
304        bool isCompressible_;
305        std::set<std::string> relFilesCompressed;
306
307       
308        std::vector<int> axisPositionInGrid_;
309        void computeAxisPositionInGrid(void) ;
310        bool computeAxisPositionInGrid_done_ = false ;
311        std::vector<int>& getAxisPositionInGrid(void) { if (!computeAxisPositionInGrid_done_) computeAxisPositionInGrid() ; return axisPositionInGrid_ ;}
312
313        bool hasDomainAxisBaseRef_;       
314        std::map<CGrid*, std::pair<bool,StdString> > gridSrc_;
315
316     //////////////////////////////////////////////////////////////////////////////////////
317     //  this part is related to distribution, element definition, views and connectors  //
318     //////////////////////////////////////////////////////////////////////////////////////
319      public:
320       CGrid* duplicateSentGrid(void) ;
321      private:
322       static void recvMask(CEventServer& event) ;
323       void receiveMask(CEventServer& event) ;
324
325      private: 
326        CGridLocalElements* gridLocalElements_= nullptr ;
327        void computeGridLocalElements(void) ;
328      public:
329        CGridLocalElements* getGridLocalElements(void) { if (gridLocalElements_==nullptr) computeGridLocalElements() ; return gridLocalElements_ ;}
330
331      private:
332        CGridLocalConnector* modelToWorkflowConnector_ = nullptr ;
333      public:
334        void computeModelToWorkflowConnector(void) ;
335        CGridLocalConnector* getModelToWorkflowConnector(void) { if (modelToWorkflowConnector_==nullptr) computeModelToWorkflowConnector() ; return modelToWorkflowConnector_;}
336
337      private:
338        CGridLocalConnector* workflowToModelConnector_ ;
339      public:
340        void computeWorkflowToModelConnector(void) ;
341        CGridLocalConnector* getWorkflowToModelConnector(void) { if (workflowToModelConnector_==nullptr) computeWorkflowToModelConnector() ; return workflowToModelConnector_;}
342
343      public: //?
344        void distributeGridToServer(CContextClient* client, const string& fieldId="");
345     
346           
347      private:
348        CGridLocalConnector* workflowToFullConnector_ = nullptr;
349      public:
350        void computeWorkflowToFullConnector(void) ;
351        CGridLocalConnector* getWorkflowToFullConnector(void) { if (workflowToFullConnector_==nullptr) computeWorkflowToFullConnector() ; return workflowToFullConnector_;}
352
353      private:
354        CGridLocalConnector* fullToWorkflowConnector_ = nullptr;
355      public:
356        void computeFullToWorkflowConnector(void) ;
357        CGridLocalConnector* getFullToWorkflowConnector(void) { if (fullToWorkflowConnector_==nullptr) computeFullToWorkflowConnector() ; return fullToWorkflowConnector_;}
358
359   
360
361      private:
362         CGridGathererConnector* clientFromClientConnector_ = nullptr ;
363      public:
364         CGridGathererConnector* getClientFromClientConnector(void) { if (clientFromClientConnector_==nullptr) computeClientFromClientConnector() ; return clientFromClientConnector_;}
365         void computeClientFromClientConnector(void) ;
366
367      private:
368         map<CContextClient*, CGridScattererConnector*> clientToClientConnector_ ;
369      public:
370         CGridScattererConnector* getClientToClientConnector(CContextClient* client) { return clientToClientConnector_[client] ;} // make some test to see if connector exits for the given client
371 
372
373      private:
374         map<CContextClient*,CGridGathererConnector*> clientFromServerConnector_  ;
375      public:
376         CGridGathererConnector* getClientFromServerConnector(CContextClient* client) { return clientFromServerConnector_[client];}
377         void computeClientFromServerConnector(void) ;
378
379      private:
380         CGridScattererConnector* serverToClientConnector_=nullptr ;
381      public:
382         CGridScattererConnector* getServerToClientConnector(void) { if (serverToClientConnector_==nullptr) computeServerToClientConnector() ; return serverToClientConnector_;}
383         void computeServerToClientConnector(void) ;
384      private:
385         map<CContextClient*, CGridScattererConnector*> clientToServerConnector_ ;
386      public:
387         CGridScattererConnector* getClientToServerConnector(CContextClient* client) { return clientToServerConnector_[client] ;} // make some test to see if connector exits for the given client
388         
389      private:
390         CGridGathererConnector* serverFromClientConnector_ = nullptr ;
391      public:
392         CGridGathererConnector* getServerFromClientConnector(void) { if (serverFromClientConnector_==nullptr) computeServerFromClientConnector() ; return serverFromClientConnector_;}
393         void computeServerFromClientConnector(void) ;
394
395   }; // class CGrid
396
397   // Declare/Define CGridGroup and CGridDefinition
398   DECLARE_GROUP(CGrid);
399
400   ///--------------------------------------------------------------
401
402} // namespace xios
403
404#endif // __XIOS_CGrid__
Note: See TracBrowser for help on using the repository browser.