libMesh
Loading...
Searching...
No Matches
Public Member Functions | List of all members
PointLocatorTest Class Reference
Inheritance diagram for PointLocatorTest:
[legend]

Public Member Functions

 LIBMESH_CPPUNIT_TEST_SUITE (PointLocatorTest)
 
 CPPUNIT_TEST (testLocatorOnEdge3)
 
 CPPUNIT_TEST (testLocatorOnQuad9)
 
 CPPUNIT_TEST (testLocatorOnTri6)
 
 CPPUNIT_TEST (testLocatorOnHex27)
 
 CPPUNIT_TEST (testPlanar)
 
 CPPUNIT_TEST_SUITE_END ()
 
void setUp ()
 
void tearDown ()
 
void testLocator (const ElemType elem_type)
 
void testPlanar ()
 
void testLocatorOnEdge3 ()
 
void testLocatorOnQuad9 ()
 
void testLocatorOnTri6 ()
 
void testLocatorOnHex27 ()
 

Detailed Description

Definition at line 16 of file point_locator_test.C.

Member Function Documentation

◆ CPPUNIT_TEST() [1/5]

PointLocatorTest::CPPUNIT_TEST ( testLocatorOnEdge3  )

◆ CPPUNIT_TEST() [2/5]

PointLocatorTest::CPPUNIT_TEST ( testLocatorOnHex27  )

◆ CPPUNIT_TEST() [3/5]

PointLocatorTest::CPPUNIT_TEST ( testLocatorOnQuad9  )

◆ CPPUNIT_TEST() [4/5]

PointLocatorTest::CPPUNIT_TEST ( testLocatorOnTri6  )

◆ CPPUNIT_TEST() [5/5]

PointLocatorTest::CPPUNIT_TEST ( testPlanar  )

◆ CPPUNIT_TEST_SUITE_END()

PointLocatorTest::CPPUNIT_TEST_SUITE_END ( )

◆ LIBMESH_CPPUNIT_TEST_SUITE()

PointLocatorTest::LIBMESH_CPPUNIT_TEST_SUITE ( PointLocatorTest  )

◆ setUp()

void PointLocatorTest::setUp ( )
inline

Definition at line 35 of file point_locator_test.C.

36 {}

◆ tearDown()

void PointLocatorTest::tearDown ( )
inline

Definition at line 38 of file point_locator_test.C.

39 {}

◆ testLocator()

void PointLocatorTest::testLocator ( const ElemType  elem_type)
inline

Definition at line 41 of file point_locator_test.C.

