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

Public Member Functions

 LIBMESH_CPPUNIT_TEST_SUITE (OverlappingCouplingGhostingTest)
 
 CPPUNIT_TEST (testSparsityCouplingMatrix)
 
 CPPUNIT_TEST (testSparsityNullCouplingMatrix)
 
 CPPUNIT_TEST (testSparsityNullCouplingMatrixUnifRef)
 
 CPPUNIT_TEST_SUITE_END ()
 
void setUp ()
 
void tearDown ()
 
void testSparsityCouplingMatrix ()
 
void testSparsityNullCouplingMatrix ()
 
void testSparsityNullCouplingMatrixUnifRef ()
 

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_sparsity_pattern_test (const unsigned int n_refinements, bool build_coupling_matrix)
 

Detailed Description

Definition at line 643 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 249 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().

250  {
251  // We are making assumptions in various places about the presence
252  // of the elements on the current processor so we're restricting to
253  // ReplicatedMesh for now.
254  _mesh = std::make_unique<ReplicatedMesh>(*TestCommWorld);
255 
256  _mesh->set_mesh_dimension(2);
257 
258  _mesh->add_point( Point(0.0,0.0),0 );
259  _mesh->add_point( Point(1.0,0.0),1 );
260  _mesh->add_point( Point(1.0,1.0),2 );
261  _mesh->add_point( Point(0.0,1.0),3 );
262 
263  {
264  Elem * elem = _mesh->add_elem(Elem::build_with_id(QUAD4, 0));
265  elem->subdomain_id() = 1;
266 
267  for (unsigned int n=0; n<4; n++)
268  elem->set_node(n, _mesh->node_ptr(n));
269  }
270 
271  _mesh->add_point( Point(1.0,2.0),4 );
272  _mesh->add_point( Point(0.0,2.0),5 );
273 
274  {
275  Elem * elem = _mesh->add_elem(Elem::build_with_id(QUAD4, 1));
276  elem->subdomain_id() = 1;
277 
278  elem->set_node(0, _mesh->node_ptr(3));
279  elem->set_node(1, _mesh->node_ptr(2));
280  elem->set_node(2, _mesh->node_ptr(4));
281  elem->set_node(3, _mesh->node_ptr(5));
282  }
283 
284  _mesh->add_point( Point(0.0,0.0),6 );
285  _mesh->add_point( Point(1.0,0.0),7 );
286  _mesh->add_point( Point(1.0,2.0),8 );
287  _mesh->add_point( Point(0.0,2.0),9 );
288 
289  {
290  Elem* elem = _mesh->add_elem(Elem::build_with_id(QUAD4, 2));
291  elem->subdomain_id() = 2;
292 
293  elem->set_node(0, _mesh->node_ptr(6));
294  elem->set_node(1, _mesh->node_ptr(7));
295  elem->set_node(2, _mesh->node_ptr(8));
296  elem->set_node(3, _mesh->node_ptr(9));
297  }
298 
299  _mesh->partitioner() = std::make_unique<OverlappingTestPartitioner>();
300 
301  _mesh->prepare_for_use();
302 
303 #ifdef LIBMESH_ENABLE_AMR
304  if (n_refinements > 0)
305  {
306  MeshRefinement refine(*_mesh);
307  refine.uniformly_refine(n_refinements);
308  }
309 #else
310  CPPUNIT_ASSERT_EQUAL(n_refinements, 0u);
311 #endif // LIBMESH_ENABLE_AMR
312  }
virtual Node *& set_node(const unsigned int i)
Definition: elem.h:2564
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:2588
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:39

◆ clear()

void OverlappingTestBase::clear ( )
inlineprotectedinherited

Definition at line 334 of file overlapping_coupling_test.C.

335  {
336  _es.reset();
337  _mesh.reset();
338  }
std::unique_ptr< MeshBase > _mesh
std::unique_ptr< EquationSystems > _es

◆ CPPUNIT_TEST() [1/3]

OverlappingCouplingGhostingTest::CPPUNIT_TEST ( testSparsityCouplingMatrix  )

◆ CPPUNIT_TEST() [2/3]

OverlappingCouplingGhostingTest::CPPUNIT_TEST ( testSparsityNullCouplingMatrix  )

◆ CPPUNIT_TEST() [3/3]

OverlappingCouplingGhostingTest::CPPUNIT_TEST ( testSparsityNullCouplingMatrixUnifRef  )

◆ CPPUNIT_TEST_SUITE_END()

OverlappingCouplingGhostingTest::CPPUNIT_TEST_SUITE_END ( )

◆ init()

void OverlappingTestBase::init ( )
inlineprotectedinherited

Definition at line 314 of file overlapping_coupling_test.C.

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

