Merge pull request #4047 from farscape-project/lX_norm

Refactor some code

Author: jwpeterson

include/base/dof_map.h

@@ -719,7 +719,7 @@ class DofMap : public ReferenceCountedObject<DofMap>,
    * \returns The number of degrees of freedom on each partition for a
    * particular variable \p vn.
    */
-  std::vector<dof_id_type> n_dofs_on_each_processor(const unsigned int vn) const
+  std::vector<dof_id_type> n_dofs_per_processor(const unsigned int vn) const
   {
     std::vector<dof_id_type> n_local_dofs(this->n_processors(), 0);
     this->comm().allgather(this->n_local_dofs(vn), n_local_dofs);

include/numerics/petsc_matrix.h

@@ -242,6 +242,8 @@ class PetscMatrix final : public PetscMatrixBase<T>
 
   virtual Real l1_norm () const override;
 
+  virtual Real frobenius_norm () const;
+
   virtual Real linfty_norm () const override;
 
   /**
@@ -360,6 +362,14 @@ class PetscMatrix final : public PetscMatrixBase<T>
   mutable Threads::spin_mutex _petsc_matrix_mutex;
 #endif
 
+  /**
+   * \returns A norm of the matrix, where the type of norm to compute is
+   * determined by the template parameter N of the PETSc-defined type NormType.
+   * The valid template arguments are NORM_1, NORM_FROBENIUS and NORM_INFINITY,
+   * as used to define l1_norm(), frobenius_norm() and linfty_norm().
+   */
+  template <NormType N> Real norm () const;
+
   friend class ::PetscMatrixTest;
 };
 

include/numerics/petsc_vector.h

@@ -465,6 +465,14 @@ class PetscVector final : public NumericVector<T>
    * Whether or not the data array is for read only access
    */
   mutable bool _values_read_only;
+
+  /**
+   * \returns A norm of the vector, where the type of norm to compute is
+   * determined by the template parameter N of the PETSc-defined type NormType.
+   * The valid template arguments are NORM_1, NORM_2 and NORM_INFINITY, as used
+   * to define l1_norm(), l2_norm() and linfty_norm().
+   */
+  template <NormType N> Real norm () const;
 };
 
 

src/numerics/petsc_matrix.C

@@ -466,7 +466,8 @@ std::unique_ptr<SparseMatrix<T>> PetscMatrix<T>::clone () const
 
 
 template <typename T>
-Real PetscMatrix<T>::l1_norm () const
+template <NormType N>
+Real PetscMatrix<T>::norm () const
 {
   libmesh_assert (this->initialized());
 
@@ -477,32 +478,26 @@ Real PetscMatrix<T>::l1_norm () const
 
   libmesh_assert (this->closed());
 
-  LibmeshPetscCall(MatNorm(this->_mat, NORM_1, &petsc_value));
+  LibmeshPetscCall(MatNorm(this->_mat, N, &petsc_value));
 
   value = static_cast<Real>(petsc_value);
 
   return value;
 }
-
-
-
+template <typename T>
+Real PetscMatrix<T>::l1_norm () const
+{
+  return PetscMatrix<T>::norm<NORM_1>();
+}
+template <typename T>
+Real PetscMatrix<T>::frobenius_norm () const
+{
+  return PetscMatrix<T>::norm<NORM_FROBENIUS>();
+}
 template <typename T>
 Real PetscMatrix<T>::linfty_norm () const
 {
-  libmesh_assert (this->initialized());
-
-  semiparallel_only();
-
-  PetscReal petsc_value;
-  Real value;
-
-  libmesh_assert (this->closed());
-
-  LibmeshPetscCall(MatNorm(this->_mat, NORM_INFINITY, &petsc_value));
-
-  value = static_cast<Real>(petsc_value);
-
-  return value;
+  return PetscMatrix<T>::norm<NORM_INFINITY>();
 }
 
 

src/numerics/petsc_vector.C

@@ -54,57 +54,40 @@ T PetscVector<T>::sum () const
 }
 
 
+
 template <typename T>
-Real PetscVector<T>::l1_norm () const
+template <NormType N>
+Real PetscVector<T>::norm () const
 {
+  parallel_object_only();
+
   this->_restore_array();
   libmesh_assert(this->closed());
 
   PetscReal value=0.;
 
-  LibmeshPetscCall(VecNorm (_vec, NORM_1, &value));
+  LibmeshPetscCall(VecNorm (_vec, N, &value));
 
   return static_cast<Real>(value);
 }
-
-
-
+template <typename T>
+Real PetscVector<T>::l1_norm () const
+{
+  return PetscVector<T>::norm<NORM_1>();
+}
 template <typename T>
 Real PetscVector<T>::l2_norm () const
 {
-  parallel_object_only();
-
-  this->_restore_array();
-  libmesh_assert(this->closed());
-
-  PetscReal value=0.;
-
-  LibmeshPetscCall(VecNorm (_vec, NORM_2, &value));
-
-  return static_cast<Real>(value);
+  return PetscVector<T>::norm<NORM_2>();
 }
-
-
-
-
 template <typename T>
 Real PetscVector<T>::linfty_norm () const
 {
-  parallel_object_only();
-
-  this->_restore_array();
-  libmesh_assert(this->closed());
-
-  PetscReal value=0.;
-
-  LibmeshPetscCall(VecNorm (_vec, NORM_INFINITY, &value));
-
-  return static_cast<Real>(value);
+  return PetscVector<T>::norm<NORM_INFINITY>();
 }
 
 
 
-
 template <typename T>
 NumericVector<T> &
 PetscVector<T>::operator += (const NumericVector<T> & v)

tests/systems/systems_test.C

@@ -604,7 +604,7 @@ public:
     for (const Node * node : mesh.node_ptr_range())
       CPPUNIT_ASSERT_EQUAL(dof_id_type(node->n_vars(0)), n_dofs);
 
-    std::vector<dof_id_type> each = sys.get_dof_map().n_dofs_on_each_processor(888);
+    std::vector<dof_id_type> each = sys.get_dof_map().n_dofs_per_processor(888);
     CPPUNIT_ASSERT_EQUAL(std::accumulate(each.begin(), each.end(), dof_id_type(0)), dof_id_type(5));
     CPPUNIT_ASSERT_EQUAL(sys.get_dof_map().n_dofs(888), dof_id_type(5));
   }