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

 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 (MeshBase &mesh)
 
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 505 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.

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 = libmesh_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( new Quad4 );
254  elem->set_id(0);
255  elem->subdomain_id() = 1;
256 
257  for (unsigned int n=0; n<4; n++)
258  elem->set_node(n) = _mesh->node_ptr(n);
259  }
260 
261  _mesh->add_point( Point(1.0,2.0),4 );
262  _mesh->add_point( Point(0.0,2.0),5 );
263 
264  {
265  Elem* elem = _mesh->add_elem( new Quad4 );
266  elem->set_id(1);
267  elem->subdomain_id() = 1;
268 
269  elem->set_node(0) = _mesh->node_ptr(3);
270  elem->set_node(1) = _mesh->node_ptr(2);
271  elem->set_node(2) = _mesh->node_ptr(4);
272  elem->set_node(3) = _mesh->node_ptr(5);
273  }
274 
275  _mesh->add_point( Point(0.0,0.0),6 );
276  _mesh->add_point( Point(1.0,0.0),7 );
277  _mesh->add_point( Point(1.0,2.0),8 );
278  _mesh->add_point( Point(0.0,2.0),9 );
279 
280  {
281  Elem* elem = _mesh->add_elem( new Quad4 );
282  elem->set_id(2);
283  elem->subdomain_id() = 2;
284 
285  elem->set_node(0) = _mesh->node_ptr(6);
286  elem->set_node(1) = _mesh->node_ptr(7);
287  elem->set_node(2) = _mesh->node_ptr(8);
288  elem->set_node(3) = _mesh->node_ptr(9);
289  }
290 
291  _mesh->partitioner() = libmesh_make_unique<OverlappingTestPartitioner>();
292 
293  _mesh->prepare_for_use();
294 
295 #ifdef LIBMESH_ENABLE_AMR
296  if (n_refinements > 0)
297  {
298  MeshRefinement refine(*_mesh);
299  refine.uniformly_refine(n_refinements);
300  }
301 #endif // LIBMESH_ENABLE_AMR
302  }

References libMesh::DofObject::set_id(), libMesh::Elem::set_node(), libMesh::Elem::subdomain_id(), TestCommWorld, and libMesh::MeshRefinement::uniformly_refine().

◆ clear()

void OverlappingTestBase::clear ( )
inlineprotectedinherited

Definition at line 324 of file overlapping_coupling_test.C.

325  {
326  _es.reset();
327  _mesh.reset();
328  }

◆ 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()

OverlappingAlgebraicGhostingTest::CPPUNIT_TEST_SUITE ( OverlappingAlgebraicGhostingTest  )

◆ CPPUNIT_TEST_SUITE_END()

OverlappingAlgebraicGhostingTest::CPPUNIT_TEST_SUITE_END ( )

◆ init()

void OverlappingTestBase::init ( MeshBase mesh)
inlineprotectedinherited

Definition at line 304 of file overlapping_coupling_test.C.

305  {
306  _es = libmesh_make_unique<EquationSystems>(*_mesh);
307  LinearImplicitSystem & sys = _es->add_system<LinearImplicitSystem> ("SimpleSystem");
308 
309  std::set<subdomain_id_type> sub_one;
310  sub_one.insert(1);
311 
312  std::set<subdomain_id_type> sub_two;
313  sub_two.insert(2);
314 
315  sys.add_variable("U", FIRST, LAGRANGE, &sub_two);
316  sys.add_variable("L", FIRST, LAGRANGE, &sub_two);
317 
318  sys.add_variable("V", FIRST, LAGRANGE, &sub_one);
319  sys.add_variable("p", FIRST, LAGRANGE, &sub_one);
320 
321  _es->init();
322  }

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

◆ 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.

545  {
546  this->build_quad_mesh(n_refinements);
547  this->init(*_mesh);
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, (int)elem->subdomain_id());
590 
591  const std::vector<libMesh::Point> & qpoints = subdomain_two_context.get_element_fe(u_var)->get_xyz();
592 
593  // Setup the context for the current element
594  subdomain_two_context.pre_fe_reinit(system,elem);
595  subdomain_two_context.elem_fe_reinit();
596 
597  std::set<subdomain_id_type> allowed_subdomains;
598  allowed_subdomains.insert(1);
599 
600  // Now loop over the quadrature points and find the subdomain-one element that overlaps
601  // with the current subdomain-two element and then initialize the FEMContext for the
602  // subdomain-one element. If the algebraic ghosting has not been done properly,
603  // this will error.
604  for ( const auto & qp : qpoints )
605  {
606  const Elem * overlapping_elem = (*point_locator)( qp, &allowed_subdomains );
607  CPPUNIT_ASSERT(overlapping_elem);
608 
609  // Setup the context for the overlapping element
610  subdomain_one_context.pre_fe_reinit(system,overlapping_elem);
611  subdomain_one_context.elem_fe_reinit();
612  }
613  }
614  }

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().

◆ setUp()

void OverlappingAlgebraicGhostingTest::setUp ( )
inline

Definition at line 519 of file overlapping_coupling_test.C.

520  {}

◆ setup_coupling_matrix()

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

Definition at line 330 of file overlapping_coupling_test.C.

331  {
332  System & system = _es->get_system("SimpleSystem");
333 
334  coupling = libmesh_make_unique<CouplingMatrix>(system.n_vars());
335 
336  const unsigned int u_var = system.variable_number("U");
337  const unsigned int l_var = system.variable_number("L");
338  const unsigned int v_var = system.variable_number("V");
339  const unsigned int p_var = system.variable_number("p");
340 
341  // Only adding the overlapping couplings since the primary ones should
342  // be there by default.
343  (*coupling)(u_var,v_var) = true;
344  (*coupling)(l_var,v_var) = true;
345  (*coupling)(l_var,p_var) = true;
346  (*coupling)(v_var,u_var) = true;
347  (*coupling)(v_var,l_var) = true;
348  }

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

