Merge lp:~asc/fluidity/solver_reordering_remove into lp:fluidity

[Adam Candy]

Removal of the named solver reordering options.
Notes have been added to both the schema and Solvers.F90 stating the reordering mechanisms have not been tested, and how to use them if you want to try them out.

[Stephan Kramer (s-kramer)]

review: Approve

=== modified file 'femtools/Solvers.F90'
--- femtools/Solvers.F90	2011-10-26 14:37:06 +0000
+++ femtools/Solvers.F90	2012-01-18 12:53:28 +0000
@@ -774,7 +774,10 @@
   end if
   
   ewrite(1, *) 'Assembling matrix.'
-  
+ 
+  ! Note the explicitly-described options rcm, 1wd and natural are now not
+  ! listed explicitly in the schema (but can still be used by adding the
+  ! appropriate string in the solver reordering node).
   call PetscOptionsGetString("", "-ordering_type", ordering_type, &
         use_reordering, ierr)
   if (.not. use_reordering) then
 
=== modified file 'schemas/solvers.rnc'
--- schemas/solvers.rnc	2010-10-27 12:18:35 +0000
+++ schemas/solvers.rnc	2012-01-18 12:53:28 +0000
@@ -427,26 +427,17 @@
       element cache_solver_context {
          empty
       }?,
-      (
-         ## Use Reverse Cuthill-McKee reordering to improve cache performance
-         element reordering {
-           attribute name { "rcm" }
-         }|
-         ## Use one way dissecting reordering to improve cache performance
-         element reordering {
-           attribute name { "1wd" }
-         }|
-         ## Use natural ordering as reordering, i.e. change nothing.
-         ## Only useful for debugging purposes.
-         element reordering {
-           attribute name { "natural" }
-         }|
-         ## Specify any other reordering mechanism supported by PETSc
-         ## see http://www-unix.mcs.anl.gov/petsc/petsc-as/snapshots/petsc-current/docs/manualpages/MatOrderings/MatGetOrdering.html
-         element reordering {
-           attribute name { xsd:string }
-         }
-      )?,
+      ## Specify a reordering mechanism supported by PETSc
+      ## to improve cache performance, see
+      ## http://www-unix.mcs.anl.gov/petsc/petsc-as/snapshots/petsc-current/docs/manualpages/MatOrderings/MatGetOrdering.html
+      ##
+      ## Note that the use of reordering mechanisms for solves is 
+      ## currently untested.  Possible schemes include:
+      ## Reverse Cuthill-McKee reordering (rcm), a one way dissecting (1wd)
+      ## algorithm, and also a natural ordering (natural) for debugging.
+      element reordering {
+         attribute name { xsd:string }
+      }?,
       ## Extra diagnostics to help debug solver problems
       element diagnostics {
          ## Print out the norm of vectors and matrices before the
 
=== modified file 'schemas/solvers.rng'
--- schemas/solvers.rng	2010-10-27 12:18:35 +0000
+++ schemas/solvers.rng	2012-01-18 12:53:28 +0000
@@ -448,34 +448,19 @@
       </element>
     </optional>
     <optional>
-      <choice>
-        <element name="reordering">
-          <a:documentation>Use Reverse Cuthill-McKee reordering to improve cache performance</a:documentation>
-          <attribute name="name">
-            <value>rcm</value>
-          </attribute>
-        </element>
-        <element name="reordering">
-          <a:documentation>Use one way dissecting reordering to improve cache performance</a:documentation>
-          <attribute name="name">
-            <value>1wd</value>
-          </attribute>
-        </element>
-        <element name="reordering">
-          <a:documentation>Use natural ordering as reordering, i.e. change nothing.
-Only useful for debugging purposes.</a:documentation>
-          <attribute name="name">
-            <value>natural</value>
-          </attribute>
-        </element>
-        <element name="reordering">
-          <a:documentation>Specify any other reordering mechanism supported by PETSc
-see http://www-unix.mcs.anl.gov/petsc/petsc-as/snapshots/petsc-current/docs/manualpages/MatOrderings/MatGetOrdering.html</a:documentation>
-          <attribute name="name">
-            <data type="string"/>
-          </attribute>
-        </element>
-      </choice>
+      <element name="reordering">
+        <a:documentation>Specify a reordering mechanism supported by PETSc
+to improve cache performance, see
+http://www-unix.mcs.anl.gov/petsc/petsc-as/snapshots/petsc-current/docs/manualpages/MatOrderings/MatGetOrdering.html
+
+Note that the use of reordering mechanisms for solves is 
+currently untested.  Possible schemes include:
+Reverse Cuthill-McKee reordering (rcm), a one way dissecting (1wd)
+algorithm, and also a natural ordering (natural) for debugging.</a:documentation>
+        <attribute name="name">
+          <data type="string"/>
+        </attribute>
+      </element>
     </optional>
     <element name="diagnostics">
       <a:documentation>Extra diagnostics to help debug solver problems</a:documentation>