[cig-commits] r15584 - in short/3D/PyLith/branches/pylith-friction/libsrc: problems utils

brad at geodynamics.org brad at geodynamics.org
Mon Aug 24 13:55:55 PDT 2009 

Author: brad
Date: 2009-08-24 13:55:54 -0700 (Mon, 24 Aug 2009)
New Revision: 15584

Modified:
   short/3D/PyLith/branches/pylith-friction/libsrc/problems/Formulation.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/problems/Solver.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverLinear.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverNonlinear.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/EventLogger.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/TestArray.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/array.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/arrayfwd.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/constdefs.h
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/lapack.h
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/macrodefs.h
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscerror.h
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscfwd.h
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievefwd.hh
   short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievetypes.hh
Log:
More work on adding doxygen stuff to header files.

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/problems/Formulation.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/problems/Formulation.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/problems/Formulation.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -32,6 +32,7 @@
 
 
 // Formulation ----------------------------------------------------------
+/// Reform the Jacobian and residual for the problem.
 class pylith::problems::Formulation
 { // Formulation
   friend class TestFormulation; // unit testing

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/problems/Solver.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/problems/Solver.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/problems/Solver.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -27,6 +27,9 @@
 
 
 // Solver ---------------------------------------------------------
+/** @brief Abstract C++ base class for using PETSc linear and
+ * nonlinear solvers.
+ */
 class pylith::problems::Solver
 { // Solver
   friend class TestSolver; // unit testing

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverLinear.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverLinear.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverLinear.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -14,9 +14,6 @@
  * @file libsrc/problems/SolverLinear.hh
  *
  * @brief Object for using PETSc scalable linear equation solvers (KSP).
- *
- * The PETSc linear KSP solvers provide an interface to Krylov subspace
- * (KS) iterative methods and preconditioners (P).
  */
 
 #if !defined(pylith_problems_solverlinear_hh)
@@ -28,6 +25,13 @@
 #include "pylith/utils/petscfwd.h" // HASA PetscKSP
 
 // SolverLinear ---------------------------------------------------------
+/** @brief Object for using PETSc scalable linear equation solvers
+ * (KSP).
+ *
+ * The PETSc linear KSP solvers provide an interface to Krylov subspace
+ * (KS) iterative methods and preconditioners (P).
+ */
+
 class pylith::problems::SolverLinear : Solver
 { // SolverLinear
   friend class TestSolverLinear; // unit testing

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverNonlinear.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverNonlinear.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/problems/SolverNonlinear.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -15,9 +15,6 @@
  *
  * @brief Object for using PETSc scalable nonlinear equation solvers
  * (SNES).
- *
- * The PETSc nonlinear solvers provide an interface to Newton-based
- * methods for solving nonlinear equations.
  */
 
 #if !defined(pylith_problems_solvernonlinear_hh)
@@ -30,6 +27,12 @@
 #include <petscmat.h> // USES MatStructure
 
 // SolverNonlinear ---------------------------------------------------------
+/** @brief Object for using PETSc scalable nonlinear equation solvers
+ * (SNES).
+ *
+ * The PETSc nonlinear solvers provide an interface to Newton-based
+ * methods for solving nonlinear equations.
+ */
 class pylith::problems::SolverNonlinear : public Solver
 { // SolverNonlinear
   friend class TestSolverNonlinear; // unit testing

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/EventLogger.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/EventLogger.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/EventLogger.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/EventLogger.hh
+ * @file libsrc/utils/EventLogger.hh
  *
  * @brief C++ object for managing event logging using PETSc.
  *
@@ -31,6 +31,10 @@
 #include "petsclog.h" // USES PetscLogEventBegin/End() in inline methods
 
 // EventLogger ----------------------------------------------------------
+/** @brief C++ object for managing event logging using PETSc.
+ *
+ * Each logger object manages the events for a single "logging class".
+ */
 class pylith::utils::EventLogger
 { // EventLogger
   friend class TestEventLogger; // unit testing

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/TestArray.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/TestArray.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/TestArray.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,15 +11,9 @@
 //
 
 /**
- * @file pylith/utils/TestArray.hh
+ * @file libsrc/utils/TestArray.hh
  *
  * @brief C++ object for testing array values.
- *
- * This object is used in unit testing of SWIG interfaces where the
- * C++ object has an accessor returning a std::valarray. The TestArray
- * methods provide the ability to compare the array returned by the
- * accessor against the expected values, which are supplied via a
- * pointer and a size (number of values).
  */
 
 #if !defined(pylith_utils_testarray_hh)
@@ -31,6 +25,14 @@
 #include "arrayfwd.hh" // USES double_array
 
 // TestArray ------------------------------------------------------------
+/** @brief C++ object for testing array values.
+ *
+ * This object is used in unit testing of SWIG interfaces where the
+ * C++ object has an accessor returning a std::valarray. The TestArray
+ * methods provide the ability to compare the array returned by the
+ * accessor against the expected values, which are supplied via a
+ * pointer and a size (number of values).
+ */
 class pylith::utils::TestArray
 { // TestArray
 

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/array.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/array.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/array.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/array.hh
+ * @file libsrc/utils/array.hh
  *
  * @brief Header file for PyLith array objects.
  *

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/arrayfwd.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/arrayfwd.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/arrayfwd.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/arrayfwd.hh
+ * @file libsrc/utils/arrayfwd.hh
  *
  * @brief Forward declarations for PyLith array objects.
  *

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/constdefs.h
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/constdefs.h	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/constdefs.h	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/macrodefs.hh
+ * @file libsrc/utils/constdefs.h
  *
  * @brief Macro definitions for PyLith.
  */

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/lapack.h
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/lapack.h	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/lapack.h	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/lapack.h
+ * @file libsrc/utils/lapack.h
  *
  * @brief Declarations for LAPACK routines that we use. We rely on
  * PETSc's interface to these routines.

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/macrodefs.h
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/macrodefs.h	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/macrodefs.h	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/macrodefs.hh
+ * @file libsrc/utils/macrodefs.h
  *
  * @brief Macro definitions for PyLith.
  */

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscerror.h
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscerror.h	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscerror.h	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/petscerror.h
+ * @file libsrc/utils/petscerror.h
  *
  * @brief Wrappers around PETSc error handling routines.
  */

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscfwd.h
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscfwd.h	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/petscfwd.h	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/petscfwd.h
+ * @file libsrc/utils/petscfwd.h
  *
  * @brief Forward declarations for Petsc objects.
  */

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievefwd.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievefwd.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievefwd.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/sievefwd.hh
+ * @file libsrc/utils/sievefwd.hh
  *
  * @brief Forward declarations for PETSc Sieve objects.
  */

Modified: short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievetypes.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievetypes.hh	2009-08-24 20:44:18 UTC (rev 15583)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/utils/sievetypes.hh	2009-08-24 20:55:54 UTC (rev 15584)
@@ -11,7 +11,7 @@
 //
 
 /**
- * @file pylith/utils/sievetypes.hh
+ * @file libsrc/utils/sievetypes.hh
  *
  * @brief Aliases for Sieve types.
  */
@@ -23,7 +23,10 @@
 
 namespace pylith {
 
+  /// Sieve mesh.
   typedef ALE::IMesh<> Mesh;
+
+  /// Sieve submesh.
   typedef ALE::IMesh<ALE::LabelSifter<int, Mesh::point_type> > SubMesh;
 
 } // pylith

More information about the CIG-COMMITS mailing list