Changeset 0bd2cda

Timestamp:

11/23/10 16:01:47 (2 years ago)

Author:

Oleg Batrashev <ogbash@…>

Branches:

master, external, fix-prolong, refactor, refactor-ext, refactor-subsolvers

Children:

f029b54

Parents:

a10a43b

git-author:

Oleg Batrashev <ogbash@…> (11/23/10 16:01:47)

git-committer:

Oleg Batrashev <ogbash@…> (11/23/10 16:01:47)

Message:

Some documentation for the operations and corresponding data structures needed for first level preconditioner.

Files:

• doc/Doxyfile.in (modified) (1 diff)
• doc/general/dd.f90 (added)
• doc/pictures/ghosts.dia (added)
• doc/pictures/ghosts.png (added)
• doc/pictures/ghosts_ol.dia (added)
• doc/pictures/ghosts_ol.png (added)
• src/datatypes/Mesh.F90 (modified) (1 diff)
• src/datatypes/SpMtx/SpMtx_arrangement.F90 (modified) (1 diff)
• src/datatypes/SpMtx/SpMtx_class.F90 (modified) (2 diffs)

doc/Doxyfile.in

@@ -611 +611 @@
 # the \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             = @top_srcdir@/doc/pictures
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 

src/datatypes/Mesh.F90

@@ -146 +146 @@
     !              actual freedoms                |     ghost freedoms       |
 
-
+     !> \addtogroup domain_decomp 
+     !! @{
      type(indlist),dimension(:),pointer :: ax_recvidx,ax_sendidx
      type(indlist),dimension(:),pointer :: ol_outer
      type(indlist),dimension(:),pointer :: ol_inner
      type(indlist),dimension(:),pointer :: ol_solve
+     !> @}
 
      !! Graph

src/datatypes/SpMtx/SpMtx_arrangement.F90

@@ -1424 +1424 @@
   end subroutine SpMtx_distributeWithOverlap
 
-
-
+  !> \ingroup domain_decomp
+  !> Calculates overlap and then figures out which vector values need to be exchanged and which matrix values must be used in parallel matrix-vector multiplication and first level preconditioner.
+  !! The implementation takes 2 times overlap from the point of each domain, so that it can move \ol steps back and deduce the overlap from the perspective of each neighbour.
   ! Take away from matrix unneeded elements...
   ! (the matrix should be arranged into row format with SpMtx_arrange_clrorder)

src/datatypes/SpMtx/SpMtx_class.F90

@@ -112 +112 @@
     integer :: scaling = D_SpMtx_SCALE_UNDEF
 
+    !> \addtogroup domain_decomp
+    !> @{
     !> \name Block structure 
     !! @{
@@ -129 +131 @@
     !> @}
 
-    !> \code
-    !>this is needed in parallel aggregation case with zero overlap.
-    !>  then A%mtx_bbe(2,2)+1,...,A%nnz holds the "incoming" nonzeroes,
-    !>                           ie, indi \in local, indj \in ghost
-    !>       A%nnz+1,...,A%ol0nnz holds the "outgoing" nonzeroes,
-    !>                           ie, indi \in ghost, indj \in local
-    !> \endcode
+    !> This is needed in parallel aggregation case with zero overlap.
+    !!  then A%mtx_bbe(2,2)+1,...,A%nnz holds the "incoming" nonzeroes,
+    !!                           ie, indi \in local, indj \in ghost
+    !!       A%nnz+1,...,A%ol0nnz holds the "outgoing" nonzeroes,
+    !!                           ie, indi \in ghost, indj \in local
+    !!
     integer                          :: ol0nnz = -1
+    !> @}
+
     !> Permutation map for freedoms : perm_map[M%nlf]
     integer,   dimension(:), pointer :: perm_map
+
 
     !> \name Aggregates info