1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
! Copyright (C) 2006 Imperial College London and others.
!
! Please see the AUTHORS file in the main source directory for a full list
! of copyright holders.
!
! Prof. C Pain
! Applied Modelling and Computation Group
! Department of Earth Science and Engineering
! Imperial College London
!
! amcgsoftware@imperial.ac.uk
!
! This library is free software; you can redistribute it and/or
! modify it under the terms of the GNU Lesser General Public
! License as published by the Free Software Foundation; either
! version 2.1 of the License, or (at your option) any later version.
!
! This library is distributed in the hope that it will be useful,
! but WITHOUT ANY WARRANTY; without even the implied warranty of
! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
! Lesser General Public License for more details.
!
! You should have received a copy of the GNU Lesser General Public
! License along with this library; if not, write to the Free Software
! Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
! USA
#include "fdebug.h"
module petsc_solve_state_module
!!< This module provides an extension of the petsc_solve interface
!!< where state can supplied as an extra argument. This allows the use
!!< of extra geometric information pulled from state in the solver.
!!< Currently this is used for the "mg" preconditioner with
!!< vertical_lumping option (with and without internal smoothing).
!!< This is put in a separate module as the way this information is stored
!!< in state is fluidity specific and should therefore not be dealt with
!!< in femtools/.
use spud
use sparse_tools
use fields
use solvers
use sparse_tools_petsc
use state_module
use global_parameters, only: OPTION_PATH_LEN
use field_options
! modules from assemble:
use free_surface_module
implicit none
interface petsc_solve
module procedure petsc_solve_scalar_state, &
petsc_solve_scalar_state_petsc_csr, &
petsc_solve_vector_state_petsc_csr
end interface
private
public petsc_solve, petsc_solve_needs_state, &
petsc_solve_state_setup
contains
subroutine petsc_solve_scalar_state(x, matrix, rhs, state, &
option_path, iterations_taken)
!!< Solve a linear system the nice way.
!!< This version uses state to pull geometric information from
!!< if required for the specified options.
type(scalar_field), intent(inout) :: x
type(scalar_field), intent(in) :: rhs
type(csr_matrix), intent(in) :: matrix
type(state_type), intent(in):: state
!! override x%option_path if provided:
character(len=*), optional, intent(in):: option_path
!! the number of petsc iterations taken
integer, intent(out), optional :: iterations_taken
integer, dimension(:), pointer:: surface_nodes
type(petsc_csr_matrix), dimension(:), pointer:: prolongators
character(len=OPTION_PATH_LEN):: solver_option_path
integer:: i
call petsc_solve_state_setup(solver_option_path, prolongators, surface_nodes, &
state, x%mesh, 1, x%option_path, has_solver_cache(matrix), option_path=option_path)
if (associated(prolongators)) then
if (associated(surface_nodes)) then
call petsc_solve(x, matrix, rhs, &
prolongators=prolongators, &
surface_node_list=surface_nodes, option_path=option_path, &
iterations_taken = iterations_taken)
deallocate(surface_nodes)
else
call petsc_solve(x, matrix, rhs, &
prolongators=prolongators, option_path=option_path, &
iterations_taken = iterations_taken)
end if
do i=1, size(prolongators)
call deallocate(prolongators(i))
end do
deallocate(prolongators)
else
call petsc_solve(x, matrix, rhs, option_path=option_path, &
iterations_taken = iterations_taken)
end if
end subroutine petsc_solve_scalar_state
subroutine petsc_solve_scalar_state_petsc_csr(x, matrix, rhs, state, &
option_path)
!!< Solve a linear system the nice way.
!!< This version uses state to pull geometric information from
!!< if required for the specified options.
type(scalar_field), intent(inout) :: x
type(scalar_field), intent(in) :: rhs
type(petsc_csr_matrix), intent(inout) :: matrix
type(state_type), intent(in):: state
!! override x%option_path if provided:
character(len=*), optional, intent(in):: option_path
integer, dimension(:), pointer:: surface_nodes
type(petsc_csr_matrix), dimension(:), pointer:: prolongators
character(len=OPTION_PATH_LEN):: solver_option_path
integer:: i
! no solver cache for petsc_csr_matrices at the mo'
call petsc_solve_state_setup(solver_option_path, prolongators, surface_nodes, &
state, x%mesh, 1, x%option_path, .false., option_path=option_path)
if (associated(prolongators)) then
if (associated(surface_nodes)) then
call petsc_solve(x, matrix, rhs, &
prolongators=prolongators, &
surface_node_list=surface_nodes, option_path=option_path)
deallocate(surface_nodes)
else
call petsc_solve(x, matrix, rhs, &
prolongators=prolongators, option_path=option_path)
end if
do i=1, size(prolongators)
call deallocate(prolongators(i))
end do
deallocate(prolongators)
else
call petsc_solve(x, matrix, rhs, option_path=option_path)
end if
end subroutine petsc_solve_scalar_state_petsc_csr
subroutine petsc_solve_vector_state_petsc_csr(x, matrix, rhs, state, &
option_path)
!!< Solve a linear system the nice way.
!!< This version uses state to pull geometric information from
!!< if required for the specified options.
type(vector_field), intent(inout) :: x
type(vector_field), intent(in) :: rhs
type(petsc_csr_matrix), intent(inout) :: matrix
type(state_type), intent(in):: state
!! override x%option_path if provided:
character(len=*), optional, intent(in):: option_path
integer, dimension(:), pointer:: surface_nodes
type(petsc_csr_matrix), dimension(:), pointer:: prolongators
character(len=OPTION_PATH_LEN):: solver_option_path
integer:: i
! no solver cache for petsc_csr_matrices at the mo'
call petsc_solve_state_setup(solver_option_path, prolongators, surface_nodes, &
state, x%mesh, x%dim, x%option_path, .false., option_path=option_path)
if (associated(prolongators)) then
call petsc_solve(x, matrix, rhs, &
prolongators=prolongators, option_path=option_path)
do i=1, size(prolongators)
call deallocate(prolongators(i))
end do
deallocate(prolongators)
else
call petsc_solve(x, matrix, rhs, option_path=option_path)
end if
end subroutine petsc_solve_vector_state_petsc_csr
subroutine petsc_solve_state_setup(solver_option_path, prolongators, surface_nodes, &
state, mesh, field_dim, field_option_path, matrix_has_solver_cache, option_path)
! sets up monitors and returns solver_option_path,
! and prolongators and surface_nodes to be used in "mg" preconditioner
character(len=*), intent(out):: solver_option_path
type(petsc_csr_matrix), dimension(:), pointer:: prolongators
integer, dimension(:), pointer:: surface_nodes
!
type(state_type), intent(in):: state
type(mesh_type), intent(in):: mesh ! mesh we're solving on
integer, intent(in):: field_dim ! dimension of the field
! option_path of the provided field:
character(len=*), intent(in):: field_option_path
logical, intent(in):: matrix_has_solver_cache
! optional option_path that may be provided to override field option_path
character(len=*), intent(in), optional:: option_path
type(vector_field):: positions
type(scalar_field), pointer:: exact
type(mesh_type), pointer:: linear_mesh
character(len=FIELD_NAME_LEN):: exact_field_name
logical:: vertical_lumping, higher_order_lumping
integer:: stat, no_prolongators
if (present(option_path)) then
solver_option_path=complete_solver_option_path(option_path)
else
solver_option_path=complete_solver_option_path(field_option_path)
end if
call get_option(trim(solver_option_path)// &
'/diagnostics/monitors/true_error/exact_solution_field', &
exact_field_name, stat=stat)
if (stat==0) then
exact => extract_scalar_field(state, exact_field_name)
call petsc_solve_monitor_exact(exact)
end if
if (have_option(trim(solver_option_path)// &
'/diagnostics/monitors/iteration_vtus')) then
positions=get_nodal_coordinate_field(state, mesh)
! creates its own reference that's cleaned up in petsc_solve:
call petsc_solve_monitor_iteration_vtus(positions)
! so we're free to get rid of ours
call deallocate(positions)
end if
nullify(prolongators)
nullify(surface_nodes)
higher_order_lumping = have_option(trim(solver_option_path)//'/preconditioner::mg/higher_order_lumping')
vertical_lumping = have_option(trim(solver_option_path)//'/preconditioner::mg/vertical_lumping')
no_prolongators = count( (/ higher_order_lumping, vertical_lumping /) )
! if the solver context has been cached from last time, we don't
! need to recreate the prolongation operators for "mg"
if (no_prolongators>0 .and. .not. matrix_has_solver_cache) then
allocate( prolongators(1:no_prolongators) )
if (higher_order_lumping) then
call find_linear_parent_mesh(state, mesh, linear_mesh)
prolongators(1) = higher_order_prolongator(linear_mesh, mesh, field_dim)
end if
if (vertical_lumping) then
if (field_dim>1) then
FLExit("Cannot use vertical_lumping for vector fields")
end if
if (higher_order_lumping) then
prolongators(2) = vertical_prolongator_from_free_surface(state, linear_mesh)
else
prolongators(1) = vertical_prolongator_from_free_surface(state, mesh)
end if
if (have_option(trim(solver_option_path)//'/preconditioner::mg/vertical_lumping/internal_smoother')) then
surface_nodes => free_surface_nodes(state, mesh)
end if
end if
end if
end subroutine petsc_solve_state_setup
logical function petsc_solve_needs_state(option_path)
! function used in petsc_readnsolve to work out whether it needs
! to read state and call the above petsc_solve_state, or can just
! go for the simple petsc_solve instead
character(len=*), intent(in):: option_path
character(len=OPTION_PATH_LEN) solver_option_path
solver_option_path=complete_solver_option_path(option_path)
petsc_solve_needs_state=have_option( &
trim(solver_option_path)//'/preconditioner::mg/vertical_lumping') &
.or. have_option( &
trim(solver_option_path)//'/preconditioner::mg/higher_order_lumping') &
.or. have_option( &
trim(solver_option_path)//'/diagnostics/monitors/true_error') &
.or. have_option( &
trim(solver_option_path)//'/diagnostics/monitors/iteration_vtus')
end function petsc_solve_needs_state
function higher_order_prolongator(p1_mesh, pn_mesh, ncomponents) result (P)
! Creates the linear operator that extrapolates p1 fields to higher
! order pn meshes. This can be used as the first stage prolongator
! in the "mg" multigrid preconditioner
type(mesh_type), intent(in):: p1_mesh, pn_mesh
integer, intent(in):: ncomponents
type(petsc_csr_matrix):: P
logical, dimension(:), allocatable:: nodes_visited
integer, dimension(:), allocatable:: onnz, dnnz
integer, dimension(:), pointer:: p1_nodes, pn_nodes
integer:: rows, columns
integer:: i, j, k, node, ele
real:: val
rows=nowned_nodes(pn_mesh)
columns=node_count(p1_mesh)
allocate(dnnz(1:rows*ncomponents), onnz(1:rows*ncomponents))
dnnz=0
onnz=0
do ele=1, ele_count(pn_mesh)
pn_nodes => ele_nodes(pn_mesh, ele)
p1_nodes => ele_nodes(p1_mesh, ele)
do j=1, size(pn_nodes)
node=pn_nodes(j)
if (node_owned(pn_mesh, node)) then
do k=1, size(p1_nodes)
if (node_owned(p1_mesh, p1_nodes(k))) then
dnnz(node)=dnnz(node)+1
else
onnz(node)=onnz(node)+1
end if
end do
end if
end do
end do
! copy over to other components, if any
do i=2, ncomponents
dnnz( (i-1)*rows+1:i*rows )=dnnz(1:rows)
onnz( (i-1)*rows+1:i*rows )=onnz(1:rows)
end do
call allocate(P, rows, columns, dnnz, onnz, (/ ncomponents, ncomponents /), name="HigherOrderProlongator")
if (associated(p1_mesh%halos)) then
P%column_halo => p1_mesh%halos(1)
call incref(P%column_halo)
end if
call zero(P)
allocate(nodes_visited(1:node_count(pn_mesh)))
nodes_visited=.false.
do ele=1, ele_count(pn_mesh)
pn_nodes => ele_nodes(pn_mesh, ele)
p1_nodes => ele_nodes(p1_mesh, ele)
do j=1, size(pn_nodes)
node=pn_nodes(j)
if (node_owned(pn_mesh, node) .and. .not. nodes_visited(node)) then
do k=1, size(p1_nodes)
val=eval_shape(p1_mesh%shape, k, local_coords(j, pn_mesh%shape))
do i=1, ncomponents
call addto(P, i, i, node, p1_nodes(k), val)
end do
end do
nodes_visited(node)=.true.
end if
end do
end do
call assemble(P)
end function higher_order_prolongator
end module petsc_solve_state_module
|