xref: /phasta/svLS/svLS_API.h (revision 712d3df0b59ebebaaeaea358162c8d2c043c6e08)
1 !     This software is Copyright (c) 2012-2015 The Regents of the
2 !     University of California. All Rights Reserved.
3 !
4 !     Permission to copy and modify this software and its documentation
5 !     for educational, research and non-profit purposes, without fee,
6 !     and without a written agreement is hereby granted, provided that
7 !     the above copyright notice, this paragraph and the following three
8 !     paragraphs appear in all copies.
9 !
10 !     Permission to make commercial use of this software may be obtained
11 !     by contacting:
12 !     Technology Transfer Office
13 !     9500 Gilman Drive, Mail Code 0910
14 !     University of California
15 !     La Jolla, CA 92093-0910
16 !     (858) 534-5815
17 !     invent@ucsd.edu
18 !
19 !     This software program and documentation are copyrighted by The
20 !     Regents of the University of California. The software program and
21 !     documentation are supplied "as is", without any accompanying
22 !     services from The Regents. The Regents does not warrant that the
23 !     operation of the program will be uninterrupted or error-free. The
24 !     end-user understands that the program was developed for research
25 !     purposes and is advised not to rely exclusively on the program for
26 !     any reason.
27 !
28 !     IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY
29 !     PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
30 !     DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS
31 !     SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
32 !     CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 !     THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
34 !     WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35 !     OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
36 !     SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE
37 !     UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE
38 !     MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
39 
40       INTERFACE
41          SUBROUTINE svLS_COMMU_CREATE(commu, commi)
42             INCLUDE "svLS_STD.h"
43             TYPE(svLS_commuType), INTENT(INOUT) :: commu
44             INTEGER, INTENT(IN) :: commi
45          END SUBROUTINE svLS_COMMU_CREATE
46          SUBROUTINE svLS_COMMU_FREE(commu)
47             INCLUDE "svLS_STD.h"
48             TYPE(svLS_commuType), INTENT(INOUT) :: commu
49          END SUBROUTINE svLS_COMMU_FREE
50 
51          SUBROUTINE svLS_LHS_CREATE(lhs, commu, gnNo, nNo, nnz,
52      2      gNodes, rowPtr, colPtr, nFaces)
53             INCLUDE "svLS_STD.h"
54             TYPE(svLS_lhsType), INTENT(INOUT) :: lhs
55             TYPE(svLS_commuType), INTENT(IN) :: commu
56             INTEGER, INTENT(IN) :: gnNo, nNo, nnz
57             INTEGER, INTENT(IN) :: gNodes(nNo), rowPtr(nNo+1),
58      2         colPtr(nnz)
59             INTEGER, INTENT(IN) :: nFaces
60          END SUBROUTINE svLS_LHS_CREATE
61          SUBROUTINE svLS_LHS_FREE(lhs)
62             INCLUDE "svLS_STD.h"
63             TYPE(svLS_lhsType), INTENT(INOUT) :: lhs
64          END SUBROUTINE svLS_LHS_FREE
65 
66          SUBROUTINE svLS_LS_CREATE(ls, LS_type, relTol, absTol, maxItr,
67      2      dimKry, relTolIn, absTolIn, maxItrIn)
68             INCLUDE "svLS_STD.h"
69             TYPE(svLS_lsType), INTENT(INOUT) :: ls
70             INTEGER, INTENT(IN) :: LS_type
71             REAL*8, INTENT(IN), OPTIONAL :: relTol, absTol, relTolIn(2),
72      2         absTolIn(2)
73             INTEGER, INTENT(IN), OPTIONAL :: maxItr, dimKry, maxItrIn(2)
74          END SUBROUTINE svLS_LS_CREATE
75          SUBROUTINE svLS_LS_FREE(ls)
76             INCLUDE "svLS_STD.h"
77             TYPE(svLS_lsType), INTENT(INOUT) :: ls
78          END SUBROUTINE svLS_LS_FREE
79 
80          SUBROUTINE svLS_BC_CREATE(lhs, faIn, nNo, dof, BC_type,
81      2         gNodes, Val)
82             INCLUDE "svLS_STD.h"
83             TYPE(svLS_lhsType), INTENT(INOUT) :: lhs
84             INTEGER, INTENT(IN) :: faIn, nNo, dof
85             INTEGER, INTENT(IN) :: BC_type
86             INTEGER, INTENT(IN) :: gNodes(nNo)
87             REAL*8, INTENT(IN), OPTIONAL :: Val(dof,nNo)
88          END SUBROUTINE svLS_BC_CREATE
89          SUBROUTINE svLS_BC_FREE(lhs, faIn)
90             INCLUDE "svLS_STD.h"
91             TYPE(svLS_lhsType), INTENT(INOUT) :: lhs
92             INTEGER, INTENT(IN) :: faIn
93          END SUBROUTINE svLS_BC_FREE
94 
95          SUBROUTINE svLS_SOLVE (lhs, ls, dof, Ri, Val, incL, res)
96             INCLUDE "svLS_STD.h"
97             TYPE(svLS_lhsType), INTENT(INOUT) :: lhs
98             TYPE(svLS_lsType), INTENT(INOUT) :: ls
99             INTEGER, INTENT(IN) :: dof
100             REAL*8, INTENT(INOUT) :: Ri(dof,lhs%nNo)
101             REAL*8, INTENT(IN) :: Val(dof*dof,lhs%nnz)
102             INTEGER, INTENT(IN), OPTIONAL :: incL(lhs%nFaces)
103             REAL*8, INTENT(IN), OPTIONAL :: res(lhs%nFaces)
104          END SUBROUTINE svLS_SOLVE
105       END INTERFACE
106 
107 
108 
109 
110 
111