Merge lp:~fluidity-core/fluidity/fluidity-petsc-legacy into lp:fluidity

[Stephan Kramer]

This cleans up the legacy support for previous PETSc versions a bit, moving most of the #ifdef logic into a single header file. Also adds fixes to make Fluidity build with petsc-dev master

[lp:~fluidity-core/fluidity/fluidity-petsc-legacy]

4317. By Rhodri Davies on 2014-05-29

Merge in trunk.

[Stephan Kramer (s-kramer)]

Changed to pull request https://github.com/FluidityProject/fluidity/pull/5

Unmerged revisions

4317. By Rhodri Davies on 2014-05-29

Merge in trunk.

4316. By Rhodri Davies on 2014-03-05

Merge in trunk.

4315. By Stephan Kramer on 2014-03-04

API change in petsc-dev: flag argument to KSP/PCSetOperators has been dropped.

Passes all short tests (with petsc 'master') after Jed's fixing of MatCreateTranspose.

4314. By Stephan Kramer on 2014-01-14

Use PetscBool instead of PetscTruth.

4313. By Stephan Kramer on 2014-01-14

Put all petsc-legacy redefinitions in one header file.

This cleans up some repeated #if PETSC_VERSION stuff in the modules that use fortran.

=== modified file 'femtools/Multigrid.F90'
--- femtools/Multigrid.F90	2013-01-29 13:20:53 +0000
+++ femtools/Multigrid.F90	2014-05-29 00:03:29 +0000
@@ -9,25 +9,11 @@
 use spud
 use futils
 use parallel_tools
-#include "petscversion.h"
 #ifdef HAVE_PETSC_MODULES
   use petsc
 #endif
 implicit none
-#ifdef HAVE_PETSC_MODULES
-#include "finclude/petscdef.h"
-#else
-#include "finclude/petsc.h"
-#endif
-#if PETSC_VERSION_MINOR>=2
-#define KSP_NORM_NO KSP_NORM_NONE
-#endif
-#if PETSC_VERSION_MINOR>=3
-#define MatCreateSeqAIJ myMatCreateSeqAIJ
-#define MatCreateMPIAIJ myMatCreateMPIAIJ
-#define MatCreateSeqBAIJ myMatCreateSeqBAIJ
-#define MatCreateMPIBAIJ myMatCreateMPIBAIJ
-#endif
+#include "petsc_legacy.h"
 
 !! Some parameters that change the behaviour of 
 !! the smoothed aggregation method. All of
@@ -165,8 +151,7 @@
   call SetupSmoothedAggregation(internal_smoother_pc, &
        Internal_Smoother_Mat, ierr, no_top_smoothing=lno_top_smoothing)
 
-  call PCSetOperators(internal_smoother_pc,Internal_Smoother_Mat, &
-       Internal_Smoother_Mat,DIFFERENT_NONZERO_PATTERN,ierr)
+  call PCSetOperators(internal_smoother_pc,Internal_Smoother_Mat, Internal_Smoother_Mat,DIFFERENT_NONZERO_PATTERN,ierr)
 
   !set up pc to output
   myPETSC_NULL_OBJECT=PETSC_NULL_OBJECT
@@ -599,8 +584,7 @@
       call SetupSORSmoother(ksp_smoother, matrices(nolevels), &
         SOR_LOCAL_SYMMETRIC_SWEEP, 20)
     else
-      call KSPSetOperators(ksp_smoother, matrices(nolevels), matrices(nolevels), &
-        SAME_PRECONDITIONER, ierr)
+      call KSPSetOperators(ksp_smoother, matrices(nolevels), matrices(nolevels), SAME_PRECONDITIONER, ierr)
       call KSPSetType(ksp_smoother, KSPPREONLY, ierr)
       call PCSetType(prec_smoother, PCLU, ierr)
       call KSPSetTolerances(ksp_smoother, 1.0e-100_PetscReal_kind, 1e-8_PetscReal_kind, 1e10_PetscReal_kind, 300, ierr)
@@ -633,7 +617,7 @@
   call KSPSetTolerances(ksp, PETSC_DEFAULT_DOUBLE_PRECISION, &
     PETSC_DEFAULT_DOUBLE_PRECISION, PETSC_DEFAULT_DOUBLE_PRECISION, &
     1, ierr)
-  call KSPSetNormType(ksp, KSP_NORM_NO, ierr)
+  call KSPSetNormType(ksp, KSP_NORM_NONE, ierr)
   
   call KSPGetPC(ksp, pc, ierr)
   call PCSetType(pc, PCSOR, ierr)
