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