libMesh
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
OverlappingAlgebraicGhostingTest Class Reference
Inheritance diagram for OverlappingAlgebraicGhostingTest:
[legend]

Public Member Functions

 LIBMESH_CPPUNIT_TEST_SUITE (OverlappingAlgebraicGhostingTest)
 
 CPPUNIT_TEST (testGhostingCouplingMatrix)
 
 CPPUNIT_TEST (testGhostingNullCouplingMatrix)
 
 CPPUNIT_TEST (testGhostingNullCouplingMatrixUnifRef)
 
 CPPUNIT_TEST_SUITE_END ()
 
void setUp ()
 
void tearDown ()
 
void testGhostingCouplingMatrix ()
 
void testGhostingNullCouplingMatrix ()
 
void testGhostingNullCouplingMatrixUnifRef ()
 

Protected Member Functions

void build_quad_mesh (unsigned int n_refinements=0)
 
void init ()
 
void clear ()
 
void setup_coupling_matrix (std::unique_ptr< CouplingMatrix > &coupling)
 

Protected Attributes

std::unique_ptr< MeshBase_mesh
 
std::unique_ptr< EquationSystems_es
 

Private Member Functions

void run_ghosting_test (const unsigned int n_refinements, bool build_coupling_matrix)
 

Detailed Description

Definition at line 502 of file overlapping_coupling_test.C.

Member Function Documentation

◆ build_quad_mesh()

void OverlappingTestBase::build_quad_mesh ( unsigned int  n_refinements = 0)
inlineprotectedinherited

Definition at line 238 of file overlapping_coupling_test.C.

References libMesh::Elem::build_with_id(), libMesh::QUAD4, libMesh::Elem::set_node(), libMesh::Elem::subdomain_id(), and libMesh::MeshRefinement::uniformly_refine().

239  {
240  // We are making assumptions in various places about the presence
241  // of the elements on the current processor so we're restricting to
242  // ReplicatedMesh for now.
243  _mesh = std::make_unique<ReplicatedMesh>(*TestCommWorld);
244 
245  _mesh->set_mesh_dimension(2);
246 
247  _mesh->add_point( Point(0.0,0.0),0 );
248  _mesh->add_point( Point(1.0,0.0),1 );
249  _mesh->add_point( Point(1.0,1.0),2 );
250  _mesh->add_point( Point(0.0,1.0),3 );
251 
252  {
253  Elem * elem = _mesh->add_elem(Elem::build_with_id(QUAD4, 0));
254  elem->subdomain_id() = 1;
255 
256  for (unsigned int n=0; n<4; n++)
257  elem->set_node(n) = _mesh->node_ptr(n);
258  }
259 
260  _mesh->add_point( Point(1.0,2.0),4 );
261  _mesh->add_point( Point(0.0,2.0),5 );
262 
263  {
264  Elem * elem = _mesh->add_elem(Elem::build_with_id(QUAD4, 1));
265  elem->subdomain_id() = 1;
266 
267  elem->set_node(0) = _mesh->node_ptr(3);
268  elem->set_node(1) = _mesh->node_ptr(2);
269  elem->set_node(2) = _mesh->node_ptr(4);
270  elem->set_node(3) = _mesh->node_ptr(5);
271  }
272 
273  _mesh->add_point( Point(0.0,0.0),6 );
274  _mesh->add_point( Point(1.0,0.0),7 );
275  _mesh->add_point( Point(1.0,2.0),8 );
276  _mesh->add_point( Point(0.0,2.0),9 );
277 
278  {
279  Elem* elem = _mesh->add_elem(Elem::build_with_id(QUAD4, 2));
280  elem->subdomain_id() = 2;
281 
282  elem->set_node(0) = _mesh->node_ptr(6);
283  elem->set_node(1) = _mesh->node_ptr(7);
284  elem->set_node(2) = _mesh->node_ptr(8);
285  elem->set_node(3) = _mesh->node_ptr(9);
286  }
287 
288  _mesh->partitioner() = std::make_unique<OverlappingTestPartitioner>();
289 
290  _mesh->prepare_for_use();
291 
292 #ifdef LIBMESH_ENABLE_AMR
293  if (n_refinements > 0)
294  {
295  MeshRefinement refine(*_mesh);
296  refine.uniformly_refine(n_refinements);
297  }
298 #endif // LIBMESH_ENABLE_AMR
299  }
virtual Node *& set_node(const unsigned int i)
Definition: elem.h:2381
This is the base class from which all geometric element types are derived.
Definition: elem.h:94
std::unique_ptr< MeshBase > _mesh
Implements (adaptive) mesh refinement algorithms for a MeshBase.
subdomain_id_type subdomain_id() const
Definition: elem.h:2391
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:39

