]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify documentation and verify what I say by adding tests. 156/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 18 Sep 2014 00:36:11 +0000 (19:36 -0500)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 18 Sep 2014 00:38:45 +0000 (19:38 -0500)
include/deal.II/dofs/dof_handler.h
tests/mpi/has_active_dofs_01.cc [new file with mode: 0644]
tests/mpi/has_active_dofs_01.mpirun=10.output [new file with mode: 0644]
tests/mpi/has_active_dofs_02.cc [new file with mode: 0644]
tests/mpi/has_active_dofs_02.mpirun=10.output [new file with mode: 0644]

index 94d7e3169a11d335a5422b07d55a8b30b55e8431..067dc00acad1cbbe0e6ed242c295af1c50594baf 100644 (file)
@@ -390,13 +390,23 @@ public:
   bool has_level_dofs() const;
 
   /**
-   * This function returns whether
-   * this DoFHandler has active
-   * DoFs or in other words if
-   * distribute_dofs() has been
-   * called.
+   * This function returns whether this DoFHandler has active
+   * DoFs. This is equivalent to asking whether (i) distribute_dofs()
+   * has been called and (ii) the finite element for which degrees of
+   * freedom have been distributed actually has degrees of freedom
+   * (which is not the case for FE_Nothing, for example).
+   *
+   * If this object is based on a
+   * parallel::distributed::Triangulation, then the current function
+   * returns true if <i>any</i> partition of the parallel DoFHandler
+   * object has any degrees of freedom. In other words, the function
+   * returns true even if the Triangulation does not own any active
+   * cells on the current MPI process, but at least one process owns
+   * cells and at least this one process has any degrees of freedom
+   * associated with it.
    */
   bool has_active_dofs() const;
