/usr/include/dolfin/mesh/SubDomain.h is in libdolfin-dev 2017.2.0.post0-2.
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 | // Copyright (C) 2007-2013 Anders Logg
//
// 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/>.
//
// First added: 2007-04-10
// Last changed: 2013-04-12
#ifndef __SUB_DOMAIN_H
#define __SUB_DOMAIN_H
#include <cstddef>
#include <map>
#include <dolfin/common/constants.h>
#include <Eigen/Dense>
namespace dolfin
{
// Forward declarations
class Mesh;
template <typename T> class MeshFunction;
template <typename T> class MeshValueCollection;
template <typename T> class Array;
/// This class defines the interface for definition of subdomains.
/// Alternatively, subdomains may be defined by a _Mesh_ and a
/// MeshFunction<std::size_t> over the mesh.
class SubDomain
{
public:
/// Constructor
///
/// @param map_tol (double)
/// The tolerance used when identifying mapped points using
/// the function SubDomain::map.
SubDomain(const double map_tol=1.0e-10);
/// Destructor
virtual ~SubDomain();
/// Return true for points inside the subdomain
///
/// @param x (Array<double>)
/// The coordinates of the point.
/// @param on_boundary (bool)
/// True for points on the boundary.
///
/// @return bool
/// True for points inside the subdomain.
virtual bool inside(const Array<double>& x, bool on_boundary) const;
/// Return true for points inside the subdomain
///
/// @param x (Eigen::Ref<const Eigen::VectorXd>)
/// The coordinates of the point.
/// @param on_boundary (bool)
/// True for points on the boundary.
///
/// @return bool
/// True for points inside the subdomain.
virtual bool inside(Eigen::Ref<const Eigen::VectorXd> x, bool on_boundary) const;
/// Map coordinate x in domain H to coordinate y in domain G (used for
/// periodic boundary conditions)
///
/// @param x (Array<double>)
/// The coordinates in domain H.
/// @param y (Array<double>)
/// The coordinates in domain G.
virtual void map(const Array<double>& x, Array<double>& y) const;
/// Map coordinate x in domain H to coordinate y in domain G (used for
/// periodic boundary conditions)
///
/// @param x (Eigen::Ref<const Eigen::VectorXd>)
/// The coordinates in domain H.
/// @param y (Eigen::Ref<Eigen::VectorXd>)
/// The coordinates in domain G.
virtual void map(Eigen::Ref<const Eigen::VectorXd> x, Eigen::Ref<Eigen::VectorXd> y) const;
/// Snap coordinate to boundary of subdomain
///
/// @param x (Array<double>)
/// The coordinates.
virtual void snap(Array<double>& x) const {}
//--- Marking of Mesh ---
/// Set subdomain markers (std::size_t) on cells for given subdomain number
///
/// @param mesh (_Mesh_)
/// The mesh to be marked.
/// @param sub_domain (std::size_t)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark_cells(Mesh& mesh,
std::size_t sub_domain,
bool check_midpoint=true) const;
/// Set subdomain markers (std::size_t) on facets for given subdomain number
///
/// @param mesh (_Mesh_)
/// The mesh to be marked.
/// @param sub_domain (std::size_t)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark_facets(Mesh& mesh,
std::size_t sub_domain,
bool check_midpoint=true) const;
/// Set subdomain markers (std::size_t) for given topological dimension
/// and subdomain number
///
/// @param mesh (_Mesh_)
/// The mesh to be marked.
/// @param dim (std::size_t)
/// The topological dimension of entities to be marked.
/// @param sub_domain (std::size_t)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(Mesh& mesh,
std::size_t dim,
std::size_t sub_domain,
bool check_midpoint=true) const;
//--- Marking of MeshFunction ---
/// Set subdomain markers (std::size_t) for given subdomain number
///
/// @param sub_domains (MeshFunction<std::size_t>)
/// The subdomain markers.
/// @param sub_domain (std::size_t)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshFunction<std::size_t>& sub_domains,
std::size_t sub_domain,
bool check_midpoint=true) const;
/// Set subdomain markers (int) for given subdomain number
///
/// @param sub_domains (MeshFunction<int>)
/// The subdomain markers.
/// @param sub_domain (int)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshFunction<int>& sub_domains,
int sub_domain,
bool check_midpoint=true) const;
/// Set subdomain markers (double) for given subdomain number
///
/// @param sub_domains (MeshFunction<double>)
/// The subdomain markers.
/// @param sub_domain (double)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshFunction<double>& sub_domains,
double sub_domain,
bool check_midpoint=true) const;
/// Set subdomain markers (bool) for given subdomain
///
/// @param sub_domains (MeshFunction<bool>)
/// The subdomain markers.
/// @param sub_domain (bool)
/// The subdomain number.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshFunction<bool>& sub_domains,
bool sub_domain,
bool check_midpoint=true) const;
//--- Marking of MeshValueCollection ---
/// Set subdomain markers (std::size_t) for given subdomain number
///
/// @param sub_domains (MeshValueCollection<std::size_t>)
/// The subdomain markers.
/// @param sub_domain (std::size_t)
/// The subdomain number.
/// @param mesh (_Mesh_)
/// The mesh.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshValueCollection<std::size_t>& sub_domains,
std::size_t sub_domain,
const Mesh& mesh,
bool check_midpoint=true) const;
/// Set subdomain markers (int) for given subdomain number
///
/// @param sub_domains (MeshValueCollection<int>)
/// The subdomain markers
/// @param sub_domain (int)
/// The subdomain number
/// @param mesh (Mesh)
/// The mesh.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshValueCollection<int>& sub_domains,
int sub_domain,
const Mesh& mesh,
bool check_midpoint=true) const;
/// Set subdomain markers (double) for given subdomain number
///
/// @param sub_domains (MeshValueCollection<double>)
/// The subdomain markers.
/// @param sub_domain (double)
/// The subdomain number
/// @param mesh (Mesh)
/// The mesh.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshValueCollection<double>& sub_domains,
double sub_domain,
const Mesh& mesh,
bool check_midpoint=true) const;
/// Set subdomain markers (bool) for given subdomain
///
/// @param sub_domains (MeshValueCollection<bool>)
/// The subdomain markers
/// @param sub_domain (bool)
/// The subdomain number
/// @param mesh (Mesh)
/// The mesh.
/// @param check_midpoint (bool)
/// Flag for whether midpoint of cell should be checked (default).
void mark(MeshValueCollection<bool>& sub_domains,
bool sub_domain,
const Mesh& mesh,
bool check_midpoint=true) const;
/// Return geometric dimension
///
/// @return std::size_t
/// The geometric dimension.
std::size_t geometric_dimension() const;
/// Property setter
///
/// @param name
/// @param value
virtual void set_property(std::string name, double value);
/// Property getter
///
/// @param name
/// @return double
virtual double get_property(std::string name) const;
/// Return tolerance uses to find matching point via map function
///
/// @return double
/// The tolerance.
const double map_tolerance;
private:
/// Apply marker of type T (most likely an std::size_t) to object of class
/// S (most likely MeshFunction or MeshValueCollection)
template<typename S, typename T>
void apply_markers(S& sub_domains,
T sub_domain,
const Mesh& mesh,
bool check_midpoint) const;
template<typename T>
void apply_markers(std::map<std::size_t, std::size_t>& sub_domains,
std::size_t dim,
T sub_domain,
const Mesh& mesh,
bool check_midpoint) const;
// Friends
friend class DirichletBC;
friend class PeriodicBC;
// Geometric dimension, needed for SWIG interface, will be set before
// calls to inside() and map()
mutable std::size_t _geometric_dimension;
};
}
#endif
|