src/MEDCoupling/MEDCouplingCartesianAMRMesh.hxx

   1 // Copyright (C) 2007-2016  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
  20
  21 #ifndef __MEDCOUPLINGCARTESIANAMRMESH_HXX__
  22 #define __MEDCOUPLINGCARTESIANAMRMESH_HXX__
  23
  24 #include "MEDCoupling.hxx"
  25 #include "MEDCouplingTimeLabel.hxx"
  26 #include "MEDCouplingRefCountObject.hxx"
  27 #include "MCAuto.hxx"
  28 #include "MCType.hxx"
  29
  30 #include "BoxSplittingOptions.hxx"
  31 #include "InterpKernelException.hxx"
  32
  33 namespace MEDCoupling
  34 {
  35   class MEDCouplingIMesh;
  36   class MEDCouplingUMesh;
  37   class DataArrayInt;
  38   class DataArrayByte;
  39   class DataArrayDouble;
  40   class MEDCoupling1SGTUMesh;
  41   class MEDCouplingFieldDouble;
  42   class MEDCouplingCartesianAMRMesh;
  43   class MEDCouplingCartesianAMRMeshGen;
  44
  45   /// @cond INTERNAL
  46
  47   /*!
  48    * This class does not inherit from TimeLabel so only const method should exist.
  49    */
  50   class MEDCouplingCartesianAMRPatchGen : public RefCountObject
  51   {
  52   public:
  53     MEDCOUPLING_EXPORT virtual MEDCouplingCartesianAMRPatchGen *deepCopy(MEDCouplingCartesianAMRMeshGen *father) const = 0;
  54     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithOverlap() const;
  55     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithoutOverlap() const;
  56     MEDCOUPLING_EXPORT int getMaxNumberOfLevelsRelativeToThis() const;
  57     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getMesh() const { return _mesh; }
  58   protected:
  59     MEDCouplingCartesianAMRPatchGen(const MEDCouplingCartesianAMRPatchGen& other, MEDCouplingCartesianAMRMeshGen *father);
  60     MEDCouplingCartesianAMRPatchGen(MEDCouplingCartesianAMRMeshGen *mesh);
  61     const MEDCouplingCartesianAMRMeshGen *getMeshSafe() const;
  62     MEDCouplingCartesianAMRMeshGen *getMeshSafe();
  63   private:
  64     std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const;
  65   protected:
  66     MCAuto<MEDCouplingCartesianAMRMeshGen> _mesh;
  67   };
  68
  69   /*!
  70    * This class does not inherit from TimeLabel so only const method should exist.
  71    */
  72   class MEDCouplingCartesianAMRPatch : public MEDCouplingCartesianAMRPatchGen
  73   {
  74   public:
  75     MEDCouplingCartesianAMRPatch(MEDCouplingCartesianAMRMeshGen *mesh, const std::vector< std::pair<int,int> >& bottomLeftTopRight);
  76     MEDCouplingCartesianAMRPatch *deepCopy(MEDCouplingCartesianAMRMeshGen *father) const;
  77     // direct forward to _mesh
  78     MEDCOUPLING_EXPORT void addPatch(const std::vector< std::pair<int,int> >& bottomLeftTopRight, const std::vector<int>& factors);
  79     // end of direct forward to _mesh
  80     MEDCOUPLING_EXPORT int getNumberOfOverlapedCellsForFather() const;
  81     MEDCOUPLING_EXPORT bool isInMyNeighborhood(const MEDCouplingCartesianAMRPatch *other, int ghostLev) const;
  82     MEDCOUPLING_EXPORT bool isInMyNeighborhoodExt(const MEDCouplingCartesianAMRPatch *other, int ghostLev) const;
  83     MEDCOUPLING_EXPORT bool isInMyNeighborhoodDiffLev(const MEDCouplingCartesianAMRPatch *other, int ghostLev) const;
  84     // basic set/get
  85     MEDCOUPLING_EXPORT const std::vector< std::pair<int,int> >& getBLTRRange() const { return _bl_tr; }
  86     MEDCOUPLING_EXPORT std::vector< std::pair<int,int> > getBLTRRangeRelativeToGF() const;
  87     MEDCOUPLING_EXPORT std::vector<int> computeCellGridSt() const;
  88     MEDCOUPLING_EXPORT static bool IsInMyNeighborhood(int ghostLev, const std::vector< std::pair<int,int> >& p1, const std::vector< std::pair<int,int> >& p2);
  89     //
  90     static std::vector< std::vector< std::pair<const MEDCouplingCartesianAMRPatch *,const MEDCouplingCartesianAMRPatch *> > > FindNeighborsOfSubPatchesOfSameLev(int ghostLev, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2);
  91     static void FindNeighborsOfSubPatchesOf(int ghostLev, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2, std::vector< std::pair<const MEDCouplingCartesianAMRPatch *,const MEDCouplingCartesianAMRPatch *> >& ret);
  92     static void UpdateNeighborsOfOneWithTwo(int ghostLev, const std::vector<int>& factors, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2, DataArrayDouble *dataOnP1, const DataArrayDouble *dataOnP2);
  93     static void UpdateNeighborsOfOneWithTwoExt(int ghostLev, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2, DataArrayDouble *dataOnP1, const DataArrayDouble *dataOnP2);
  94     static void UpdateNeighborsOfOneWithTwoMixedLev(int ghostLev, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2, DataArrayDouble *dataOnP1, const DataArrayDouble *dataOnP2, bool isConservative);
  95   private:
  96     static void ComputeZonesOfTwoRelativeToOneDiffLev(int ghostLev, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2, std::vector< std::pair<int,int> >& p1Zone, std::vector< std::pair<int,int> >& p2Zone, std::vector<int>& factToApplyOn2);
  97   private:
  98     std::size_t getHeapMemorySizeWithoutChildren() const;
  99     static const MEDCouplingCartesianAMRMeshGen *FindCommonAncestor(const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2, int& lev);
 100     static std::vector<int> ComputeOffsetFromTwoToOne(const MEDCouplingCartesianAMRMeshGen *comAncestor, int lev, const MEDCouplingCartesianAMRPatch *p1, const MEDCouplingCartesianAMRPatch *p2);
 101     static void UpdateNeighborsOfOneWithTwoInternal(int ghostLev, const std::vector<int>& factors, const std::vector< std::pair<int,int> >&p1 ,const std::vector< std::pair<int,int> >&p2, DataArrayDouble *dataOnP1, const DataArrayDouble *dataOnP2);
 102   public:
 103     static void ApplyFactorsOnCompactFrmt(std::vector< std::pair<int,int> >& partBeforeFact, const std::vector<int>& factors);
 104     static void ApplyAllGhostOnCompactFrmt(std::vector< std::pair<int,int> >& partBeforeFact, int ghostSize);
 105   private:
 106     MEDCouplingCartesianAMRPatch(const MEDCouplingCartesianAMRPatch& other, MEDCouplingCartesianAMRMeshGen *father);
 107   private:
 108     //! bottom left/top right cell range relative to \a _father
 109     std::vector< std::pair<int,int> > _bl_tr;
 110   };
 111
 112   /*!
 113    * This class does not inherit from TimeLabel so only const method should exist.
 114    */
 115   class MEDCouplingCartesianAMRPatchGF : public MEDCouplingCartesianAMRPatchGen
 116   {
 117   public:
 118     MEDCouplingCartesianAMRPatchGF(MEDCouplingCartesianAMRMesh *mesh);
 119     MEDCouplingCartesianAMRPatchGF *deepCopy(MEDCouplingCartesianAMRMeshGen *father) const;
 120   private:
 121     std::size_t getHeapMemorySizeWithoutChildren() const;
 122   private:
 123     MEDCouplingCartesianAMRPatchGF(const MEDCouplingCartesianAMRPatchGF& other, MEDCouplingCartesianAMRMeshGen *father);
 124   };
 125
 126   /// @endcond
 127
 128   /*!
 129    * This class is the base class dedicated to AMR using Adaptative Hierarchical Overlapped image Grid.
 130    * This class does \b NOT inherit from MEDCouplingMesh because this class overlaps image grid structured meshes to perform adaptative mesh refinement.
 131    * But this class aggregates MEDCouplingMesh instances !
 132    */
 133   class MEDCouplingCartesianAMRMeshGen : public RefCountObject, public TimeLabel
 134   {
 135   public:
 136     MEDCOUPLING_EXPORT virtual MEDCouplingCartesianAMRMeshGen *deepCopy(MEDCouplingCartesianAMRMeshGen *father) const = 0;
 137     MEDCOUPLING_EXPORT int getSpaceDimension() const;
 138     MEDCOUPLING_EXPORT const std::vector<int>& getFactors() const { return _factors; }
 139     MEDCOUPLING_EXPORT void setFactors(const std::vector<int>& newFactors);
 140     MEDCOUPLING_EXPORT int getMaxNumberOfLevelsRelativeToThis() const;
 141     MEDCOUPLING_EXPORT int getNumberOfCellsAtCurrentLevel() const;
 142     MEDCOUPLING_EXPORT int getNumberOfCellsAtCurrentLevelGhost(int ghostLev) const;
 143     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithOverlap() const;
 144     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithoutOverlap() const;
 145     MEDCOUPLING_EXPORT const MEDCouplingIMesh *getImageMesh() const { return _mesh; }
 146     //
 147     MEDCOUPLING_EXPORT virtual const MEDCouplingCartesianAMRMeshGen *getFather() const = 0;
 148     MEDCOUPLING_EXPORT virtual const MEDCouplingCartesianAMRMeshGen *getGodFather() const = 0;
 149     MEDCOUPLING_EXPORT virtual int getAbsoluteLevel() const = 0;
 150     MEDCOUPLING_EXPORT virtual void detachFromFather() = 0;
 151     MEDCOUPLING_EXPORT virtual std::vector< std::pair<int,int> > positionRelativeToGodFather(std::vector<int>& st) const = 0;
 152     MEDCOUPLING_EXPORT virtual int getAbsoluteLevelRelativeTo(const MEDCouplingCartesianAMRMeshGen *ref) const = 0;
 153     MEDCOUPLING_EXPORT std::vector<int> getPositionRelativeTo(const MEDCouplingCartesianAMRMeshGen *ref) const;
 154     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRPatch *getPatchAtPosition(const std::vector<int>& pos) const;
 155     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getMeshAtPosition(const std::vector<int>& pos) const;
 156     MEDCOUPLING_EXPORT virtual std::vector<MEDCouplingCartesianAMRPatchGen *> retrieveGridsAt(int absoluteLev) const;
 157     MEDCOUPLING_EXPORT void addPatch(const std::vector< std::pair<int,int> >& bottomLeftTopRight, const std::vector<int>& factors);
 158     MEDCOUPLING_EXPORT void removeAllPatches();
 159     MEDCOUPLING_EXPORT void removePatch(int patchId);
 160     MEDCOUPLING_EXPORT int getNumberOfPatches() const;
 161     MEDCOUPLING_EXPORT void createPatchesFromCriterion(const INTERP_KERNEL::BoxSplittingOptions& bso, const std::vector<bool>& criterion, const std::vector<int>& factors);
 162     MEDCOUPLING_EXPORT void createPatchesFromCriterion(const INTERP_KERNEL::BoxSplittingOptions& bso, const DataArrayByte *criterion, const std::vector<int>& factors);
 163     MEDCOUPLING_EXPORT void createPatchesFromCriterion(const INTERP_KERNEL::BoxSplittingOptions& bso, const DataArrayDouble *criterion, const std::vector<int>& factors, double eps);
 164     MEDCOUPLING_EXPORT int getPatchIdFromChildMesh(const MEDCouplingCartesianAMRMeshGen *mesh) const;
 165     MEDCOUPLING_EXPORT std::vector< const MEDCouplingCartesianAMRPatch *> getPatches() const;
 166     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRPatch *getPatch(int patchId) const;
 167     MEDCOUPLING_EXPORT bool isPatchInNeighborhoodOf(int patchId1, int patchId2, int ghostLev) const;
 168     MEDCOUPLING_EXPORT DataArrayDouble *createCellFieldOnPatch(int patchId, const DataArrayDouble *cellFieldOnThis) const;
 169     // coarse to fine
 170     MEDCOUPLING_EXPORT void fillCellFieldOnPatch(int patchId, const DataArrayDouble *cellFieldOnThis, DataArrayDouble *cellFieldOnPatch, bool isConservative=true) const;
 171     MEDCOUPLING_EXPORT void fillCellFieldOnPatchGhost(int patchId, const DataArrayDouble *cellFieldOnThis, DataArrayDouble *cellFieldOnPatch, int ghostLev, bool isConservative=true) const;
 172     MEDCOUPLING_EXPORT void fillCellFieldOnPatchOnlyOnGhostZone(int patchId, const DataArrayDouble *cellFieldOnThis, DataArrayDouble *cellFieldOnPatch, int ghostLev) const;
 173     // coarse to fine + fine to fine
 174     MEDCOUPLING_EXPORT void fillCellFieldOnPatchGhostAdv(int patchId, const DataArrayDouble *cellFieldOnThis, int ghostLev, const std::vector<const DataArrayDouble *>& arrsOnPatches, bool isConservative=true) const;
 175     // fine to fine
 176     MEDCOUPLING_EXPORT void fillCellFieldOnPatchOnlyGhostAdv(int patchId, int ghostLev, const std::vector<const DataArrayDouble *>& arrsOnPatches) const;
 177     MEDCOUPLING_EXPORT void fillCellFieldOnPatchOnlyOnGhostZoneWith(int ghostLev, const MEDCouplingCartesianAMRPatch *patchToBeModified, const MEDCouplingCartesianAMRPatch *neighborPatch, DataArrayDouble *cellFieldOnPatch, const DataArrayDouble *cellFieldNeighbor) const;
 178     // fine to coarse
 179     MEDCOUPLING_EXPORT void fillCellFieldComingFromPatch(int patchId, const DataArrayDouble *cellFieldOnPatch, DataArrayDouble *cellFieldOnThis, bool isConservative=true) const;
 180     MEDCOUPLING_EXPORT void fillCellFieldComingFromPatchGhost(int patchId, const DataArrayDouble *cellFieldOnPatch, DataArrayDouble *cellFieldOnThis, int ghostLev, bool isConservative=true) const;
 181     //
 182     MEDCOUPLING_EXPORT DataArrayInt *findPatchesInTheNeighborhoodOf(int patchId, int ghostLev) const;
 183     //
 184     MEDCOUPLING_EXPORT MEDCouplingUMesh *buildUnstructured() const;
 185     MEDCOUPLING_EXPORT MEDCoupling1SGTUMesh *buildMeshFromPatchEnvelop() const;
 186     MEDCOUPLING_EXPORT MEDCoupling1SGTUMesh *buildMeshOfDirectChildrenOnly() const;
 187     MEDCOUPLING_EXPORT MEDCouplingFieldDouble *buildCellFieldOnRecurseWithoutOverlapWithoutGhost(int ghostSz, const std::vector<const DataArrayDouble *>& recurseArrs) const;
 188     MEDCOUPLING_EXPORT DataArrayDouble *extractGhostFrom(int ghostSz, const DataArrayDouble *arr) const;
 189     MEDCOUPLING_EXPORT std::vector<int> getPatchIdsInTheNeighborhoodOf(int patchId, int ghostLev) const;
 190     MEDCOUPLING_EXPORT std::string buildPythonDumpOfThis() const;
 191   protected:
 192     MEDCouplingCartesianAMRMeshGen(const MEDCouplingCartesianAMRMeshGen& other);
 193     MEDCouplingCartesianAMRMeshGen(const std::string& meshName, int spaceDim, const int *nodeStrctStart, const int *nodeStrctStop,
 194                                    const double *originStart, const double *originStop, const double *dxyzStart, const double *dxyzStop);
 195     MEDCouplingCartesianAMRMeshGen(MEDCouplingIMesh *mesh);
 196     void checkPatchId(int patchId) const;
 197     void checkFactorsAndIfNotSetAssign(const std::vector<int>& factors);
 198     void retrieveGridsAtInternal(int lev, std::vector< MCAuto<MEDCouplingCartesianAMRPatchGen> >& grids) const;
 199     static int GetGhostLevelInFineRef(int ghostLev, const std::vector<int>& factors);
 200     std::vector<const DataArrayDouble *> extractSubTreeFromGlobalFlatten(const MEDCouplingCartesianAMRMeshGen *head, const std::vector<const DataArrayDouble *>& all) const;
 201     void dumpPatchesOf(const std::string& varName, std::ostream& oss) const;
 202   public:
 203     virtual void getPositionRelativeToInternal(const MEDCouplingCartesianAMRMeshGen *ref, std::vector<int>& ret) const = 0;
 204   protected:
 205     MEDCOUPLING_EXPORT std::size_t getHeapMemorySizeWithoutChildren() const;
 206     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const;
 207     MEDCOUPLING_EXPORT void updateTime() const;
 208   protected:
 209     MCAuto<MEDCouplingIMesh> _mesh;
 210     std::vector< MCAuto<MEDCouplingCartesianAMRPatch> > _patches;
 211     std::vector<int> _factors;
 212   };
 213
 214   class MEDCouplingCartesianAMRMeshSub : public MEDCouplingCartesianAMRMeshGen
 215   {
 216   public:
 217     MEDCouplingCartesianAMRMeshSub(MEDCouplingCartesianAMRMeshGen *father, MEDCouplingIMesh *mesh);
 218     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getFather() const;
 219     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getGodFather() const;
 220     MEDCOUPLING_EXPORT int getAbsoluteLevel() const;
 221     MEDCOUPLING_EXPORT void detachFromFather();
 222     MEDCOUPLING_EXPORT std::vector< std::pair<int,int> > positionRelativeToGodFather(std::vector<int>& st) const;
 223     MEDCOUPLING_EXPORT int getAbsoluteLevelRelativeTo(const MEDCouplingCartesianAMRMeshGen *ref) const;
 224   private:
 225     MEDCouplingCartesianAMRMeshSub(const MEDCouplingCartesianAMRMeshSub& other, MEDCouplingCartesianAMRMeshGen *father);
 226     MEDCouplingCartesianAMRMeshSub *deepCopy(MEDCouplingCartesianAMRMeshGen *father) const;
 227     void getPositionRelativeToInternal(const MEDCouplingCartesianAMRMeshGen *ref, std::vector<int>& ret) const;
 228   protected:
 229     MEDCouplingCartesianAMRMeshGen *_father;
 230   };
 231
 232   class MEDCouplingCartesianAMRMesh : public MEDCouplingCartesianAMRMeshGen
 233   {
 234   public:
 235     MEDCOUPLING_EXPORT static MEDCouplingCartesianAMRMesh *New(const std::string& meshName, int spaceDim, const int *nodeStrctStart, const int *nodeStrctStop,
 236                                                                const double *originStart, const double *originStop, const double *dxyzStart, const double *dxyzStop);
 237     MEDCOUPLING_EXPORT static MEDCouplingCartesianAMRMesh *New(MEDCouplingIMesh *mesh);
 238     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getFather() const;
 239     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getGodFather() const;
 240     MEDCOUPLING_EXPORT int getAbsoluteLevel() const;
 241     MEDCOUPLING_EXPORT void detachFromFather();
 242     MEDCOUPLING_EXPORT std::vector< std::pair<int,int> > positionRelativeToGodFather(std::vector<int>& st) const;
 243     MEDCOUPLING_EXPORT int getAbsoluteLevelRelativeTo(const MEDCouplingCartesianAMRMeshGen *ref) const;
 244     MEDCOUPLING_EXPORT std::vector<MEDCouplingCartesianAMRPatchGen *> retrieveGridsAt(int absoluteLev) const;
 245     MEDCouplingCartesianAMRMesh *deepCopy(MEDCouplingCartesianAMRMeshGen *father) const;
 246     MEDCOUPLING_EXPORT void createPatchesFromCriterionML(const std::vector<const INTERP_KERNEL::BoxSplittingOptions *>& bso, const DataArrayDouble *criterion, const std::vector< std::vector<int> >& factors, double eps);
 247   private:
 248     void getPositionRelativeToInternal(const MEDCouplingCartesianAMRMeshGen *ref, std::vector<int>& ret) const;
 249     MEDCouplingCartesianAMRMesh(const MEDCouplingCartesianAMRMesh& other);
 250     MEDCouplingCartesianAMRMesh(const std::string& meshName, int spaceDim, const int *nodeStrctStart, const int *nodeStrctStop,
 251                                 const double *originStart, const double *originStop, const double *dxyzStart, const double *dxyzStop);
 252     MEDCouplingCartesianAMRMesh(MEDCouplingIMesh *mesh);
 253     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const;
 254     ~MEDCouplingCartesianAMRMesh();
 255   };
 256 }
 257
 258 #endif
 259