@@ -656,7 +640,7 @@
     PETSC_DEFAULT_DOUBLE_PRECISION, PETSC_DEFAULT_DOUBLE_PRECISION, &
     0, ierr)
   call KSPRichardsonSetScale(ksp,real(0.0, kind = PetscReal_kind),ierr)
-  call KSPSetNormType(ksp, KSP_NORM_NO, ierr)
+  call KSPSetNormType(ksp, KSP_NORM_NONE, ierr)
   
   call KSPGetPC(ksp, pc, ierr)
   call PCSetType(pc,PCNONE,ierr)
@@ -672,21 +656,13 @@
   PC:: pc
   PetscErrorCode:: ierr
   
-#if PETSC_VERSION_MINOR>=3
   call KSPSetType(ksp, KSPCHEBYSHEV, ierr)
-#else
-  call KSPSetType(ksp, KSPCHEBYCHEV, ierr)
-#endif
   call KSPSetOperators(ksp, matrix, matrix, SAME_PRECONDITIONER, ierr)
   call KSPSetTolerances(ksp, PETSC_DEFAULT_DOUBLE_PRECISION, &
     PETSC_DEFAULT_DOUBLE_PRECISION, PETSC_DEFAULT_DOUBLE_PRECISION, &
     iterations, ierr)
-#if PETSC_VERSION_MINOR>=3
   call KSPChebyshevSetEigenvalues(ksp, emax, emin, ierr)
-#else
-  call KSPChebychevSetEigenvalues(ksp, emax, emin, ierr)
-#endif
-  call KSPSetNormType(ksp, KSP_NORM_NO, ierr)
+  call KSPSetNormType(ksp, KSP_NORM_NONE, ierr)
 
   call KSPGetPC(ksp, pc, ierr)
   call PCSetType(pc, PCNONE, ierr)
@@ -699,11 +675,7 @@
 integer, intent(out):: maxlevels, coarsesize
 integer, intent(out):: nosmd, nosmu, clustersize
 
-#if PETSC_VERSION_MINOR>=2
   PetscBool flag
-#else
-  PetscTruth flag
-#endif
   PetscErrorCode ierr
 
     call PetscOptionsGetReal('', '-mymg_epsilon', epsilon, flag, ierr)
@@ -800,11 +772,7 @@
   
   !
   call VecCopy(diag, sqrt_diag, ierr)
-#if PETSC_VERSION_MINOR>=2
   call VecSqrtAbs(sqrt_diag, ierr)
-#else
-  call VecSqrt(sqrt_diag, ierr)
-#endif
   !
   call VecDuplicate(sqrt_diag, inv_sqrt_diag, ierr)
   call VecCopy(sqrt_diag, inv_sqrt_diag, ierr)

=== modified file 'femtools/Petsc_Tools.F90'
--- femtools/Petsc_Tools.F90	2014-01-10 17:50:49 +0000
+++ femtools/Petsc_Tools.F90	2014-05-29 00:03:29 +0000
@@ -26,7 +26,6 @@
 !    USA
 #include "fdebug.h"
 module Petsc_Tools
-#include "petscversion.h"
   use FLDebug
   use Sparse_Tools
   use parallel_tools
@@ -42,12 +41,8 @@
   use petsc 
 #endif
   implicit none
-#include "petscversion.h"
-#ifdef HAVE_PETSC_MODULES
-#include "finclude/petscdef.h"
-#else
-#include "finclude/petsc.h"
-#endif
+
+#include "petsc_legacy.h"
 
   PetscReal, parameter, private :: dummy_petsc_real = 0.0
   integer, parameter, public :: PetscReal_kind = kind(dummy_petsc_real)
@@ -122,10 +117,6 @@
   logical, public, save :: petsc_test_error_handler_called = .false.
   public petsc_test_error_handler
 #if PETSC_VERSION_MINOR>=3
-#define MatCreateSeqAIJ myMatCreateSeqAIJ
-#define MatCreateMPIAIJ myMatCreateMPIAIJ
-#define MatCreateSeqBAIJ myMatCreateSeqBAIJ
-#define MatCreateMPIBAIJ myMatCreateMPIBAIJ
   public MatCreateSeqAIJ, MatCreateMPIAIJ, MatCreateSeqBAIJ, MatCreateMPIBAIJ
 #endif
 contains

=== modified file 'femtools/Solvers.F90'
--- femtools/Solvers.F90	2013-11-12 04:47:40 +0000
+++ femtools/Solvers.F90	2014-05-29 00:03:29 +0000
@@ -25,7 +25,6 @@
 !    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 !    USA
 #include "fdebug.h"
-#include "petscversion.h"
 module solvers
   use FLDebug
   use elements
@@ -49,12 +48,7 @@
   implicit none
   ! Module to provide explicit interfaces to matrix solvers.
 