+
   /**
    * After distribute_dofs() with
    * an FESystem element, the block
diff --git a/tests/mpi/has_active_dofs_01.cc b/tests/mpi/has_active_dofs_01.cc
new file mode 100644 (file)
index 0000000..e3fdbcf
--- /dev/null
@@ -0,0 +1,117 @@
+// ---------------------------------------------------------------------
+// $Id$
+//
+// Copyright (C) 2009 - 2014 by the deal.II authors
+//
+// This file is part of the deal.II library.
+//
+// The deal.II library is free software; you can use it, redistribute
+// it, and/or modify it under the terms of the GNU Lesser General
+// Public License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+// The full text of the license can be found in the file LICENSE at
+// the top level of the deal.II distribution.
+//
+// ---------------------------------------------------------------------
+
+
+
+// verify that DoFHandler::has_active_dofs() works also on meshes
+// where some processors have no active dofs because they don't own
+// any cells
+
+#include "../tests.h"
+#include <deal.II/base/logstream.h>
+#include <deal.II/grid/tria.h>
+#include <deal.II/distributed/tria.h>
+#include <deal.II/grid/tria_accessor.h>
+#include <deal.II/grid/grid_generator.h>
+#include <deal.II/dofs/dof_handler.h>
+#include <deal.II/fe/fe_q.h>
+
+
+#include <fstream>
+
+
+template<int dim>
+void test()
+{
+  unsigned int myid = Utilities::MPI::this_mpi_process (MPI_COMM_WORLD);
+
+  // create a mesh with fewer cells than there are MPI processes
+  parallel::distributed::Triangulation<dim> tr(MPI_COMM_WORLD);
+  GridGenerator::hyper_cube(tr);
+  tr.refine_global(2);
+
+  // assign DoFs to the mesh
+  FE_Q<dim> fe(1);
+  DoFHandler<dim> dof_handler (tr);
+  dof_handler.distribute_dofs (fe);
+  
+  // there are 2^(2*dim) cells to be owned by this distributed
+  // triangulation. however, since p4est makes sure that all active
+  // children belonging to the same parent are stored on the same
+  // processor, only 2^dim processors can own cells.
+  //
+  // let each of the processors report whether they own
+  // cells or now by setting a bit mask that we then add up.
+  // output which processor owns something and which don't
+  const int cells_owned = Utilities::MPI::sum (tr.n_locally_owned_active_cells() > 0
+                                              ?
+                                              1 << Utilities::MPI::this_mpi_process (MPI_COMM_WORLD)
+                                              :
+                                              0,
+                                              MPI_COMM_WORLD);
+  if (Utilities::MPI::this_mpi_process (MPI_COMM_WORLD) == 0)
+    {
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       deallog << "Processor " << i << " has cells: "
+               << ((cells_owned & (1 << i)) ? "yes" : "no")
+               << std::endl;
+      
+      unsigned int n_owning_processors = 0;      
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       if (cells_owned & (1 << i))
+         ++n_owning_processors;
+      deallog << "# processors owning cells=" << n_owning_processors << std::endl;
+    }
+
+  // now check how many processors own DoFs using the same procedure
+  const int dofs_owned = Utilities::MPI::sum (dof_handler.has_active_dofs()
+                                             ?
+                                             1 << Utilities::MPI::this_mpi_process (MPI_COMM_WORLD)
+                                             :
+                                             0,
+                                             MPI_COMM_WORLD);
+  if (Utilities::MPI::this_mpi_process (MPI_COMM_WORLD) == 0)
+    {
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       deallog << "Processor " << i << " has dofs: "
+               << ((dofs_owned & (1 << i)) ? "yes" : "no")
+               << std::endl;
+      
+      unsigned int n_owning_processors = 0;      
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       if (dofs_owned & (1 << i))
+         ++n_owning_processors;
+      deallog << "# processors owning dofs=" << n_owning_processors << std::endl;
+    }
+  
+  if (Utilities::MPI::this_mpi_process (MPI_COMM_WORLD) == 0)
+    deallog << std::endl;
+}
+
+
+int main(int argc, char *argv[])
+{
+  Utilities::MPI::MPI_InitFinalize mpi_initialization(argc, argv, 1);
+  MPILogInitAll log;
+
+  deallog.push("2d");
+  test<2>();
+  deallog.pop();
+
+  deallog.push("3d");
+  test<3>();
+  deallog.pop();
+}
diff --git a/tests/mpi/has_active_dofs_01.mpirun=10.output b/tests/mpi/has_active_dofs_01.mpirun=10.output
new file mode 100644 (file)
index 0000000..c8e6e14
--- /dev/null
@@ -0,0 +1,65 @@
+
+DEAL:0:2d::Processor 0 has cells: no
+DEAL:0:2d::Processor 1 has cells: yes
+DEAL:0:2d::Processor 2 has cells: no
+DEAL:0:2d::Processor 3 has cells: yes
+DEAL:0:2d::Processor 4 has cells: no
+DEAL:0:2d::Processor 5 has cells: no
+DEAL:0:2d::Processor 6 has cells: yes
+DEAL:0:2d::Processor 7 has cells: no
+DEAL:0:2d::Processor 8 has cells: yes
+DEAL:0:2d::Processor 9 has cells: no
+DEAL:0:2d::# processors owning cells=4
+DEAL:0:2d::Processor 0 has dofs: yes
+DEAL:0:2d::Processor 1 has dofs: yes
+DEAL:0:2d::Processor 2 has dofs: yes
+DEAL:0:2d::Processor 3 has dofs: yes
+DEAL:0:2d::Processor 4 has dofs: yes
+DEAL:0:2d::Processor 5 has dofs: yes
+DEAL:0:2d::Processor 6 has dofs: yes
+DEAL:0:2d::Processor 7 has dofs: yes
+DEAL:0:2d::Processor 8 has dofs: yes
+DEAL:0:2d::Processor 9 has dofs: yes
+DEAL:0:2d::# processors owning dofs=10
+DEAL:0:2d::
+DEAL:0:3d::Processor 0 has cells: yes
+DEAL:0:3d::Processor 1 has cells: yes
+DEAL:0:3d::Processor 2 has cells: no
+DEAL:0:3d::Processor 3 has cells: yes
+DEAL:0:3d::Processor 4 has cells: yes
+DEAL:0:3d::Processor 5 has cells: yes
+DEAL:0:3d::Processor 6 has cells: yes
+DEAL:0:3d::Processor 7 has cells: no
+DEAL:0:3d::Processor 8 has cells: yes
+DEAL:0:3d::Processor 9 has cells: yes
+DEAL:0:3d::# processors owning cells=8
+DEAL:0:3d::Processor 0 has dofs: yes
+DEAL:0:3d::Processor 1 has dofs: yes
+DEAL:0:3d::Processor 2 has dofs: yes
+DEAL:0:3d::Processor 3 has dofs: yes
+DEAL:0:3d::Processor 4 has dofs: yes
+DEAL:0:3d::Processor 5 has dofs: yes
+DEAL:0:3d::Processor 6 has dofs: yes
+DEAL:0:3d::Processor 7 has dofs: yes
+DEAL:0:3d::Processor 8 has dofs: yes
+DEAL:0:3d::Processor 9 has dofs: yes
+DEAL:0:3d::# processors owning dofs=10
+DEAL:0:3d::
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/mpi/has_active_dofs_02.cc b/tests/mpi/has_active_dofs_02.cc
new file mode 100644 (file)
index 0000000..c4f4699
--- /dev/null
@@ -0,0 +1,119 @@
+// ---------------------------------------------------------------------
+// $Id$
+//
+// Copyright (C) 2009 - 2014 by the deal.II authors
+//
+// This file is part of the deal.II library.
+//
+// The deal.II library is free software; you can use it, redistribute
+// it, and/or modify it under the terms of the GNU Lesser General
+// Public License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+// The full text of the license can be found in the file LICENSE at
+// the top level of the deal.II distribution.
+//
+// ---------------------------------------------------------------------
+
+
+
+// verify that DoFHandler::has_active_dofs() works also on meshes
+// where some processors have no active dofs because they don't own
+// any cells
+//
+// like _01, but for FE_Nothing
+
+#include "../tests.h"
+#include <deal.II/base/logstream.h>
+#include <deal.II/grid/tria.h>
+#include <deal.II/distributed/tria.h>
+#include <deal.II/grid/tria_accessor.h>
+#include <deal.II/grid/grid_generator.h>
+#include <deal.II/dofs/dof_handler.h>
+#include <deal.II/fe/fe_nothing.h>
+
+
+#include <fstream>
+
+
+template<int dim>
+void test()
+{
+  unsigned int myid = Utilities::MPI::this_mpi_process (MPI_COMM_WORLD);
+
+  // create a mesh with fewer cells than there are MPI processes
+  parallel::distributed::Triangulation<dim> tr(MPI_COMM_WORLD);
+  GridGenerator::hyper_cube(tr);
+  tr.refine_global(2);
+
+  // assign DoFs to the mesh
+  FE_Nothing<dim> fe(1);
+  DoFHandler<dim> dof_handler (tr);
+  dof_handler.distribute_dofs (fe);
+  
+  // there are 2^(2*dim) cells to be owned by this distributed
+  // triangulation. however, since p4est makes sure that all active
+  // children belonging to the same parent are stored on the same
+  // processor, only 2^dim processors can own cells.
+  //
+  // let each of the processors report whether they own
+  // cells or now by setting a bit mask that we then add up.
+  // output which processor owns something and which don't
+  const int cells_owned = Utilities::MPI::sum (tr.n_locally_owned_active_cells() > 0
+                                              ?
+                                              1 << Utilities::MPI::this_mpi_process (MPI_COMM_WORLD)
+                                              :
+                                              0,
+                                              MPI_COMM_WORLD);
+  if (Utilities::MPI::this_mpi_process (MPI_COMM_WORLD) == 0)
+    {
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       deallog << "Processor " << i << " has cells: "
+               << ((cells_owned & (1 << i)) ? "yes" : "no")
+               << std::endl;
+      
+      unsigned int n_owning_processors = 0;      
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       if (cells_owned & (1 << i))
+         ++n_owning_processors;
+      deallog << "# processors owning cells=" << n_owning_processors << std::endl;
+    }
+
+  // now check how many processors own DoFs using the same procedure
+  const int dofs_owned = Utilities::MPI::sum (dof_handler.has_active_dofs()
+                                             ?
+                                             1 << Utilities::MPI::this_mpi_process (MPI_COMM_WORLD)
+                                             :
+                                             0,
+                                             MPI_COMM_WORLD);
+  if (Utilities::MPI::this_mpi_process (MPI_COMM_WORLD) == 0)
+    {
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       deallog << "Processor " << i << " has dofs: "
+               << ((dofs_owned & (1 << i)) ? "yes" : "no")
+               << std::endl;
+      
+      unsigned int n_owning_processors = 0;      
+      for (unsigned int i=0; i<Utilities::MPI::n_mpi_processes (MPI_COMM_WORLD); ++i)
+       if (dofs_owned & (1 << i))
+         ++n_owning_processors;
+      deallog << "# processors owning dofs=" << n_owning_processors << std::endl;
+    }
+  
+  if (Utilities::MPI::this_mpi_process (MPI_COMM_WORLD) == 0)
+    deallog << std::endl;
+}
+
+
+int main(int argc, char *argv[])
+{
+  Utilities::MPI::MPI_InitFinalize mpi_initialization(argc, argv, 1);
+  MPILogInitAll log;
+
+  deallog.push("2d");
+  test<2>();
+  deallog.pop();
+
+  deallog.push("3d");
+  test<3>();
+  deallog.pop();
+}
diff --git a/tests/mpi/has_active_dofs_02.mpirun=10.output b/tests/mpi/has_active_dofs_02.mpirun=10.output
new file mode 100644 (file)
index 0000000..66ad5d1
--- /dev/null
@@ -0,0 +1,65 @@
+
+DEAL:0:2d::Processor 0 has cells: no
+DEAL:0:2d::Processor 1 has cells: yes
+DEAL:0:2d::Processor 2 has cells: no
+DEAL:0:2d::Processor 3 has cells: yes
+DEAL:0:2d::Processor 4 has cells: no
+DEAL:0:2d::Processor 5 has cells: no
+DEAL:0:2d::Processor 6 has cells: yes
+DEAL:0:2d::Processor 7 has cells: no
+DEAL:0:2d::Processor 8 has cells: yes
+DEAL:0:2d::Processor 9 has cells: no
+DEAL:0:2d::# processors owning cells=4
+DEAL:0:2d::Processor 0 has dofs: no
+DEAL:0:2d::Processor 1 has dofs: no
+DEAL:0:2d::Processor 2 has dofs: no
+DEAL:0:2d::Processor 3 has dofs: no
+DEAL:0:2d::Processor 4 has dofs: no
+DEAL:0:2d::Processor 5 has dofs: no
+DEAL:0:2d::Processor 6 has dofs: no
+DEAL:0:2d::Processor 7 has dofs: no
+DEAL:0:2d::Processor 8 has dofs: no
+DEAL:0:2d::Processor 9 has dofs: no
+DEAL:0:2d::# processors owning dofs=0
+DEAL:0:2d::
+DEAL:0:3d::Processor 0 has cells: yes
+DEAL:0:3d::Processor 1 has cells: yes
+DEAL:0:3d::Processor 2 has cells: no
+DEAL:0:3d::Processor 3 has cells: yes
+DEAL:0:3d::Processor 4 has cells: yes
+DEAL:0:3d::Processor 5 has cells: yes
+DEAL:0:3d::Processor 6 has cells: yes
+DEAL:0:3d::Processor 7 has cells: no
+DEAL:0:3d::Processor 8 has cells: yes
+DEAL:0:3d::Processor 9 has cells: yes
+DEAL:0:3d::# processors owning cells=8
+DEAL:0:3d::Processor 0 has dofs: no
+DEAL:0:3d::Processor 1 has dofs: no
+DEAL:0:3d::Processor 2 has dofs: no
+DEAL:0:3d::Processor 3 has dofs: no
+DEAL:0:3d::Processor 4 has dofs: no
+DEAL:0:3d::Processor 5 has dofs: no
+DEAL:0:3d::Processor 6 has dofs: no
+DEAL:0:3d::Processor 7 has dofs: no
+DEAL:0:3d::Processor 8 has dofs: no
+DEAL:0:3d::Processor 9 has dofs: no
+DEAL:0:3d::# processors owning dofs=0
+DEAL:0:3d::
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.