/usr/include/deal.II/fe/fe_update_flags.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 340 341 342 343 344 345 346 347 348 349 350 351 352 | // ---------------------------------------------------------------------
// $Id: fe_update_flags.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__fe_update_flags_h
#define __deal2__fe_update_flags_h
#include <deal.II/base/config.h>
DEAL_II_NAMESPACE_OPEN
/*!@addtogroup feaccess */
/*@{*/
/**
* The enum type given to the constructors of FEValues, FEFaceValues
* and FESubfaceValues, telling those objects which data will be
* needed on each mesh cell.
*
* Selecting these flags in a restrictive way is crucial for the
* efficiency of FEValues::reinit(), FEFaceValues::reinit() and
* FESubfaceValues::reinit(). Therefore, only the flags actually
* needed should be selected. It is the responsibility of the involved
* Mapping and FiniteElement to add additional flags according to
* their own requirements. For instance, most finite elements will
* add #update_covariant_transformation if #update_gradients is
* selected.
* By default, all flags are off, i.e. no reinitialization will be
* done.
*
* You can select more than one flag by concatenation
* using the bitwise or operator|(UpdateFlags,UpdateFlags).
*
* <h3>Generating the actual flags</h3>
*
* When given a set of UpdateFlags @p flags, the FEValues object must
* determine, which values will have to be computed once only for the
* reference cell and which values will have to be updated for each
* cell. Here, it is important to note that in many cases, the
* FiniteElement will require additional updates from the Mapping. To
* this end, several auxiliary functions have been implemented:
*
* FiniteElement::update_once(flags) and
* FiniteElement::update_each(flags) determine the values required by
* the FiniteElement once or on each cell. The same functions exist in Mapping.
*
* Since the FiniteElement does not know if a value required from
* Mapping should be computed once or for each cell,
* FEValuesBase::compute_update_flags() is used to compute the union
* of all values to be computed ever. It does this by first adding to
* the flags set by the user all flags (once and each) added by the
* FiniteElement. This new set of flags is then given to the Mapping
* and all flags required there are added, again once and each.
*
* This union of all flags is given to Mapping::fill_fe_values() and
* FiniteElement::fill_fe_values, where it is split again into the
* information generated only once and the information that must be
* updated on each cell.
*
* The flags finally stored in FEValues then are the union of all the
* flags required by the user, by FiniteElement and by Mapping, for
* computation once or on each cell. Subsequent calls to the functions
* @p update_once and @p update_each should just select among these
* flags, but should not add new flags.
*
* The mechanism by which all this is accomplished is also discussed
* on the page on @ref UpdateFlagsEssay.
*/
enum UpdateFlags
{
//! No update
update_default = 0,
//! Shape function values
/**
* Compute the values of the shape functions at the quadrature points on
* the real space cell. For the usual Lagrange elements, these values are
* equal to the values of the shape functions at the quadrature points on
* the unit cell, but they are different for more complicated elements,
* such as FE_RaviartThomas elements.
*/
update_values = 0x0001,
//! Shape function gradients
/**
* Compute the gradients of the shape functions in coordinates of the
* real cell.
*/
update_gradients = 0x0002,
//! Second derivatives of shape functions
/**
* Compute the second derivatives of the shape functions in coordinates
* of the real cell.
*/
update_hessians = 0x0004,
//! Outer normal vector, not normalized
/**
* Vector product of tangential vectors, yielding a normal vector with
* a length corresponding to the surface element; may be more efficient
* than computing both.
*/
update_boundary_forms = 0x0008,
//! Transformed quadrature points
/**
* Compute the quadrature points transformed into real cell coordinates.
*/
update_quadrature_points = 0x0010,
//! Transformed quadrature weights
/**
* Compute the quadrature weights on the real cell, i.e. the weights
* of the quadrature rule multiplied with the determinant of the Jacoian
* of the transformation from reference to realcell.
*/
update_JxW_values = 0x0020,
//! Normal vectors
/**
* Compute the normal vectors, either for a face or for a cell of
* codimension one. Setting this flag for any other object will raise
* an error.
*/
update_normal_vectors = 0x0040,
/**
* @deprecated Use #update_normal_vectors
*/
update_face_normal_vectors = update_normal_vectors,
/**
* @deprecated Use #update_normal_vectors
*/
update_cell_normal_vectors = update_normal_vectors,
//! Volume element
/**
* Compute the Jacobian of the transformation from the reference cell
* to the real cell.
*/
update_jacobians = 0x0080,
//! Gradient of volume element
/**
* Compute the dervatives of the Jacobian of the transformation.
*/
update_jacobian_grads = 0x0100,
//! Volume element
/**
* Compute the inverse Jacobian of the transformation from the reference
* cell to the real cell.
*/
update_inverse_jacobians = 0x0200,
//! Covariant transformation
/**
* Compute all values the Mapping needs to perform a contravariant
* transformation of vectors. For special mappings like MappingCartesian
* this may be simpler than #update_inverse_jacobians.
*/
update_covariant_transformation = 0x0400,
//! Contravariant transformation
/**
* Compute all values the Mapping needs to perform a contravariant
* transformation of vectors. For special mappings like MappingCartesian
* this may be simpler than #update_jacobians.
*/
update_contravariant_transformation = 0x0800,
//! Shape function values of transformation
/**
* Compute the shape function values of the transformation defined by
* the Mapping.
*/
update_transformation_values = 0x1000,
//! Shape function gradients of transformation
/**
* Compute the shape function gradients of the transformation defined
* by the Mapping.
*/
update_transformation_gradients = 0x2000,
//! Determinant of the Jacobian
/**
* Compute the volume element in each quadrature point.
*/
update_volume_elements = 0x4000,
/**
* @deprecated: this flag has no effect.
*/
update_support_points = 0x10000,
/**
* Update the Jacobian of the mapping in generalized support points.
*/
update_support_jacobians = 0x20000,
/**
* Update the inverse Jacobian of the mapping in generalized support
* points.
*/
update_support_inverse_jacobians = 0x40000,
/**
* @deprecated Update quadrature points
*/
update_q_points = update_quadrature_points,
/**
* @deprecated Update second derivatives.
*/
update_second_derivatives = update_hessians,
//! Values needed for Piola transform
/**
* Combination of the flags needed for Piola transform of Hdiv elements.
*/
update_piola = update_volume_elements | update_contravariant_transformation
};
/**
* Output operator which outputs update flags as a set of or'd text values.
*
* @ref UpdateFlags
*/
template <class STREAM>
inline
STREAM &operator << (STREAM &s, UpdateFlags u)
{
s << " UpdateFlags|";
if (u & update_values) s << "values|";
if (u & update_gradients) s << "gradients|";
if (u & update_hessians) s << "hessians|";
if (u & update_quadrature_points) s << "quadrature_points|";
if (u & update_JxW_values) s << "JxW_values|";
if (u & update_normal_vectors) s << "normal_vectors|";
if (u & update_jacobians) s << "jacobians|";
if (u & update_inverse_jacobians) s << "inverse_jacobians|";
if (u & update_jacobian_grads) s << "jacobian_grads|";
if (u & update_covariant_transformation) s << "covariant_transformation|";
if (u & update_contravariant_transformation) s << "contravariant_transformation|";
if (u & update_transformation_values) s << "transformation_values|";
if (u & update_transformation_gradients) s << "transformation_gradients|";
if (u & update_support_points) s << "support_points|";
if (u & update_support_jacobians) s << "support_jacobians|";
if (u & update_support_inverse_jacobians) s << "support_inverse_jacobians|";
//TODO: check that 'u' really only has the flags set that are handled above
return s;
}
/**
* Global operator which returns an object in which all bits are set
* which are either set in the first or the second argument. This
* operator exists since if it did not then the result of the bit-or
* <tt>operator |</tt> would be an integer which would in turn trigger
* a compiler warning when we tried to assign it to an object of type
* UpdateFlags.
*
* @ref UpdateFlags
*/
inline
UpdateFlags
operator | (UpdateFlags f1, UpdateFlags f2)
{
return static_cast<UpdateFlags> (
static_cast<unsigned int> (f1) |
static_cast<unsigned int> (f2));
}
/**
* Global operator which sets the bits from the second argument also
* in the first one.
*
* @ref UpdateFlags
*/
inline
UpdateFlags &
operator |= (UpdateFlags &f1, UpdateFlags f2)
{
f1 = f1 | f2;
return f1;
}
/**
* Global operator which returns an object in which all bits are set
* which are set in the first as well as the second argument. This
* operator exists since if it did not then the result of the bit-and
* <tt>operator &</tt> would be an integer which would in turn trigger
* a compiler warning when we tried to assign it to an object of type
* UpdateFlags.
*
* @ref UpdateFlags
*/
inline
UpdateFlags
operator & (UpdateFlags f1, UpdateFlags f2)
{
return static_cast<UpdateFlags> (
static_cast<unsigned int> (f1) &
static_cast<unsigned int> (f2));
}
/**
* Global operator which clears all the bits in the first argument if
* they are not also set in the second argument.
*
* @ref UpdateFlags
*/
inline
UpdateFlags &
operator &= (UpdateFlags &f1, UpdateFlags f2)
{
f1 = f1 & f2;
return f1;
}
/**
* This enum definition is used for storing similarities of the current cell
* to the previously visited cell. This information is used for reusing data
* when calling the method FEValues::reinit() (like derivatives, which do
* not change if one cell is just a translation of the previous). Currently,
* this variable does only recognize a translation and an inverted translation
* (if dim<spacedim). However, this concept
* makes it easy to add additional staties to be detected in
* FEValues/FEFaceValues for making use of these similarities as well.
*/
namespace CellSimilarity
{
enum Similarity
{
none,
translation,
inverted_translation,
invalid_next_cell
};
}
/*@}*/
DEAL_II_NAMESPACE_CLOSE
#endif
|