[cig-commits] r15575 - in short/3D/PyLith/branches/pylith-friction: doc/refguide libsrc/bc libsrc/faults libsrc/feassemble libsrc/materials libsrc/topology
brad at geodynamics.org
brad at geodynamics.org
Fri Aug 21 17:31:03 PDT 2009
Author: brad
Date: 2009-08-21 17:30:58 -0700 (Fri, 21 Aug 2009)
New Revision: 15575
Modified:
short/3D/PyLith/branches/pylith-friction/doc/refguide/doxyconfig
short/3D/PyLith/branches/pylith-friction/libsrc/bc/AbsorbingDampers.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/BCIntegratorSubMesh.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryCondition.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryConditionPoints.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBC.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBoundary.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/Neumann.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/PointForce.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependent.hh
short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependentPoints.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/BruneSlipFn.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/CohesiveTopology.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/ConstRateSlipFn.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/EqKinSrc.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/Fault.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesive.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveDyn.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveKin.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/LiuCosSlipFn.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/SlipTimeFn.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/StepSlipFn.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyOps.hh
short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyVisitors.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/CellGeometry.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Constraint.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityExplicit.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityImplicit.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryHex3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine1D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine2D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint1D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint2D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad2D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTet3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri2D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Integrator.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/IntegratorElasticity.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature0D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din2D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2Din3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureEngine.hh
short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureRefCell.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/EffectiveStress.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticIsotropic3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticMaterial.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStrain.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStress.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStrain1D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStress1D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/GenMaxwellIsotropic3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/Material.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellIsotropic3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellPlaneStrain.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/Metadata.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/PowerLaw3D.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/ViscoelasticMaxwell.hh
short/3D/PyLith/branches/pylith-friction/libsrc/materials/materialsfwd.hh
short/3D/PyLith/branches/pylith-friction/libsrc/topology/Mesh.hh
Log:
Worked on doxygen stuff in header files.
Modified: short/3D/PyLith/branches/pylith-friction/doc/refguide/doxyconfig
===================================================================
--- short/3D/PyLith/branches/pylith-friction/doc/refguide/doxyconfig 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/doc/refguide/doxyconfig 2009-08-22 00:30:58 UTC (rev 15575)
@@ -23,7 +23,7 @@
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 1.1
+PROJECT_NUMBER = 1.4.2
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
@@ -53,16 +53,6 @@
OUTPUT_LANGUAGE = English
-# This tag can be used to specify the encoding used in the generated output.
-# The encoding is not always determined by the language that is chosen,
-# but also whether or not the output is meant for Windows or non-Windows users.
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
-# forces the Windows encoding (this is the default for the Windows binary),
-# whereas setting the tag to NO uses a Unix-style encoding (the default for
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING = NO
-
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
@@ -70,10 +60,11 @@
BRIEF_MEMBER_DESC = YES
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
-# the brief description of a member or function before the detailed description.
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
-# brief descriptions will be completely suppressed.
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will
+# prepend the brief description of a member or function before the
+# detailed description. Note: if both HIDE_UNDOC_MEMBERS and
+# BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
+# completely suppressed.
REPEAT_BRIEF = YES
@@ -115,7 +106,7 @@
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH = ../
+STRIP_FROM_PATH = ../../
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
@@ -148,13 +139,6 @@
MULTILINE_CPP_IS_BRIEF = NO
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member
-# documentation.
-
-DETAILS_AT_TOP = NO
-
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
@@ -188,19 +172,20 @@
OPTIMIZE_OUTPUT_FOR_C = NO
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
-# sources only. Doxygen will then generate output that is more tailored for Java.
-# For instance, namespaces will be presented as packages, qualified scopes
-# will look different, etc.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of
+# Java sources only. Doxygen will then generate output that is more
+# tailored for Java. For instance, namespaces will be presented as
+# packages, qualified scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
-# include (a tag file for) the STL sources as input, then you should
-# set this tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
-# func(std::string) {}). This also make the inheritance and collaboration
-# diagrams that involve STL classes more complete and accurate.
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do
+# not want to include (a tag file for) the STL sources as input, then
+# you should set this tag to YES in order to let doxygen match
+# functions declarations and definitions whose arguments contain STL
+# classes (e.g. func(std::string); v.s. func(std::string) {}). This
+# also make the inheritance and collaboration diagrams that involve
+# STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
@@ -360,12 +345,12 @@
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST = YES
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
-ENABLED_SECTIONS =
+ENABLED_SECTIONS = YES
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
@@ -383,19 +368,20 @@
SHOW_USED_FILES = YES
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
-# in the documentation. The default is NO.
+# If the sources in your project are distributed over multiple
+# directories then setting the SHOW_DIRECTORIES tag to YES will show
+# the directory hierarchy in the documentation. The default is NO.
-SHOW_DIRECTORIES = NO
+SHOW_DIRECTORIES = YES
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically from the
-# version control system). Doxygen will invoke the program by executing (via
-# popen()) the command <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the program writes to standard output
-# is used as the file version. See the manual for examples.
+# The FILE_VERSION_FILTER tag can be used to specify a program or
+# script that doxygen should invoke to get the current version for
+# each file (typically from the version control system). Doxygen will
+# invoke the program by executing (via popen()) the command <command>
+# <input-file>, where <command> is the value of the
+# FILE_VERSION_FILTER tag, and <input-file> is the name of an input
+# file provided by doxygen. Whatever the program writes to standard
+# output is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
@@ -433,7 +419,7 @@
# wrong or incomplete parameter documentation, but not about the absence of
# documentation.
-WARN_NO_PARAMDOC = NO
+WARN_NO_PARAMDOC = YES
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
@@ -454,12 +440,12 @@
# configuration options related to the input files
#---------------------------------------------------------------------------
-# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
+# The INPUT tag can be used to specify the files and/or directories
+# that contain documented source files. You may enter file names like
+# "myfile.cpp" or directories like "/usr/src/myproject". Separate the
+# files or directories with spaces.
-INPUT = ../../
+INPUT = ../../libsrc ../../modulesrc ../../pylith
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -514,7 +500,7 @@
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
-EXAMPLE_RECURSIVE = NO
+EXAMPLE_RECURSIVE = YES
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
@@ -729,7 +715,7 @@
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature.
-GENERATE_TREEVIEW = NO
+GENERATE_TREEVIEW = YES
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
@@ -1126,7 +1112,7 @@
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
-TEMPLATE_RELATIONS = NO
+TEMPLATE_RELATIONS = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
@@ -1187,22 +1173,6 @@
DOTFILE_DIRS =
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than
-# this value, doxygen will try to truncate the graph, so that it fits within
-# the specified constraint. Beware that most browsers cannot cope with very
-# large images.
-
-MAX_DOT_GRAPH_WIDTH = 1024
-
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than
-# this value, doxygen will try to truncate the graph, so that it fits within
-# the specified constraint. Beware that most browsers cannot cope with very
-# large images.
-
-MAX_DOT_GRAPH_HEIGHT = 1024
-
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/AbsorbingDampers.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/AbsorbingDampers.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/AbsorbingDampers.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -54,6 +54,7 @@
#include "BCIntegratorSubMesh.hh" // ISA BCIntegratorSubMesh
// AbsorbingDampers ------------------------------------------------------
+/// Absorbing boundary with simple dampers.
class pylith::bc::AbsorbingDampers : public BCIntegratorSubMesh
{ // class AbsorbingDampers
friend class TestAbsorbingDampers; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/BCIntegratorSubMesh.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/BCIntegratorSubMesh.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/BCIntegratorSubMesh.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -32,6 +32,8 @@
#include "pylith/feassemble/Integrator.hh" // ISA Integrator
// BCIntegratorSubMesh ----------------------------------------------
+/// @brief Abstract base classs for BoundaryCondition object with
+/// boundary condition applied at a simple-connect surface (submesh).
class pylith::bc::BCIntegratorSubMesh : public BoundaryCondition,
public feassemble::Integrator<feassemble::Quadrature<topology::SubMesh> >
{ // class BCIntegratorSubMesh
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryCondition.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryCondition.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryCondition.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -32,6 +32,7 @@
#include <string> // HASA std::string
// BoundaryCondition ----------------------------------------------------
+/// Abstract base class for boundary conditions.
class pylith::bc::BoundaryCondition
{ // class BoundaryCondition
friend class TestBoundaryCondition; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryConditionPoints.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryConditionPoints.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/BoundaryConditionPoints.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -27,6 +27,9 @@
#include "pylith/utils/array.hh" // HASA int_array
// BoundaryConditionPoints ----------------------------------------------
+/** @brief C++ abstract base class for BoundaryCondition object with
+ * boundary condition applied at a set of points.
+ */
class pylith::bc::BoundaryConditionPoints : public BoundaryCondition
{ // class BoundaryCondition
friend class TestBoundaryConditionPoints; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBC.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBC.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBC.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -26,6 +26,8 @@
#include "pylith/utils/array.hh" // HASA int_array
// DirichletBC ------------------------------------------------------
+/// @brief Dirichlet (prescribed values at degrees of freedom) boundary
+/// conditions with a set of points.
class pylith::bc::DirichletBC : public TimeDependentPoints,
public feassemble::Constraint
{ // class DirichletBC
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBoundary.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBoundary.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/DirichletBoundary.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -23,6 +23,8 @@
#include "DirichletBC.hh" // ISA DirichletBC
// DirichletBoundary ----------------------------------------------------
+/// @brief Dirichlet (prescribed values at degrees of freedom) boundary
+/// conditions with points on a boundary.
class pylith::bc::DirichletBoundary : public DirichletBC
{ // class DirichletBoundary
friend class TestDirichletBoundary; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/Neumann.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/Neumann.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/Neumann.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -24,8 +24,10 @@
#include "TimeDependent.hh" // ISA TimeDependent
// Neumann ------------------------------------------------------
+/// @brief Time dependent Neumann (traction) boundary conditions
+/// applied to a simply-connected boundary.
class pylith::bc::Neumann : public BCIntegratorSubMesh,
- public TimeDependent
+ public TimeDependent
{ // class Neumann
friend class TestNeumann; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/PointForce.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/PointForce.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/PointForce.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -25,6 +25,7 @@
#include "pylith/feassemble/Integrator.hh" // ISA Integrator
// PointForce ------------------------------------------------------
+/// Point forces applied at vertices.
class pylith::bc::PointForce : public TimeDependentPoints,
public feassemble::Integrator<feassemble::Quadrature<topology::Mesh> >
{ // class PointForce
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependent.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependent.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependent.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -12,7 +12,8 @@
/** @file libsrc/bc/TimeDependent.hh
*
- * @brief C++ implementation of point force on vertices.
+ * @brief C++ Abstract base class for time-dependent boundary
+ * conditions.
*/
#if !defined(pylith_bc_timedependent_hh)
@@ -27,6 +28,7 @@
#include "spatialdata/units/unitsfwd.hh" // USES Nondimensional
// TimeDependent ------------------------------------------------------
+/// Abstract base class for time-dependent boundary conditions.
class pylith::bc::TimeDependent
{ // class TimeDependent
friend class TestTimeDependent; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependentPoints.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependentPoints.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/bc/TimeDependentPoints.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -26,6 +26,7 @@
#include "pylith/utils/array.hh" // HASA int_array
// TimeDependentPoints ------------------------------------------------------
+/// Time dependent boundary conditions applied to a set of vertices.
class pylith::bc::TimeDependentPoints : public BoundaryConditionPoints,
public TimeDependent
{ // class TimeDependentPoints
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/BruneSlipFn.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/BruneSlipFn.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/BruneSlipFn.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -13,12 +13,6 @@
/** @file libsrc/faults/BruneSlipFn.hh
*
* @brief C++ implementation of Brune slip time function.
- *
- * Slip time function follows the integral of Brune's (1970) far-field
- * time function.
- *
- * Normalize slip = 1 - exp(-t/tau)(1 + t/tau),
- * where tau = finalSlip / (exp(1.0) * peakRate)
*/
#if !defined(pylith_faults_bruneslipfn_hh)
@@ -32,6 +26,14 @@
#include "pylith/utils/array.hh" // HASA double_array
// BruneSlipFn ----------------------------------------------------------
+/** @brief Brune slip-time function.
+ *
+ * Slip time function follows the integral of Brune's (1970) far-field
+ * time function.
+ *
+ * Normalize slip = 1 - exp(-t/tau)(1 + t/tau),
+ * where tau = finalSlip / (exp(1.0) * peakRate)
+ */
class pylith::faults::BruneSlipFn : public SlipTimeFn
{ // class BruneSlipFn
friend class TestBruneSlipFn; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/CohesiveTopology.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/CohesiveTopology.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/CohesiveTopology.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -25,6 +25,7 @@
#include "pylith/utils/sievetypes.hh" // USE ALE::Obj
// CohesiveTopology -----------------------------------------------------
+/// Creation of cohesive cells.
class pylith::faults::CohesiveTopology
{ // class CohesiveTopology
@@ -39,8 +40,10 @@
* @param faultMesh Finite-element mesh of fault (output).
* @param faultBoundary Finite-element mesh of fault boundary (output).
* @param mesh Finite-element mesh of domain.
- * @param faultVertices Vertices assocated with faces of cells defining
- * fault surface
+ * @param groupdField Group of vertices assocated with faces of
+ * cells defining fault surface
+ * @param flipFault Flag indicating to flip positive/negative sides
+ * of the fault.
*/
static
void createFault(topology::SubMesh* faultMesh,
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/ConstRateSlipFn.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/ConstRateSlipFn.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/ConstRateSlipFn.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -13,11 +13,6 @@
/** @file libsrc/faults/ConstRateSlipFn.hh
*
* @brief C++ implementation of a constant slip rate slip time function.
- *
- * Slip time function follows the integral of constant slip rate slip
- * time function.
- *
- * Normalized slip = sliprate * (t - t0)
*/
#if !defined(pylith_faults_constrateslipfn_hh)
@@ -31,6 +26,13 @@
#include "pylith/utils/array.hh" // HASA double_array
// ConstRateTimeFn ------------------------------------------------------
+/** @brief Constant slip rate slip-time function.
+ *
+ * Slip time function follows the integral of constant slip rate slip
+ * time function.
+ *
+ * Normalized slip = sliprate * (t - t0)
+ */
class pylith::faults::ConstRateSlipFn : public SlipTimeFn
{ // class ConstRateSlipFn
friend class TestConstRateSlipFn; // unit testing
@@ -63,7 +65,6 @@
/** Initialize slip time function.
*
* @param faultMesh Finite-element mesh of fault.
- * @param cs Coordinate system for mesh
* @param normalizer Nondimensionalization of scales.
* @param originTime Origin time for earthquake source.
*/
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/EqKinSrc.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/EqKinSrc.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/EqKinSrc.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -14,9 +14,6 @@
*
* @brief C++ object for managing parameters for a kinematic
* earthquake source.
- *
- * EqKinSrc is responsible for providing the value of slip at time t
- * over a fault surface.
*/
#if !defined(pylith_faults_eqkinsrc_hh)
@@ -30,6 +27,11 @@
#include "spatialdata/units/unitsfwd.hh" // USES Nondimensional
// EqKinSrc -------------------------------------------------------------
+/** @brief Kinematic earthquake source.
+ *
+ * EqKinSrc is responsible for providing the value of slip at time t
+ * over a fault surface.
+ */
class pylith::faults::EqKinSrc
{ // class EqKinSrc
friend class TestEqKinSrc; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/Fault.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/Fault.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/Fault.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -12,13 +12,6 @@
/** @file libsrc/faults/Fault.hh
*
- * @brief C++ abstract base class for Fault object.
- *
- * Interface definition for fault.
- *
- * The fault id is associated with the material-id for the fault and
- * the label is associated with the group of vertices that define the
- * fault surface.
*/
#if !defined(pylith_faults_fault_hh)
@@ -35,6 +28,15 @@
#include <string> // HASA std::string
// Fault ----------------------------------------------------------------
+/**
+ * @brief C++ abstract base class for Fault object.
+ *
+ * Interface definition for fault.
+ *
+ * The fault id is associated with the material-id for the fault and
+ * the label is associated with the group of vertices that define the
+ * fault surface.
+ */
class pylith::faults::Fault
{ // class Fault
friend class TestFault; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesive.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesive.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesive.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -28,6 +28,7 @@
#include "pylith/feassemble/Integrator.hh" // ISA Integrator
// FaultCohesive --------------------------------------------------------
+/// Absract base class for fault surface implemented with cohesive cells.
class pylith::faults::FaultCohesive : public Fault,
public feassemble::Integrator<feassemble::Quadrature<topology::SubMesh> >
{ // class FaultCohesive
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveDyn.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveDyn.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveDyn.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -14,10 +14,6 @@
*
* @brief C++ implementation for a fault surface with spontaneous
* (dynamic) slip implemented with cohesive elements.
- *
- * The ordering of vertices in a cohesive cell is the vertices on the
- * POSITIVE/NEGATIVE (CHECK WHICH IT IS) side of the fault and then the
- * corresponding entries on the other side of the fault.
*/
#if !defined(pylith_faults_faultcohesivedyn_hh)
@@ -27,6 +23,14 @@
#include "FaultCohesive.hh" // ISA FaultCohesive
// FaultCohesiveDyn -----------------------------------------------------
+/**
+ * @brief C++ implementation for a fault surface with spontaneous
+ * (dynamic) slip implemented with cohesive elements.
+ *
+ * The ordering of vertices in a cohesive cell is the vertices on the
+ * negative side of the fault and then the corresponding entries on
+ * the positive side of the fault.
+ */
class pylith::faults::FaultCohesiveDyn : public FaultCohesive
{ // class FaultCohesiveDyn
friend class TestFaultCohesiveDyn; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveKin.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveKin.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/FaultCohesiveKin.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -14,6 +14,24 @@
*
* @brief C++ implementation for a fault surface with kinematic
* (prescribed) slip implemented with cohesive elements.
+ */
+
+#if !defined(pylith_faults_faultcohesivekin_hh)
+#define pylith_faults_faultcohesivekin_hh
+
+// Include directives ---------------------------------------------------
+#include "FaultCohesive.hh" // ISA FaultCohesive
+
+#include "pylith/topology/SubMesh.hh" // ISA Integrator<Quadrature<SubMesh> >
+#include "pylith/feassemble/Quadrature.hh" // ISA Integrator<Quadrature>
+#include "pylith/feassemble/Integrator.hh" // ISA Integrator
+
+#include <string> // HASA std::string
+
+// FaultCohesiveKin -----------------------------------------------------
+/**
+ * @brief C++ implementation for a fault surface with kinematic
+ * (prescribed) slip implemented with cohesive elements.
*
* Fault boundary condition is specified using Lagrange
* multipliers. The constraints are associated with "constraint"
@@ -54,20 +72,6 @@
* because this introduces weighting of the orientation of the fault
* for the direction of slip at the vertices of the cohesive cells.
*/
-
-#if !defined(pylith_faults_faultcohesivekin_hh)
-#define pylith_faults_faultcohesivekin_hh
-
-// Include directives ---------------------------------------------------
-#include "FaultCohesive.hh" // ISA FaultCohesive
-
-#include "pylith/topology/SubMesh.hh" // ISA Integrator<Quadrature<SubMesh> >
-#include "pylith/feassemble/Quadrature.hh" // ISA Integrator<Quadrature>
-#include "pylith/feassemble/Integrator.hh" // ISA Integrator
-
-#include <string> // HASA std::string
-
-// FaultCohesiveKin -----------------------------------------------------
class pylith::faults::FaultCohesiveKin : public FaultCohesive
{ // class FaultCohesiveKin
friend class TestFaultCohesiveKin; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/LiuCosSlipFn.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/LiuCosSlipFn.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/LiuCosSlipFn.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -12,11 +12,7 @@
/** @file libsrc/faults/LiuCosSlipFn.hh
*
- * @brief C++ implementation of LiuCos slip time function.
- *
- * Sine/cosine slip time function from Liu, Archuleta, and Hartzell,
- * BSSA, 2006 (doi:10.1785/0120060036) which has a rapid rise and then
- * a gradual falloff with a finite duration.
+ * @brief C++ implementation of Liu cosine-sine slip time function.
*/
#if !defined(pylith_faults_liucosslipfn_hh)
@@ -30,6 +26,13 @@
#include "pylith/utils/array.hh" // HASA double_array
// LiuCosSlipFn ---------------------------------------------------------
+/**
+ * @brief C++ implementation of Liu cosine-sine slip time function.
+ *
+ * Sine/cosine slip time function from Liu, Archuleta, and Hartzell,
+ * BSSA, 2006 (doi:10.1785/0120060036) which has a rapid rise and then
+ * a gradual falloff with a finite duration.
+ */
class pylith::faults::LiuCosSlipFn : public SlipTimeFn
{ // class LiuCosSlipFn
friend class TestLiuCosSlipFn; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/SlipTimeFn.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/SlipTimeFn.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/SlipTimeFn.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -13,8 +13,6 @@
/** @file libsrc/faults/SlipTimeFn.hh
*
* @brief C++ abstract base class for kinematic slip time function.
- *
- * Interface definition for slip time function.
*/
#if !defined(pylith_faults_sliptimefn_hh)
@@ -29,6 +27,11 @@
#include "spatialdata/spatialdb/spatialdbfwd.hh" // USES SpatialDB
// SlipTimeFn -----------------------------------------------------------
+/**
+ * @brief Abstract base class for kinematic slip time function.
+ *
+ * Interface definition for slip time function.
+ */
class pylith::faults::SlipTimeFn
{ // class SlipTimeFn
friend class TestSlipTimeFn; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/StepSlipFn.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/StepSlipFn.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/StepSlipFn.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -13,10 +13,6 @@
/** @file libsrc/faults/StepSlipFn.hh
*
* @brief C++ implementation of a step-function slip time function.
- *
- * Slip time function is a step function with slip beginning at time t0.
- *
- * Normalized slip = 1 if t >= t0, 0 otherwise
*/
#if !defined(pylith_faults_stepslipfn_hh)
@@ -28,6 +24,13 @@
#include "pylith/utils/array.hh" // HASA double_array
// StepSlipFn -----------------------------------------------------------
+/**
+ * @brief C++ implementation of a step-function slip time function.
+ *
+ * Slip time function is a step function with slip beginning at time t0.
+ *
+ * Normalized slip = 1 if t >= t0, 0 otherwise
+*/
class pylith::faults::StepSlipFn : public SlipTimeFn
{ // class StepSlipFn
friend class TestStepSlipFn; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyOps.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyOps.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyOps.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -12,7 +12,7 @@
/** @file libsrc/faults/TopologyOps.hh
*
- * @brief C++ object to manage creation of cohesive cells.
+ * @brief C++ helper object for creation of cohesive cells.
*/
#if !defined(pylith_faults_topologyops_hh)
@@ -24,6 +24,7 @@
#include "pylith/topology/Mesh.hh" // USES Mesh
// TopologyOps ----------------------------------------------------------
+/// Helper object for creation of cohesive cells.
class pylith::faults::TopologyOps
{ // class TopologyOps
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyVisitors.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyVisitors.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/faults/TopologyVisitors.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -22,6 +22,7 @@
#include "faultsfwd.hh" // forward declarations
// ReplaceVisitor -------------------------------------------------------
+/// Visitor for replacement.
template<typename Sieve, typename Renumbering>
class pylith::faults::ReplaceVisitor {
private:
@@ -46,6 +47,7 @@
};
// ClassifyVisitor ------------------------------------------------------
+/// Visitor for classification.
template<typename Sieve>
class pylith::faults::ClassifyVisitor {
public:
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/CellGeometry.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/CellGeometry.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/CellGeometry.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/CellGeometry.hh
+ * @file libsrc/feassemble/CellGeometry.hh
*
* @brief C++ abstract base class for cell geometry calculations.
*/
@@ -25,6 +25,7 @@
#include "pylith/utils/array.hh" // HASA double_array
// CellGeometry ---------------------------------------------------------
+/// Abstract base class for cell geometry calculations.
class pylith::feassemble::CellGeometry
{ // CellGeometry
friend class TestCellGeometry; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Constraint.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Constraint.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Constraint.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -26,6 +26,9 @@
#include "spatialdata/units/unitsfwd.hh" // USES Nondimensional
// Constraint -----------------------------------------------------------
+/** @brief Abstract base class for defining constraints applied to
+ * vertices of finite-elements.
+ */
class pylith::feassemble::Constraint
{ // class Constraint
friend class TestConstraint; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityExplicit.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityExplicit.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityExplicit.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,10 +11,21 @@
//
/**
- * @file pylith/feassemble/ElasticityExplicit.hh
+ * @file libsrc/feassemble/ElasticityExplicit.hh
*
* @brief Explicit time integration of dynamic elasticity equation
* using finite-elements.
+ */
+
+#if !defined(pylith_feassemble_elasticityexplicit_hh)
+#define pylith_feassemble_elasticityexplicit_hh
+
+// Include directives ---------------------------------------------------
+#include "IntegratorElasticity.hh" // ISA IntegratorElasticity
+
+// ElasticityExplicit ---------------------------------------------------
+/**@brief Explicit time integration of the dynamic elasticity equation
+ * using finite-elements.
*
* Note: This object operates on a single finite-element family, which
* is defined by the quadrature and a database of material property
@@ -22,9 +33,9 @@
*
* Computes contributions to terms A and r in
*
- * A(t) u(t+dt) = b(u(t), u(t-dt)),
+ * A(t+dt) du(t) = b(t+dt, u(t), u(t-dt)) - A(t+dt) u(t),
*
- * r = b - A u0(t+dt)
+ * r(t+dt) = b(t+dt) - A(t+dt) (u(t) + du(t))
*
* where A(t) is a sparse matrix or vector, u(t+dt) is the field we
* want to compute at time t+dt, b is a vector that depends on the
@@ -50,15 +61,7 @@
*
* See governing equations section of user manual for more
* information.
- */
-
-#if !defined(pylith_feassemble_elasticityexplicit_hh)
-#define pylith_feassemble_elasticityexplicit_hh
-
-// Include directives ---------------------------------------------------
-#include "IntegratorElasticity.hh" // ISA IntegratorElasticity
-
-// ElasticityExplicit ---------------------------------------------------
+*/
class pylith::feassemble::ElasticityExplicit : public IntegratorElasticity
{ // ElasticityExplicit
friend class TestElasticityExplicit; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityImplicit.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityImplicit.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/ElasticityImplicit.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/ElasticityImplicit.hh
+ * @file libsrc/feassemble/ElasticityImplicit.hh
*
* @brief Implicit time integration of quasi-static elasticity equation
* using finite-elements.
@@ -22,13 +22,13 @@
*
* Computes contributions to terms A and r in
*
- * A(t) u(t+dt) = b(u(t), u(t-dt)),
+ * A(t+dt) du(t) = b(t+dt, u(t), u(t-dt)) - A(t+dt) u(t)
*
- * r = b - A u0(t+dt)
+ * r = b(t+dt) - A(t+dt) (u(t) + du(t))
*
* where A(t) is a sparse matrix or vector, u(t+dt) is the field we
- * want to compute at time t+dt, b is a vector that depends on the
- * field at time t and t-dt, and u0 is zero at unknown DOF and set to
+ * want to compute at time t+dt, b(t+dt) is a vector that depends on the
+ * field at time t+dt and t, and du is zero at unknown DOF and set to
* the constrained values at known DOF.
*
* Contributions to the RHS (b) include body forces, which are either
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryHex3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryHex3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryHex3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,22 +11,10 @@
//
/**
- * @file pylith/feassemble/GeometryHex3D.hh
+ * @file libsrc/feassemble/GeometryHex3D.hh
*
* @brief C++ implementation of cell geometry calculations for 3-D
* hexahedral cell.
- *
- * Reference cell:
- *
- * Vertex x y z
- * 0 -1.0 -1.0 -1.0
- * 1 +1.0 -1.0 -1.0
- * 2 +1.0 +1.0 -1.0
- * 3 -1.0 +1.0 -1.0
- * 4 -1.0 -1.0 +1.0
- * 5 +1.0 -1.0 +1.0
- * 6 +1.0 +1.0 +1.0
- * 7 -1.0 +1.0 +1.0
*/
#if !defined(pylith_feassemble_geometryhex3d_hh)
@@ -36,6 +24,23 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryHex3D --------------------------------------------------------
+/**
+ * @brief C++ implementation of cell geometry calculations for 3-D
+ * hexahedral cell.
+ *
+ * Reference cell:
+ at verbatim
+Vertex x y z
+ 0 -1.0 -1.0 -1.0
+ 1 +1.0 -1.0 -1.0
+ 2 +1.0 +1.0 -1.0
+ 3 -1.0 +1.0 -1.0
+ 4 -1.0 -1.0 +1.0
+ 5 +1.0 -1.0 +1.0
+ 6 +1.0 +1.0 +1.0
+ 7 -1.0 +1.0 +1.0
+ at endverbatim
+ */
class pylith::feassemble::GeometryHex3D : public CellGeometry
{ // GeometryHex3D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine1D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine1D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine1D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/GeometryLine1D.hh
+ * @file libsrc/feassemble/GeometryLine1D.hh
*
* @brief C++ implementation of cell geometry calculations for 1-D
* line cell.
@@ -24,6 +24,7 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryLine1D -------------------------------------------------------
+/// Cell geometry calculations for 1-D line cell.
class pylith::feassemble::GeometryLine1D : public CellGeometry
{ // GeometryLine1D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine2D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine2D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine2D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/GeometryLine2D.hh
+ * @file libsrc/feassemble/GeometryLine2D.hh
*
* @brief C++ implementation of cell geometry calculations for 1-D
* line cell in 2-D space.
@@ -24,6 +24,7 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryLine2D -------------------------------------------------------
+/// Cell geometry calculations for 1-D line cell in 2-D space.
class pylith::feassemble::GeometryLine2D : public CellGeometry
{ // GeometryLine2D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryLine3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/GeometryLine3D.hh
+ * @file libsrc/feassemble/GeometryLine3D.hh
*
* @brief C++ implementation of cell geometry calculations for 1-D
* line cell.
@@ -24,6 +24,7 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryLine3D -------------------------------------------------------
+/// Cell geometry calculations for 1-D line cell in 3-D space.
class pylith::feassemble::GeometryLine3D : public CellGeometry
{ // GeometryLine3D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint1D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint1D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint1D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/GeometryPoint1D.hh
+ * @file libsrc/feassemble/GeometryPoint1D.hh
*
* @brief C++ implementation of cell geometry calculations for 0-D
* point cell.
@@ -24,6 +24,7 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryPoint1D ------------------------------------------------------
+/// Cell geometry calculations for 0-D point cell.
class pylith::feassemble::GeometryPoint1D : public CellGeometry
{ // GeometryPoint1D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint2D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint2D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint2D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,10 +11,10 @@
//
/**
- * @file pylith/feassemble/GeometryPoint2D.hh
+ * @file libsrc/feassemble/GeometryPoint2D.hh
*
* @brief C++ implementation of cell geometry calculations for 0-D
- * point cell.
+ * point cell in 2-D space.
*/
#if !defined(pylith_feassemble_geometrypoint2d_hh)
@@ -24,6 +24,7 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryPoint2D ------------------------------------------------------
+/// Cell geometry calculations for 0-D line cell in 2-D space.
class pylith::feassemble::GeometryPoint2D : public CellGeometry
{ // GeometryPoint2D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryPoint3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,10 +11,10 @@
//
/**
- * @file pylith/feassemble/GeometryPoint3D.hh
+ * @file libsrc/feassemble/GeometryPoint3D.hh
*
* @brief C++ implementation of cell geometry calculations for 0-D
- * point cell.
+ * point cell in 3-D space.
*/
#if !defined(pylith_feassemble_geometrypoint3d_hh)
@@ -24,6 +24,7 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryPoint3D ------------------------------------------------------
+/// Cell geometry calculations for 0-D line cell in 3-D space.
class pylith::feassemble::GeometryPoint3D : public CellGeometry
{ // GeometryPoint3D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad2D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad2D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad2D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,23 +11,10 @@
//
/**
- * @file pylith/feassemble/GeometryQuad2D.hh
+ * @file libsrc/feassemble/GeometryQuad2D.hh
*
* @brief C++ implementation of cell geometry calculations for 2-D
* quadrilateral cell.
- *
- * Reference cell:
- *
- * 3 -- 2
- * | |
- * | |
- * 0 -- 1
- *
- * Vertex x y
- * 0 -1.0 -1.0
- * 1 +1.0 -1.0
- * 2 +1.0 +1.0
- * 3 -1.0 +1.0
*/
#if !defined(pylith_feassemble_geometryquad2d_hh)
@@ -37,9 +24,28 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryQuad2D -------------------------------------------------------
-class pylith::feassemble::GeometryQuad2D : public CellGeometry
-{ // GeometryQuad2D
+/** @brief Cell geometry calculations for 2-D quadrilateral cell in
+ * 2-D space.
+ *
+ * @brief C++ implementation of cell geometry calculations for 2-D
+ * quadrilateral cell.
+ *
+ * Reference cell:
+ at verbatim
+3 -- 2
+| |
+| |
+0 -- 1
+Vertex x y
+ 0 -1.0 -1.0
+ 1 +1.0 -1.0
+ 2 +1.0 +1.0
+ 3 -1.0 +1.0
+ at endverbatim
+ */
+class pylith::feassemble::GeometryQuad2D : public CellGeometry {
+
// PUBLIC METHODS ///////////////////////////////////////////////////////
public :
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryQuad3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,23 +11,10 @@
//
/**
- * @file pylith/feassemble/GeometryQuad3D.hh
+ * @file libsrc/feassemble/GeometryQuad3D.hh
*
* @brief C++ implementation of cell geometry calculations for 2-D
* quadrilateral cell in 3-D.
- *
- * Reference cell:
- *
- * 3 -- 2
- * | |
- * | |
- * 0 -- 1
- *
- * Vertex x y
- * 0 -1.0 -1.0
- * 1 +1.0 -1.0
- * 2 +1.0 +1.0
- * 3 -1.0 +1.0
*/
#if !defined(pylith_feassemble_geometryquad3d_hh)
@@ -37,6 +24,23 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryQuad3D -------------------------------------------------------
+/** @brief C++ implementation of cell geometry calculations for 2-D
+ * quadrilateral cell in 3-D.
+ *
+ * Reference cell:
+ at verbatim
+3 -- 2
+| |
+| |
+0 -- 1
+
+Vertex x y
+ 0 -1.0 -1.0
+ 1 +1.0 -1.0
+ 2 +1.0 +1.0
+ 3 -1.0 +1.0
+ at endverbatim
+ */
class pylith::feassemble::GeometryQuad3D : public CellGeometry
{ // GeometryQuad3D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTet3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTet3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTet3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,18 +11,10 @@
//
/**
- * @file pylith/feassemble/GeometryTet3D.hh
+ * @file libsrc/feassemble/GeometryTet3D.hh
*
* @brief C++ implementation of cell geometry calculations for 3-D
* tetrahedral cell.
- *
- * Reference cell:
- *
- * Vertex x y z
- * 0 -1.0 -1.0 -1.0
- * 1 +1.0 -1.0 -1.0
- * 2 -1.0 +1.0 -1.0
- * 3 -1.0 -1.0 +1.0
*/
#if !defined(pylith_feassemble_geometrytet3d_hh)
@@ -32,6 +24,18 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryTet3D --------------------------------------------------------
+/** @brief C++ implementation of cell geometry calculations for 3-D
+ * tetrahedral cell.
+ *
+ * Reference cell:
+ at verbatim
+Vertex x y z
+ 0 -1.0 -1.0 -1.0
+ 1 +1.0 -1.0 -1.0
+ 2 -1.0 +1.0 -1.0
+ 3 -1.0 -1.0 +1.0
+ at endverbatim
+ */
class pylith::feassemble::GeometryTet3D : public CellGeometry
{ // GeometryTet3D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri2D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri2D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri2D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/GeometryTri2D.hh
+ * @file libsrc/feassemble/GeometryTri2D.hh
*
* @brief C++ implementation of cell geometry calculations for 2-D
* triangular cell.
@@ -31,6 +31,17 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryTri2D --------------------------------------------------------
+/** @brief C++ implementation of cell geometry calculations for 2-D
+ * triangular cell.
+ *
+ * Reference cell:
+ at verbatim
+Vertex x y
+ 0 -1.0 -1.0
+ 1 +1.0 -1.0
+ 2 -1.0 +1.0
+ at endverbatim
+ */
class pylith::feassemble::GeometryTri2D : public CellGeometry
{ // GeometryTri2D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/GeometryTri3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/GeometryTri3D.hh
+ * @file libsrc/feassemble/GeometryTri3D.hh
*
* @brief C++ implementation of cell geometry calculations for 2-D
* triangular cell.
@@ -31,6 +31,17 @@
#include "CellGeometry.hh" // ISA CellGeometry
// GeometryTri3D --------------------------------------------------------
+/** @brief C++ implementation of cell geometry calculations for 2-D
+ * triangular cell.
+ *
+ * Reference cell:
+ at verbatim
+Vertex x y
+ 0 -1.0 -1.0
+ 1 +1.0 -1.0
+ 2 -1.0 +1.0
+ at endverbatim
+ */
class pylith::feassemble::GeometryTri3D : public CellGeometry
{ // GeometryTri3D
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Integrator.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Integrator.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Integrator.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,14 +11,10 @@
//
/**
- * @file pylith/feassemble/Integrator.hh
+ * @file libsrc/feassemble/Integrator.hh
*
* @brief Abstract base class for integration of finite-element
* actions.
- *
- * Note: Each object operates on a single finite-element family, which
- * is defined by the quadrature and a database of material property
- * parameters.
*/
#if !defined(pylith_feassemble_integrator_hh)
@@ -36,6 +32,13 @@
#include "pylith/utils/array.hh" // HASA double_array
// Integrator -----------------------------------------------------------
+/** @brief Abstract base class for integration of finite-element
+ * actions.
+ *
+ * Note: Each object operates on a single finite-element family, which
+ * is defined by the quadrature and a database of material property
+ * parameters.
+ */
template<typename quadrature_type>
class pylith::feassemble::Integrator
{ // Integrator
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/IntegratorElasticity.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/IntegratorElasticity.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/IntegratorElasticity.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/IntegratorElasticity.hh
+ * @file libsrc/feassemble/IntegratorElasticity.hh
*
* @brief Object containing general elasticity operations for implicit
* and explicit time integration of the elasticity equation.
@@ -32,6 +32,9 @@
#include "pylith/utils/arrayfwd.hh" // USES std::vector, double_array
// IntegratorElasticity -------------------------------------------------
+/** @brief General elasticity operations for implicit and explicit
+ * time integration of the elasticity equation.
+ */
class pylith::feassemble::IntegratorElasticity :
public Integrator<Quadrature<topology::Mesh> >
{ // IntegratorElasticity
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,19 +11,10 @@
//
/**
- * @file pylith/feassemble/Quadrature.hh
+ * @file libsrc/feassemble/Quadrature.hh
*
* @brief Abstract base class for integrating over finite-elements
* using quadrature.
- *
- * This object contains the informatio needed to perform numerical
- * quadrature over a finite-element cell. It inherits quadrature
- * information over the reference cell from the QuadratureRefCell object.
-
- * Given a cell this object will compute the cell's Jacobian, the
- * determinant of the Jacobian, the inverse of the Jacobian, and the
- * coordinates in the domain of the cell's quadrature points. The
- * Jacobian and its inverse are computed at the quadrature points.
*/
#if !defined(pylith_feassemble_quadrature_hh)
@@ -37,6 +28,19 @@
#include "pylith/utils/array.hh" // HASA double_array
// Quadrature -----------------------------------------------------------
+/** @brief Abstract base class for integrating over finite-elements
+ * using quadrature.
+ *
+ * This object contains the informatio needed to perform numerical
+ * quadrature over a finite-element cell. It inherits quadrature
+ * information over the reference cell from the QuadratureRefCell
+ * object.
+ *
+ * Given a cell this object will compute the cell's Jacobian, the
+ * determinant of the Jacobian, the inverse of the Jacobian, and the
+ * coordinates in the domain of the cell's quadrature points. The
+ * Jacobian and its inverse are computed at the quadrature points.
+ */
template<typename mesh_type>
class pylith::feassemble::Quadrature : public QuadratureRefCell
{ // Quadrature
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature0D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature0D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature0D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,25 +11,23 @@
//
/**
- * @file pylith/feassemble/Quadrature0D.hh
+ * @file libsrc/feassemble/Quadrature0D.hh
*
* @brief Quadrature for 0-D finite-elements.
- *
- * Need Quadrature in 0-D for integration of boundary condition for
- * 1-D meshes.
*/
#if !defined(pylith_feassemble_quadrature0d_hh)
#define pylith_feassemble_quadrature0d_hh
+// Include directives ---------------------------------------------------
#include "QuadratureEngine.hh"
-namespace pylith {
- namespace feassemble {
- class TestQuadrature0D;
- } // feassemble
-} // pylith
-
+// Quadrature0D ---------------------------------------------------------
+/** @brief Quadrature for 0-D finite-elements.
+ *
+ * Need Quadrature in 0-D for integration of boundary condition for
+ * 1-D meshes.
+ */
class pylith::feassemble::Quadrature0D : public QuadratureEngine
{ // Quadrature0D
friend class TestQuadrature0D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/Quadrature1D.hh
+ * @file libsrc/feassemble/Quadrature1D.hh
*
* @brief Quadrature for 1-D finite-elements.
*/
@@ -19,8 +19,11 @@
#if !defined(pylith_feassemble_quadrature1d_hh)
#define pylith_feassemble_quadrature1d_hh
+// Include directives ---------------------------------------------------
#include "QuadratureEngine.hh" // ISA Quadrature
+// Quadrature1D ---------------------------------------------------------
+/// Quadrature for 1-D finite-elements.
class pylith::feassemble::Quadrature1D : public QuadratureEngine
{ // Quadrature1D
friend class TestQuadrature1D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din2D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din2D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din2D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/Quadrature1Din2D.hh
+ * @file libsrc/feassemble/Quadrature1Din2D.hh
*
* @brief Quadrature for 1-D finite-elements in 2-D space.
*/
@@ -19,14 +19,11 @@
#if !defined(pylith_feassemble_quadrature1din2d_hh)
#define pylith_feassemble_quadrature1din2d_hh
+// Include directives ---------------------------------------------------
#include "QuadratureEngine.hh"
-namespace pylith {
- namespace feassemble {
- class Quadrature1Din2D;
- } // feassemble
-} // pylith
-
+// Quadrature0D ---------------------------------------------------------
+/// Quadrature for 1-D finite-elements in 2-D space.
class pylith::feassemble::Quadrature1Din2D : public QuadratureEngine
{ // Quadrature1Din2D
friend class TestQuadrature1Din2D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature1Din3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/Quadrature1Din3D.hh
+ * @file libsrc/feassemble/Quadrature1Din3D.hh
*
* @brief Quadrature for 1-D finite-elements in 3-D space.
*/
@@ -19,14 +19,12 @@
#if !defined(pylith_feassemble_quadrature1din3d_hh)
#define pylith_feassemble_quadrature1din3d_hh
+// Include directives ---------------------------------------------------
#include "QuadratureEngine.hh"
-namespace pylith {
- namespace feassemble {
- class Quadrature1Din3D;
- } // feassemble
-} // pylith
-
+// Quadrature0D ---------------------------------------------------------
+/** @brief Quadrature for 1-D finite-elements in 3-D space.
+ */
class pylith::feassemble::Quadrature1Din3D : public QuadratureEngine
{ // Quadrature1Din3D
friend class TestQuadrature1Din3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/Quadrature2D.hh
+ * @file libsrc/feassemble/Quadrature2D.hh
*
* @brief Quadrature for 2-D finite-elements in 2-D space.
*/
@@ -19,15 +19,11 @@
#if !defined(pylith_feassemble_quadrature2d_hh)
#define pylith_feassemble_quadrature2d_hh
+// Include directives ---------------------------------------------------
#include "QuadratureEngine.hh"
-namespace pylith {
- namespace feassemble {
- class Quadrature2D;
- class TestQuadrature2D;
- } // feassemble
-} // pylith
-
+// Quadrature0D ---------------------------------------------------------
+/// Quadrature for 2-D finite-elements in 2-D space.
class pylith::feassemble::Quadrature2D : public QuadratureEngine
{ // Quadrature2D
friend class TestQuadrature2D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2Din3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2Din3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature2Din3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/Quadrature2Din3D.hh
+ * @file libsrc/feassemble/Quadrature2Din3D.hh
*
* @brief Quadrature for 2-D finite-elements in 3-D space.
*/
@@ -19,15 +19,11 @@
#if !defined(pylith_feassemble_quadrature2din3d_hh)
#define pylith_feassemble_quadrature2din3d_hh
+// Include directives ---------------------------------------------------
#include "QuadratureEngine.hh"
-namespace pylith {
- namespace feassemble {
- class Quadrature2Din3D;
- class TestQuadrature2Din3D;
- } // feassemble
-} // pylith
-
+// Quadrature0D ---------------------------------------------------------
+/// Quadrature for 2-D finite-elements in 3-D space.
class pylith::feassemble::Quadrature2Din3D : public QuadratureEngine
{ // Quadrature2Din3D
friend class TestQuadrature2Din3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/Quadrature3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/Quadrature3D.hh
+ * @file libsrc/feassemble/Quadrature3D.hh
*
* @brief Quadrature for 3-D finite-elements.
*/
@@ -19,8 +19,11 @@
#if !defined(pylith_feassemble_quadrature3d_hh)
#define pylith_feassemble_quadrature3d_hh
-#include "QuadratureEngine.hh" // ISA QuadratureEngine
+// Include directives ---------------------------------------------------
+#include "QuadratureEngine.hh"
+// Quadrature0D ---------------------------------------------------------
+/// Quadrature for 3-D finite-elements in 3-D space.
class pylith::feassemble::Quadrature3D : public QuadratureEngine
{ // Quadrature3D
friend class TestQuadrature3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureEngine.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureEngine.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureEngine.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,7 +11,7 @@
//
/**
- * @file pylith/feassemble/QuadratureEngine.hh
+ * @file libsrc/feassemble/QuadratureEngine.hh
*
* @brief Abstract base class for quadrature computation engine.
*/
@@ -19,9 +19,12 @@
#if !defined(pylith_feassemble_quadratureengine_hh)
#define pylith_feassemble_quadratureengine_hh
+// Include directives ---------------------------------------------------
#include "feassemblefwd.hh" // forward declaration
#include "pylith/utils/array.hh" // USES double_array
+// Quadrature0D ---------------------------------------------------------
+/// Abstract base class for quadrature computation engine.
class pylith::feassemble::QuadratureEngine
{ // QuadratureEngine
friend class TestQuadratureEngine;
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureRefCell.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureRefCell.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/feassemble/QuadratureRefCell.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,16 +11,10 @@
//
/**
- * @file pylith/feassemble/QuadratureRefCell.hh
+ * @file libsrc/feassemble/QuadratureRefCell.hh
*
- * @brief Object with basic quadrature information for the reference cell.
- *
- * This object contains the basis functions and their derivatives
- * evaluated at the quadrature points of the reference element, and
- * the coordinates and weights of the quadrature points.
- *
- * The Quadrature object manages the general functionality of the
- * numerical quadrature.
+ * @brief Object with basic quadrature information for the reference
+ * cell.
*/
#if !defined(pylith_feassemble_quadraturerefcell_hh)
@@ -32,6 +26,16 @@
#include "pylith/utils/array.hh" // HASA double_array
// Quadrature -----------------------------------------------------------
+/** @brief Object with basic quadrature information for the reference
+ * cell.
+ *
+ * This object contains the basis functions and their derivatives
+ * evaluated at the quadrature points of the reference element, and
+ * the coordinates and weights of the quadrature points.
+ *
+ * The Quadrature object manages the general functionality of the
+ * numerical quadrature.
+ */
class pylith::feassemble::QuadratureRefCell
{ // Quadrature
friend class TestQuadratureRefCell; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/EffectiveStress.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/EffectiveStress.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/EffectiveStress.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -13,23 +13,20 @@
/** @file libsrc/materials/EffectiveStress.hh
*
* @brief C++ EffectiveStress object.
- *
- * This class contains bracketing and root-finding functions for
- * materials that use an effective stress formulation.
*/
#if !defined(pylith_materials_effectivestress_hh)
#define pylith_materials_effectivestress_hh
-/// Namespace for pylith package
-namespace pylith {
- namespace materials {
- class EffectiveStress;
- } // materials
+// Include directives ---------------------------------------------------
+#include "materialsfwd.hh"
-} // pylith
-
-/// C++ abstract base class for Material object.
+// EffectiveStress ------------------------------------------------------
+/** @brief C++ EffectiveStress object.
+ *
+ * This class contains bracketing and root-finding functions for
+ * materials that use an effective stress formulation.
+ */
class pylith::materials::EffectiveStress
{ // class EffectiveStress
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticIsotropic3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticIsotropic3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticIsotropic3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,14 +10,23 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/ElasticIsotropic3D.h
+/** @file libsrc/materials/ElasticIsotropic3D.hh
*
- * @brief C++ ElasticIsotropic3D object
+ * @brief C++ 3-D, isotropic, linear elastic material.
+ */
+
+#if !defined(pylith_materials_elasticisotropic3d_hh)
+#define pylith_materials_elasticisotropic3d_hh
+
+// Include directives ---------------------------------------------------
+#include "ElasticMaterial.hh" // ISA ElasticMaterial
+
+// ElasticIsotropic3D ---------------------------------------------------
+/** @brief 3-D, isotropic, linear elastic material.
*
- * 3-D, isotropic, linear elastic material. The physical properties
- * are specified using density, shear-wave speed, and
- * compressional-wave speed. The physical properties are stored
- * internally using density, lambda, and mu, which are directly
+ * The physical properties are specified using density, shear-wave
+ * speed, and compressional-wave speed. The physical properties are
+ * stored internally using density, lambda, and mu, which are directly
* related to the elasticity constants used in the finite-element
* integration.
*
@@ -26,14 +35,6 @@
* This implies that when $\epsilon = \epsilon_0$, $\sigma =
* \sigma_0$.
*/
-
-#if !defined(pylith_materials_elasticisotropic3d_hh)
-#define pylith_materials_elasticisotropic3d_hh
-
-// Include directives ---------------------------------------------------
-#include "ElasticMaterial.hh" // ISA ElasticMaterial
-
-// ElasticIsotropic3D ---------------------------------------------------
class pylith::materials::ElasticIsotropic3D : public ElasticMaterial
{ // class ElasticIsotropic3D
friend class TestElasticIsotropic3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticMaterial.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticMaterial.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticMaterial.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -12,9 +12,8 @@
/** @file libsrc/materials/ElasticMaterial.hh
*
- * @brief C++ ElasticMaterial object
- *
- * Interface definition for linear and nonlinear elastic materials.
+ * @brief Interface definition for linear and nonlinear elastic
+ * materials.
*/
#if !defined(pylith_materials_elasticmaterial_hh)
@@ -24,6 +23,9 @@
#include "Material.hh" // ISA Material
// ElasticMaterial ------------------------------------------------------
+/** @brief Interface definition for linear and nonlinear elastic
+ * materials.
+ */
class pylith::materials::ElasticMaterial : public Material
{ // class ElasticMaterial
friend class TestElasticMaterial; ///< unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStrain.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStrain.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStrain.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,14 +10,23 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/ElasticPlaneStrain.h
+/** @file libsrc/materials/ElasticPlaneStrain.hh
*
- * @brief C++ ElasticPlaneStrain object
+ * @brief 2-D, isotropic, linear elastic material for plane strain.
+ */
+
+#if !defined(pylith_materials_elasticplanestrain_hh)
+#define pylith_materials_elasticplanestrain_hh
+
+// Include directives ---------------------------------------------------
+#include "ElasticMaterial.hh" // ISA ElasticMaterial
+
+// ElasticPlaneStrain ---------------------------------------------------
+/** @brief 2-D, isotropic, linear elastic material for plane strain.
*
- * 2-D, isotropic, linear elastic material for plane strain. The
- * physical properties are specified using density, shear-wave speed,
- * and compressional-wave speed. The physical properties are stored
- * internally using density, lambda, and mu, which are directly
+ * The physical properties are specified using density, shear-wave
+ * speed, and compressional-wave speed. The physical properties are
+ * stored internally using density, lambda, and mu, which are directly
* related to the elasticity constants used in the finite-element
* integration.
*
@@ -26,14 +35,6 @@
* This implies that when $\epsilon = \epsilon_0$, $\sigma =
* \sigma_0$.
*/
-
-#if !defined(pylith_materials_elasticplanestrain_hh)
-#define pylith_materials_elasticplanestrain_hh
-
-// Include directives ---------------------------------------------------
-#include "ElasticMaterial.hh" // ISA ElasticMaterial
-
-// ElasticPlaneStrain ---------------------------------------------------
class pylith::materials::ElasticPlaneStrain : public ElasticMaterial
{ // class ElasticPlaneStrain
friend class TestElasticPlaneStrain; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStress.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStress.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticPlaneStress.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,21 +10,9 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/ElasticPlaneStress.h
+/** @file libsrc/materials/ElasticPlaneStress.hh
*
- * @brief C++ ElasticPlaneStress object
- *
- * 2-D, isotropic, linear elastic material for plane stress. The
- * physical properties are specified using density, shear-wave speed,
- * and compressional-wave speed. The physical properties are stored
- * internally using density, lambda, and mu, which are directly
- * related to the elasticity constants used in the finite-element
- * integration.
- *
- * $\sigma - \sigma_0 = C (\epsilon - \epsilon_0)
- *
- * This implies that when $\epsilon = \epsilon_0$, $\sigma =
- * \sigma_0$.
+ * @brief 2-D, isotropic, linear elastic material for plane stress.
*/
#if !defined(pylith_materials_elasticplanestress_hh)
@@ -34,6 +22,21 @@
#include "ElasticMaterial.hh" // ISA ElasticMaterial
// ElasticPlaneStrain ---------------------------------------------------
+/** @brief 2-D, isotropic, linear elastic material for plane stress.
+ *
+ * The physical properties are specified using density, shear-wave
+ * speed, and compressional-wave speed. The physical properties are
+ * stored internally using density, lambda, and mu, which are directly
+ * related to the elasticity constants used in the finite-element
+ * integration.
+ *
+ * \f[
+ * \sigma - \sigma_0 = C (\epsilon - \epsilon_0)
+ * \f]
+ *
+ * This implies that when \f$\epsilon = \epsilon_0\f$, \f$\sigma =
+ * \sigma_0\f$.
+ */
class pylith::materials::ElasticPlaneStress : public ElasticMaterial
{ // class ElasticPlaneStress
friend class TestElasticPlaneStress; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStrain1D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStrain1D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStrain1D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,20 +10,9 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/ElasticStrain1D.h
+/** @file libsrc/materials/ElasticStrain1D.hh
*
- * @brief C++ ElasticStrain1D object
- *
- * 1-D, linear elastic material with axial strain. The physical
- * properties are specified using density and compressional-wave
- * speed. The physical properties are stored internally using density
- * and lambda + 2 mu, which are directly related to the elasticity
- * constants used in the finite-element integration.
- *
- * $\sigma - \sigma_0 = (\lambda + 2 \mu) (\epislon - \epsilon_0)$
- *
- * This implies that when $\epsilon = \epsilon_0$, $\sigma =
- * \sigma_0$.
+ * @brief 1-D, linear elastic material with axial strain.
*/
#if !defined(pylith_materials_elasticstrain1d_hh)
@@ -33,6 +22,20 @@
#include "ElasticMaterial.hh" // ISA ElasticMaterial
// ElasticStrain1D ------------------------------------------------------
+/** @brief 1-D, linear elastic material with axial strain.
+ *
+ * The physical properties are specified using density and
+ * compressional-wave speed. The physical properties are stored
+ * internally using density and lambda + 2 mu, which are directly
+ * related to the elasticity constants used in the finite-element
+ * integration.
+ *
+ * $\sigma - \sigma_0 = (\lambda + 2 \mu) (\epislon - \epsilon_0)$
+ *
+ * This implies that when $\epsilon = \epsilon_0$, $\sigma =
+ * \sigma_0$.
+ */
+
class pylith::materials::ElasticStrain1D : public ElasticMaterial
{ // class ElasticStrain1D
friend class TestElasticStrain1D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStress1D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStress1D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ElasticStress1D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,14 +10,23 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/ElasticStress1D.h
+/** @file libsrc/materials/ElasticStress1D.hh
*
- * @brief C++ ElasticStress1D object
+ * @brief 1-D, linear elastic material with axial stress.
+ */
+
+#if !defined(pylith_materials_elasticstress1d_hh)
+#define pylith_materials_elasticstress1d_hh
+
+// Include directives ---------------------------------------------------
+#include "ElasticMaterial.hh" // ISA ElasticMaterial
+
+// ElasticStress1D ------------------------------------------------------
+/** @brief 1-D, linear elastic material with axial stress.
*
- * 1-D, linear elastic material with axial stress. The physical
- * properties are specified using density, shear-wave speed, and
- * compressional-wave speed. The physical properties are stored
- * internally using density, mu, and lambda, which are directly
+ * The physical properties are specified using density, shear-wave
+ * speed, and compressional-wave speed. The physical properties are
+ * stored internally using density, mu, and lambda, which are directly
* related to the elasticity constants used in the finite-element
* integration.
*
@@ -28,13 +37,6 @@
* \sigma_0$.
*/
-#if !defined(pylith_materials_elasticstress1d_hh)
-#define pylith_materials_elasticstress1d_hh
-
-// Include directives ---------------------------------------------------
-#include "ElasticMaterial.hh" // ISA ElasticMaterial
-
-// ElasticStress1D ------------------------------------------------------
class pylith::materials::ElasticStress1D : public ElasticMaterial
{ // class ElasticStress1D
friend class TestElasticStress1D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/GenMaxwellIsotropic3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/GenMaxwellIsotropic3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/GenMaxwellIsotropic3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,11 +10,24 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/GenMaxwellIsotropic3D.h
+/** @file libsrc/materials/GenMaxwellIsotropic3D.hh
*
* @brief C++ GenMaxwellIsotropic3D object
+ */
+
+// :TODO: Rewrite as template over the number of Maxwell models?
+// We could instatiate for 2 and 3 models and provide example for how to
+// instantiate over other numbers of Maxwell models.
+
+#if !defined(pylith_materials_genmaxwellisotropic3d_hh)
+#define pylith_materials_genmaxwellisotropic3d_hh
+
+// Include directives ---------------------------------------------------
+#include "ElasticMaterial.hh" // ISA ElasticMaterial
+
+// GenMaxwellIsotropic3D ------------------------------------------------
+/** @brief 3-D, isotropic, generalized linear Maxwell viscoelastic material.
*
- * 3-D, isotropic, generalized linear Maxwell viscoelastic material.
* This consists of several Maxwell models in parallel. At present,
* the number of models is fixed at 3, but this will be changed in the
* future. The physical properties are specified using density,
@@ -31,18 +44,6 @@
* (viscosity/mu), and the shear ratio is also stored for each Maxwell
* model.
*/
-
-// :TODO: Rewrite as template over the number of Maxwell models?
-// We could instatiate for 2 and 3 models and provide example for how to
-// instantiate over other numbers of Maxwell models.
-
-#if !defined(pylith_materials_genmaxwellisotropic3d_hh)
-#define pylith_materials_genmaxwellisotropic3d_hh
-
-// Include directives ---------------------------------------------------
-#include "ElasticMaterial.hh" // ISA ElasticMaterial
-
-// GenMaxwellIsotropic3D ------------------------------------------------
class pylith::materials::GenMaxwellIsotropic3D : public ElasticMaterial
{ // class GenMaxwellIsotropic3D
friend class TestGenMaxwellIsotropic3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/Material.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/Material.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/Material.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -13,10 +13,6 @@
/** @file libsrc/materials/Material.hh
*
* @brief C++ abstract base class for Material object.
- *
- * Interface definition for a material. The physical properties for
- * the material are associated with the constants in the constitutive
- * model.
*/
#if !defined(pylith_materials_material_hh)
@@ -35,6 +31,13 @@
#include <string> // HASA std::string
// Material -------------------------------------------------------------
+/** @brief C++ abstract base class for Material object.
+ *
+ * Interface definition for a material. The physical properties for
+ * the material are associated with the constants in the constitutive
+ * model.
+ */
+
class pylith::materials::Material
{ // class Material
friend class TestMaterial; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellIsotropic3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellIsotropic3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellIsotropic3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,16 +10,9 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/MaxwellIsotropic3D.h
+/** @file libsrc/materials/MaxwellIsotropic3D.hh
*
- * @brief C++ MaxwellIsotropic3D object
- *
- * 3-D, isotropic, linear Maxwell viscoelastic material. The
- * physical properties are specified using density, shear-wave speed,
- * viscosity, and compressional-wave speed. The physical properties are
- * stored internally using density, lambda, mu, which are directly
- * related to the elasticity constants used in the finite-element
- * integration. The viscosity is stored using Maxwell Time (viscosity/mu).
+ * @brief 3-D, isotropic, linear Maxwell viscoelastic material.
*/
#if !defined(pylith_materials_maxwellisotropic3d_hh)
@@ -29,6 +22,15 @@
#include "ElasticMaterial.hh" // ISA ElasticMaterial
// MaxwellIsotropic3D ---------------------------------------------------
+/** @brief 3-D, isotropic, linear Maxwell viscoelastic material.
+ *
+ * The physical properties are specified using density, shear-wave
+ * speed, viscosity, and compressional-wave speed. The physical
+ * properties are stored internally using density, lambda, mu, which
+ * are directly related to the elasticity constants used in the
+ * finite-element integration. The viscosity is stored using Maxwell
+ * Time (viscosity/mu).
+ */
class pylith::materials::MaxwellIsotropic3D : public ElasticMaterial
{ // class MaxwellIsotropic3D
friend class TestMaxwellIsotropic3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellPlaneStrain.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellPlaneStrain.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/MaxwellPlaneStrain.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,21 +10,16 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/MaxwellPlaneStrain.h
+/** @file libsrc/materials/MaxwellPlaneStrain.hh
*
- * @brief C++ MaxwellPlaneStrain object
- *
- * 2-D, isotropic, linear Maxwell viscoelastic material for plane strain. The
- * physical properties are specified using density, shear-wave speed,
- * viscosity, and compressional-wave speed. The physical properties are
- * stored internally using density, lambda, mu, which are directly
- * related to the elasticity constants used in the finite-element
- * integration. The viscosity is stored using Maxwell Time (viscosity/mu).
+ * @brief 2-D, isotropic, linear Maxwell viscoelastic material for
+ * plane strain.
*/
#if !defined(pylith_materials_maxwellplanestrain_hh)
#define pylith_materials_maxwellplanestrain_hh
+// Include directives ---------------------------------------------------
#include "ElasticMaterial.hh"
/// Namespace for pylith package
@@ -35,7 +30,17 @@
} // materials
} // pylith
-/// 2-D, isotropic, linear Maxwell viscoelastic material.
+// MaxwellPlaneStrain ---------------------------------------------------
+/** @brief 2-D, isotropic, linear Maxwell viscoelastic material for
+ * plane strain.
+ *
+ * The physical properties are specified using density, shear-wave
+ * speed, viscosity, and compressional-wave speed. The physical
+ * properties are stored internally using density, lambda, mu, which
+ * are directly related to the elasticity constants used in the
+ * finite-element integration. The viscosity is stored using Maxwell
+ * Time (viscosity/mu).
+ */
class pylith::materials::MaxwellPlaneStrain : public ElasticMaterial
{ // class MaxwellPlaneStrain
friend class TestMaxwellPlaneStrain; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/Metadata.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/Metadata.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/Metadata.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -11,12 +11,9 @@
//
/**
- * @file libsrc/topology/Metadata.hh
+ * @file libsrc/materials/Metadata.hh
*
* @brief C++ object for material metadata.
- *
- * Extends Sieve mesh to include coordinate system associated with
- * domain.
*/
#if !defined(pylith_materials_metadata_hh)
@@ -31,6 +28,12 @@
#include <map> // HASA std::map
// MaterialMetadata -----------------------------------------------------
+/** @brief C++ object for material metadata.
+ *
+ * Extends Sieve mesh to include coordinate system associated with
+ * domain.
+ */
+
class pylith::materials::Metadata
{ // Mesh
friend class TestMetadata; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/PowerLaw3D.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/PowerLaw3D.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/PowerLaw3D.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -10,17 +10,9 @@
// ----------------------------------------------------------------------
//
-/** @file libsrc/materials/PowerLaw3D.h
+/** @file libsrc/materials/PowerLaw3D.hh
*
- * @brief C++ PowerLaw3D object
- *
- * 3-D, isotropic, power-law Maxwell viscoelastic material. The
- * physical properties are specified using density, shear-wave speed,
- * viscosity coefficient, power-law exponent, and compressional-wave speed.
- * The physical properties are stored internally using density, lambda, mu,
- * which are directly related to the elasticity constants used in the
- * finite-element integration. The viscosity information is retained as
- * specified.
+ * @brief 3-D, isotropic, power-law viscoelastic material.
*/
#if !defined(pylith_materials_powerlaw3d_hh)
@@ -30,6 +22,16 @@
#include "ElasticMaterial.hh" // ISA ElasticMaterial
// Powerlaw3D -----------------------------------------------------------
+/** @brief 3-D, isotropic, power-law viscoelastic material.
+ *
+ * The physical properties are specified using density, shear-wave
+ * speed, viscosity coefficient, power-law exponent, and
+ * compressional-wave speed. The physical properties are stored
+ * internally using density, lambda, mu, which are directly related to
+ * the elasticity constants used in the finite-element
+ * integration. The viscosity information is retained as specified.
+ */
+
class pylith::materials::PowerLaw3D : public ElasticMaterial
{ // class PowerLaw3D
friend class TestPowerLaw3D; // unit testing
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/ViscoelasticMaxwell.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/ViscoelasticMaxwell.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/ViscoelasticMaxwell.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -12,24 +12,21 @@
/** @file libsrc/materials/ViscoelasticMaxwell.hh
*
- * @brief C++ ViscoelasticMaxwell object.
- *
- * This class contains a single function that can be used by any
- * linear Maxwell viscoelastic class.
+ * @brief Class for basic Maxwell viscoelastic functions.
*/
#if !defined(pylith_materials_viscoelasticmaxwell_hh)
#define pylith_materials_viscoelasticmaxwell_hh
-/// Namespace for pylith package
-namespace pylith {
- namespace materials {
- class ViscoelasticMaxwell;
- } // materials
+// Include directives ---------------------------------------------------
+#include "materialsfwd.hh" // forward declarations
-} // pylith
-
-/// C++ abstract base class for Material object.
+// ViscoelasticMaxwell --------------------------------------------------
+/** @brief Class for basic Maxwell viscoelastic functions.
+ *
+ * This class contains functions that can be used by any linear
+ * Maxwell viscoelastic class.
+ */
class pylith::materials::ViscoelasticMaxwell
{ // class ViscoelasticMaxwell
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/materials/materialsfwd.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/materials/materialsfwd.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/materials/materialsfwd.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -39,6 +39,9 @@
class GenMaxwellIsotropic3D;
class PowerLaw3D;
+ class EffectiveStress;
+ class ViscoelasticMaxwell;
+
} // materials
} // pylith
Modified: short/3D/PyLith/branches/pylith-friction/libsrc/topology/Mesh.hh
===================================================================
--- short/3D/PyLith/branches/pylith-friction/libsrc/topology/Mesh.hh 2009-08-21 21:31:43 UTC (rev 15574)
+++ short/3D/PyLith/branches/pylith-friction/libsrc/topology/Mesh.hh 2009-08-22 00:30:58 UTC (rev 15575)
@@ -14,9 +14,6 @@
* @file libsrc/topology/Mesh.hh
*
* @brief C++ PyLith finite-element mesh.
- *
- * Extends Sieve mesh to include coordinate system associated with
- * domain.
*/
#if !defined(pylith_topology_mesh_hh)
@@ -30,6 +27,11 @@
#include <petscmesh.hh> // HASA ALE::IMesh
// Mesh -----------------------------------------------------------------
+/** @brief PyLith finite-element mesh.
+ *
+ * Extends Sieve mesh to include coordinate system associated with
+ * domain.
+ */
class pylith::topology::Mesh
{ // Mesh
friend class TestMesh; // unit testing
@@ -37,15 +39,17 @@
// PUBLIC TYPEDEFS //////////////////////////////////////////////////////
public :
- // Typedefs for basic types associated with Sieve mesh.
- // All other PyLith mesh and submesh objects should define:
- // (1) SieveMesh - Sieve mesh
- // (2) RealSection - Section of doubles
- // (3) IntSection - Section of ints
- // because these are used in templated code.
- //
- // All other mesh objects for the domain should also define
- // (1) SieveSubMesh - SubMesh object
+ /** Typedefs for basic types associated with Sieve mesh.
+ * All other PyLith mesh and submesh objects should define:
+ * (1) SieveMesh - Sieve mesh
+ * (2) RealSection - Section of doubles
+ * (3) IntSection - Section of ints
+ * because these are used in templated code.
+ *
+ * All other mesh objects for the domain should also define
+ * (1) SieveSubMesh - SubMesh object
+ */
+ //@{
typedef ALE::IMesh<> SieveMesh;
typedef SieveMesh::real_section_type RealSection;
typedef SieveMesh::int_section_type IntSection;
@@ -53,6 +57,7 @@
typedef ALE::ISieveVisitor::RestrictVisitor<RealSection> RestrictVisitor;
typedef ALE::ISieveVisitor::UpdateAddVisitor<RealSection> UpdateAddVisitor;
typedef ALE::ISieveVisitor::IndicesVisitor<RealSection,SieveMesh::order_type,PetscInt> IndicesVisitor;
+ //@}
// PUBLIC METHODS ///////////////////////////////////////////////////////
More information about the CIG-COMMITS
mailing list