[cig-commits] r15583 - short/3D/PyLith/branches/pylith-friction/libsrc/topology
brad at geodynamics.org
brad at geodynamics.org
Mon Aug 24 13:44:19 PDT 2009
Author: brad
Date: 2009-08-24 13:44:18 -0700 (Mon, 24 Aug 2009)
New Revision: 15583
Modified:
short/3D/PyLith/branches/pylith-friction/libsrc/topology/Distributor.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/Field.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/FieldBase.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/Fields.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/Jacobian.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/MeshOps.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/RefineUniform.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/SolutionFields.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/SubMesh.hh
Log:
More work on adding doxygen stuff to header files.
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/Distributor.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/Distributor.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/Distributor.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/topology/Distributor.hh
+ * @file libsrc/topology/Distributor.hh
*
* @brief Object for managing distribution of mesh among processors.
*/
@@ -25,6 +25,7 @@
#include "pylith/meshio/meshiofwd.hh" // USES DataWriter<Mesh>
// Distributor ----------------------------------------------------------
+/// Distribute mesh among processors.
class pylith::topology::Distributor
{ // Distributor
friend class TestDistributor; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/Field.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/Field.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/Field.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -15,8 +15,6 @@
*
* @brief Vector field over the vertices or cells of a finite-element
* mesh.
- *
- * Extends Sieve real general section by adding metadata.
*/
#if !defined(pylith_topology_field_hh)
@@ -31,6 +29,11 @@
#include <petscmesh.hh>
// Field ----------------------------------------------------------------
+/** @brief Vector field over the vertices or cells of a finite-element
+ * mesh.
+ *
+ * Extends Sieve real general section by adding metadata.
+ */
template<typename mesh_type>
class pylith::topology::Field : public FieldBase
{ // Field
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/FieldBase.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/FieldBase.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/FieldBase.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -24,6 +24,9 @@
#include "topologyfwd.hh" // forward declarations
// FieldBase ------------------------------------------------------------
+/** @brief Basic information related to a vector field over the
+ * vertices or cells of a finite-element mesh.
+ */
class pylith::topology::FieldBase
{ // Field
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/Fields.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/Fields.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/Fields.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -13,7 +13,8 @@
/**
* @file libsrc/topology/Fields.hh
*
- * @brief Object for managing fields over a finite-element mesh.
+ * @brief Container for managing multiple fields over a finite-element
+ * mesh.
*/
#if !defined(pylith_topology_fields_hh)
@@ -27,6 +28,7 @@
#include <string> // USES std::string
// Fields ---------------------------------------------------------------
+/// Container for managing multiple fields over a finite-element mesh.
template<typename field_type>
class pylith::topology::Fields
{ // Fields
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/Jacobian.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/Jacobian.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/Jacobian.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -25,6 +25,7 @@
#include "pylith/utils/petscfwd.h" // HOLDSA PetscMat
// Jacobian -------------------------------------------------------------
+/// Jacobian of the system as a PETSc sparse matrix.
class pylith::topology::Jacobian
{ // Jacobian
friend class TestJacobian; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/MeshOps.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/MeshOps.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/MeshOps.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/topology/MeshOps.hh
+ * @file libsrc/topology/MeshOps.hh
*
* @brief Simple operations on a Mesh object.
*/
@@ -23,6 +23,7 @@
#include "topologyfwd.hh" // forward declarations
// MeshOps --------------------------------------------------------------
+/// Simple operations on a Mesh object.
class pylith::topology::MeshOps
{ // MeshOps
friend class TestMeshOps; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/RefineUniform.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/RefineUniform.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/RefineUniform.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/topology/RefineUniform.hh
+ * @file libsrc/topology/RefineUniform.hh
*
* @brief Object for managing uniform global mesh refinement.
*/
@@ -23,6 +23,7 @@
#include "topologyfwd.hh" // forward declarations
// RefineUniform --------------------------------------------------------
+/// Object for managing uniform global mesh refinement.
class pylith::topology::RefineUniform
{ // RefineUniform
friend class TestRefineUniform; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/SolutionFields.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/SolutionFields.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/SolutionFields.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -30,6 +30,9 @@
#include "Fields.hh" // ISA Fields< Field<Mesh> >
// SolutionFields -------------------------------------------------------
+/** @brief Object for managing solution fields over a finite-element
+ * mesh.
+ */
class pylith::topology::SolutionFields : public Fields<Field<Mesh> >
{ // SolutionFields
friend class TestSolutionFields; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/SubMesh.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/SubMesh.hh 2009-08-24 17:19:45 UTC (rev 15582)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/SubMesh.hh 2009-08-24 20:44:18 UTC (rev 15583)
@@ -14,9 +14,6 @@
* @file libsrc/topology/SubMesh.hh
*
* @brief C++ PyLith finite-element mesh.
- *
- * Extends Sieve mesh over subset of domain to include coordinate
- * system associated with domain.
*/
#if !defined(pylith_topology_submesh_hh)
@@ -29,6 +26,12 @@
#include "Mesh.hh" // USES Mesh
// SubMesh -----------------------------------------------------------------
+/** @brief C++ PyLith finite-element mesh.
+ *
+ * Extends Sieve mesh over subset of domain to include coordinate
+ * system associated with domain. Also has functions to simply
+ * creating submeshes from groups of vertices.
+ */
class pylith::topology::SubMesh
{ // SubMesh
friend class TestSubMesh; // unit testing
More information about the CIG-COMMITS
mailing list