-#include "petscversion.h"
-#ifdef HAVE_PETSC_MODULES
-#include "finclude/petscdef.h"
-#else
-#include "finclude/petsc.h"
-#endif
+#include "petsc_legacy.h"
 
   ! stuff used in the PETSc monitor (see petsc_solve_callback_setup() below)
   integer :: petsc_monitor_iteration = 0
@@ -1612,7 +1606,7 @@
        end if
 
 #if PETSC_VERSION_MINOR<3
-       FLExit("multigrid_near_null_space only available in petsc 3.3")
+       FLExit("multigrid_near_null_space only available in petsc version>=3.3")
 #else
        if (.not. present(petsc_numbering)) then
          FLAbort("Need petsc_numbering for multigrid near null space")
@@ -1938,10 +1932,6 @@
     case ("additive")
       call pcfieldsplitsettype(pc, PC_COMPOSITE_ADDITIVE, ierr)
     case ("symmetric_multiplicative")
-! workaround silly bug in petsc 3.1
-#ifndef PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE
-#define PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE PC_COMPOSITE_SYM_MULTIPLICATIVE
-#endif
       call pcfieldsplitsettype(pc, PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, ierr)
     case default
       FLAbort("Unknown fieldsplit_type")
@@ -1964,11 +1954,7 @@
     PCType:: pctype
     PetscReal:: rtol, atol, dtol
     PetscInt:: maxits
-#if PETSC_VERSION_MINOR>=2
     PetscBool:: flag
-#else
-    PetscTruth:: flag
-#endif
     PetscErrorCode:: ierr
     
     ewrite(2, *) 'Using solver options from cache:'
@@ -2358,11 +2344,7 @@
    Vec, allocatable, dimension(:) :: null_space_array, rot_null_space_array
    PetscReal :: norm
    PetscErrorCode :: ierr
-#if PETSC_VERSION_MINOR>=2
    PetscBool :: isnull
-#else
-   PetscTruth :: isnull
-#endif
 
    integer :: i, nnulls, nnodes, comp, dim, universal_nodes
    logical, dimension(3) :: rot_mask

=== modified file 'femtools/Sparse_Tools.F90'
--- femtools/Sparse_Tools.F90	2012-12-10 11:07:54 +0000
+++ femtools/Sparse_Tools.F90	2014-05-29 00:03:29 +0000
@@ -25,7 +25,6 @@
 !    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 !    USA
 #include "fdebug.h"
-#include "petscversion.h"
 module sparse_tools
   !!< This module implements abstract data types for sparse matrices and
   !!< operations on them.
@@ -44,11 +43,7 @@
   
   implicit none
   
-#ifdef HAVE_PETSC_MODULES
-#include "finclude/petsckspdef.h"
-#else
-#include "finclude/petsc.h"
-#endif
+#include "petsc_legacy.h"
 
   private
   

=== modified file 'femtools/Sparse_Tools_Petsc.F90'
--- femtools/Sparse_Tools_Petsc.F90	2013-11-06 11:48:34 +0000
+++ femtools/Sparse_Tools_Petsc.F90	2014-05-29 00:03:29 +0000
@@ -29,7 +29,6 @@
   !!< This module is an extension to the sparse_tools module that 
   !!< implements a csr matrix type 'petsc_csr_matrix' that directly
   !!< stores the matrix in petsc format.
-#include "petscversion.h"
   use FLDebug
   use Sparse_Tools
   use Reference_Counting
@@ -43,18 +42,7 @@
   use petsc
 #endif
   implicit none
-#ifdef HAVE_PETSC_MODULES
-#include "finclude/petscdef.h"
-#else
-#include "finclude/petsc.h"
-#endif
-#if PETSC_VERSION_MINOR>=3
-#define MatCreateSeqAIJ myMatCreateSeqAIJ
-#define MatCreateMPIAIJ myMatCreateMPIAIJ
-#define MatCreateSeqBAIJ myMatCreateSeqBAIJ
-#define MatCreateMPIBAIJ myMatCreateMPIBAIJ
-#endif
-
+#include "petsc_legacy.h"
   private
   
   type petsc_csr_matrix

