From: kronbichler Date: Mon, 18 Oct 2010 14:42:13 +0000 (+0000) Subject: Improve comments/documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3a2e3402828f809d15d78b52e0dd185991f00a28;p=dealii-svn.git Improve comments/documentation. git-svn-id: https://svn.dealii.org/trunk@22361 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/grid_in.h b/deal.II/deal.II/include/grid/grid_in.h index b2dbd8f900..409305844e 100644 --- a/deal.II/deal.II/include/grid/grid_in.h +++ b/deal.II/deal.II/include/grid/grid_in.h @@ -50,7 +50,7 @@ class SubCellData; * way. Since such cases are very hard to detect, the library does not make * any attempt to abort on such situations, and you will get a triangulation * that probably does not do what you want. A solution to this problem is the - * PersistantTriangulation class. + * PersistentTriangulation class. * * Note: if you experience unexpected problems with the use of this * class, be sure to read the documentation right until the end, and @@ -140,8 +140,8 @@ class SubCellData; * *
  • Cubit format: deal.II doesn't directly support importing from * Cubit at this time. However, Cubit can export in UCD format using a simple - * plugin, and the resulting UCD file can then be read by this class. The - * plugin script can be found on the deal.II wiki page, + * plug-in, and the resulting UCD file can then be read by this class. The + * plug-in script can be found on the deal.II wiki page, * http://sourceforge.net/apps/mediawiki/dealii/index.php?title=Mesh_Input_and_Output_Interfaces . * * There is also a little program, written by Jean-Paul Pelteret, that diff --git a/deal.II/lac/include/lac/constraint_matrix.h b/deal.II/lac/include/lac/constraint_matrix.h index f8ffc9a374..33f4ab8a68 100644 --- a/deal.II/lac/include/lac/constraint_matrix.h +++ b/deal.II/lac/include/lac/constraint_matrix.h @@ -1817,7 +1817,7 @@ ConstraintMatrix::add_entry (const unsigned int line, // if in debug mode, check whether an // entry for this column already - // exists and if its the same as + // exists and if it's the same as // the one entered at present // // in any case: exit the function if an diff --git a/deal.II/lac/include/lac/constraint_matrix.templates.h b/deal.II/lac/include/lac/constraint_matrix.templates.h index 889938f542..93496d8306 100644 --- a/deal.II/lac/include/lac/constraint_matrix.templates.h +++ b/deal.II/lac/include/lac/constraint_matrix.templates.h @@ -901,9 +901,27 @@ namespace internals // obtained directly by some local entry // (local_row) or some constraints // (constraint_position). This is not - // directly used in - // the user code, but accessed via the + // directly used in the user code, but + // accessed via the // GlobalRowsFromLocal. + // + // The actions performed here correspond to + // reshaping the constraint information + // from global degrees of freedom to local + // ones (i.e., cell-related DoFs), and also + // transforming the constraint information + // from compressed row storage (each local + // dof that is constrained has a list of + // constraint entries associated to it) + // into compressed column storage based on + // the cell-related DoFs (we have a list of + // global degrees of freedom, and to each + // we have a list of local rows where the + // entries come from). To increase the + // speed, we additionally store whether an + // entry is generated directly from the + // local degrees of freedom or whether it + // comes from a constraint. struct Distributing { Distributing (const unsigned int global_row = numbers::invalid_unsigned_int, @@ -954,8 +972,7 @@ namespace internals // this is a cache for constraints that // are encountered on a local level. - // corresponds to functionality also - // provided by + // The functionality is similar to // std::vector // > >, but tuned so that frequent memory // allocation for each entry is @@ -1070,6 +1087,24 @@ namespace internals // means that a global dof might also have // indirect contributions from a local dof via // a constraint, besides the direct ones. + // + // The actions performed here correspond to + // reshaping the constraint information + // from global degrees of freedom to local + // ones (i.e., cell-related DoFs), and also + // transforming the constraint information + // from compressed row storage (each local + // dof that is constrained has a list of + // constraint entries associated to it) + // into compressed column storage based on + // the cell-related DoFs (we have a list of + // global degrees of freedom, and to each + // we have a list of local rows where the + // entries come from). To increase the + // speed, we additionally store whether an + // entry is generated directly from the + // local degrees of freedom or whether it + // comes from a constraint. class GlobalRowsFromLocal { public: