]> https://gitweb.dealii.org/ - dealii.git/commitdiff
.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 6 May 1998 15:38:25 +0000 (15:38 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 6 May 1998 15:38:25 +0000 (15:38 +0000)
git-svn-id: https://svn.dealii.org/trunk@261 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/Conventions
deal.II/deal.II/Todo

index c636c249624c21c70f0b290b73d2ad7d83eaca55..854935b2eb54e20bbe0ab9efb594fe4214401a7c 100644 (file)
@@ -13,7 +13,7 @@ Here are some conventions for source code of the deal.II library:
   visibly enough.
 
 4./ Whenever an integer variable can only assume nonnegative values,
-  it has to be marked as unsigned int.
+  it has to be marked as unsigned.
 
 5./ Whenever an argument will not be changed, it should be marked
   const, even if it passed by value. This makes programs more readable
@@ -26,4 +26,16 @@ Here are some conventions for source code of the deal.II library:
 7./ Function and variable names may not consist of only one or two
   letters, unless the variable is a pure counting index.
 
-8./ Each class has to have at least 200 pages of documentation ;-)
+8./ Use the geometry information in GeometryInfo<dim> to get the
+  number of faces per cell, the number of children per cell, the
+  child indices of the child cells adjacent to face 3, etc, rather
+  than writing them into the directly as 2*dim, (1<<dim) and
+  {0,3}. This reduces the possibilities for errors and enhances
+  readability of code. Unfortunately, the GeometryInfo mechanism
+  was not invented right at the start of the program, so there are
+  quite a lot of places where this rule is violated. Of you find
+  such a place, fix it. We have set an amount of 1 cent per fixed
+  place, payable by cheque when the deal.II project is considered
+  finished by the author(s).
+
+9./ Each class has to have at least 200 pages of documentation ;-)
index 15902cb0d6bccfc887f1c43919957892ddd71553..c0a34de33f8417654c9bb32b0cbfe5680c202af9 100644 (file)
@@ -77,6 +77,9 @@ Try to find out what happens if DoFAccessor::get_dof_values is
 
 Update doc to the FEValues hierarchy
 
+Change <iostream> in <ostream> in grid/point.h and
+  grid/tria_iterator.h when this becomes possible.
+
 
 
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.