=== added file 'include/petsc_legacy.h'
--- include/petsc_legacy.h	1970-01-01 00:00:00 +0000
+++ include/petsc_legacy.h	2014-05-29 00:03:29 +0000
@@ -0,0 +1,54 @@
+! This header file should be included in fortran modules that use petsc
+! directly after the implicit none. It provides legacy support for building
+! Fluidity with petsc versions older than the latest released petsc. Where names
+! have changed this #defines the new name as its older equivalent, so that new
+! names can be used in the code everywhere. Where interfaces have changed we
+! still need #ifdef PETSC_VERSION>... in the main code
+#include "petscversion.h"
+#ifdef HAVE_PETSC_MODULES
+#include "finclude/petscdef.h"
+#else
+#include "finclude/petsc.h"
+#endif
+! this is the one exception where we keep the old names for now (until 
+! we get rid of petsc 3.1 and 3.2 support). MatCreate{Seq|MPI}[B]AIJ()
+! no longer exists in petsc>=3.3. Instead we need to call MatCreateAIJ()
+! followed by MatSetUp() (now required). We provide wrapper routines
+! in the petsc_tools module.
+#if PETSC_VERSION_MINOR>=3
+#define MatCreateSeqAIJ myMatCreateSeqAIJ
+#define MatCreateMPIAIJ myMatCreateMPIAIJ
+#define MatCreateSeqBAIJ myMatCreateSeqBAIJ
+#define MatCreateMPIBAIJ myMatCreateMPIBAIJ
+#endif
+
+#if PETSC_VERSION_MINOR<2
+#define KSP_NORM_NONE KSP_NORM_NO
+#endif
+#if PETSC_VERSION_MINOR<3
+#define KSPCHEBYSHEV KSPCHEBYCHEV
+#define KSPChebyshevSetEigenvalues KSPChebychevSetEigenvalues
+#endif
+#if PETSC_VERSION_MINOR<2
+#define PetscBool PetscTruth
+#endif
+#if PETSC_VERSION_MINOR<2
+#define VecSqrtAbs VecSqrt
+#endif
+! workaround sily bug in petsc 3.1
+#ifndef PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE
+#define PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE PC_COMPOSITE_SYM_MULTIPLICATIVE
+#endif
+! Changes in petsc-dev (master)
+! should be changed to use PETSC_DEFAULT_REAL in code when petsc 3.5 is released
+! (can't use #ifndef cause PETSC_DEFAULT_REAL is a module variable in petsc-dev)
+#if PETSC_VERSION_MINOR>=4 && PETSC_VERSION_RELEASE==0
+#define PETSC_DEFAULT_DOUBLE_PRECISION PETSC_DEFAULT_REAL
+#endif
+! flag argument to KSP/PCSetOperators() has been dropped:
+! we use this macro hack which means that the call cannot be split over multiple lines
+! also note the (ab)use of fortran's case insensivity to avoid recursion
+#if PETSC_VERSION_MINOR>=4 && PETSC_VERSION_RELEASE==0
+#define KSPSetOperators(ksp, amat, pmat, flag, ierr) kspsetoperators(ksp, amat, pmat, ierr)
+#define PCSetOperators(pc, amat, pmat, flag, ierr) pcsetoperators(pc, amat, pmat, ierr)
+#endif

=== modified file 'tools/petsc_readnsolve.F90'
--- tools/petsc_readnsolve.F90	2013-06-12 16:58:00 +0000
+++ tools/petsc_readnsolve.F90	2014-05-29 00:03:29 +0000
@@ -1,6 +1,5 @@
 #include "confdefs.h"
 #include "fdebug.h"
-#include "petscversion.h"
 !! Little program that reads in a matrix equation from a file called 
 !! 'matrixdump' in the current directory containing a matrix, rhs vector and 
 !! initial guess, written in PETSc binary format. It then subsequently solves 
@@ -41,20 +40,7 @@
   use petsc 
 #endif
 implicit none
-#ifdef HAVE_PETSC_MODULES
-#include "finclude/petscvecdef.h"
-#include "finclude/petscmatdef.h"
-#include "finclude/petsckspdef.h"
-#include "finclude/petscpcdef.h"
-#include "finclude/petscviewerdef.h"
-#include "finclude/petscisdef.h"
-#else
-#include "finclude/petsc.h"
-#endif
-! hack around PetscTruth->PetscBool change in petsc 3.2
-#if PETSC_VERSION_MINOR>=2
-#define PetscTruth PetscBool
-#endif
+#include "petsc_legacy.h"
   ! options read from command-line (-prns_... options)
   character(len=4096) filename, flml
   character(len=FIELD_NAME_LEN):: field
@@ -154,7 +140,7 @@
     PC  prec
     Vec y
     PetscViewer viewer
-    PetscTruth flag
+    PetscBool flag
     PetscErrorCode ierr
     KSPConvergedReason reason
     type(petsc_numbering_type) petsc_numbering
@@ -795,7 +781,7 @@
   character(len=*), intent(out):: filename, flml, field
   logical, intent(out):: zero_init_guess, scipy, random_rhs
 
-    PetscTruth flag
+    PetscBool flag
     PetscErrorCode ierr
     
     call PetscOptionsGetString('prns_', '-filename', filename, flag, ierr)