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