42 {
43 Mesh mesh(*TestCommWorld);
44
45 const unsigned int n_elem_per_side = 5;
46 const unsigned int dim = Elem::type_to_dim_map[elem_type];
47 const unsigned int ymax = dim > 1;
48 const unsigned int zmax = dim > 2;
49 const unsigned int ny = ymax * n_elem_per_side;
50 const unsigned int nz = zmax * n_elem_per_side;
51
52 MeshTools::Generation::build_cube (mesh,
53 n_elem_per_side,
54 ny,
55 nz,
56 0., 1.,
57 0., ymax,
58 0., zmax,
59 elem_type);
60
61 std::unique_ptr<PointLocatorBase> locator = mesh.sub_point_locator();
62
63 // Make sure we throw in default (not out-of-mesh) mode when
64 // debugging and querying a point out of the mesh
65 const Point p{2,0,0};
66#if defined(LIBMESH_ENABLE_EXCEPTIONS) && !defined(NDEBUG)
67 auto test_exception = [&locator, p]()
68 {
69 bool threw_desired_exception = false;
70 try {
71 locator->operator()(p);
72 }
73 catch (libMesh::LogicError & e) {
74 std::regex msg_regex("out_of_mesh_mode");
75 CPPUNIT_ASSERT(std::regex_search(e.what(), msg_regex));
76 threw_desired_exception = true;
77 }
78 catch (...) {
79 CPPUNIT_ASSERT_MESSAGE("Unexpected exception type thrown", false);
80 }
81 CPPUNIT_ASSERT(threw_desired_exception);
82 };
83 test_exception();
84#endif
85
86 if (!mesh.is_serial())
87 locator->enable_out_of_mesh_mode();
88
89 for (unsigned int i=0; i != n_elem_per_side+1; ++i)
90 {
91 for (unsigned int j=0; j != ny+1; ++j)
92 {
93 for (unsigned int k=0; k != nz+1; ++k)
94 {
95 const libMesh::Real h = libMesh::Real(1)/n_elem_per_side;
96 Point p(i*h, j*h, k*h);
97
98 const Elem *elem = locator->operator()(p);
99
100 bool found_elem = elem;
101 if (!mesh.is_serial())
102 mesh.comm().max(found_elem);
103
104 CPPUNIT_ASSERT(found_elem);
105 if (elem)
106 {
107 CPPUNIT_ASSERT(elem->contains_point(p));
108 }
109
110 const Node *node = locator->locate_node(p);
111
112 bool found_node = node;
113 if (!mesh.is_serial())
114 mesh.comm().max(found_node);
115
116 CPPUNIT_ASSERT(found_node);
117
118 if (node)
119 {
120 LIBMESH_ASSERT_FP_EQUAL(i*h, (*node)(0),
121 TOLERANCE*TOLERANCE);
122 if (LIBMESH_DIM > 1)
123 LIBMESH_ASSERT_FP_EQUAL(j*h, (*node)(1),
124 TOLERANCE*TOLERANCE);
125 if (LIBMESH_DIM > 2)
126 LIBMESH_ASSERT_FP_EQUAL(k*h, (*node)(2),
127 TOLERANCE*TOLERANCE);
128 }
129 }
130 }
131 }
132
133 // Make sure we do not throw in out-of-mesh mode when looking for
134 // a point out of the mesh
135 locator->enable_out_of_mesh_mode();
136 const Elem *elem = locator->operator()(p);
137 CPPUNIT_ASSERT(!elem);
138
139 // Make sure we throw again after disabling out-of-mesh mode again.
140 locator->disable_out_of_mesh_mode();
141#if defined(LIBMESH_ENABLE_EXCEPTIONS) && !defined(NDEBUG)
142 test_exception();
143#endif // LIBMESH_ENABLE_EXCEPTIONS
144
145 locator->clear();
146 CPPUNIT_ASSERT(!locator->initialized());
147
148 locator->init();
149 CPPUNIT_ASSERT(locator->initialized());
150
151 locator->set_close_to_point_tol(1e-1);
152 Point p2{1.001,0,0};
153 const Elem *elem2 = locator->operator()(p2);
154 bool found_elem = elem2;
155 if (!mesh.is_serial())
156 mesh.comm().max(found_elem);
157
158 CPPUNIT_ASSERT(found_elem);
159 }
dim
unsigned int dim
Definition adaptivity_ex3.C:114
libMesh::Parallel::Communicator::max
void max(const T &r, T &o, Request &req) const
libMesh::Elem
This is the base class from which all geometric element types are derived.
Definition elem.h:96
libMesh::Elem::contains_point
virtual bool contains_point(const Point &p, Real tol=TOLERANCE) const
Definition elem.C:2784
libMesh::Elem::type_to_dim_map
static const unsigned int type_to_dim_map[INVALID_ELEM]
This array maps the integer representation of the ElemType enum to the geometric dimension of the ele...
Definition elem.h:628
libMesh::LogicError
A class to represent the internal "this should never happen" errors, to be thrown by "libmesh_error()...
Definition libmesh_exceptions.h:66
libMesh::MeshBase::is_serial
virtual bool is_serial() const
Definition mesh_base.h:357
libMesh::MeshBase::sub_point_locator
std::unique_ptr< PointLocatorBase > sub_point_locator() const
Definition mesh_base.C:1833
libMesh::Mesh
The Mesh class is a thin wrapper, around the ReplicatedMesh class by default.
Definition mesh.h:51
libMesh::Node
A Node is like a Point, but with more information.
Definition node.h:55
libMesh::ParallelObject::comm
const Parallel::Communicator & comm() const
Definition parallel_object.h:97
libMesh::Point
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition point.h:40
mesh
MeshBase & mesh
Definition mesh_communication.C:1460
libMesh::MeshTools::Generation::build_cube
void build_cube(UnstructuredMesh &mesh, const unsigned int nx=0, const unsigned int ny=0, const unsigned int nz=0, const Real xmin=0., const Real xmax=1., const Real ymin=0., const Real ymax=1., const Real zmin=0., const Real zmax=1., const ElemType type=INVALID_ELEM, const bool gauss_lobatto_grid=false)
Builds a (elements) cube.
Definition mesh_generation.C:317
libMesh::TOLERANCE
static constexpr Real TOLERANCE
Definition libmesh_common.h:151
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Definition libmesh_common.h:144

