[cig-commits] r15585 - short/3D/PyLith/branches/pylith-friction/libsrc/meshio
brad at geodynamics.org
brad at geodynamics.org
Mon Aug 24 14:27:53 PDT 2009
Author: brad
Date: 2009-08-24 14:27:52 -0700 (Mon, 24 Aug 2009)
New Revision: 15585
Modified:
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/BinaryIO.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilter.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilterAvg.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriter.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriterVTK.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFile.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileAscii.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileBinary.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshBuilder.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIO.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOAscii.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOCubit.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOLagrit.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputManager.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputSolnSubset.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFile.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileAscii.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileBinary.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/UCDFaultFile.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilter.hh
short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilterVecNorm.hh
Log:
Finished first pass of adding doxygen stuff to header files.
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/BinaryIO.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/BinaryIO.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/BinaryIO.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/MeshIOCubit.hh
+ * @file libsrc/meshio/BinaryIO.hh
*
* @brief C++ object for general binary input/output operations.
*/
@@ -25,6 +25,7 @@
#include <iosfwd>
// BinaryIO -------------------------------------------------------------
+/// General binary input/output operations.
class pylith::meshio::BinaryIO
{ // BinaryIO
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilter.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilter.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilter.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/CellFilter.hh
+ * @file libsrc/meshio/CellFilter.hh
*
* @brief C++ object for filtering cell fields when outputing
* finite-element data.
@@ -27,6 +27,9 @@
#include "pylith/feassemble/feassemblefwd.hh" // HOLDSA Quadrature<Mesh>
// CellFilter -----------------------------------------------------------
+/** @brief C++ object for filtering cell fields when outputing
+ * finite-element data.
+ */
template<typename mesh_type, typename field_type>
class pylith::meshio::CellFilter
{ // CellFilter
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilterAvg.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilterAvg.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/CellFilterAvg.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/CellFilterAvg.hh
+ * @file libsrc/meshio/CellFilterAvg.hh
*
* @brief C++ object for averaging cell fields over quadrature points
* when outputing finite-element data.
@@ -24,6 +24,9 @@
#include "CellFilter.hh" // ISA CellFilter
// CellFilter -----------------------------------------------------------
+/** @brief C++ object for averaging cell fields over quadrature points
+ * when outputing finite-element data.
+ */
template<typename mesh_type, typename field_type>
class pylith::meshio::CellFilterAvg : public CellFilter<mesh_type, field_type>
{ // CellFilterAvg
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriter.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriter.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriter.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/DataWriter.hh
+ * @file libsrc/meshio/DataWriter.hh
*
* @brief Abstract base class for writing finite-element data to file.
*/
@@ -25,6 +25,7 @@
#include "pylith/topology/topologyfwd.hh" // USES Field
// DataWriter -----------------------------------------------------------
+/// Abstract base class for writing finite-element data to file.
template<typename mesh_type, typename field_type>
class pylith::meshio::DataWriter
{ // DataWriter
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriterVTK.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriterVTK.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/DataWriterVTK.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,9 +11,9 @@
//
/**
- * @file pylith/meshio/DataWriterVTK.hh
+ * @file libsrc/meshio/DataWriterVTK.hh
*
- * @brief Abstract base class for writing finite-element data to file.
+ * @brief Object for writing finite-element data to VTK file.
*/
#if !defined(pylith_meshio_datawritervtk_hh)
@@ -23,6 +23,7 @@
#include "DataWriter.hh" // ISA DataWriter
// DataWriterVTK --------------------------------------------------------
+/// Object for writing finite-element data to VTK file.
template<typename mesh_type, typename field_type>
class pylith::meshio::DataWriterVTK : public DataWriter<mesh_type,field_type>
{ // DataWriterVTK
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFile.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFile.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFile.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file libsrc/topology/GMVFile.hh
+ * @file libsrc/meshio/GMVFile.hh
*
* @brief C++ base class for input/output of LaGriT GMV files.
*/
@@ -20,6 +20,7 @@
#define pylith_meshio_gmvfile_hh
// Include directives ---------------------------------------------------
+/// C++ base class for input/output of LaGriT GMV files.
#include "meshiofwd.hh" // forward declarations
#include <string> // HASA std::string
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileAscii.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileAscii.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileAscii.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file libsrc/topology/GMVFileAscii.hh
+ * @file libsrc/meshio/GMVFileAscii.hh
*
* @brief C++ object for input/output of LaGriT ASCII GMV files.
*/
@@ -26,6 +26,7 @@
#include <iosfwd>
// GMVFileAscii ---------------------------------------------------------
+/// C++ object for input/output of LaGriT ASCII GMV files.
class pylith::meshio::GMVFileAscii : public GMVFile
{ // GMVFileAscii
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileBinary.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileBinary.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/GMVFileBinary.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,9 +11,9 @@
//
/**
- * @file libsrc/topology/GMVFileAscii.hh
+ * @file libsrc/meshio/GMVFileBinary.hh
*
- * @brief C++ object for input/output of LaGriT ASCII GMV files.
+ * @brief C++ object for input/output of LaGriT binary GMV files.
*/
#if !defined(pylith_meshio_gmvfilebinary_hh)
@@ -26,6 +26,7 @@
#include <iosfwd>
// GMVFileBinary --------------------------------------------------------
+/// C++ object for input/output of LaGriT binary GMV files.
class pylith::meshio::GMVFileBinary : public GMVFile
{ // GMVFileBinary
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshBuilder.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshBuilder.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshBuilder.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -10,6 +10,12 @@
// ======================================================================
//
+/**
+ * @file libsrc/meshio/MeshBuilder.hh
+ *
+ * @brief Helper class for constructing Sieve mesh data structures.
+ */
+
#if !defined(pylith_meshio_meshbuilder_hh)
#define pylith_meshio_meshbuilder_hh
@@ -24,6 +30,7 @@
#include "pylith/topology/Mesh.hh" // USES Mesh
// MeshBuilder ----------------------------------------------------------
+/// Helper class for constructing Sieve mesh data structures.
class pylith::meshio::MeshBuilder
{ // MeshBuilder
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIO.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIO.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIO.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,9 +11,9 @@
//
/**
- * @file libsrc/topology/MeshIO.hh
+ * @file libsrc/meshio/MeshIO.hh
*
- * @brief C++ object for managing mesh input/output.
+ * @brief C++ base class for managing mesh input/output.
*/
#if !defined(pylith_meshio_meshio_hh)
@@ -29,6 +29,7 @@
// string_vector
// MeshIO ---------------------------------------------------------------
+/// C++ abstract base class for managing mesh input/output.
class pylith::meshio::MeshIO
{ // MeshIO
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOAscii.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOAscii.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOAscii.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -28,6 +28,7 @@
#include <string> // HASA std::string
// MeshIOAscii ----------------------------------------------------------
+/// C++ input/output manager for PyLith ASCII mesh files.
class pylith::meshio::MeshIOAscii : public MeshIO
{ // MeshIOAscii
friend class TestMeshIOAscii; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOCubit.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOCubit.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOCubit.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/MeshIOCubit.hh
+ * @file libsrc/meshio/MeshIOCubit.hh
*
* @brief C++ input/output manager for CUBIT Exodus II files.
*/
@@ -25,6 +25,7 @@
#include <string> // HASA std::string
// Forward declarations -------------------------------------------------
+/// C++ input/output manager for CUBIT Exodus II files.
class NcFile; // netcdf file
// MeshIOCubit ----------------------------------------------------------
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOLagrit.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOLagrit.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/MeshIOLagrit.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -25,6 +25,7 @@
#include <string> // HASA std::string
// MeshIOLagrit ---------------------------------------------------------
+/// Input/output manager for LaGriT GMV and Pset files.
class pylith::meshio::MeshIOLagrit : public MeshIO
{ // MeshIOLagrit
friend class TestMeshIOLagrit; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputManager.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputManager.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputManager.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,9 +11,9 @@
//
/**
- * @file pylith/meshio/OutputManager.hh
+ * @file libsrc/meshio/OutputManager.hh
*
- * @brief C++ object for manager output of finite-element data.
+ * @brief Manager for output of finite-element data.
*/
#if !defined(pylith_meshio_outputmanager_hh)
@@ -26,6 +26,7 @@
#include "spatialdata/geocoords/geocoordsfwd.hh" // USES CoordSys
// OutputManager --------------------------------------------------------
+/// Manager for output of finite-element data.
template<typename mesh_type, typename field_type>
class pylith::meshio::OutputManager
{ // OutputManager
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputSolnSubset.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputSolnSubset.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/OutputSolnSubset.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,9 +11,9 @@
//
/**
- * @file pylith/meshio/OutputSolnSubset.hh
+ * @file libsrc/meshio/OutputSolnSubset.hh
*
- * @brief C++ object for manager output of finite-element data over a
+ * @brief C++ object for managing output of finite-element data over a
* subdomain.
*/
@@ -31,6 +31,9 @@
#include <string> // HASA std::string
// OutputSolnSubset -----------------------------------------------------
+/** @brief C++ object for managing output of finite-element data over
+ * a subdomain.
+ */
class pylith::meshio::OutputSolnSubset :
public OutputManager<topology::SubMesh, topology::Field<topology::Mesh> >
{ // OutputSolnSubset
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFile.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFile.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFile.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file libsrc/topology/PsetFile.hh
+ * @file libsrc/meshio/PsetFile.hh
*
* @brief C++ base class for input/output of LaGriT Pset files.
*/
@@ -26,6 +26,7 @@
#include <string> // HASA std::string
// PsetFile -------------------------------------------------------------
+/// C++ base class for input/output of LaGriT Pset files.
class pylith::meshio::PsetFile
{ // PsetFile
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileAscii.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileAscii.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileAscii.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file libsrc/topology/PsetFile.hh
+ * @file libsrc/meshio/PsetFileAscii.hh
*
* @brief C++ object for input/output of LaGriT binary Pset files.
*/
@@ -25,6 +25,7 @@
#include <iosfwd>
// PsetFileAscii --------------------------------------------------------
+/// C++ object for input/output of LaGriT ascii Pset files.
class pylith::meshio::PsetFileAscii : public PsetFile
{ // PsetFileAscii
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileBinary.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileBinary.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/PsetFileBinary.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file libsrc/topology/PsetFile.hh
+ * @file libsrc/meshio/PsetFileBinary.hh
*
* @brief C++ object for input/output of LaGriT binary Pset files.
*/
@@ -25,6 +25,7 @@
#include <iosfwd>
// PsetFileBinary -------------------------------------------------------
+/// C++ object for input/output of LaGriT binary Pset files.
class pylith::meshio::PsetFileBinary : public PsetFile
{ // PsetFileBinary
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/UCDFaultFile.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/UCDFaultFile.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/UCDFaultFile.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -14,12 +14,6 @@
* @file libsrc/meshio/UCDFaultFile.hh
*
* @brief C++ object for reading a fault mesh from a UCD file.
- *
- * Temporary fix for getting a fault mesh information into
- * PyLith. Using a fault mesh permits cells to have more than one face
- * on the fault surface. Supporting information also provides the
- * orientation of the fault surface, eliminating the need to determine
- * it from the faces/vertices alone.
*/
#if !defined(pylith_meshio_ucdfaultfile_hh)
@@ -33,6 +27,14 @@
#include "pylith/utils/sievetypes.hh" // USES ALE::Obj, ALE::Mesh
// UCDFaultFile ---------------------------------------------------------
+/** @brief C++ object for reading a fault mesh from a UCD file.
+ *
+ * TEMPORARY fix for getting a fault mesh information into
+ * PyLith. Using a fault mesh permits cells to have more than one face
+ * on the fault surface. Supporting information also provides the
+ * orientation of the fault surface, eliminating the need to determine
+ * it from the faces/vertices alone.
+ */
class pylith::meshio::UCDFaultFile
{ // UCDFaultFile
friend class TestUCDFaultFile; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilter.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilter.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilter.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/VertexFilter.hh
+ * @file libsrc/meshio/VertexFilter.hh
*
* @brief C++ object for filtering vertex fields when outputing
* finite-element data.
@@ -26,6 +26,9 @@
#include "pylith/topology/topologyfwd.hh" // USES Field
// VertexFilter ---------------------------------------------------------
+/** @brief C++ object for filtering vertex fields when outputing
+ * finite-element data.
+ */
template<typename field_type>
class pylith::meshio::VertexFilter
{ // VertexFilter
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilterVecNorm.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilterVecNorm.hh 2009-08-24 20:55:54 UTC (rev 15584)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/meshio/VertexFilterVecNorm.hh 2009-08-24 21:27:52 UTC (rev 15585)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/meshio/VertexFilterVecNorm.hh
+ * @file libsrc/meshio/VertexFilterVecNorm.hh
*
* @brief C++ object for computing vector norms for fields over
* vertices when outputing finite-element data.
@@ -24,6 +24,9 @@
#include "VertexFilter.hh" // ISA VertexFilter
// VertexFilterVecNorm --------------------------------------------------
+/** @brief C++ object for computing vector norms for fields over
+ * vertices when outputing finite-element data.
+ */
template<typename field_type>
class pylith::meshio::VertexFilterVecNorm : public VertexFilter<field_type>
{ // VertexFilterVecNorm
More information about the CIG-COMMITS
mailing list