This file is indexed.

/usr/include/deal.II/grid/tria_levels.h is in libdeal.ii-dev 8.1.0-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
// ---------------------------------------------------------------------
// $Id: tria_levels.h 30036 2013-07-18 16:55:32Z maier $
//
// Copyright (C) 1998 - 2013 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------

#ifndef __deal2__tria_levels_h
#define __deal2__tria_levels_h


#include <deal.II/base/config.h>
#include <vector>
#include <deal.II/grid/tria_object.h>
#include <deal.II/base/point.h>
#include <deal.II/grid/tria_objects.h>

#include <boost/serialization/utility.hpp>

DEAL_II_NAMESPACE_OPEN

namespace internal
{
  namespace Triangulation
  {
    /**
     * Store all information which belongs to one level of the multilevel
     * hierarchy.
     *
     * In TriaLevel, all cell data is stored which is not dependent on the
     * dimension, e.g. a field to store the refinement flag for the cells
     * (what a cell actually is is declared elsewhere), etc. See also
     * TriaObjects for non leveloriented data.
     *
     * There is another field, which may fit in here, namely the
     * material data (for cells) or the boundary indicators (for faces),
     * but since we need for a line or quad either boundary information or
     * material data, we store them with the lines and quads rather than
     * with the common data. Likewise, in 3d, we need boundary indicators
     * for lines and quads (we need to know how to refine a line if the
     * two adjacent faces have different boundary indicators), and
     * material data for cells.
     *
     * @author Wolfgang Bangerth, Guido Kanschat, 1998, 2007
     */
    template <int dim>
    class TriaLevel
    {
    public:
      /**
       *  @p RefinementCase<dim>::Type flags
       *  for the cells to be
       *  refined with or not
       *  (RefinementCase<dim>::no_refinement). The
       *  meaning what a cell is,
       *  is dimension specific,
       *  therefore also the length
       *  of this vector depends on
       *  the dimension: in one
       *  dimension, the length of
       *  this vector equals the
       *  length of the @p lines
       *  vector, in two dimensions
       *  that of the @p quads
       *  vector, etc.
       */
      std::vector<unsigned char> refine_flags;

      /**
       * Same meaning as the one above, but
       * specifies whether a cell must be
       * coarsened.
       */
      std::vector<bool> coarsen_flags;

      /**
       *  Levels and indices of the neighbors
       *  of the cells. Convention is, that the
       *  neighbors of the cell with index @p i
       *  are stored in the fields following
       *  $i*(2*real\_space\_dimension)$, e.g. in
       *  one spatial dimension, the neighbors
       *  of cell 0 are stored in <tt>neighbors[0]</tt>
       *  and <tt>neighbors[1]</tt>, the neighbors of
       *  cell 1 are stored in <tt>neighbors[2]</tt>
       *  and <tt>neighbors[3]</tt>, and so on.
       *
       *  In neighbors, <tt>neighbors[i].first</tt> is
       *  the level, while <tt>neighbors[i].first</tt>
       *  is the index of the neighbor.
       *
       *  If a neighbor does not exist (cell is
       *  at the boundary), <tt>level=index=-1</tt>
       *  is set.
       *
       *  <em>Conventions:</em> The
       *  @p ith neighbor of a cell is
       *  the one which shares the
       *  @p ith face (@p Line in 2D,
       *  @p Quad in 3D) of this cell.
       *
       *  The neighbor of a cell has at most the
       *  same level as this cell, i.e. it may
       *  or may not be refined.
       *
       *  In one dimension, a neighbor may have
       *  any level less or equal the level of
       *  this cell. If it has the same level,
       *  it may be refined an arbitrary number
       *  of times, but the neighbor pointer
       *  still points to the cell on the same
       *  level, while the neighbors of the
       *  childs of the neighbor may point to
       *  this cell or its children.
       *
       *  In two and more dimensions, the
       *  neighbor is either on the same level
       *  and refined (in which case its children
       *  have neighbor pointers to this cell or
       *  its direct children), unrefined on
       *  the same level or one level down (in
       *  which case its neighbor pointer points
       *  to the mother cell of this cell).
       */
      std::vector<std::pair<int,int> > neighbors;

      /**
       * One integer per cell to store
       * which subdomain it belongs
       * to. This field is most often
       * used in parallel computations,
       * where it denotes which
       * processor shall work on the
       * cells with a given subdomain
       * number.
       */
      std::vector<types::subdomain_id> subdomain_ids;

      /**
       * for parallel multigrid
       */
      std::vector<types::subdomain_id> level_subdomain_ids;

