CFD Online Logo CFD Online URL
www.cfd-online.com
[Sponsors]
Home > Wiki > Sample code for BiCGSTAB - Fortran 90

Sample code for BiCGSTAB - Fortran 90

From CFD-Wiki

(Difference between revisions)
Jump to: navigation, search
m
 
(8 intermediate revisions not shown)
Line 1: Line 1:
<pre>
<pre>
-
!-----------------------------------MIT LICENCE-----------------------------------------!
 
-
! !
 
-
! Copyright (c) 2015, Biswajit Ghosh         !
 
-
! All rights reserved. !
 
-
! !
 
-
! Permission is hereby granted, free of charge, to any person obtaining a copy !
 
-
! of this software and associated documentation files (the "Software"), to deal !
 
-
! in the Software without restriction, including without limitation the rights !
 
-
! to use, copy, modify, merge, publish, distribute, sublicense, and/or sell !
 
-
! copies of the Software, and to permit persons to whom the Software is !
 
-
! furnished to do so, subject to the following conditions:                        !
 
-
! !
 
-
! The above copyright notice and this permission notice shall be included in !
 
-
! all copies or substantial portions of the Software. !
 
-
! !
 
-
! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR !
 
-
! IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, !
 
-
! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE !
 
-
! AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER !
 
-
! LIABILITY, WHE  THER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, !
 
-
! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN !
 
-
!---------------------------------------------------------------------------------------!
 
-
 
         !---------------------------------------------------------------------------------------!
         !---------------------------------------------------------------------------------------!
-
         !       REFERENCE :                                                                    !
+
         !                     This code is tested with gFortran 5.01                          !
-
        !      The Improved BiCGStab Method for Large and Sparse Unsymmetric Linear            !
+
         !                                   (C) Biswa                                          !
-
        !      Systems on Parallel Distributed Memory Architectures; Yang et. al.              !
+
-
        !                                                                                      !
+
-
        !      NOTE:                                                                          !
+
-
        !      This is the classic version of BICGStab. Stopping criteria of these code        !
+
-
         !       needs additional treatment to avoid/detect failure condition!                  !
+
         !---------------------------------------------------------------------------------------!
         !---------------------------------------------------------------------------------------!
 +
module BiCGStab_mod
 +
    implicit none
-
program main
+
    integer (kind=2 ), parameter    :: sp = kind(1.000)
-
         implicit none
+
    integer (kind=2 ), parameter    :: dp = kind(1.0d0)
 +
    integer (kind=2 ), parameter    :: qp = kind(1.0q0)
 +
    integer (kind=2 ), parameter    :: wp = dp         ! can be changed to "qp" to get quad precision.
-
        interface BicgStab
+
contains
-
                function BicgStab(A,b) result(x)
+
-
                        real    (kind=8), intent(in )  :: A(:,:)
+
-
                        real    (kind=8), intent(in )  :: b( : )
+
-
                        real    (kind=8)                :: x(1:size(b, dim=1))
+
-
                end function BicgStab
+
-
        end interface ! BicgStab
+
-
        integer (kind=4), parameter            :: m=4, n=4
+
    function BiCGStab(A,b) result(x)
-
        real    (kind=8), dimension(1:m,1:n)    :: A
+
-
        real    (kind=8), dimension(1:m    )    :: x,b
+
-
 
+
-
!-------------------------------A,b DEFINATION----------------------------------!
+
-
        A(1,:) = (/1.0d0, 1.0d0, 1.0d0, 1.0d0/) ![x(1)] = b(1) |
+
-
        A(2,:) = (/2.0d0, 3.0d0, 1.0d0, 1.0d0/) ![x(2)] = b(2) |---> [A]{x}={b}
+
-
        A(3,:) = (/3.0d0, 4.0d0, 1.0d0, 1.0d0/) ![x(3)] = b(3) |
+
-
        A(4,:) = (/3.0d0, 4.0d0, 1.0d0, 2.0d0/) ![x(4)] = b(4) |
+
-
        b( : ) = (/5.0d0, 9.0d0,12.0d0,13.0d0/)
+
-
!-----------------------------END A,b DEFINATION--------------------------------!
+
-
 