315  {
316  _es = std::make_unique<EquationSystems>(*_mesh);
317  LinearImplicitSystem & sys = _es->add_system<LinearImplicitSystem> ("SimpleSystem");
318 
319  std::set<subdomain_id_type> sub_one;
320  sub_one.insert(1);
321 
322  std::set<subdomain_id_type> sub_two;
323  sub_two.insert(2);
324 
325  sys.add_variable("U", FIRST, LAGRANGE, &sub_two);
326  sys.add_variable("L", FIRST, LAGRANGE, &sub_two);
327 
328  sys.add_variable("V", FIRST, LAGRANGE, &sub_one);
329  sys.add_variable("p", FIRST, LAGRANGE, &sub_one);
330 
331  _es->init();
332  }
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:1344

◆ LIBMESH_CPPUNIT_TEST_SUITE()

OverlappingCouplingGhostingTest::LIBMESH_CPPUNIT_TEST_SUITE ( OverlappingCouplingGhostingTest  )

◆ run_sparsity_pattern_test()

void OverlappingCouplingGhostingTest::run_sparsity_pattern_test ( const unsigned int  n_refinements,
bool  build_coupling_matrix 
)
inlineprivate

Definition at line 685 of file overlapping_coupling_test.C.

References libMesh::DofMap::add_coupling_functor(), libMesh::SparseMatrix< T >::add_matrix(), libMesh::NumericVector< T >::build(), libMesh::DofMap::clear_sparsity(), libMesh::SparseMatrix< T >::close(), libMesh::ParallelObject::comm(), libMesh::DofMap::compute_sparsity(), libMesh::System::current_local_solution, libMesh::FEMContext::elem_fe_reinit(), libMesh::DiffContext::get_dof_indices(), libMesh::System::get_dof_map(), libMesh::DiffContext::get_elem_jacobian(), libMesh::FEMContext::get_element_fe(), libMesh::System::get_mesh(), libMesh::DofMap::get_send_list(), libMesh::ImplicitSystem::get_system_matrix(), libMesh::DenseMatrix< T >::get_values(), libMesh::GHOSTED, libMesh::TriangleWrapper::init(), libMesh::SparseMatrix< T >::init(), libMesh::DofMap::is_attached(), libMesh::libmesh_assert(), libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), libMesh::FEMContext::pre_fe_reinit(), libMesh::DofMap::reinit_send_list(), libMesh::DenseMatrix< T >::resize(), libMesh::System::solution, and libMesh::System::variable_number().

