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

Last change on this file since 2258 was 2206, checked in by ymipsl, 3 years ago

New feature : when can now use the syntax :
fieldId:domainId[n], in domain reference inside the workflow (XML). Same for axis and scalar.

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