      /**
       * One integer for every consecutive
       * pair of cells to store which
       * index their parent has.
       */
      std::vector<int> parents;

      /**
       * One bool per cell to indicate the
       * direction of the normal
       * true:  use orientation from vertex
       * false: revert the orientation. See
       * @ref GlossDirectionFlag .
       *
       * This is only used for
       * codim==1 meshes.
       */
      std::vector<bool> direction_flags;

      /**
       * The object containing the data on lines and
       * related functions
       */
      TriaObjects<TriaObject<dim> > cells;


      /**
       *  Reserve enough space to accommodate
       *  @p total_cells cells on this level.
       *  Since there are no @p used flags on this
       *  level, you have to give the total number
       *  of cells, not only the number of newly
       *  to accommodate ones, like in the
       *  <tt>TriaLevel<N>::reserve_space</tt>
       *  functions, with <tt>N>0</tt>.
       *
       *  Since the
       *  number of neighbors per cell depends
       *  on the dimensions, you have to pass
       *  that additionally.
       */

      void reserve_space (const unsigned int total_cells,
                          const unsigned int dimension,
                          const unsigned int space_dimension);

      /**
       *  Check the memory consistency of the
       *  different containers. Should only be
       *  called with the prepro flag @p DEBUG
       *  set. The function should be called from
       *  the functions of the higher
       *  TriaLevel classes.
       */
      void monitor_memory (const unsigned int true_dimension) const;

      /**
       * Determine an estimate for the
       * memory consumption (in bytes)
       * of this object.
       */
      std::size_t memory_consumption () const;

      /**
       * Read or write the data of this object to or
       * from a stream for the purpose of serialization
       */
      template <class Archive>
      void serialize(Archive &ar,
                     const unsigned int version);

      /**
       *  Exception
       */
      DeclException3 (ExcMemoryWasted,
                      char *, int, int,
                      << "The container " << arg1 << " contains "
                      << arg2 << " elements, but it`s capacity is "
                      << arg3 << ".");
      /**
       *  Exception
       */
      DeclException2 (ExcMemoryInexact,
                      int, int,
                      << "The containers have sizes " << arg1 << " and "
                      << arg2 << ", which is not as expected.");
    };

//TODO: Replace TriaObjectsHex to avoid this specialization

    /**
     * Specialization of TriaLevels for 3D. Since we need TriaObjectsHex
     * instead of TriaObjects. Refer to the documentation of the template
     * for details.
     */
    template<>
    class TriaLevel<3>
    {
    public:
      std::vector<unsigned char> refine_flags;
      std::vector<bool> coarsen_flags;
      std::vector<std::pair<int,int> > neighbors;
      std::vector<types::subdomain_id> subdomain_ids;
      std::vector<types::subdomain_id> level_subdomain_ids;
      std::vector<int> parents;

      // The following is not used
      // since we don't support
      // codim=1 meshes in 3d; only
      // needed to allow
      // compilation
      // TODO[TH]: this is no longer true and might be a bug.
      std::vector<bool> direction_flags;

      TriaObjectsHex cells;


      void reserve_space (const unsigned int total_cells,
                          const unsigned int dimension,
                          const unsigned int space_dimension);
      void monitor_memory (const unsigned int true_dimension) const;
      std::size_t memory_consumption () const;

      /**
       * Read or write the data of this object to or
       * from a stream for the purpose of serialization
       */
      template <class Archive>
      void serialize(Archive &ar,
                     const unsigned int version);

      /**
       *  Exception
       */
      DeclException3 (ExcMemoryWasted,
                      char *, int, int,
                      << "The container " << arg1 << " contains "
                      << arg2 << " elements, but it`s capacity is "
                      << arg3 << ".");
      /**
       *  Exception
       */
      DeclException2 (ExcMemoryInexact,
                      int, int,
                      << "The containers have sizes " << arg1 << " and "
                      << arg2 << ", which is not as expected.");
    };



    template <int dim>
    template <class Archive>
    void TriaLevel<dim>::serialize(Archive &ar,
                                   const unsigned int)
    {
      ar &refine_flags &coarsen_flags;
      ar &neighbors;
      ar &subdomain_ids;
      ar &level_subdomain_ids;
      ar &parents;
      ar &direction_flags;
      ar &cells;
    }



    template <class Archive>
    void TriaLevel<3>::serialize(Archive &ar,
                                 const unsigned int)
    {
      ar &refine_flags &coarsen_flags;
      ar &neighbors;
      ar &subdomain_ids;
      ar &level_subdomain_ids;
      ar &parents;
      ar &direction_flags;
      ar &cells;
    }

  }
}



DEAL_II_NAMESPACE_CLOSE

#endif