Salome HOME
Modification of C++ API of MEDCouplingMesh::getCellsContainingPoints to avoid copy.
[tools/medcoupling.git] / src / MEDCoupling / MEDCouplingMesh.hxx
1 // Copyright (C) 2007-2013  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.
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       UNSTRUCTURED_DESC = 6,
41       CARTESIAN = 7,
42       EXTRUDED = 8,
43       CURVE_LINEAR = 9,
44       SINGLE_STATIC_GEO_TYPE_UNSTRUCTURED = 10,
45       SINGLE_DYNAMIC_GEO_TYPE_UNSTRUCTURED = 11
46     } MEDCouplingMeshType;
47
48   class DataArrayInt;
49   class DataArrayDouble;
50   class MEDCouplingUMesh;
51   class MEDCouplingFieldDouble;
52
53   class MEDCOUPLING_EXPORT MEDCouplingMesh : public RefCountObject, public TimeLabel
54   {
55   public:
56     std::size_t getHeapMemorySize() const;
57     void setName(const char *name) { _name=name; }
58     std::string getName() const { return _name; }
59     void setDescription(const char *descr) { _description=descr; }
60     std::string getDescription() const { return _description; }
61     double getTime(int& iteration, int& order) const { iteration=_iteration; order=_order; return _time; }
62     void setTime(double val, int iteration, int order) { _time=val; _iteration=iteration; _order=order; }
63     void setTimeUnit(const char *unit) { _time_unit=unit; }
64     const char *getTimeUnit() const { return _time_unit.c_str(); }
65     virtual MEDCouplingMesh *deepCpy() const = 0;
66     virtual MEDCouplingMeshType getType() const = 0;
67     bool isStructured() const;
68     virtual void copyTinyStringsFrom(const MEDCouplingMesh *other) throw(INTERP_KERNEL::Exception);
69     virtual void copyTinyInfoFrom(const MEDCouplingMesh *other) throw(INTERP_KERNEL::Exception);
70     // comparison methods
71     virtual bool isEqualIfNotWhy(const MEDCouplingMesh *other, double prec, std::string& reason) const throw(INTERP_KERNEL::Exception);
72     virtual bool isEqual(const MEDCouplingMesh *other, double prec) const throw(INTERP_KERNEL::Exception);
73     virtual bool isEqualWithoutConsideringStr(const MEDCouplingMesh *other, double prec) const = 0;
74     virtual void checkDeepEquivalWith(const MEDCouplingMesh *other, int cellCompPol, double prec,
75                                       DataArrayInt *&cellCor, DataArrayInt *&nodeCor) const throw(INTERP_KERNEL::Exception) = 0;
76     virtual void checkDeepEquivalOnSameNodesWith(const MEDCouplingMesh *other, int cellCompPol, double prec,
77                                                  DataArrayInt *&cellCor) const throw(INTERP_KERNEL::Exception) = 0;
78     virtual void checkFastEquivalWith(const MEDCouplingMesh *other, double prec) const throw(INTERP_KERNEL::Exception);
79     void checkGeoEquivalWith(const MEDCouplingMesh *other, int levOfCheck, double prec,
80                              DataArrayInt *&cellCor, DataArrayInt *&nodeCor) const throw(INTERP_KERNEL::Exception);
81     //
82     virtual void checkCoherency() const throw(INTERP_KERNEL::Exception) = 0;
83     virtual void checkCoherency1(double eps=1e-12) const throw(INTERP_KERNEL::Exception) = 0;
84     virtual void checkCoherency2(double eps=1e-12) const throw(INTERP_KERNEL::Exception) = 0;
85     virtual int getNumberOfCells() const = 0;
86     virtual int getNumberOfNodes() const = 0;
87     virtual int getSpaceDimension() const = 0;
88     virtual int getMeshDimension() const = 0;
89     virtual DataArrayDouble *getCoordinatesAndOwner() const = 0;
90     virtual DataArrayDouble *getBarycenterAndOwner() const = 0;
91     virtual DataArrayDouble *computeIsoBarycenterOfNodesPerCell() const throw(INTERP_KERNEL::Exception) = 0;
92     virtual DataArrayInt *giveCellsWithType(INTERP_KERNEL::NormalizedCellType type) const throw(INTERP_KERNEL::Exception) = 0;
93     virtual DataArrayInt *computeNbOfNodesPerCell() const throw(INTERP_KERNEL::Exception) = 0;
94     virtual DataArrayInt *computeEffectiveNbOfNodesPerCell() const throw(INTERP_KERNEL::Exception) = 0;
95     virtual DataArrayInt *computeNbOfFacesPerCell() const throw(INTERP_KERNEL::Exception) = 0;
96     virtual int getNumberOfCellsWithType(INTERP_KERNEL::NormalizedCellType type) const = 0;
97     virtual INTERP_KERNEL::NormalizedCellType getTypeOfCell(int cellId) const = 0;
98     virtual std::set<INTERP_KERNEL::NormalizedCellType> getAllGeoTypes() const = 0;
99     virtual void getNodeIdsOfCell(int cellId, std::vector<int>& conn) const = 0;
100     virtual DataArrayInt *getCellIdsFullyIncludedInNodeIds(const int *partBg, const int *partEnd) const;
101     virtual void getCoordinatesOfNode(int nodeId, std::vector<double>& coo) const throw(INTERP_KERNEL::Exception) = 0;
102     virtual std::string simpleRepr() const = 0;
103     virtual std::string advancedRepr() const = 0;
104     // tools
105     virtual std::vector<int> getDistributionOfTypes() const throw(INTERP_KERNEL::Exception) = 0;
106     virtual DataArrayInt *checkTypeConsistencyAndContig(const std::vector<int>& code, const std::vector<const DataArrayInt *>& idsPerType) const throw(INTERP_KERNEL::Exception) = 0;
107     virtual void splitProfilePerType(const DataArrayInt *profile, std::vector<int>& code, std::vector<DataArrayInt *>& idsInPflPerType, std::vector<DataArrayInt *>& idsPerType) const throw(INTERP_KERNEL::Exception) = 0;
108     virtual void getBoundingBox(double *bbox) const = 0;
109     virtual MEDCouplingFieldDouble *getMeasureField(bool isAbs) const = 0;
110     virtual MEDCouplingFieldDouble *getMeasureFieldOnNode(bool isAbs) const = 0;
111     virtual int getCellContainingPoint(const double *pos, double eps) const = 0;
112     virtual void getCellsContainingPoint(const double *pos, double eps, std::vector<int>& elts) const;
113     virtual void getCellsContainingPoints(const double *pos, int nbOfPoints, double eps, MEDCouplingAutoRefCountObjectPtr<DataArrayInt>& elts, MEDCouplingAutoRefCountObjectPtr<DataArrayInt>& eltsIndex) const;
114     virtual MEDCouplingFieldDouble *fillFromAnalytic(TypeOfField t, int nbOfComp, FunctionToEvaluate func) const;
115     virtual MEDCouplingFieldDouble *fillFromAnalytic(TypeOfField t, int nbOfComp, const char *func) const;
116     virtual MEDCouplingFieldDouble *fillFromAnalytic2(TypeOfField t, int nbOfComp, const char *func) const;
117     virtual MEDCouplingFieldDouble *fillFromAnalytic3(TypeOfField t, int nbOfComp, const std::vector<std::string>& varsOrder, const char *func) const;
118     virtual MEDCouplingFieldDouble *buildOrthogonalField() const = 0;
119     virtual void rotate(const double *center, const double *vector, double angle) = 0;
120     virtual void translate(const double *vector) = 0;
121     virtual void scale(const double *point, double factor) = 0;
122     virtual void renumberCells(const int *old2NewBg, bool check=true) throw(INTERP_KERNEL::Exception) = 0;
123     virtual MEDCouplingMesh *mergeMyselfWith(const MEDCouplingMesh *other) const = 0;
124     virtual MEDCouplingMesh *buildPart(const int *start, const int *end) const = 0;
125     virtual MEDCouplingMesh *buildPartAndReduceNodes(const int *start, const int *end, DataArrayInt*& arr) const = 0;
126     virtual MEDCouplingMesh *buildPartRange(int beginCellIds, int endCellIds, int stepCellIds) const throw(INTERP_KERNEL::Exception);
127     virtual MEDCouplingMesh *buildPartRangeAndReduceNodes(int beginCellIds, int endCellIds, int stepCellIds, int& beginOut, int& endOut, int& stepOut, DataArrayInt*& arr) const throw(INTERP_KERNEL::Exception);
128     virtual MEDCouplingUMesh *buildUnstructured() const throw(INTERP_KERNEL::Exception) = 0;
129     virtual DataArrayInt *simplexize(int policy) throw(INTERP_KERNEL::Exception) = 0;
130     virtual bool areCompatibleForMerge(const MEDCouplingMesh *other) const;
131     static MEDCouplingMesh *MergeMeshes(const MEDCouplingMesh *mesh1, const MEDCouplingMesh *mesh2) throw(INTERP_KERNEL::Exception);
132     static MEDCouplingMesh *MergeMeshes(std::vector<const MEDCouplingMesh *>& meshes) throw(INTERP_KERNEL::Exception);
133     static bool IsStaticGeometricType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception);
134     static bool IsLinearGeometricType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception);
135     static INTERP_KERNEL::NormalizedCellType GetCorrespondingPolyType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception);
136     static int GetNumberOfNodesOfGeometricType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception);
137     static int GetDimensionOfGeometricType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception);
138     static const char *GetReprOfGeometricType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception);
139     //serialisation-unserialization
140     virtual void getTinySerializationInformation(std::vector<double>& tinyInfoD, std::vector<int>& tinyInfo, std::vector<std::string>& littleStrings) const = 0;
141     virtual void resizeForUnserialization(const std::vector<int>& tinyInfo, DataArrayInt *a1, DataArrayDouble *a2, std::vector<std::string>& littleStrings) const = 0;
142     virtual void serialize(DataArrayInt *&a1, DataArrayDouble *&a2) const = 0;
143     virtual void unserialization(const std::vector<double>& tinyInfoD, const std::vector<int>& tinyInfo, const DataArrayInt *a1, DataArrayDouble *a2,
144                                  const std::vector<std::string>& littleStrings) = 0;
145     void writeVTK(const char *fileName) const throw(INTERP_KERNEL::Exception);
146     /// @cond INTERNAL
147     void writeVTKAdvanced(const char *fileName, const std::string& cda, const std::string& pda) const throw(INTERP_KERNEL::Exception);
148     /// @endcond
149     virtual void writeVTKLL(std::ostream& ofs, const std::string& cellData, const std::string& pointData) const throw(INTERP_KERNEL::Exception) = 0;
150     virtual void reprQuickOverview(std::ostream& stream) const throw(INTERP_KERNEL::Exception) = 0;
151   protected:
152     MEDCouplingMesh();
153     MEDCouplingMesh(const MEDCouplingMesh& other);
154     virtual std::string getVTKDataSetType() const throw(INTERP_KERNEL::Exception) = 0;
155     virtual ~MEDCouplingMesh() { }
156   private:
157     std::string _name;
158     std::string _description;
159     double _time;
160     int _iteration;
161     int _order;
162     std::string _time_unit;
163   };
164 }
165
166 #endif