source: XIOS/trunk/src/node/axis.hpp @ 676

Last change on this file since 676 was 676, checked in by rlacroix, 6 years ago

Add support for indexed output.

If the new field attribute "indexed_output" is set to true and a mask is defined (either at grid, domain or axis level), the indexed data will be outputed instead of the full data with missing values.

See http://cfconventions.org/Data/cf-conventions/cf-conventions-1.5/build/cf-conventions.html#compression-by-gathering for more information.

  • 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: 6.1 KB
Line 
1#ifndef __XIOS_CAxis__
2#define __XIOS_CAxis__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "group_factory.hpp"
7#include "virtual_node.hpp"
8
9#include "declare_group.hpp"
10#include "declare_ref_func.hpp"
11#include "declare_virtual_node.hpp"
12#include "attribute_array.hpp"
13#include "attribute_enum.hpp"
14#include "attribute_enum_impl.hpp"
15#include "server_distribution_description.hpp"
16#include "transformation.hpp"
17#include "transformation_enum.hpp"
18
19namespace xios {
20   /// ////////////////////// Déclarations ////////////////////// ///
21
22   class CAxisGroup;
23   class CAxisAttributes;
24   class CAxis;
25
26   ///--------------------------------------------------------------
27
28   // Declare/Define CAxisAttribute
29   BEGIN_DECLARE_ATTRIBUTE_MAP(CAxis)
30#  include "axis_attribute.conf"
31   END_DECLARE_ATTRIBUTE_MAP(CAxis)
32
33   ///--------------------------------------------------------------
34
35   class CAxis
36      : public CObjectTemplate<CAxis>
37      , public CAxisAttributes
38   {
39         enum EEventId
40         {
41           EVENT_ID_SERVER_ATTRIBUT,
42           EVENT_ID_INDEX,
43           EVENT_ID_DISTRIBUTED_VALUE,
44           EVENT_ID_NON_DISTRIBUTED_VALUE
45         } ;
46
47         /// typedef ///
48         typedef CObjectTemplate<CAxis>   SuperClass;
49         typedef CAxisAttributes SuperClassAttribute;
50
51      public :
52
53         typedef CAxisAttributes RelAttributes;
54         typedef CAxisGroup      RelGroup;
55         typedef CTransformation<CAxis>::TransformationMapTypes TransMapTypes;
56
57      public:
58         /// Constructeurs ///
59         CAxis(void);
60         explicit CAxis(const StdString & id);
61         CAxis(const CAxis & axis);       // Not implemented yet.
62         CAxis(const CAxis * const axis); // Not implemented yet.
63
64         static CAxis* createAxis();
65
66         /// Accesseurs ///
67         const std::set<StdString> & getRelFiles(void) const;
68
69         const std::vector<int>& getIndexesToWrite(void) const;
70         int getNumberWrittenIndexes() const;
71         int getTotalNumberWrittenIndexes() const;
72         int getOffsetWrittenIndexes() const;
73
74         /// Test ///
75         bool IsWritten(const StdString & filename) const;
76         bool isWrittenCompressed(const StdString& filename) const;
77         bool isDistributed(void) const;
78         bool isCompressible(void) const;
79
80         /// Mutateur ///
81         void addRelFile(const StdString & filename);
82         void addRelFileCompressed(const StdString& filename);
83
84         /// Vérifications ///
85         void checkAttributes(void);
86
87         /// Destructeur ///
88         virtual ~CAxis(void);
89
90         virtual void parse(xml::CXMLNode & node);
91
92         /// Accesseurs statiques ///
93         static StdString GetName(void);
94         static StdString GetDefName(void);
95         static ENodeType GetType(void);
96
97         void sendServerAttribut(const std::vector<int>& globalDim, int orderPositionInGrid,
98                                 CServerDistributionDescription::ServerDistributionType distType);
99         static bool dispatchEvent(CEventServer& event);
100         static void recvServerAttribut(CEventServer& event);
101         void recvServerAttribut(CBufferIn& buffer) ;
102         void checkAttributesOnClient(const std::vector<int>& globalDim, int orderPositionInGrid,
103                                      CServerDistributionDescription::ServerDistributionType disType = CServerDistributionDescription::BAND_DISTRIBUTION);
104         void sendCheckedAttributes(const std::vector<int>& globalDim, int orderPositionInGrid,
105                                    CServerDistributionDescription::ServerDistributionType disType = CServerDistributionDescription::BAND_DISTRIBUTION);
106
107         void checkEligibilityForCompressedOutput();
108
109         bool hasTransformation();
110         void solveInheritanceTransformation();
111         TransMapTypes getAllTransformations();
112
113      public:
114        int zoom_begin_srv, zoom_end_srv, zoom_size_srv;
115        int ni_srv, begin_srv, end_srv;
116        int global_zoom_begin, global_zoom_size;  // The real global zoom begin and zoom size after axis is transformed (zoomed)
117        CArray<double,1> value_srv;
118        CArray<double,2> bound_srv;
119
120      private:
121         void checkData();
122         void checkMask();
123         void checkZoom();
124         void checkBounds();
125         void checkTransformations();
126         void computeServerIndex(const std::vector<int>& globalDim, int orderPositionInGrid,
127                                 CServerDistributionDescription::ServerDistributionType disType);
128         void sendValue();
129         void computeConnectedServer(void);
130         void sendDistributedValue();
131         void sendNonDistributedValue();
132
133         static void recvIndex(CEventServer& event);
134         static void recvDistributedValue(CEventServer& event);
135         static void recvNonDistributedValue(CEventServer& event);
136         void recvIndex(int rank, CBufferIn& buffer);
137         void recvDistributedValue(int rank, CBufferIn& buffer);
138         void recvNonDistributedValue(int rank, CBufferIn& buffer);
139
140         void setTransformations(const TransMapTypes&);
141
142      private:
143         bool isChecked;
144         bool areClientAttributesChecked_;
145         std::set<StdString> relFiles, relFilesCompressed;
146         TransMapTypes transformationMap_;
147         bool isDistributed_;
148         //! True if and only if the data defined on the axis can be outputted in a compressed way
149         bool isCompressible_;
150         std::map<int,int> nbConnectedClients_; // Mapping of number of communicating client to a server
151         std::map<int, vector<size_t> > indSrv_; // Global index of each client sent to server
152         std::map<int, vector<int> > indWrittenSrv_; // Global written index of each client sent to server
153         std::vector<int> indexesToWrite;
154         int numberWrittenIndexes_, totalNumberWrittenIndexes_, offsetWrittenIndexes_;
155         std::vector<int> connectedServerRank_;
156         std::map<int, CArray<int,1> > indiSrv_;
157         bool hasBounds_;
158         DECLARE_REF_FUNC(Axis,axis)
159   }; // class CAxis
160
161   ///--------------------------------------------------------------
162
163   // Declare/Define CAxisGroup and CAxisDefinition
164   DECLARE_GROUP(CAxis);
165} // namespace xios
166
167#endif // __XIOS_CAxis__
Note: See TracBrowser for help on using the repository browser.