Salome HOME
Synchronize adm files
[modules/med.git] / src / MEDCoupling / MEDCouplingMesh.hxx
1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 // Author : Anthony Geay (CEA/DEN)
20
21 #ifndef __PARAMEDMEM_MEDCOUPLINGMESH_HXX__
22 #define __PARAMEDMEM_MEDCOUPLINGMESH_HXX__
23
24 #include "MEDCoupling.hxx"
25 #include "MEDCouplingTimeLabel.hxx"
26 #include "MEDCouplingRefCountObject.hxx"
27 #include "NormalizedUnstructuredMesh.hxx"
28 #include "MEDCouplingAutoRefCountObjectPtr.hxx"
29
30 #include "InterpKernelException.hxx"
31
32 #include <set>
33 #include <vector>
34
35 namespace ParaMEDMEM
36 {
37   typedef enum
38     {
39       UNSTRUCTURED = 5,
40       CARTESIAN = 7,
41       EXTRUDED = 8,
42       CURVE_LINEAR = 9,
43       SINGLE_STATIC_GEO_TYPE_UNSTRUCTURED = 10,
44       SINGLE_DYNAMIC_GEO_TYPE_UNSTRUCTURED = 11,
45       IMAGE_GRID = 12
46     } MEDCouplingMeshType;
47   // -- WARNING this enum must be synchronized with MEDCouplingCommon.i file ! --
48
49   class DataArrayInt;
50   class DataArrayByte;
51   class DataArrayDouble;
52   class MEDCouplingUMesh;
53   class MEDCouplingFieldDouble;
54
55   class MEDCouplingMesh : public RefCountObject, public TimeLabel
56   {
57   public:
58     MEDCOUPLING_EXPORT std::size_t getHeapMemorySizeWithoutChildren() const;
59     MEDCOUPLING_EXPORT void setName(const std::string& name) { _name=name; }
60     MEDCOUPLING_EXPORT std::string getName() const { return _name; }
61     MEDCOUPLING_EXPORT void setDescription(const std::string& descr) { _description=descr; }
62     MEDCOUPLING_EXPORT std::string getDescription() const { return _description; }
63     MEDCOUPLING_EXPORT double getTime(int& iteration, int& order) const { iteration=_iteration; order=_order; return _time; }
64     MEDCOUPLING_EXPORT void setTime(double val, int iteration, int order) { _time=val; _iteration=iteration; _order=order; }
65     MEDCOUPLING_EXPORT void setTimeUnit(const std::string& unit) { _time_unit=unit; }
66     MEDCOUPLING_EXPORT std::string getTimeUnit() const { return _time_unit; }
67     MEDCOUPLING_EXPORT virtual MEDCouplingMesh *deepCpy() const = 0;
68     MEDCOUPLING_EXPORT virtual MEDCouplingMeshType getType() const = 0;
69     MEDCOUPLING_EXPORT bool isStructured() const;
70     MEDCOUPLING_EXPORT virtual void copyTinyStringsFrom(const MEDCouplingMesh *other);
71     MEDCOUPLING_EXPORT virtual void copyTinyInfoFrom(const MEDCouplingMesh *other);
72     // comparison methods
73     MEDCOUPLING_EXPORT virtual bool isEqualIfNotWhy(const MEDCouplingMesh *other, double prec, std::string& reason) const;
74     MEDCOUPLING_EXPORT virtual bool isEqual(const MEDCouplingMesh *other, double prec) const;
75     MEDCOUPLING_EXPORT virtual bool isEqualWithoutConsideringStr(const MEDCouplingMesh *other, double prec) const = 0;
76     MEDCOUPLING_EXPORT virtual void checkDeepEquivalWith(const MEDCouplingMesh *other, int cellCompPol, double prec,
77                                                          DataArrayInt *&cellCor, DataArrayInt *&nodeCor) const = 0;
78     MEDCOUPLING_EXPORT virtual void checkDeepEquivalOnSameNodesWith(const MEDCouplingMesh *other, int cellCompPol, double prec,
79                                                                     DataArrayInt *&cellCor) const = 0;
80     MEDCOUPLING_EXPORT virtual void checkFastEquivalWith(const MEDCouplingMesh *other, double prec) const;
81     MEDCOUPLING_EXPORT void checkGeoEquivalWith(const MEDCouplingMesh *other, int levOfCheck, double prec,
82                                                 DataArrayInt *&cellCor, DataArrayInt *&nodeCor) const;
83     //
84     MEDCOUPLING_EXPORT virtual void checkCoherency() const = 0;
85     MEDCOUPLING_EXPORT virtual void checkCoherency1(double eps=1e-12) const = 0;
86     MEDCOUPLING_EXPORT virtual void checkCoherency2(double eps=1e-12) const = 0;
87     MEDCOUPLING_EXPORT virtual int getNumberOfCells() const = 0;
88     MEDCOUPLING_EXPORT virtual int getNumberOfNodes() const = 0;
89     MEDCOUPLING_EXPORT virtual int getSpaceDimension() const = 0;
90     MEDCOUPLING_EXPORT virtual int getMeshDimension() const = 0;
91     MEDCOUPLING_EXPORT virtual DataArrayDouble *getCoordinatesAndOwner() const = 0;
92     MEDCOUPLING_EXPORT virtual DataArrayDouble *getBarycenterAndOwner() const = 0;
93     MEDCOUPLING_EXPORT virtual DataArrayDouble *computeIsoBarycenterOfNodesPerCell() const = 0;
94     MEDCOUPLING_EXPORT virtual DataArrayInt *giveCellsWithType(INTERP_KERNEL::NormalizedCellType type) const = 0;
95     MEDCOUPLING_EXPORT virtual DataArrayInt *computeNbOfNodesPerCell() const = 0;
96     MEDCOUPLING_EXPORT virtual DataArrayInt *computeEffectiveNbOfNodesPerCell() const = 0;
97     MEDCOUPLING_EXPORT virtual DataArrayInt *computeNbOfFacesPerCell() const = 0;
98     MEDCOUPLING_EXPORT virtual int getNumberOfCellsWithType(INTERP_KERNEL::NormalizedCellType type) const = 0;
99     MEDCOUPLING_EXPORT virtual INTERP_KERNEL::NormalizedCellType getTypeOfCell(int cellId) const = 0;
100     MEDCOUPLING_EXPORT virtual std::set<INTERP_KERNEL::NormalizedCellType> getAllGeoTypes() const = 0;
101     MEDCOUPLING_EXPORT virtual void getNodeIdsOfCell(int cellId, std::vector<int>& conn) const = 0;
102     MEDCOUPLING_EXPORT virtual DataArrayInt *getCellIdsFullyIncludedInNodeIds(const int *partBg, const int *partEnd) const;
103     MEDCOUPLING_EXPORT virtual void getCoordinatesOfNode(int nodeId, std::vector<double>& coo) const = 0;
104     MEDCOUPLING_EXPORT virtual std::string simpleRepr() const = 0;
105     MEDCOUPLING_EXPORT virtual std::string advancedRepr() const = 0;
106     // tools
107     MEDCOUPLING_EXPORT virtual std::vector<int> getDistributionOfTypes() const = 0;
108     MEDCOUPLING_EXPORT virtual DataArrayInt *checkTypeConsistencyAndContig(const std::vector<int>& code, const std::vector<const DataArrayInt *>& idsPerType) const = 0;
109     MEDCOUPLING_EXPORT virtual void splitProfilePerType(const DataArrayInt *profile, std::vector<int>& code, std::vector<DataArrayInt *>& idsInPflPerType, std::vector<DataArrayInt *>& idsPerType) const = 0;
110     MEDCOUPLING_EXPORT virtual void getBoundingBox(double *bbox) const = 0;
111     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *getMeasureField(bool isAbs) const = 0;
112     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *getMeasureFieldOnNode(bool isAbs) const = 0;
113     MEDCOUPLING_EXPORT virtual int getCellContainingPoint(const double *pos, double eps) const = 0;
114     MEDCOUPLING_EXPORT virtual void getCellsContainingPoint(const double *pos, double eps, std::vector<int>& elts) const;
115     MEDCOUPLING_EXPORT virtual void getCellsContainingPoints(const double *pos, int nbOfPoints, double eps, MEDCouplingAutoRefCountObjectPtr<DataArrayInt>& elts, MEDCouplingAutoRefCountObjectPtr<DataArrayInt>& eltsIndex) const;
116     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *fillFromAnalytic(TypeOfField t, int nbOfComp, FunctionToEvaluate func) const;
117     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *fillFromAnalytic(TypeOfField t, int nbOfComp, const std::string& func) const;
118     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *fillFromAnalytic2(TypeOfField t, int nbOfComp, const std::string& func) const;
119     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *fillFromAnalytic3(TypeOfField t, int nbOfComp, const std::vector<std::string>& varsOrder, const std::string& func) const;
120     MEDCOUPLING_EXPORT virtual MEDCouplingFieldDouble *buildOrthogonalField() const = 0;
121     MEDCOUPLING_EXPORT virtual void rotate(const double *center, const double *vector, double angle) = 0;
122     MEDCOUPLING_EXPORT virtual void translate(const double *vector) = 0;
123     MEDCOUPLING_EXPORT virtual void scale(const double *point, double factor) = 0;
124     MEDCOUPLING_EXPORT virtual void renumberCells(const int *old2NewBg, bool check=true) = 0;
125     MEDCOUPLING_EXPORT virtual MEDCouplingMesh *mergeMyselfWith(const MEDCouplingMesh *other) const = 0;
126     MEDCOUPLING_EXPORT virtual MEDCouplingMesh *buildPart(const int *start, const int *end) const = 0;
127     MEDCOUPLING_EXPORT virtual MEDCouplingMesh *buildPartAndReduceNodes(const int *start, const int *end, DataArrayInt*& arr) const = 0;
128     MEDCOUPLING_EXPORT virtual MEDCouplingMesh *buildPartRange(int beginCellIds, int endCellIds, int stepCellIds) const;
129     MEDCOUPLING_EXPORT virtual MEDCouplingMesh *buildPartRangeAndReduceNodes(int beginCellIds, int endCellIds, int stepCellIds, int& beginOut, int& endOut, int& stepOut, DataArrayInt*& arr) const;
130     MEDCOUPLING_EXPORT virtual MEDCouplingUMesh *buildUnstructured() const = 0;
131     MEDCOUPLING_EXPORT virtual DataArrayInt *simplexize(int policy) = 0;
132     MEDCOUPLING_EXPORT virtual void getReverseNodalConnectivity(DataArrayInt *revNodal, DataArrayInt *revNodalIndx) const = 0;
133     MEDCOUPLING_EXPORT virtual bool areCompatibleForMerge(const MEDCouplingMesh *other) const;
134     MEDCOUPLING_EXPORT static MEDCouplingMesh *MergeMeshes(const MEDCouplingMesh *mesh1, const MEDCouplingMesh *mesh2);
135     MEDCOUPLING_EXPORT static MEDCouplingMesh *MergeMeshes(std::vector<const MEDCouplingMesh *>& meshes);
136     MEDCOUPLING_EXPORT static bool IsStaticGeometricType(INTERP_KERNEL::NormalizedCellType type);
137     MEDCOUPLING_EXPORT static bool IsLinearGeometricType(INTERP_KERNEL::NormalizedCellType type);
138     MEDCOUPLING_EXPORT static INTERP_KERNEL::NormalizedCellType GetCorrespondingPolyType(INTERP_KERNEL::NormalizedCellType type);
139     MEDCOUPLING_EXPORT static int GetNumberOfNodesOfGeometricType(INTERP_KERNEL::NormalizedCellType type);
140     MEDCOUPLING_EXPORT static int GetDimensionOfGeometricType(INTERP_KERNEL::NormalizedCellType type);
141     MEDCOUPLING_EXPORT static const char *GetReprOfGeometricType(INTERP_KERNEL::NormalizedCellType type);
142     //serialisation-unserialization
143     MEDCOUPLING_EXPORT virtual void getTinySerializationInformation(std::vector<double>& tinyInfoD, std::vector<int>& tinyInfo, std::vector<std::string>& littleStrings) const = 0;
144     MEDCOUPLING_EXPORT virtual void resizeForUnserialization(const std::vector<int>& tinyInfo, DataArrayInt *a1, DataArrayDouble *a2, std::vector<std::string>& littleStrings) const = 0;
145     MEDCOUPLING_EXPORT virtual void serialize(DataArrayInt *&a1, DataArrayDouble *&a2) const = 0;
146     MEDCOUPLING_EXPORT virtual void unserialization(const std::vector<double>& tinyInfoD, const std::vector<int>& tinyInfo, const DataArrayInt *a1, DataArrayDouble *a2,
147                                                     const std::vector<std::string>& littleStrings) = 0;
148     MEDCOUPLING_EXPORT std::string writeVTK(const std::string& fileName, bool isBinary=true) const;
149     MEDCOUPLING_EXPORT std::string getVTKFileNameOf(const std::string& fileName) const;
150     MEDCOUPLING_EXPORT virtual std::string getVTKFileExtension() const = 0;
151     /// @cond INTERNAL
152     MEDCOUPLING_EXPORT void writeVTKAdvanced(const std::string& fileName, const std::string& cda, const std::string& pda, DataArrayByte *byteData) const;
153     MEDCOUPLING_EXPORT static void SplitExtension(const std::string& fileName, std::string& baseName, std::string& extension);
154     /// @endcond
155     MEDCOUPLING_EXPORT virtual void writeVTKLL(std::ostream& ofs, const std::string& cellData, const std::string& pointData, DataArrayByte *byteData) const = 0;
156     MEDCOUPLING_EXPORT virtual void reprQuickOverview(std::ostream& stream) const = 0;
157   protected:
158     MEDCOUPLING_EXPORT MEDCouplingMesh();
159     MEDCOUPLING_EXPORT MEDCouplingMesh(const MEDCouplingMesh& other);
160     MEDCOUPLING_EXPORT virtual std::string getVTKDataSetType() const = 0;
161     MEDCOUPLING_EXPORT virtual ~MEDCouplingMesh() { }
162   private:
163     std::string _name;
164     std::string _description;
165     double _time;
166     int _iteration;
167     int _order;
168     std::string _time_unit;
169   };
170 }
171
172 #endif