This file is indexed.

/usr/include/deal.II/dofs/dof_objects.h is in libdeal.ii-dev 6.3.1-1.1.

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
//---------------------------------------------------------------------------
//    $Id: dof_objects.h 17866 2008-12-05 22:27:44Z bangerth $
//    Version: $Name$
//
//    Copyright (C) 2006 by the deal.II authors
//
//    This file is subject to QPL and may not be  distributed
//    without copyright and license information. Please refer
//    to the file deal.II/doc/license.html for the  text  and
//    further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__dof_objects_h
#define __deal2__dof_objects_h


#include <base/config.h>
#include <base/exceptions.h>
#include <vector>

DEAL_II_NAMESPACE_OPEN

template <int, int> class DoFHandler;

namespace internal
{
  namespace DoFHandler
  {
    template <int> class DoFLevel;
    template <int> class DoFFaces;
    

/**
 * Store the indices of the degrees of freedom which are located on
 * objects of dimension @p dim. 
 *
 * <h3>Information for all DoFObjects classes</h3>
 *
 * The DoFObjects classes store the global indices of the
 * degrees of freedom for each cell on a certain level. The global
 * index or number of a degree of freedom is the zero-based index of
 * the according value in the solution vector and the row and column
 * index in the global matrix or the multigrid matrix for this
 * level. These indices refer to the unconstrained vectors and
 * matrices, where we have not taken account of the constraints
 * introduced by hanging nodes.
 *
 * Since vertices are not associated with a particular level, the
 * indices associated with vertices are not stored in the DoFObjects
 * classes but rather in the DoFHandler::vertex_dofs array.
 *
 * The DoFObjects classes are not used directly, but objects
 * of theses classes are included in the DoFLevel and
 * DoFFaces classes.
 *
 * @ingroup dofs
 * @author Tobias Leicht, 2006
 */
    template <int dim>
    class DoFObjects
    {
      public:
                                         /**
                                          * Store the global indices of
                                          * the degrees of freedom.
                                          */
        std::vector<unsigned int> dofs;

      public:
                                         /**
                                          * Set the global index of
                                          * the @p local_index-th
                                          * degree of freedom located
                                          * on the object with number @p
                                          * obj_index to the value
                                          * given by the last
                                          * argument. The @p
                                          * dof_handler argument is
                                          * used to access the finite
                                          * element that is to be used
                                          * to compute the location
                                          * where this data is stored.
                                          *
                                          * The third argument, @p
                                          * fe_index, must equal
                                          * zero. It is otherwise
                                          * unused, but we retain the
                                          * argument so that we can
                                          * use the same interface for
                                          * non-hp and hp finite
                                          * element methods, in effect
                                          * making it possible to
                                          * share the DoFAccessor
                                          * class hierarchy between hp
                                          * and non-hp classes.
                                          */
	template <int dh_dim, int spacedim>
        void
        set_dof_index (const dealii::DoFHandler<dh_dim,spacedim> &dof_handler,
		       const unsigned int       obj_index,
		       const unsigned int       fe_index,
		       const unsigned int       local_index,
		       const unsigned int       global_index);

                                         /**
                                          * Return the global index of
                                          * the @p local_index-th
                                          * degree of freedom located
                                          * on the object with number @p
                                          * obj_index. The @p
                                          * dof_handler argument is
                                          * used to access the finite
                                          * element that is to be used
                                          * to compute the location
                                          * where this data is stored.
                                          *
                                          * The third argument, @p
                                          * fe_index, must equal
                                          * zero. It is otherwise
                                          * unused, but we retain the
                                          * argument so that we can
                                          * use the same interface for
                                          * non-hp and hp finite
                                          * element methods, in effect
                                          * making it possible to
                                          * share the DoFAccessor
                                          * class hierarchy between hp
                                          * and non-hp classes.
                                          */
	template <int dh_dim, int spacedim>
	unsigned int
        get_dof_index (const dealii::DoFHandler<dh_dim,spacedim> &dof_handler,
		       const unsigned int       obj_index,
		       const unsigned int       fe_index,
		       const unsigned int       local_index) const;

                                         /**
                                          * Return the value 1. The
                                          * meaning of this function
                                          * becomes clear by looking
                                          * at what the corresponding
                                          * functions in the classes
                                          * internal::hp::DoFObjects 
                                          */
        template <int dh_dim, int spacedim>
        unsigned int
        n_active_fe_indices (const dealii::DoFHandler<dh_dim,spacedim> &dof_handler,
                             const unsigned int       index) const;

                                         /**
                                          * Similar to the function
                                          * above. Assert that the
                                          * given index is zero, and
                                          * then return true.
                                          */
        template <int dh_dim, int spacedim>
        bool
        fe_index_is_active (const dealii::DoFHandler<dh_dim,spacedim> &dof_handler,
                            const unsigned int       index,
                            const unsigned int       fe_index) const;

                                         /**
                                          * Determine an estimate for the
                                          * memory consumption (in bytes)
                                          * of this object.
                                          */
        unsigned int memory_consumption () const;
	
                                         /**
                                          * Make the DoFHandler and
                                          * MGDoFHandler classes a
                                          * friend, so that they can
                                          * resize arrays as
                                          * necessary.
                                          */
	template <int> friend class DoFLevel;
	template <int> friend class DoFFaces;	
    };


// --------------------- template and inline functions ------------------

    template <int dim>
    template <int dh_dim, int spacedim>
    inline
    unsigned int
    DoFObjects<dim>::n_active_fe_indices (const dealii::DoFHandler<dh_dim,spacedim> &,
					  const unsigned) const
    {
      return 1;
    }
    

    
    template <int dim>
    template <int dh_dim, int spacedim>
    inline
    bool
    DoFObjects<dim>::fe_index_is_active (const dealii::DoFHandler<dh_dim,spacedim> &,
					 const unsigned int,
					 const unsigned int fe_index) const
    {
      Assert (fe_index == 0,
              ExcMessage ("Only zero fe_index values are allowed for "
                          "non-hp DoFHandlers."));
      return true;
    }

    

    template <int dim>
    template <int dh_dim, int spacedim>
    inline
    unsigned int
    DoFObjects<dim>::
    get_dof_index (const dealii::DoFHandler<dh_dim,spacedim> &dof_handler,
		   const unsigned int       obj_index,
		   const unsigned int       fe_index,
		   const unsigned int       local_index) const
    {
      Assert ((fe_index == dealii::DoFHandler<dh_dim,spacedim>::default_fe_index),
	      ExcMessage ("Only the default FE index is allowed for non-hp DoFHandler objects"));
      Assert (local_index<dof_handler.get_fe().template n_dofs_per_object<dim>(),
	      ExcIndexRange (local_index, 0, dof_handler.get_fe().template n_dofs_per_object<dim>()));
      Assert (obj_index * dof_handler.get_fe().template n_dofs_per_object<dim>()+local_index
	      <
	      dofs.size(),
	      ExcInternalError());
      
      return dofs[obj_index * dof_handler.get_fe()
                  .template n_dofs_per_object<dim>() + local_index];
    }    

  }
}

DEAL_II_NAMESPACE_CLOSE

#endif