◆ clear()

void OverlappingTestBase::clear ( )
inlineprotectedinherited

Definition at line 321 of file overlapping_coupling_test.C.

322  {
323  _es.reset();
324  _mesh.reset();
325  }
std::unique_ptr< MeshBase > _mesh
std::unique_ptr< EquationSystems > _es

◆ CPPUNIT_TEST() [1/3]

OverlappingAlgebraicGhostingTest::CPPUNIT_TEST ( testGhostingCouplingMatrix  )

◆ CPPUNIT_TEST() [2/3]

OverlappingAlgebraicGhostingTest::CPPUNIT_TEST ( testGhostingNullCouplingMatrix  )

◆ CPPUNIT_TEST() [3/3]

OverlappingAlgebraicGhostingTest::CPPUNIT_TEST ( testGhostingNullCouplingMatrixUnifRef  )

◆ CPPUNIT_TEST_SUITE_END()

OverlappingAlgebraicGhostingTest::CPPUNIT_TEST_SUITE_END ( )

◆ init()

void OverlappingTestBase::init ( )
inlineprotectedinherited

Definition at line 301 of file overlapping_coupling_test.C.

References libMesh::System::add_variable(), libMesh::FIRST, and libMesh::LAGRANGE.

302  {
303  _es = std::make_unique<EquationSystems>(*_mesh);
304  LinearImplicitSystem & sys = _es->add_system<LinearImplicitSystem> ("SimpleSystem");
305 
306  std::set<subdomain_id_type> sub_one;
307  sub_one.insert(1);
308 
309  std::set<subdomain_id_type> sub_two;
310  sub_two.insert(2);
311 
312  sys.add_variable("U", FIRST, LAGRANGE, &sub_two);
313  sys.add_variable("L", FIRST, LAGRANGE, &sub_two);
314 
315  sys.add_variable("V", FIRST, LAGRANGE, &sub_one);
316  sys.add_variable("p", FIRST, LAGRANGE, &sub_one);
317 
318  _es->init();
319  }
Manages consistently variables, degrees of freedom, coefficient vectors, matrices and linear solvers ...
std::unique_ptr< EquationSystems > _es
unsigned int add_variable(std::string_view var, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
Adds the variable var to the list of variables for this system.
Definition: system.C:1305

◆ LIBMESH_CPPUNIT_TEST_SUITE()

OverlappingAlgebraicGhostingTest::LIBMESH_CPPUNIT_TEST_SUITE ( OverlappingAlgebraicGhostingTest  )

◆ run_ghosting_test()

void OverlappingAlgebraicGhostingTest::run_ghosting_test ( const unsigned int  n_refinements,
bool  build_coupling_matrix 
)
inlineprivate

Definition at line 544 of file overlapping_coupling_test.C.

References libMesh::DofMap::add_algebraic_ghosting_functor(), libMesh::NumericVector< T >::build(), libMesh::ParallelObject::comm(), libMesh::System::current_local_solution, libMesh::FEMContext::elem_fe_reinit(), libMesh::System::get_dof_map(), libMesh::FEMContext::get_element_fe(), libMesh::System::get_mesh(), libMesh::DofMap::get_send_list(), libMesh::GHOSTED, libMesh::TriangleWrapper::init(), libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), libMesh::FEMContext::pre_fe_reinit(), libMesh::DofMap::reinit_send_list(), libMesh::System::solution, and libMesh::System::variable_number().

