SubDomain.h¶
Note
The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.
-
class
SubDomain
¶ This class defines the interface for definition of subdomains. Alternatively, subdomains may be defined by a
Mesh
and aMeshFunction
<std::size_t> over the mesh.-
SubDomain
(const double map_tol = 1.0e-10)¶ Constructor
- Arguments
- map_tol (double)
- The tolerance used when identifying mapped points using the function SubDomain::map.
-
bool
inside
(const Array<double> &x, bool on_boundary) const¶ Return true for points inside the subdomain
- Arguments
- x (
Array
<double>) - The coordinates of the point.
- on_boundary (bool)
- True for points on the boundary.
- x (
- Returns
- bool
- True for points inside the subdomain.
-
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)
-
void
snap
(Array<double> &x) const¶ Snap coordinate to boundary of subdomain
- Arguments
- x (
Array
<double>) - The coordinates.
- x (
-
void
mark_cells
(Mesh &mesh, std::size_t sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (std::size_t) on cells for given subdomain number
- Arguments
- mesh (
Mesh
) - The mesh to be marked.
- sub_domain (std::size_t)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- mesh (
-
void
mark_facets
(Mesh &mesh, std::size_t sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (std::size_t) on facets for given subdomain number
- Arguments
- mesh (
Mesh
) - The mesh to be marked.
- sub_domain (std::size_t)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- mesh (
-
void
mark
(Mesh &mesh, std::size_t dim, std::size_t sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (std::size_t) for given topological dimension and subdomain number
- Arguments
- mesh (
Mesh
) - The mesh to be marked.
- dim (std::size_t)
- The topological dimension of entities to be marked.
- sub_domain (std::size_t)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- mesh (
-
void
mark
(MeshFunction<std::size_t> &sub_domains, std::size_t sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (std::size_t) for given subdomain number
- Arguments
- sub_domains (
MeshFunction
<std::size_t>) - The subdomain markers.
- sub_domain (std::size_t)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshFunction<int> &sub_domains, int sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (int) for given subdomain number
- Arguments
- sub_domains (
MeshFunction
<int>) - The subdomain markers.
- sub_domain (int)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshFunction<double> &sub_domains, double sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (double) for given subdomain number
- Arguments
- sub_domains (
MeshFunction
<double>) - The subdomain markers.
- sub_domain (double)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshFunction<bool> &sub_domains, bool sub_domain, bool check_midpoint = true) const¶ Set subdomain markers (bool) for given subdomain
- Arguments
- sub_domains (
MeshFunction
<bool>) - The subdomain markers.
- sub_domain (bool)
- The subdomain number.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshValueCollection<std::size_t> &sub_domains, std::size_t sub_domain, const Mesh &mesh, bool check_midpoint = true) const¶ Set subdomain markers (std::size_t) for given subdomain number
- Arguments
- sub_domains (
MeshValueCollection
<std::size_t>) - The subdomain markers.
- sub_domain (std::size_t)
- The subdomain number.
- mesh (
Mesh
) - The mesh.
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshValueCollection<int> &sub_domains, int sub_domain, const Mesh &mesh, bool check_midpoint = true) const¶ Set subdomain markers (int) for given subdomain number
- Arguments
- sub_domains (
MeshValueCollection
<int>) - The subdomain markers
- sub_domain (int)
- The subdomain number
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshValueCollection<double> &sub_domains, double sub_domain, const Mesh &mesh, bool check_midpoint = true) const¶ Set subdomain markers (double) for given subdomain number
- Arguments
- sub_domains (
MeshValueCollection
<double>) - The subdomain markers.
- sub_domain (double)
- The subdomain number
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
void
mark
(MeshValueCollection<bool> &sub_domains, bool sub_domain, const Mesh &mesh, bool check_midpoint = true) const¶ Set subdomain markers (bool) for given subdomain
- Arguments
- sub_domains (
MeshValueCollection
<bool>) - The subdomain markers
- sub_domain (bool)
- The subdomain number
- check_midpoint (bool)
- Flag for whether midpoint of cell should be checked (default).
- sub_domains (
-
std::size_t
geometric_dimension
() const¶ Return geometric dimension
- Returns
- std::size_t
- The geometric dimension.
-