686  {
687  this->build_quad_mesh(n_refinements);
688  this->init();
689 
690  std::unique_ptr<CouplingMatrix> coupling_matrix;
691  if (build_coupling_matrix)
692  this->setup_coupling_matrix(coupling_matrix);
693 
694  LinearImplicitSystem & system = _es->get_system<LinearImplicitSystem>("SimpleSystem");
695 
696  // If we don't add this coupling functor and properly recompute the
697  // sparsity pattern, then PETSc will throw a malloc error when we
698  // try to assemble into the global matrix
699  OverlappingCouplingFunctor coupling_functor(system);
700  coupling_functor.set_coupling_matrix(coupling_matrix);
701 
702  DofMap & dof_map = system.get_dof_map();
703  dof_map.add_coupling_functor(coupling_functor);
704  dof_map.reinit_send_list(system.get_mesh());
705 
706  // Update current local solution
708 
709  system.current_local_solution->init(system.n_dofs(), system.n_local_dofs(),
710  dof_map.get_send_list(), false,
712 
713  system.solution->localize(*(system.current_local_solution),dof_map.get_send_list());
714 
715  // Now that we've added the coupling functor, we need
716  // to recompute the sparsity
717  dof_map.clear_sparsity();
718  dof_map.compute_sparsity(system.get_mesh());
719 
720  // Now that we've recomputed the sparsity pattern, we need
721  // to reinitialize the system matrix.
722  SparseMatrix<Number> & matrix = system.get_system_matrix();
723  libmesh_assert(dof_map.is_attached(matrix));
724  matrix.init();
725 
726  std::unique_ptr<PointLocatorBase> point_locator = _mesh->sub_point_locator();
727 
728  const unsigned int u_var = system.variable_number("U");
729  const unsigned int v_var = system.variable_number("V");
730 
731  DenseMatrix<Number> K12, K21;
732 
733  FEMContext subdomain_one_context(system);
734  subdomain_one_context.get_element_fe(u_var)->get_nothing();
735  subdomain_one_context.get_element_fe(v_var)->get_nothing();
736 
737  FEMContext subdomain_two_context(system);
738  subdomain_two_context.get_element_fe(u_var)->get_xyz();
739  subdomain_two_context.get_element_fe(v_var)->get_nothing();
740 
741  // Add normally coupled parts of the matrix
742  for (const auto & elem : _mesh->active_local_subdomain_elements_ptr_range(1))
743  {
744  subdomain_one_context.pre_fe_reinit(system,elem);
745  subdomain_one_context.elem_fe_reinit();
746 
747  std::vector<dof_id_type> & rows = subdomain_one_context.get_dof_indices();
748 
749  // Fill with ones in case PETSc ignores the zeros at some point
750  std::fill( subdomain_one_context.get_elem_jacobian().get_values().begin(),
751  subdomain_one_context.get_elem_jacobian().get_values().end(),
752  1);
753 
754  // Insert the Jacobian for the dofs for this element
755  matrix.add_matrix( subdomain_one_context.get_elem_jacobian(), rows );
756  }
757 
758  for (const auto & elem : _mesh->active_local_subdomain_elements_ptr_range(2))
759  {
760  // A little extra unit testing on the range iterator
761  CPPUNIT_ASSERT_EQUAL(2, static_cast<int>(elem->subdomain_id()));
762 
763  const std::vector<libMesh::Point> & qpoints = subdomain_two_context.get_element_fe(u_var)->get_xyz();
764 
765  // Setup the context for the current element
766  subdomain_two_context.pre_fe_reinit(system,elem);
767  subdomain_two_context.elem_fe_reinit();
768 
769  // We're only assembling rows for the dofs on subdomain 2 (U,L), so
770  // the current element will have all those dof_indices.
771  std::vector<dof_id_type> & rows = subdomain_two_context.get_dof_indices();
772 
773  std::fill( subdomain_two_context.get_elem_jacobian().get_values().begin(),
774  subdomain_two_context.get_elem_jacobian().get_values().end(),
775  1);
776 
777  // Insert the Jacobian for the normally coupled dofs for this element
778  matrix.add_matrix( subdomain_two_context.get_elem_jacobian(), rows );
779 
780  std::set<subdomain_id_type> allowed_subdomains;
781  allowed_subdomains.insert(1);
782 
783  // Now loop over the quadrature points and find the subdomain-one element that overlaps
784  // with the current subdomain-two element and then add a local element matrix with
785  // the coupling to the global matrix to try and trip any issues with sparsity pattern
786  // construction
787  for ( const auto & qp : qpoints )
788  {
789  const Elem * overlapping_elem = (*point_locator)( qp, &allowed_subdomains );
790  CPPUNIT_ASSERT(overlapping_elem);
791 
792  // Setup the context for the overlapping element
793  subdomain_one_context.pre_fe_reinit(system,overlapping_elem);
794  subdomain_one_context.elem_fe_reinit();
795 
796  // We're only coupling to the "V" variable so only need those dof indices
797  std::vector<dof_id_type> & v_indices = subdomain_one_context.get_dof_indices(v_var);
798  std::vector<dof_id_type> columns(rows);
799  columns.insert( columns.end(), v_indices.begin(), v_indices.end() );
800 
801  // This will also zero the matrix so we can just insert zeros for this test
802  K21.resize( rows.size(), columns.size() );
803 
804  std::fill(K21.get_values().begin(), K21.get_values().end(), 1);
805 
806  // Now adding this local matrix to the global would trip a PETSc
807  // malloc error if the sparsity pattern hasn't been correctly
808  // built to include the overlapping coupling.
809  matrix.add_matrix (K21, rows, columns);
810 
811  // Now add the other part of the overlapping coupling
812  K12.resize(v_indices.size(), rows.size());
813  std::fill(K12.get_values().begin(), K12.get_values().end(), 1);
814  matrix.add_matrix(K12,v_indices,rows);
815  }
816  } // end element loop
817 
818  // We need to make sure to close the matrix for this test. There could still
819  // be PETSc malloc errors tripped here if we didn't allocate the off-processor
820  // part of the sparsity pattern correctly.
821  matrix.close();
822  }
void setup_coupling_matrix(std::unique_ptr< CouplingMatrix > &coupling)
Manages consistently variables, degrees of freedom, coefficient vectors, matrices and linear solvers ...
bool is_attached(SparseMatrix< Number > &matrix)
Matrices should not be attached more than once.
Definition: dof_map.C:295
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:155
const MeshBase & get_mesh() const
Definition: system.h:2401
void add_coupling_functor(GhostingFunctor &coupling_functor, bool to_mesh=true)
Adds a functor which can specify coupling requirements for creation of sparse matrices.
Definition: dof_map.C:2005
dof_id_type n_dofs() const
Definition: system.C:118
unsigned int variable_number(std::string_view var) const
Definition: system.C:1398
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:179
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:1877
virtual void add_matrix(const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols)=0
Add the full matrix dm to the SparseMatrix.
std::unique_ptr< NumericVector< Number > > solution
Data structure to hold solution values.
Definition: system.h:1655
libmesh_assert(ctx)
This class provides all data required for a physics package (e.g.
Definition: fem_context.h:62
std::vector< T > & get_values()
Definition: dense_matrix.h:382
virtual void close()=0
Calls the SparseMatrix&#39;s internal assembly routines, ensuring that the values are consistent across p...
void resize(const unsigned int new_m, const unsigned int new_n)
Resizes the matrix to the specified size and calls zero().
Definition: dense_matrix.h:895
static std::unique_ptr< NumericVector< T > > build(const Parallel::Communicator &comm, SolverPackage solver_package=libMesh::default_solver_package(), ParallelType parallel_type=AUTOMATIC)
Builds a NumericVector on the processors in communicator comm using the linear solver package specifi...
void clear_sparsity()
Clears the sparsity pattern.
Definition: dof_map.C:1981
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:1667
void compute_sparsity(const MeshBase &)
Computes the sparsity pattern for the matrices corresponding to proc_id and sends that data to Linear...
Definition: dof_map.C:1960
const DofMap & get_dof_map() const
Definition: system.h:2417
const SparseMatrix< Number > & get_system_matrix() const
const std::vector< dof_id_type > & get_send_list() const
Definition: dof_map.h:533
virtual void init(const numeric_index_type m, const numeric_index_type n, const numeric_index_type m_l, const numeric_index_type n_l, const numeric_index_type nnz=30, const numeric_index_type noz=10, const numeric_index_type blocksize=1)=0
Initialize SparseMatrix with the specified sizes.

◆ setUp()

void OverlappingCouplingGhostingTest::setUp ( )
inline

Definition at line 659 of file overlapping_coupling_test.C.

660  {}

◆ setup_coupling_matrix()

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

Definition at line 340 of file overlapping_coupling_test.C.

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

341  {
342  System & system = _es->get_system("SimpleSystem");
343 
344  coupling = std::make_unique<CouplingMatrix>(system.n_vars());
345 
346  const unsigned int u_var = system.variable_number("U");
347  const unsigned int l_var = system.variable_number("L");
348  const unsigned int v_var = system.variable_number("V");
349  const unsigned int p_var = system.variable_number("p");
350 
351  // Only adding the overlapping couplings since the primary ones should
352  // be there by default.
353  (*coupling)(u_var,v_var) = true;
354  (*coupling)(l_var,v_var) = true;
355  (*coupling)(l_var,p_var) = true;
356  (*coupling)(v_var,u_var) = true;
357  (*coupling)(v_var,l_var) = true;
358  }
unsigned int variable_number(std::string_view var) const
Definition: system.C:1398
std::unique_ptr< EquationSystems > _es
Manages consistently variables, degrees of freedom, and coefficient vectors.
Definition: system.h:98
unsigned int n_vars() const
Definition: system.C:2674

◆ tearDown()

void OverlappingCouplingGhostingTest::tearDown ( )
inline

Definition at line 662 of file overlapping_coupling_test.C.

663  { this->clear(); }

◆ testSparsityCouplingMatrix()

void OverlappingCouplingGhostingTest::testSparsityCouplingMatrix ( )
inline

Definition at line 665 of file overlapping_coupling_test.C.

666  {
667  LOG_UNIT_TEST;
668  this->run_sparsity_pattern_test(0, true);
669  }
void run_sparsity_pattern_test(const unsigned int n_refinements, bool build_coupling_matrix)

◆ testSparsityNullCouplingMatrix()

void OverlappingCouplingGhostingTest::testSparsityNullCouplingMatrix ( )
inline

Definition at line 671 of file overlapping_coupling_test.C.

672  {
673  LOG_UNIT_TEST;
674  this->run_sparsity_pattern_test(0, false);
675  }
void run_sparsity_pattern_test(const unsigned int n_refinements, bool build_coupling_matrix)

◆ testSparsityNullCouplingMatrixUnifRef()

void OverlappingCouplingGhostingTest::testSparsityNullCouplingMatrixUnifRef ( )
inline

Definition at line 677 of file overlapping_coupling_test.C.

678  {
679  LOG_UNIT_TEST;
680  this->run_sparsity_pattern_test(1, false);
681  }
void run_sparsity_pattern_test(const unsigned int n_refinements, bool build_coupling_matrix)

Member Data Documentation

◆ _es

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

Definition at line 247 of file overlapping_coupling_test.C.

◆ _mesh

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

Definition at line 245 of file overlapping_coupling_test.C.


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