Salome HOME
cf467e235d31fc141d848e3e14b92e05e000bea2
[tools/medcoupling.git] / 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 MEDCouplingCartesianAMRMesh;
41   class MEDCouplingCartesianAMRMeshGen;
42
43   /// @cond INTERNAL
44
45   class MEDCouplingCartesianAMRPatchGen : public RefCountObject
46   {
47   public:
48     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithOverlap() const;
49     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithoutOverlap() const;
50     MEDCOUPLING_EXPORT int getMaxNumberOfLevelsRelativeToThis() const;
51     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getMesh() const { return _mesh; }
52   protected:
53     MEDCouplingCartesianAMRPatchGen(MEDCouplingCartesianAMRMeshGen *mesh);
54   private:
55     std::vector<const BigMemoryObject *> getDirectChildren() const;
56   protected:
57     MEDCouplingAutoRefCountObjectPtr<MEDCouplingCartesianAMRMeshGen> _mesh;
58   };
59
60   class MEDCouplingCartesianAMRPatch : public MEDCouplingCartesianAMRPatchGen
61   {
62   public:
63     MEDCouplingCartesianAMRPatch(MEDCouplingCartesianAMRMeshGen *mesh, const std::vector< std::pair<int,int> >& bottomLeftTopRight);
64     // direct forward to _mesh
65     MEDCOUPLING_EXPORT void addPatch(const std::vector< std::pair<int,int> >& bottomLeftTopRight, const std::vector<int>& factors);
66     // end of direct forward to _mesh
67     MEDCOUPLING_EXPORT int getNumberOfOverlapedCellsForFather() const;
68     MEDCOUPLING_EXPORT bool isInMyNeighborhood(const MEDCouplingCartesianAMRPatch *other, int ghostLev) const;
69     // basic set/get
70     MEDCOUPLING_EXPORT const std::vector< std::pair<int,int> >& getBLTRRange() const { return _bl_tr; }
71   private:
72     std::size_t getHeapMemorySizeWithoutChildren() const;
73   private:
74     //! bottom left/top right cell range relative to \a _father
75     std::vector< std::pair<int,int> > _bl_tr;
76   };
77
78   class MEDCouplingCartesianAMRPatchGF : public MEDCouplingCartesianAMRPatchGen
79   {
80   public:
81     MEDCouplingCartesianAMRPatchGF(MEDCouplingCartesianAMRMesh *mesh);
82   private:
83     std::size_t getHeapMemorySizeWithoutChildren() const;
84   };
85
86   class MEDCouplingGodFatherData : public RefCountObject
87   {
88   };
89   /// @endcond
90
91   /*!
92    * This class is the base class dedicated to AMR using Adaptative Hierarchical Overlapped image Grid.
93    * This class does \b NOT inherit from MEDCouplingMesh because this class overlaps image grid structured meshes to perform adaptative mesh refinement.
94    * But this class aggregates MEDCouplingMesh instances !
95    */
96   class MEDCouplingCartesianAMRMeshGen : public RefCountObject, public TimeLabel
97   {
98   public:
99     MEDCOUPLING_EXPORT int getSpaceDimension() const;
100     MEDCOUPLING_EXPORT const std::vector<int>& getFactors() const { return _factors; }
101     MEDCOUPLING_EXPORT void setFactors(const std::vector<int>& newFactors);
102     MEDCOUPLING_EXPORT int getMaxNumberOfLevelsRelativeToThis() const;
103     MEDCOUPLING_EXPORT int getNumberOfCellsAtCurrentLevel() const;
104     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithOverlap() const;
105     MEDCOUPLING_EXPORT int getNumberOfCellsRecursiveWithoutOverlap() const;
106     MEDCOUPLING_EXPORT const MEDCouplingIMesh *getImageMesh() const { return _mesh; }
107     //
108     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getFather() const;
109     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRMeshGen *getGodFather() const;
110     MEDCOUPLING_EXPORT int getAbsoluteLevel() const;
111     MEDCOUPLING_EXPORT std::vector<MEDCouplingCartesianAMRPatchGen *> retrieveGridsAt(int absoluteLev) const;
112     MEDCOUPLING_EXPORT void detachFromFather();
113     MEDCOUPLING_EXPORT void addPatch(const std::vector< std::pair<int,int> >& bottomLeftTopRight, const std::vector<int>& factors);
114     MEDCOUPLING_EXPORT void createPatchesFromCriterion(const INTERP_KERNEL::BoxSplittingOptions& bso, const std::vector<bool>& criterion, const std::vector<int>& factors);
115     MEDCOUPLING_EXPORT void createPatchesFromCriterion(const INTERP_KERNEL::BoxSplittingOptions& bso, const DataArrayByte *criterion, const std::vector<int>& factors);
116     MEDCOUPLING_EXPORT void removeAllPatches();
117     MEDCOUPLING_EXPORT void removePatch(int patchId);
118     MEDCOUPLING_EXPORT int getNumberOfPatches() const;
119     MEDCOUPLING_EXPORT const MEDCouplingCartesianAMRPatch *getPatch(int patchId) const;
120     MEDCOUPLING_EXPORT bool isPatchInNeighborhoodOf(int patchId1, int patchId2, int ghostLev) const;
121     MEDCOUPLING_EXPORT DataArrayDouble *createCellFieldOnPatch(int patchId, const DataArrayDouble *cellFieldOnThis) const;
122     MEDCOUPLING_EXPORT void fillCellFieldOnPatch(int patchId, const DataArrayDouble *cellFieldOnThis, DataArrayDouble *cellFieldOnPatch) const;
123     MEDCOUPLING_EXPORT void fillCellFieldOnPatchGhost(int patchId, const DataArrayDouble *cellFieldOnThis, DataArrayDouble *cellFieldOnPatch, int ghostLev) const;
124     MEDCOUPLING_EXPORT void fillCellFieldOnPatchGhostAdv(int patchId, const DataArrayDouble *cellFieldOnThis, int ghostLev, const std::vector<const DataArrayDouble *>& arrsOnPatches) const;
125     MEDCOUPLING_EXPORT void fillCellFieldComingFromPatch(int patchId, const DataArrayDouble *cellFieldOnPatch, DataArrayDouble *cellFieldOnThis) const;
126     MEDCOUPLING_EXPORT void fillCellFieldComingFromPatchGhost(int patchId, const DataArrayDouble *cellFieldOnPatch, DataArrayDouble *cellFieldOnThis, int ghostLev) const;
127     MEDCOUPLING_EXPORT DataArrayInt *findPatchesInTheNeighborhoodOf(int patchId, int ghostLev) const;
128     //
129     MEDCOUPLING_EXPORT MEDCouplingUMesh *buildUnstructured() const;
130     MEDCOUPLING_EXPORT MEDCoupling1SGTUMesh *buildMeshFromPatchEnvelop() const;
131     MEDCOUPLING_EXPORT MEDCoupling1SGTUMesh *buildMeshOfDirectChildrenOnly() const;
132   protected:
133     MEDCouplingCartesianAMRMeshGen(const std::string& meshName, int spaceDim, const int *nodeStrctStart, const int *nodeStrctStop,
134                                    const double *originStart, const double *originStop, const double *dxyzStart, const double *dxyzStop);
135     MEDCouplingCartesianAMRMeshGen(MEDCouplingCartesianAMRMeshGen *father, MEDCouplingIMesh *mesh);
136     void checkPatchId(int patchId) const;
137     void checkFactorsAndIfNotSetAssign(const std::vector<int>& factors);
138     void retrieveGridsAtInternal(int lev, std::vector< MEDCouplingAutoRefCountObjectPtr<MEDCouplingCartesianAMRPatchGen> >& grids) const;
139     static void ApplyFactorsOnCompactFrmt(std::vector< std::pair<int,int> >& partBeforeFact, const std::vector<int>& factors);
140     static void ApplyGhostOnCompactFrmt(std::vector< std::pair<int,int> >& partBeforeFact, int ghostSize);
141     static void ApplyAllGhostOnCompactFrmt(std::vector< std::pair<int,int> >& partBeforeFact, int ghostSize);
142   protected:
143     MEDCOUPLING_EXPORT std::size_t getHeapMemorySizeWithoutChildren() const;
144     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildren() const;
145     MEDCOUPLING_EXPORT void updateTime() const;
146   private:
147     MEDCouplingCartesianAMRMeshGen *_father;
148     MEDCouplingAutoRefCountObjectPtr<MEDCouplingIMesh> _mesh;
149     std::vector< MEDCouplingAutoRefCountObjectPtr<MEDCouplingCartesianAMRPatch> > _patches;
150     std::vector<int> _factors;
151   };
152
153   class MEDCouplingCartesianAMRMeshSub : public MEDCouplingCartesianAMRMeshGen
154   {
155   public:
156     MEDCouplingCartesianAMRMeshSub(MEDCouplingCartesianAMRMeshGen *father, MEDCouplingIMesh *mesh);
157   };
158
159   class MEDCouplingCartesianAMRMesh : public MEDCouplingCartesianAMRMeshGen
160   {
161   public:
162     MEDCOUPLING_EXPORT static MEDCouplingCartesianAMRMesh *New(const std::string& meshName, int spaceDim, const int *nodeStrctStart, const int *nodeStrctStop,
163                                                                const double *originStart, const double *originStop, const double *dxyzStart, const double *dxyzStop);
164   private:
165     MEDCouplingCartesianAMRMesh(const std::string& meshName, int spaceDim, const int *nodeStrctStart, const int *nodeStrctStop,
166                                 const double *originStart, const double *originStop, const double *dxyzStart, const double *dxyzStop);
167   };
168 }
169
170 #endif
171