References libMesh::MeshTools::Generation::build_cube(), libMesh::ParallelObject::comm(), libMesh::Elem::contains_point(), dim, libMesh::MeshBase::is_serial(), libMesh::Parallel::Communicator::max(), mesh, libMesh::Real, libMesh::MeshBase::sub_point_locator(), TestCommWorld, libMesh::TOLERANCE, and libMesh::Elem::type_to_dim_map.

Referenced by testLocatorOnEdge3(), testLocatorOnHex27(), testLocatorOnQuad9(), and testLocatorOnTri6().

◆ testLocatorOnEdge3()

void PointLocatorTest::testLocatorOnEdge3 ( )
inline

Definition at line 203 of file point_locator_test.C.

203{ LOG_UNIT_TEST; testLocator(EDGE3); }
PointLocatorTest::testLocator
void testLocator(const ElemType elem_type)
Definition point_locator_test.C:41

References libMesh::EDGE3, and testLocator().

◆ testLocatorOnHex27()

void PointLocatorTest::testLocatorOnHex27 ( )
inline

Definition at line 206 of file point_locator_test.C.

206{ LOG_UNIT_TEST; testLocator(HEX27); }

References libMesh::HEX27, and testLocator().

◆ testLocatorOnQuad9()

void PointLocatorTest::testLocatorOnQuad9 ( )
inline

Definition at line 204 of file point_locator_test.C.

204{ LOG_UNIT_TEST; testLocator(QUAD9); }

References libMesh::QUAD9, and testLocator().

◆ testLocatorOnTri6()

void PointLocatorTest::testLocatorOnTri6 ( )
inline

Definition at line 205 of file point_locator_test.C.

205{ LOG_UNIT_TEST; testLocator(TRI6); }

References testLocator(), and libMesh::TRI6.

◆ testPlanar()

void PointLocatorTest::testPlanar ( )
inline

Definition at line 161 of file point_locator_test.C.

162 {
163 LOG_UNIT_TEST;
164
165 // Here we test locating points in a Mesh which lies slightly above the z-axis
166 Mesh mesh(*TestCommWorld);
167
168 MeshTools::Generation::build_square(mesh,
169 /*nx=*/10, /*ny=*/10,
170 /*xmin=*/0., /*xmax=*/1.,
171 /*ymin=*/0., /*ymax=*/1.,
172 TRI3);
173
174 // Move all nodes a small amount in the +z-direction
175 for (auto & node : mesh.node_ptr_range())
176 (*node)(2) += 3.1e-15;
177
178 // Construct a PointLocator object
179 std::unique_ptr<PointLocatorBase> locator = mesh.sub_point_locator();
180
181 // Turn on out-of-mesh-mode to handle parallel testing
182 if (!mesh.is_serial())
183 locator->enable_out_of_mesh_mode();
184
185 // Test locating a Point which is in the z=0 plane, i.e. slightly
186 // below the plane of the Mesh, but which should otherwise be
187 // found within the Mesh.
188 Point p(0.53, 0.7, 0.0);
189 const Elem *elem = (*locator)(p);
190
191 bool found_elem = elem;
192 if (!mesh.is_serial())
193 mesh.comm().max(found_elem);
194
195 CPPUNIT_ASSERT(found_elem);
196
197 // Note: Tri3::contains_point() returns true for points which are
198 // out-of-plane by less than TOLERANCE by default.
199 if (elem)
200 CPPUNIT_ASSERT(elem->contains_point(p));
201 }
libMesh::MeshTools::Generation::build_square
void build_square(UnstructuredMesh &mesh, const unsigned int nx, const unsigned int ny, const Real xmin=0., const Real xmax=1., const Real ymin=0., const Real ymax=1., const ElemType type=INVALID_ELEM, const bool gauss_lobatto_grid=false)
A specialized build_cube() for 2D meshes.
Definition mesh_generation.C:1981

References libMesh::MeshTools::Generation::build_square(), libMesh::ParallelObject::comm(), libMesh::Elem::contains_point(), libMesh::MeshBase::is_serial(), libMesh::Parallel::Communicator::max(), mesh, libMesh::MeshBase::sub_point_locator(), TestCommWorld, and libMesh::TRI3.

The documentation for this class was generated from the following file:
Generated on Fri Aug 21 2026 13:32:35 for libMesh by doxygen 1.9.8