lump.f

Go to the documentation of this file.

!                   ***************
                    SUBROUTINE lump
!                   ***************
!
     &(diag,a,mesh,xmul)
!
!***********************************************************************
! BIEF   V6P1                                   21/08/2010
!***********************************************************************
!
!brief    SUMS UP THE TERMS OF MATRIX A, BY LINE.
!+
!+            MULTIPLIES THE RESULT BY XMUL.
!+
!+            TO DO SO SIMPLY DOES DIAG = A X (X VECTOR EQUAL TO XMUL).
!
!history  J-M HERVOUET (LNH)
!+        08/12/94
!+        V5P5
!+
!
!history  N.DURAND (HRW), S.E.BOURBAN (HRW)
!+        13/07/2010
!+        V6P0
!+   Translation of French comments within the FORTRAN sources into
!+   English comments
!
!history  N.DURAND (HRW), S.E.BOURBAN (HRW)
!+        21/08/2010
!+        V6P0
!+   Creation of DOXYGEN tags for automated documentation and
!+   cross-referencing of the FORTRAN sources
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| A              |-->| MATRIX
!| DIAG           |<--| RESULTING VECTOR
!| MESH           |-->| MESH STRUCTURE
!| XMUL           |-->| COEFFICIENT FOR MULTIPLICATION
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief, ex_lump => lump
!
      USE declarations_special
      IMPLICIT NONE
!
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!
      DOUBLE PRECISION, INTENT(IN)   :: XMUL
      TYPE(bief_obj), INTENT(IN)     :: A
      TYPE(bief_obj), INTENT(INOUT)  :: DIAG
      TYPE(bief_mesh), INTENT(INOUT) :: MESH
!
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!
      DOUBLE PRECISION C
!
!-----------------------------------------------------------------------
!
      IF(a%ELMLIN.NE.a%ELMCOL) THEN
        WRITE(lu,51)
51      FORMAT(1x,'LUMP (BIEF) : A IS NOT A SQUARE MATRIX')
        CALL plante(1)
        stop
      ENDIF
!
!-----------------------------------------------------------------------
!
      CALL cpstvc(a%D,diag)
!
!-----------------------------------------------------------------------
!
!  BUILDS A VECTOR THAT IS XMUL EVERYWHERE
!
      CALL os( 'X=C     ', x=diag , c=xmul )
!
!  DIAG IS THE PRODUCT OF A BY THIS VECTOR
!  DIAG HERE PLAYS THE ROLE OF X AND Y (CAN BE DONE)
!
      CALL matvec('X=AY    ',diag,a,diag,c,mesh,.true.)
!
!-----------------------------------------------------------------------
!
      RETURN
      END