◆ tearDown()

void OverlappingAlgebraicGhostingTest::tearDown ( )
inline

Definition at line 522 of file overlapping_coupling_test.C.

523  { this->clear(); }

◆ testGhostingCouplingMatrix()

void OverlappingAlgebraicGhostingTest::testGhostingCouplingMatrix ( )
inline

Definition at line 525 of file overlapping_coupling_test.C.

526  {
527  this->run_ghosting_test(0, true);
528  }

◆ testGhostingNullCouplingMatrix()

void OverlappingAlgebraicGhostingTest::testGhostingNullCouplingMatrix ( )
inline

Definition at line 530 of file overlapping_coupling_test.C.

531  {
532  this->run_ghosting_test(0, false);
533  }

◆ testGhostingNullCouplingMatrixUnifRef()

void OverlappingAlgebraicGhostingTest::testGhostingNullCouplingMatrixUnifRef ( )
inline

Definition at line 535 of file overlapping_coupling_test.C.

536  {
537  std::unique_ptr<CouplingMatrix> coupling_matrix;
538 
539  this->run_ghosting_test(2, false);
540  }

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:
libMesh::DofMap::add_algebraic_ghosting_functor
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:1862
libMesh::System
Manages consistently variables, degrees of freedom, and coefficient vectors.
Definition: system.h:100
libMesh::System::n_vars
unsigned int n_vars() const
Definition: system.h:2155
libMesh::DofObject::set_id
dof_id_type & set_id()
Definition: dof_object.h:776
libMesh::ParallelObject::comm
const Parallel::Communicator & comm() const
Definition: parallel_object.h:94
libMesh::DenseMatrix< Number >
libMesh::GHOSTED
Definition: enum_parallel_type.h:37
OverlappingAlgebraicGhostingTest::run_ghosting_test
void run_ghosting_test(const unsigned int n_refinements, bool build_coupling_matrix)
Definition: overlapping_coupling_test.C:544
libMesh::NumericVector::build
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...
Definition: numeric_vector.C:49
libMesh::MeshRefinement
Implements (adaptive) mesh refinement algorithms for a MeshBase.
Definition: mesh_refinement.h:61
OverlappingCouplingFunctor
Definition: overlapping_coupling_test.C:37
libMesh::System::n_local_dofs
dof_id_type n_local_dofs() const
Definition: system.C:187
OverlappingTestBase::_mesh
std::unique_ptr< MeshBase > _mesh
Definition: overlapping_coupling_test.C:234
libMesh::System::get_mesh
const MeshBase & get_mesh() const
Definition: system.h:2083
libMesh::System::add_variable
unsigned int add_variable(const std::string &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:1069
libMesh::System::current_local_solution
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:1551
OverlappingTestBase::_es
std::unique_ptr< EquationSystems > _es
Definition: overlapping_coupling_test.C:236
TestCommWorld
libMesh::Parallel::Communicator * TestCommWorld
Definition: driver.C:111
libMesh::Point
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:38
libMesh::Quad4
The QUAD4 is an element in 2D composed of 4 nodes.
Definition: face_quad4.h:51
libMesh::DofMap::get_send_list
const std::vector< dof_id_type > & get_send_list() const
Definition: dof_map.h:496
libMesh::Elem::set_node
virtual Node *& set_node(const unsigned int i)
Definition: elem.h:2059
libMesh::DofMap::reinit_send_list
void reinit_send_list(MeshBase &mesh)
Clears the _send_list vector and then rebuilds it.
Definition: dof_map.C:1690
OverlappingTestBase::setup_coupling_matrix
void setup_coupling_matrix(std::unique_ptr< CouplingMatrix > &coupling)
Definition: overlapping_coupling_test.C:330
OverlappingTestBase::build_quad_mesh
void build_quad_mesh(unsigned int n_refinements=0)
Definition: overlapping_coupling_test.C:238
libMesh::System::solution
std::unique_ptr< NumericVector< Number > > solution
Data structure to hold solution values.
Definition: system.h:1539
libMesh::DofMap
This class handles the numbering of degrees of freedom on a mesh.
Definition: dof_map.h:176
OverlappingTestBase::init
void init(MeshBase &mesh)
Definition: overlapping_coupling_test.C:304
libMesh::Elem::subdomain_id
subdomain_id_type subdomain_id() const
Definition: elem.h:2069
libMesh::Elem
This is the base class from which all geometric element types are derived.
Definition: elem.h:100
libMesh::System::variable_number
unsigned short int variable_number(const std::string &var) const
Definition: system.C:1232
libMesh::System::get_dof_map
const DofMap & get_dof_map() const
Definition: system.h:2099
libMesh::System::n_dofs
dof_id_type n_dofs() const
Definition: system.C:150
libMesh::LAGRANGE
Definition: enum_fe_family.h:36
libMesh::LinearImplicitSystem
Manages consistently variables, degrees of freedom, coefficient vectors, matrices and linear solvers ...
Definition: linear_implicit_system.h:55
OverlappingTestBase::clear
void clear()
Definition: overlapping_coupling_test.C:324
libMesh::FIRST
Definition: enum_order.h:42
libMesh::FEMContext
This class provides all data required for a physics package (e.g.
Definition: fem_context.h:62