+
-
        x = BicgStab(A,b)
+
-
 
+
-
        print*, "X is:",x
+
-
 
+
-
end program main
+
-
 
+
-
 
+
-
 
+
-
 
+
-
 
+
-
function BicgStab(A,b) result(x)
+
         implicit none
         implicit none
-
 
-
        interface mat_vec_mul
 
-
                function mat_vec_mul(a_mvm,b_mvm) result(c_mvm)
 
-
                      real    (kind=8), intent(in) :: a_mvm(:,:),b_mvm(:)
 
-
                      real    (kind=8)            :: c_mvm(1:size(b_mvm, dim=1))
 
-
                end function mat_vec_mul
 
-
        end interface ! mat_vec_mul
 
-
 
-
        interface dot_prod
 
-
                function dot_prod(a_dp,b_dp) result(c_dp)
 
-
                      real    (kind=8), intent(in) :: a_dp(:),b_dp(:)
 
-
                      real    (kind=8)            :: c_dp
 
-
                end function dot_prod
 
-
        end interface ! dot_prod
 
!--------------------------PARAMETER AND VARIABLE-------------------------------!
!--------------------------PARAMETER AND VARIABLE-------------------------------!
-
         real    (kind=8), intent(in )                  :: A (:,:)
+
         real    (kind=wp), intent(in )                  :: A (:,:)
-
         real    (kind=8), intent(in )                  :: b ( : )
+
         real    (kind=wp), intent(in )                  :: b ( : )
-
         real    (kind=8), dimension(1:size(b, dim=1))  :: x
+
         real    (kind=wp), dimension(1:size(b, dim=1))  :: x
-
         real    (kind=8), dimension(1:size(b, dim=1))  :: r, rs, v, p, s, t
+
         real    (kind=wp), dimension(1:size(b, dim=1))  :: r, rs, v, p, s, t
-
         real    (kind=8), parameter                    :: e = 1d-20
+
         real    (kind=wp), parameter                    :: e = 1d-33
-
         real    (kind=8)                                :: rho      , rho_prev
+
         real    (kind=wp)                                :: rho      , rho_prev
-
         real    (kind=8)                                :: alpha    , omega  , beta
+
         real    (kind=wp)                                :: alpha    , omega  , beta
-
         real    (kind=8)                                :: norm_r  , norm_b       
+
         real    (kind=wp)                                :: norm_r  , norm_b       
-
         real    (kind=8)                                :: summesion, temp
+
         real    (kind=wp)                                :: summesion, temp
-
         integer                                         :: m,n
+
         integer (kind=sp)                                :: it=0,err
-
        integer                                        :: i,j
+
-
        integer                                        :: it=0,err
+
!------------------------END PARAMETER AND VARIABLE-----------------------------!   
!------------------------END PARAMETER AND VARIABLE-----------------------------!   
-
         m = size(A, dim=1)
+
         if(size(A, dim=1) /= size(A, dim=2)) stop &
-
        n = size(A, dim=2)
+
        "Error: Improper dimension of matrix A in BiCGStab."
 +
 
 +
 
-
!---------------------------------------!
 
-
        x = 0.0d0                      !-------> GUESS X
 
-
!---------------------------------------!
 
-
        r  = b - mat_vec_mul(A,x)      !-------> STEP 1
 
-
        rs = r                          !
 
-
!---------------------------------------!
 
-
        rho  = 1.0d0                  !
 
-
        alpha = 1.0d0                  !-------> STEP 2
 
-
        omega = 1.0d0                  !
 
-
!---------------------------------------!
 
-
        v = 0.0d0                      !-------> STEP 3
 
-
        p = 0.0d0                      !
 
-
!                                      !
 
-
        norm_r = dsqrt(dot_prod(r,r))  !
 
-
        norm_b = dsqrt(dot_prod(b,b))  !
 
-
!---------------------------------------!
 
-
!-------------------START OF LOOP-----------------------!     
 
-
        do while(norm_r .GT. e*norm_b)                  !-------> STEP 4
 
-
!-------------------------------------------------------!
 