545  {
546  this->build_quad_mesh(n_refinements);
547  this->init();
548 
549  std::unique_ptr<CouplingMatrix> coupling_matrix;
550  if (build_coupling_matrix)
551  this->setup_coupling_matrix(coupling_matrix);
552 
553  LinearImplicitSystem & system = _es->get_system<LinearImplicitSystem>("SimpleSystem");
554 
555  // If we don't add this coupling functor and properly recompute the
556  // sparsity pattern, then PETSc will throw a malloc error when we
557  // try to assemble into the global matrix
558  OverlappingCouplingFunctor functor(system);
559  functor.set_coupling_matrix(coupling_matrix);
560 
561  DofMap & dof_map = system.get_dof_map();
562  dof_map.add_algebraic_ghosting_functor(functor);
563  dof_map.reinit_send_list(system.get_mesh());
564 
565  // Update current local solution
567 
568  system.current_local_solution->init(system.n_dofs(), system.n_local_dofs(),
569  dof_map.get_send_list(), false,
571 
572  system.solution->localize(*(system.current_local_solution),dof_map.get_send_list());
573 
574  std::unique_ptr<PointLocatorBase> point_locator = _mesh->sub_point_locator();
575 
576  const unsigned int u_var = system.variable_number("U");
577 
579 
580  FEMContext subdomain_one_context(system);
581  FEMContext subdomain_two_context(system);
582 
583  // The use case on which this test is based, we only add terms to the residual
584  // corresponding to the dofs in the second subdomain, but that have couplings
585  // to dofs in the first subdomain.
586  for (const auto & elem : _mesh->active_local_subdomain_elements_ptr_range(2))
587  {
588  // A little extra unit testing on the range iterator
589  CPPUNIT_ASSERT_EQUAL(2, static_cast<int>(elem->subdomain_id()));
590 
591  subdomain_one_context.get_element_fe(u_var)->get_nothing(); // for this unit test
592  const std::vector<libMesh::Point> & qpoints = subdomain_two_context.get_element_fe(u_var)->get_xyz();
593 
594  // Setup the context for the current element
595  subdomain_two_context.pre_fe_reinit(system,elem);
596  subdomain_two_context.elem_fe_reinit();
597 
598  std::set<subdomain_id_type> allowed_subdomains;
599  allowed_subdomains.insert(1);
600 
601  // Now loop over the quadrature points and find the subdomain-one element that overlaps
602  // with the current subdomain-two element and then initialize the FEMContext for the
603  // subdomain-one element. If the algebraic ghosting has not been done properly,
604  // this will error.
605  for ( const auto & qp : qpoints )
606  {
607  const Elem * overlapping_elem = (*point_locator)( qp, &allowed_subdomains );
608  CPPUNIT_ASSERT(overlapping_elem);
609 
610  // Setup the context for the overlapping element
611  subdomain_one_context.pre_fe_reinit(system,overlapping_elem);
612  subdomain_one_context.elem_fe_reinit();
613  }
614  }
615  }
void setup_coupling_matrix(std::unique_ptr< CouplingMatrix > &coupling)
Manages consistently variables, degrees of freedom, coefficient vectors, matrices and linear solvers ...
This is the base class from which all geometric element types are derived.
Definition: elem.h:94
const Parallel::Communicator & comm() const
dof_id_type n_local_dofs() const
Definition: system.C:150
const MeshBase & get_mesh() const
Definition: system.h:2277
dof_id_type n_dofs() const
Definition: system.C:113
unsigned int variable_number(std::string_view var) const
Definition: system.C:1557
std::unique_ptr< MeshBase > _mesh
std::unique_ptr< EquationSystems > _es
This class handles the numbering of degrees of freedom on a mesh.
Definition: dof_map.h:169
void build_quad_mesh(unsigned int n_refinements=0)
void reinit_send_list(MeshBase &mesh)
Clears the _send_list vector and then rebuilds it.
Definition: dof_map.C:1734
std::unique_ptr< NumericVector< Number > > solution
Data structure to hold solution values.
Definition: system.h:1573
This class provides all data required for a physics package (e.g.
Definition: fem_context.h:62
static std::unique_ptr< NumericVector< T > > build(const Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())
Builds a NumericVector on the processors in communicator comm using the linear solver package specifi...
std::unique_ptr< NumericVector< Number > > current_local_solution
All the values I need to compute my contribution to the simulation at hand.
Definition: system.h:1585
void add_algebraic_ghosting_functor(GhostingFunctor &evaluable_functor, bool to_mesh=true)
Adds a functor which can specify algebraic ghosting requirements for use with distributed vectors...
Definition: dof_map.C:1886
const DofMap & get_dof_map() const
Definition: system.h:2293
const std::vector< dof_id_type > & get_send_list() const
Definition: dof_map.h:511

◆ setUp()

void OverlappingAlgebraicGhostingTest::setUp ( )
inline

Definition at line 516 of file overlapping_coupling_test.C.

517  {}

◆ setup_coupling_matrix()

void OverlappingTestBase::setup_coupling_matrix ( std::unique_ptr< CouplingMatrix > &  coupling)
inlineprotectedinherited

Definition at line 327 of file overlapping_coupling_test.C.

References libMesh::System::n_vars(), and libMesh::System::variable_number().

328  {
329  System & system = _es->get_system("SimpleSystem");
330 
331  coupling = std::make_unique<CouplingMatrix>(system.n_vars());
332 
333  const unsigned int u_var = system.variable_number("U");
334  const unsigned int l_var = system.variable_number("L");
335  const unsigned int v_var = system.variable_number("V");
336  const unsigned int p_var = system.variable_number("p");
337 
338  // Only adding the overlapping couplings since the primary ones should
339  // be there by default.
340  (*coupling)(u_var,v_var) = true;
341  (*coupling)(l_var,v_var) = true;
342  (*coupling)(l_var,p_var) = true;
343  (*coupling)(v_var,u_var) = true;
344  (*coupling)(v_var,l_var) = true;
345  }
unsigned int variable_number(std::string_view var) const
Definition: system.C:1557
std::unique_ptr< EquationSystems > _es
Manages consistently variables, degrees of freedom, and coefficient vectors.
Definition: system.h:96
unsigned int n_vars() const
Definition: system.h:2349

◆ tearDown()

void OverlappingAlgebraicGhostingTest::tearDown ( )
inline

Definition at line 519 of file overlapping_coupling_test.C.

520  { this->clear(); }

◆ testGhostingCouplingMatrix()

void OverlappingAlgebraicGhostingTest::testGhostingCouplingMatrix ( )
inline

Definition at line 522 of file overlapping_coupling_test.C.

523  {
524  LOG_UNIT_TEST;
525  this->run_ghosting_test(0, true);
526  }
void run_ghosting_test(const unsigned int n_refinements, bool build_coupling_matrix)

◆ testGhostingNullCouplingMatrix()

void OverlappingAlgebraicGhostingTest::testGhostingNullCouplingMatrix ( )
inline

Definition at line 528 of file overlapping_coupling_test.C.

529  {
530  LOG_UNIT_TEST;
531  this->run_ghosting_test(0, false);
532  }
void run_ghosting_test(const unsigned int n_refinements, bool build_coupling_matrix)

◆ testGhostingNullCouplingMatrixUnifRef()

void OverlappingAlgebraicGhostingTest::testGhostingNullCouplingMatrixUnifRef ( )
inline

Definition at line 534 of file overlapping_coupling_test.C.

535  {
536  LOG_UNIT_TEST;
537  std::unique_ptr<CouplingMatrix> coupling_matrix;
538 
539  this->run_ghosting_test(2, false);
540  }
void run_ghosting_test(const unsigned int n_refinements, bool build_coupling_matrix)

Member Data Documentation

◆ _es

std::unique_ptr<EquationSystems> OverlappingTestBase::_es
protectedinherited

Definition at line 236 of file overlapping_coupling_test.C.

◆ _mesh

std::unique_ptr<MeshBase> OverlappingTestBase::_mesh
protectedinherited

Definition at line 234 of file overlapping_coupling_test.C.


The documentation for this class was generated from the following file: