/usr/include/dolfin/fem/DofMap.h is in libdolfin-dev 1.4.0+dfsg-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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 | // Copyright (C) 2007-2012 Anders Logg and Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Martin Alnes, 2008
// Modified by Kent-Andre Mardal, 2009
// Modified by Ola Skavhaug, 2009
// Modified by Joachim B Haga, 2012
// Modified by Mikael Mortensen, 2012
// Modified by Jan Blechta, 2013
//
// First added: 2007-03-01
// Last changed: 2013-09-19
#ifndef __DOLFIN_DOF_MAP_H
#define __DOLFIN_DOF_MAP_H
#include <map>
#include <memory>
#include <utility>
#include <vector>
#include <boost/multi_array.hpp>
#include <memory>
#include <boost/unordered_map.hpp>
#include <ufc.h>
#include <dolfin/common/types.h>
#include <dolfin/mesh/Cell.h>
#include "GenericDofMap.h"
namespace dolfin
{
class GenericVector;
class Restriction;
/// This class handles the mapping of degrees of freedom. It builds
/// a dof map based on a ufc::dofmap on a specific mesh. It will
/// reorder the dofs when running in parallel. Sub-dofmaps, both
/// views and copies, are supported.
class DofMap : public GenericDofMap
{
public:
/// Create dof map on mesh (mesh is not stored)
///
/// *Arguments*
/// ufc_dofmap (ufc::dofmap)
/// The ufc::dofmap.
/// mesh (_Mesh_)
/// The mesh.
DofMap(std::shared_ptr<const ufc::dofmap> ufc_dofmap,
const Mesh& mesh);
/// Create a periodic dof map on mesh (mesh is not stored)
///
/// *Arguments*
/// ufc_dofmap (ufc::dofmap)
/// The ufc::dofmap.
/// mesh (_Mesh_)
/// The mesh.
/// conatrained_boundary (_SubDomain_)
/// The subdomain marking the constrained (tied) boudaries.
DofMap(std::shared_ptr<const ufc::dofmap> ufc_dofmap,
const Mesh& mesh,
std::shared_ptr<const SubDomain> constrained_domain);
/// Create restricted dof map on mesh
///
/// *Arguments*
/// ufc_dofmap (ufc::dofmap)
/// The ufc::dofmap.
/// restriction (_Restriction_)
/// The restriction.
DofMap(std::shared_ptr<const ufc::dofmap> ufc_dofmap,
std::shared_ptr<const Restriction> restriction);
private:
// Create a sub-dofmap (a view) from parent_dofmap
DofMap(const DofMap& parent_dofmap,
const std::vector<std::size_t>& component,
const Mesh& mesh);
// Create a collapsed dofmap from parent_dofmap
DofMap(boost::unordered_map<std::size_t, std::size_t>& collapsed_map,
const DofMap& dofmap_view, const Mesh& mesh);
// Copy constructor
DofMap(const DofMap& dofmap);
public:
/// Destructor
~DofMap();
/// True iff dof map is a view into another map
///
/// *Returns*
/// bool
/// True if the dof map is a sub-dof map (a view into
/// another map).
bool is_view() const
{ return _is_view; }
/// True if dof map is restricted
///
/// *Returns*
/// bool
/// True if dof map is restricted
bool is_restricted() const
{ return static_cast<bool>(_restriction); }
/// Return the dimension of the global finite element function
/// space
///
/// *Returns*
/// std::size_t
/// The dimension of the global finite element function space.
std::size_t global_dimension() const;
// FIXME: Rename this function, 'cell_dimension' sounds confusing
/// Return the dimension of the local finite element function
/// space on a cell
///
/// *Arguments*
/// cell_index (std::size_t)
/// Index of cell
///
/// *Returns*
/// std::size_t
/// Dimension of the local finite element function space.
std::size_t cell_dimension(std::size_t cell_index) const;
/// Return the maximum dimension of the local finite element
/// function space
///
/// *Returns*
/// std::size_t
/// Maximum dimension of the local finite element function
/// space.
std::size_t max_cell_dimension() const;
/// Return the number of dofs for a given entity dimension
///
/// *Arguments*
/// dim (std::size_t)
/// Entity dimension
///
/// *Returns*
/// std::size_t
/// Number of dofs associated with given entity dimension
virtual std::size_t num_entity_dofs(std::size_t dim) const;
/// Return the geometric dimension of the coordinates this dof map
/// provides
///
/// *Returns*
/// std::size_t
/// The geometric dimension.
std::size_t geometric_dimension() const;
/// Return number of facet dofs
///
/// *Returns*
/// std::size_t
/// The number of facet dofs.
std::size_t num_facet_dofs() const;
/// Restriction if any. If the dofmap is not restricted, a null
/// pointer is returned.
///
/// *Returns*
/// std::shared_ptr<const Restriction>
// The restriction.
std::shared_ptr<const Restriction> restriction() const;
/// Return the ownership range (dofs in this range are owned by
/// this process)
///
/// *Returns*
/// std::pair<std::size_t, std::size_t>
/// The ownership range.
std::pair<std::size_t, std::size_t> ownership_range() const;
/// Return map from nonlocal dofs that appear in local dof map to
/// owning process
///
/// *Returns*
/// boost::unordered_map<std::size_t, std::size_t>
/// The map from non-local dofs.
const boost::unordered_map<std::size_t, unsigned int>&
off_process_owner() const;
/// Return map from all shared dofs to the sharing processes (not
/// including the current process) that share it.
///
/// *Returns*
/// boost::unordered_map<std::size_t, std::vector<unsigned int> >
/// The map from dofs to list of processes
const boost::unordered_map<std::size_t, std::vector<unsigned int> >&
shared_dofs() const;
/// Return set of processes that share dofs with this process
///
/// *Returns*
/// std::set<std::size_t>
/// The set of processes
const std::set<std::size_t>& neighbours() const;
/// Local-to-global mapping of dofs on a cell
///
/// *Arguments*
/// cell_index (std::size_t)
/// The cell index.
///
/// *Returns*
/// std::vector<dolfin::la_index>
/// Local-to-global mapping of dofs.
const std::vector<dolfin::la_index>& cell_dofs(std::size_t cell_index) const
{
dolfin_assert(cell_index < _dofmap.size());
return _dofmap[cell_index];
}
/// Tabulate local-local facet dofs
///
/// *Arguments*
/// dofs (std::size_t)
/// Degrees of freedom.
/// local_facet (std::size_t)
/// The local facet.
void tabulate_facet_dofs(std::vector<std::size_t>& dofs,
std::size_t local_facet) const;
/// Tabulate local-local mapping of dofs on entity (dim, local_entity)
///
/// *Arguments*
/// dofs (std::size_t)
/// Degrees of freedom.
/// dim (std::size_t)
/// The entity dimension
/// local_entity (std::size_t)
/// The local entity index
void tabulate_entity_dofs(std::vector<std::size_t>& dofs,
std::size_t dim, std::size_t local_entity) const;
/// Tabulate the coordinates of all dofs on a cell (UFC cell
/// version)
///
/// *Arguments*
/// coordinates (boost::multi_array<double, 2>)
/// The coordinates of all dofs on a cell.
/// vertex_coordinates (std::vector<double>)
/// The cell vertex coordinates
/// cell (Cell)
/// The cell.
void tabulate_coordinates(boost::multi_array<double, 2>& coordinates,
const std::vector<double>& vertex_coordinates,
const Cell& cell) const;
/// Tabulate the coordinates of all dofs on this process. This
/// function is typically used by preconditioners that require the
/// spatial coordinates of dofs, for example for re-partitioning or
/// nullspace computations.
///
/// *Arguments*
/// mesh (_Mesh_)
/// The mesh.
///
/// *Returns*
/// std::vector<double>
/// The dof coordinates (x0, y0, x1, y1, . . .)
std::vector<double> tabulate_all_coordinates(const Mesh& mesh) const;
/// Create a copy of the dof map
///
/// *Returns*
/// DofMap
/// The Dofmap copy.
std::shared_ptr<GenericDofMap> copy() const;
/// Create a copy of the dof map on a new mesh
///
/// *Arguments*
/// new_mesh (_Mesh_)
/// The new mesh to create the dof map on.
///
/// *Returns*
/// DofMap
/// The new Dofmap copy.
std::shared_ptr<GenericDofMap> create(const Mesh& new_mesh) const;
/// Extract subdofmap component
///
/// *Arguments*
/// component (std::vector<std::size_t>)
/// The component.
/// mesh (_Mesh_)
/// The mesh.
///
/// *Returns*
/// DofMap
/// The subdofmap component.
std::shared_ptr<GenericDofMap>
extract_sub_dofmap(const std::vector<std::size_t>& component,
const Mesh& mesh) const;
/// Create a "collapsed" dofmap (collapses a sub-dofmap)
///
/// *Arguments*
/// collapsed_map (boost::unordered_map<std::size_t, std::size_t>)
/// The "collapsed" map.
/// mesh (_Mesh_)
/// The mesh.
///
/// *Returns*
/// DofMap
/// The collapsed dofmap.
std::shared_ptr<GenericDofMap>
collapse(boost::unordered_map<std::size_t, std::size_t>&
collapsed_map, const Mesh& mesh) const;
// FIXME: Document this function
std::vector<dolfin::la_index> dofs() const;
/// Set dof entries in vector to a specified value. Parallel layout
/// of vector must be consistent with dof map range. This
/// function is typically used to construct the null space of a
/// matrix operator.
///
/// *Arguments*
/// vector (_GenericVector_)
/// The vector to set.
/// value (double)
/// The value to set.
void set(GenericVector& x, double value) const;
/// Set dof entries in vector to the x[i] coordinate of the dof
/// spatial coordinate. Parallel layout of vector must be consistent
/// with dof map range This function is typically used to
/// construct the null space of a matrix operator, e.g. rigid
/// body rotations.
///
/// *Arguments*
/// vector (_GenericVector_)
/// The vector to set.
/// value (double)
/// The value to multiply to coordinate by.
/// component (std::size_t)
/// The coordinate index.
/// mesh (_Mesh_)
/// The mesh.
void set_x(GenericVector& x, double value, std::size_t component,
const Mesh& mesh) const;
/// Return the underlying dof map data. Intended for internal library
/// use only.
///
/// *Returns*
/// std::vector<std::vector<dolfin::la_index> >
/// The local-to-global map for each cell.
const std::vector<std::vector<dolfin::la_index> >& data() const
{ return _dofmap; }
/// Return informal string representation (pretty-print)
///
/// *Arguments*
/// verbose (bool)
/// Flag to turn on additional output.
///
/// *Returns*
/// std::string
/// An informal representation of the function space.
std::string str(bool verbose) const;
private:
// Friends
friend class DofMapBuilder;
// Check dimensional consistency between UFC dofmap and the mesh
static void check_dimensional_consistency(const ufc::dofmap& dofmap,
const Mesh& mesh);
// Check that mesh provides the entities needed by dofmap
static void check_provided_entities(const ufc::dofmap& dofmap,
const Mesh& mesh);
// Local-to-global dof map (dofs for cell dofmap[i])
std::vector<std::vector<dolfin::la_index> > _dofmap;
// UFC dof map
std::shared_ptr<const ufc::dofmap> _ufc_dofmap;
// Number global mesh entities. This is usually the same as what
// is reported by the mesh, but will differ for dofmaps constrained,
// e.g. dofmaps with periodoc bcs
std::vector<std::size_t> num_global_mesh_entities;
// Map from UFC dof numbering to renumbered dof (ufc_dof, actual_dof)
boost::unordered_map<std::size_t, std::size_t> ufc_map_to_dofmap;
// Restriction, pointer zero if not restricted
std::shared_ptr<const Restriction> _restriction;
// Flag to determine if the DofMap is a view
bool _is_view;
// Global dimension. Note that this may differ from the global
// dimension of the UFC dofmap if the function space is restricted
// or periodic.
std::size_t _global_dimension;
// UFC dof map offset
std::size_t _ufc_offset;
// Ownership range (dofs in this range are owned by this
// process). Set to (0, 0) if dofmap is a view
std::pair<std::size_t, std::size_t> _ownership_range;
// Map from dofs in local dof map are not owned by this process to
// the owner process
boost::unordered_map<std::size_t, unsigned int> _off_process_owner;
// List of processes that share a given dof
boost::unordered_map<std::size_t, std::vector<unsigned int> > _shared_dofs;
// Neighbours (processes that we share dofs with)
std::set<std::size_t> _neighbours;
// Map from slave to master mesh entities
std::shared_ptr<std::map<unsigned int, std::map<unsigned int,
std::pair<unsigned int, unsigned int> > > > slave_master_mesh_entities;
};
}
#endif
|