!-------------------------------------------------------!
!-------------------------------------------------------!
-
         rho_prev = rho                                  !-------> STEP 5
+
         x  = 0.0_wp                                    !-------> INITIAL GUESS
-
        rho      = dot_prod(rs,r)                      !
+
!-------------------------------------------------------!
!-------------------------------------------------------!
-
         beta    = (rho/rho_prev) * (alpha/omega)        !-------> STEP 6
+
         r  = b - matmul(A,x)                           !-------> LINE 1
 +
        rs = r                                          !
!-------------------------------------------------------!
!-------------------------------------------------------!
-
         p      = r + beta * (p - omega*v)              !-------> STEP 7
+
         rho  = 1.0_wp; alpha = 1.0_wp; omega = 1.0_wp  !-------> LINE 2
!-------------------------------------------------------!
!-------------------------------------------------------!
-
         v       = mat_vec_mul(A,p)                      !-------> STEP 8
+
         v = 0.0_wp; p = 0.0_wp                        !-------> LINE 3
-
!-------------------------------------------------------!
+
!                                                       !
-
         alpha  = rho/dot_prod(rs,v)                    !-------> STEP 9
+
         norm_r = sqrt(dot_product(r,r))                !
-
!-------------------------------------------------------!
+
         norm_b = sqrt(dot_product(b,b))                !
-
        s      = r - alpha*v                          !-------> STEP 10
+
-
!-------------------------------------------------------!
+
-
        t      = mat_vec_mul(A,s)                     !-------> STEP 11
+
-
!-------------------------------------------------------!
+
-
         omega  = dot_prod(t,s)/dot_prod(t,t)           !-------> STEP 12
+
-
!-------------------------------------------------------!
+
-
        x      = x + alpha*p + omega*s                 !-------> STEP 13
+
-
!-------------------------------------------------------!
+
-
        r      = s - omega*t                          !-------> STEP 17
+
!-------------------------------------------------------!
!-------------------------------------------------------!
-
        norm_r = dsqrt(dot_prod(r,r))
 
-
        norm_b = dsqrt(dot_prod(b,b)) 
 
-
        it = it + 1
 
-
        end do !END LOOP
 
-
         print*, "Iter :",it
+
         do while(norm_r .GT. e*norm_b)                          !-------> START OF LOOP
-
return
+
        !-------------------------------------------------------!
-
end function BicgStab
+
            rho_prev = rho                                      !-------> LINE 5
 +
            rho      = dot_product(rs,r)                        !
 +
        !-------------------------------------------------------!
 +
            beta    = (rho/rho_prev) * (alpha/omega)          !-------> LINE 6
 +
        !-------------------------------------------------------!
 +
            p        = r + beta * (p - omega*v)                !-------> LINE 7
 +
        !-------------------------------------------------------!
 +
            v        = matmul(A,p)                              !-------> LINE 8
 +
        !-------------------------------------------------------!
 +
            alpha    = rho/dot_product(rs,v)                    !-------> LINE 9
 +
        !-------------------------------------------------------!
 +
            s        = r - alpha*v                              !-------> LINE 10
 +
        !-------------------------------------------------------!
 +
            t        = matmul(A,s)                              !-------> LINE 11
 +
        !-------------------------------------------------------!
 +
            omega    = dot_product(t,s)/dot_product(t,t)        !-------> LINE 12
 +
        !-------------------------------------------------------!
 +
            x        = x + alpha*p + omega*s                    !-------> LINE 13
 +
        !-------------------------------------------------------!
 +
            r        = s - omega*t                              !-------> LINE 17
 +
        !-------------------------------------------------------!
 +
            norm_r  = sqrt(dot_product(r,r))                  !
 +
            norm_b  = sqrt(dot_product(b,b))                  !
 +
        !-------------------------------------------------------!
 +
            it = it + 1                                        !
 +
        !-------------------------------------------------------!
 +
        end do                                                      !-------> END OF LOOP
 +
        print*, "Iteration Required :", it
 +
return
 +
end function BiCGStab   
 +
end module BiCGStab_mod
-
function mat_vec_mul(a_mvm,b_mvm) result(c_mvm)
 
-
        implicit none
 
-
       
 
-
        real    (kind=8), intent(in) :: a_mvm(:,:),b_mvm(:)
 
-
        real    (kind=8)            :: c_mvm(1:size(b_mvm, dim=1))
 
-
        if (size(a_mvm, dim=2) /= size(b_mvm, dim=1)) stop &
+
program main
-
        "Error: Improper dimension of matrix/vector in mat_vec_mul."
+
    use BiCGStab_mod
 +
    implicit none
-
        c_mvm = matmul(a_mvm,b_mvm)
+
    integer (kind=sp), parameter            :: m=4, n=4
 +
    real    (kind=wp), dimension(1:m,1:n)   :: A
 +
    real    (kind=wp), dimension(1:m    )    :: x_calculated,x_actual,b
-
        return
+
!-----------------------------A,b DEFINATION--------------------------------!
-
end function mat_vec_mul
+
    A      (1,:) = [ 1.0_wp, 1.0_wp, 1.0_wp, 1.0_wp] ![x(1)] = b(1) |
 +
    A      (2,:) = [ 2.0_wp, 3.0_wp, 1.0_wp, 1.0_wp] ![x(2)] = b(2) |---> [A]{x}={b}
 +
    A      (3,:) = [ 3.0_wp, 4.0_wp, 1.0_wp, 1.0_wp] ![x(3)] = b(3) |
 +
    A      (4,:) = [ 3.0_wp, 4.0_wp, 1.0_wp, 2.0_wp] ![x(4)] = b(4) |
 +
! 
 +
    x_actual( : ) = [ 5.0_wp, 8.0_wp,10.0_wp,12.0_wp]
 +
!  settting b = Ax
 +
    b = matmul(A,x_actual)
 +
!---------------------------END A,b DEFINATION------------------------------!
 +
!----------CALL BiCGStab func-----------!
 +
!                                      !
 +
    x_calculated = BiCGStab(A,b)        !
 +
!                                      !
 +
!---------------------------------------!
 +
    print*, "analytical solution =", x_actual
 +
    print*, "computed  solution =", x_calculated
 +
    print*, "Error in computed solution =", abs(x_actual-x_calculated)/x_actual
-
function dot_prod(a_dp,b_dp) result(c_dp)
+
end program main
-
        implicit none
+
-
 
+
-
        real    (kind=8), intent(in) :: a_dp(:),b_dp(:)
+
-
        real    (kind=8)            :: c_dp
+
-
 
+
-
        if (size(a_dp, dim=1) /= size(b_dp, dim=1)) stop &
+
-
        "Error: Improper dimension of matrices in dot_prod."
+
-
 
+
-
        c_dp = dot_product(a_dp,b_dp)
+
-
 
+
-
        return
+
-
end function dot_prod
+
</pre>
</pre>

Latest revision as of 07:14, 9 May 2018


        !---------------------------------------------------------------------------------------!
        !                      This code is tested with gFortran 5.01                           !
        !                                   (C) Biswa                                           !
        !---------------------------------------------------------------------------------------!

module BiCGStab_mod
    implicit none

    integer (kind=2 ), parameter    :: sp = kind(1.000)
    integer (kind=2 ), parameter    :: dp = kind(1.0d0)
    integer (kind=2 ), parameter    :: qp = kind(1.0q0)
    integer (kind=2 ), parameter    :: wp = dp         ! can be changed to "qp" to get quad precision.

contains

    function BiCGStab(A,b) result(x)
        implicit none

!--------------------------PARAMETER AND VARIABLE-------------------------------!
        real    (kind=wp), intent(in )                   :: A (:,:)
        real    (kind=wp), intent(in )                   :: b ( : )
        real    (kind=wp), dimension(1:size(b, dim=1))   :: x

        real    (kind=wp), dimension(1:size(b, dim=1))   :: r, rs, v, p, s, t
        real    (kind=wp), parameter                     :: e = 1d-33
        real    (kind=wp)                                :: rho      , rho_prev
        real    (kind=wp)                                :: alpha    , omega   , beta
        real    (kind=wp)                                :: norm_r   , norm_b       
        real    (kind=wp)                                :: summesion, temp

        integer (kind=sp)                                :: it=0,err
!------------------------END PARAMETER AND VARIABLE-----------------------------!  

        if(size(A, dim=1) /= size(A, dim=2)) stop &
        "Error: Improper dimension of matrix A in BiCGStab."





!-------------------------------------------------------!
        x  = 0.0_wp                                     !-------> INITIAL GUESS
!-------------------------------------------------------!
        r  = b - matmul(A,x)                            !-------> LINE 1
        rs = r                                          !
!-------------------------------------------------------!
        rho   = 1.0_wp; alpha = 1.0_wp; omega = 1.0_wp  !-------> LINE 2
!-------------------------------------------------------!
        v  = 0.0_wp; p  = 0.0_wp                        !-------> LINE 3
!                                                       !
        norm_r = sqrt(dot_product(r,r))                 !
        norm_b = sqrt(dot_product(b,b))                 !
!-------------------------------------------------------!





        do while(norm_r .GT. e*norm_b)                          !-------> START OF LOOP

        !-------------------------------------------------------!
            rho_prev = rho                                      !-------> LINE 5
            rho      = dot_product(rs,r)                        !
        !-------------------------------------------------------!
            beta     = (rho/rho_prev) * (alpha/omega)           !-------> LINE 6
        !-------------------------------------------------------!
            p        = r + beta * (p - omega*v)                 !-------> LINE 7
        !-------------------------------------------------------!
            v        = matmul(A,p)                              !-------> LINE 8
        !-------------------------------------------------------!
            alpha    = rho/dot_product(rs,v)                    !-------> LINE 9
        !-------------------------------------------------------!
            s        = r - alpha*v                              !-------> LINE 10
        !-------------------------------------------------------!
            t        = matmul(A,s)                              !-------> LINE 11
        !-------------------------------------------------------!
            omega    = dot_product(t,s)/dot_product(t,t)        !-------> LINE 12
        !-------------------------------------------------------!
            x        = x + alpha*p + omega*s                    !-------> LINE 13
        !-------------------------------------------------------!
            r        = s - omega*t                              !-------> LINE 17
        !-------------------------------------------------------!
            norm_r   = sqrt(dot_product(r,r))                   !
            norm_b   = sqrt(dot_product(b,b))                   !
        !-------------------------------------------------------!
            it = it + 1                                         !
        !-------------------------------------------------------!

        end do                                                      !-------> END OF LOOP

        print*, "Iteration Required :", it

return
end function BiCGStab     

end module BiCGStab_mod


program main
    use BiCGStab_mod
    implicit none

    integer (kind=sp), parameter             :: m=4, n=4
    real    (kind=wp), dimension(1:m,1:n)    :: A
    real    (kind=wp), dimension(1:m    )    :: x_calculated,x_actual,b

!-----------------------------A,b DEFINATION--------------------------------!
    A       (1,:) = [ 1.0_wp, 1.0_wp, 1.0_wp, 1.0_wp] ![x(1)] = b(1) |
    A       (2,:) = [ 2.0_wp, 3.0_wp, 1.0_wp, 1.0_wp] ![x(2)] = b(2) |---> [A]{x}={b}
    A       (3,:) = [ 3.0_wp, 4.0_wp, 1.0_wp, 1.0_wp] ![x(3)] = b(3) |
    A       (4,:) = [ 3.0_wp, 4.0_wp, 1.0_wp, 2.0_wp] ![x(4)] = b(4) |

!   
    x_actual( : ) = [ 5.0_wp, 8.0_wp,10.0_wp,12.0_wp]

!   settting b = Ax
    b = matmul(A,x_actual)
!---------------------------END A,b DEFINATION------------------------------!

!----------CALL BiCGStab func-----------!
!                                       !
    x_calculated = BiCGStab(A,b)        !
!                                       !
!---------------------------------------!

    print*, "analytical solution =", x_actual
    print*, "computed   solution =", x_calculated
    print*, "Error in computed solution =", abs(x_actual-x_calculated)/x_actual

end program main
Retrieved from "https://cfd-online.com/Wiki/Sample_code_for_BiCGSTAB_-_Fortran_90"
My wiki