xref: /petsc/src/ksp/pc/impls/bddc/bddc.c (revision b097fa669589ad349c7cabc524d342c8706d7cb7)
1 /* TODOLIST
2 
3    ConstraintsSetup
4    - tolerances for constraints as an option (take care of single precision!)
5 
6    Solvers
7    - Add support for cholesky for coarse solver (similar to local solvers)
8    - Propagate ksp prefixes for solvers to mat objects?
9    - Propagate nearnullspace info among levels
10 
11    User interface
12    - ** DofSplitting and DM attached to pc?
13 
14    Debugging output
15    - * Better management of verbosity levels of debugging output
16 
17    Build
18    - make runexe59
19 
20    Extra
21    - *** Is it possible to work with PCBDDCGraph on boundary indices only (less memory consumed)?
22    - Change of basis approach does not work with my nonlinear mechanics example. why? (seems not an issue with l2gmap)
23    - BDDC with MG framework?
24 
25    FETIDP
26    - Move FETIDP code to its own classes
27 
28    MATIS related operations contained in BDDC code
29    - Provide general case for subassembling
30    - *** Preallocation routines in MatISGetMPIAXAIJ
31 
32 */
33 
34 /* ----------------------------------------------------------------------------------------------------------------------------------------------
35    Implementation of BDDC preconditioner based on:
36    C. Dohrmann "An approximate BDDC preconditioner", Numerical Linear Algebra with Applications Volume 14, Issue 2, pages 149-168, March 2007
37    ---------------------------------------------------------------------------------------------------------------------------------------------- */
38 
39 #include <../src/ksp/pc/impls/bddc/bddc.h> /*I "petscpc.h" I*/  /* includes for fortran wrappers */
40 #include <../src/ksp/pc/impls/bddc/bddcprivate.h>
41 #include <petscblaslapack.h>
42 
43 /* -------------------------------------------------------------------------- */
44 #undef __FUNCT__
45 #define __FUNCT__ "PCSetFromOptions_BDDC"
46 PetscErrorCode PCSetFromOptions_BDDC(PetscOptions *PetscOptionsObject,PC pc)
47 {
48   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
49   PetscErrorCode ierr;
50 
51   PetscFunctionBegin;
52   ierr = PetscOptionsHead(PetscOptionsObject,"BDDC options");CHKERRQ(ierr);
53   /* Verbose debugging */
54   ierr = PetscOptionsInt("-pc_bddc_check_level","Verbose output for PCBDDC (intended for debug)","none",pcbddc->dbg_flag,&pcbddc->dbg_flag,NULL);CHKERRQ(ierr);
55   /* Primal space cumstomization */
56   ierr = PetscOptionsBool("-pc_bddc_use_local_mat_graph","Use or not adjacency graph of local mat for interface analysis","none",pcbddc->use_local_adj,&pcbddc->use_local_adj,NULL);CHKERRQ(ierr);
57   ierr = PetscOptionsBool("-pc_bddc_use_vertices","Use or not corner dofs in coarse space","none",pcbddc->use_vertices,&pcbddc->use_vertices,NULL);CHKERRQ(ierr);
58   ierr = PetscOptionsBool("-pc_bddc_use_edges","Use or not edge constraints in coarse space","none",pcbddc->use_edges,&pcbddc->use_edges,NULL);CHKERRQ(ierr);
59   ierr = PetscOptionsBool("-pc_bddc_use_faces","Use or not face constraints in coarse space","none",pcbddc->use_faces,&pcbddc->use_faces,NULL);CHKERRQ(ierr);
60   ierr = PetscOptionsBool("-pc_bddc_use_true_nnsp","Use near null space attached to the matrix without modifications","none",pcbddc->use_nnsp_true,&pcbddc->use_nnsp_true,NULL);CHKERRQ(ierr);
61   ierr = PetscOptionsBool("-pc_bddc_use_qr_single","Use QR factorization for single constraints on cc (QR is always used for multiple constraints on the same cc)","none",pcbddc->use_qr_single,&pcbddc->use_qr_single,NULL);CHKERRQ(ierr);
62   /* Change of basis */
63   ierr = PetscOptionsBool("-pc_bddc_use_change_of_basis","Use or not internal change of basis on local edge nodes","none",pcbddc->use_change_of_basis,&pcbddc->use_change_of_basis,NULL);CHKERRQ(ierr);
64   ierr = PetscOptionsBool("-pc_bddc_use_change_on_faces","Use or not internal change of basis on local face nodes","none",pcbddc->use_change_on_faces,&pcbddc->use_change_on_faces,NULL);CHKERRQ(ierr);
65   if (!pcbddc->use_change_of_basis) {
66     pcbddc->use_change_on_faces = PETSC_FALSE;
67   }
68   /* Switch between M_2 (default) and M_3 preconditioners (as defined by C. Dohrmann in the ref. article) */
69   ierr = PetscOptionsBool("-pc_bddc_switch_static","Switch on static condensation ops around the interface preconditioner","none",pcbddc->switch_static,&pcbddc->switch_static,NULL);CHKERRQ(ierr);
70   ierr = PetscOptionsInt("-pc_bddc_coarse_redistribute","Number of procs where to redistribute coarse problem","none",pcbddc->redistribute_coarse,&pcbddc->redistribute_coarse,NULL);CHKERRQ(ierr);
71   ierr = PetscOptionsInt("-pc_bddc_coarsening_ratio","Set coarsening ratio used in multilevel coarsening","none",pcbddc->coarsening_ratio,&pcbddc->coarsening_ratio,NULL);CHKERRQ(ierr);
72   ierr = PetscOptionsInt("-pc_bddc_levels","Set maximum number of levels for multilevel","none",pcbddc->max_levels,&pcbddc->max_levels,NULL);CHKERRQ(ierr);
73   ierr = PetscOptionsBool("-pc_bddc_use_coarse_estimates","Use estimated eigenvalues for coarse problem","none",pcbddc->use_coarse_estimates,&pcbddc->use_coarse_estimates,NULL);CHKERRQ(ierr);
74   ierr = PetscOptionsBool("-pc_bddc_use_deluxe_scaling","Use deluxe scaling for BDDC","none",pcbddc->use_deluxe_scaling,&pcbddc->use_deluxe_scaling,NULL);CHKERRQ(ierr);
75   ierr = PetscOptionsInt("-pc_bddc_schur_threshold","Schur principal minors smaller than this value are explicilty computed (-1 computes all)","none",pcbddc->sub_schurs_threshold,&pcbddc->sub_schurs_threshold,NULL);CHKERRQ(ierr);
76   ierr = PetscOptionsBool("-pc_bddc_schur_rebuild","Whether or not the interface graph for Schur principal minors has to be rebuilt (i.e. define the interface without any adjacency)","none",pcbddc->sub_schurs_rebuild,&pcbddc->sub_schurs_rebuild,NULL);CHKERRQ(ierr);
77   ierr = PetscOptionsInt("-pc_bddc_schur_layers","Number of dofs' layers for the computation of principal minors (i.e. -1 uses all dofs)","none",pcbddc->sub_schurs_layers,&pcbddc->sub_schurs_layers,NULL);CHKERRQ(ierr);
78   ierr = PetscOptionsBool("-pc_bddc_schur_use_useradj","Whether or not the CSR graph specified by the user should be used for computing successive layers (default is to use adj of local mat)","none",pcbddc->sub_schurs_use_useradj,&pcbddc->sub_schurs_use_useradj,NULL);CHKERRQ(ierr);
79   ierr = PetscOptionsReal("-pc_bddc_adaptive_threshold","Threshold to be used for adaptive selection of constraints","none",pcbddc->adaptive_threshold,&pcbddc->adaptive_threshold,NULL);CHKERRQ(ierr);
80   ierr = PetscOptionsInt("-pc_bddc_adaptive_nmin","Minimum number of constraints per connected components","none",pcbddc->adaptive_nmin,&pcbddc->adaptive_nmin,NULL);CHKERRQ(ierr);
81   ierr = PetscOptionsInt("-pc_bddc_adaptive_nmax","Maximum number of constraints per connected components","none",pcbddc->adaptive_nmax,&pcbddc->adaptive_nmax,NULL);CHKERRQ(ierr);
82   ierr = PetscOptionsBool("-pc_bddc_adaptive_invert_stildas","Whether or not to invert the Stildas matrices","none",pcbddc->adaptive_invert_Stildas,&pcbddc->adaptive_invert_Stildas,NULL);CHKERRQ(ierr);
83   ierr = PetscOptionsTail();CHKERRQ(ierr);
84   PetscFunctionReturn(0);
85 }
86 /* -------------------------------------------------------------------------- */
87 #undef __FUNCT__
88 #define __FUNCT__ "PCBDDCSetChangeOfBasisMat_BDDC"
89 static PetscErrorCode PCBDDCSetChangeOfBasisMat_BDDC(PC pc, Mat change)
90 {
91   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
92   PetscErrorCode ierr;
93 
94   PetscFunctionBegin;
95   ierr = MatDestroy(&pcbddc->user_ChangeOfBasisMatrix);CHKERRQ(ierr);
96   ierr = PetscObjectReference((PetscObject)change);CHKERRQ(ierr);
97   pcbddc->user_ChangeOfBasisMatrix = change;
98   PetscFunctionReturn(0);
99 }
100 #undef __FUNCT__
101 #define __FUNCT__ "PCBDDCSetChangeOfBasisMat"
102 /*@
103  PCBDDCSetChangeOfBasisMat - Set user defined change of basis for dofs
104 
105    Collective on PC
106 
107    Input Parameters:
108 +  pc - the preconditioning context
109 -  change - the change of basis matrix
110 
111    Level: intermediate
112 
113    Notes:
114 
115 .seealso: PCBDDC
116 @*/
117 PetscErrorCode PCBDDCSetChangeOfBasisMat(PC pc, Mat change)
118 {
119   PetscErrorCode ierr;
120 
121   PetscFunctionBegin;
122   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
123   PetscValidHeaderSpecific(change,MAT_CLASSID,2);
124   PetscCheckSameComm(pc,1,change,2);
125   if (pc->mat) {
126     PetscInt rows_c,cols_c,rows,cols;
127     ierr = MatGetSize(pc->mat,&rows,&cols);CHKERRQ(ierr);
128     ierr = MatGetSize(change,&rows_c,&cols_c);CHKERRQ(ierr);
129     if (rows_c != rows) {
130       SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Invalid number of rows for change of basis matrix! %d != %d",rows_c,rows);
131     }
132     if (cols_c != cols) {
133       SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Invalid number of columns for change of basis matrix! %d != %d",cols_c,cols);
134     }
135     ierr = MatGetLocalSize(pc->mat,&rows,&cols);CHKERRQ(ierr);
136     ierr = MatGetLocalSize(change,&rows_c,&cols_c);CHKERRQ(ierr);
137     if (rows_c != rows) {
138       SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Invalid number of local rows for change of basis matrix! %d != %d",rows_c,rows);
139     }
140     if (cols_c != cols) {
141       SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Invalid number of local columns for change of basis matrix! %d != %d",cols_c,cols);
142     }
143   }
144   ierr = PetscTryMethod(pc,"PCBDDCSetChangeOfBasisMat_C",(PC,Mat),(pc,change));CHKERRQ(ierr);
145   PetscFunctionReturn(0);
146 }
147 /* -------------------------------------------------------------------------- */
148 #undef __FUNCT__
149 #define __FUNCT__ "PCBDDCSetPrimalVerticesLocalIS_BDDC"
150 static PetscErrorCode PCBDDCSetPrimalVerticesLocalIS_BDDC(PC pc, IS PrimalVertices)
151 {
152   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
153   PetscErrorCode ierr;
154 
155   PetscFunctionBegin;
156   ierr = ISDestroy(&pcbddc->user_primal_vertices);CHKERRQ(ierr);
157   ierr = PetscObjectReference((PetscObject)PrimalVertices);CHKERRQ(ierr);
158   pcbddc->user_primal_vertices = PrimalVertices;
159   PetscFunctionReturn(0);
160 }
161 #undef __FUNCT__
162 #define __FUNCT__ "PCBDDCSetPrimalVerticesLocalIS"
163 /*@
164  PCBDDCSetPrimalVerticesLocalIS - Set additional user defined primal vertices in PCBDDC
165 
166    Not collective
167 
168    Input Parameters:
169 +  pc - the preconditioning context
170 -  PrimalVertices - index set of primal vertices in local numbering
171 
172    Level: intermediate
173 
174    Notes:
175 
176 .seealso: PCBDDC
177 @*/
178 PetscErrorCode PCBDDCSetPrimalVerticesLocalIS(PC pc, IS PrimalVertices)
179 {
180   PetscErrorCode ierr;
181 
182   PetscFunctionBegin;
183   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
184   PetscValidHeaderSpecific(PrimalVertices,IS_CLASSID,2);
185   ierr = PetscTryMethod(pc,"PCBDDCSetPrimalVerticesLocalIS_C",(PC,IS),(pc,PrimalVertices));CHKERRQ(ierr);
186   PetscFunctionReturn(0);
187 }
188 /* -------------------------------------------------------------------------- */
189 #undef __FUNCT__
190 #define __FUNCT__ "PCBDDCSetCoarseningRatio_BDDC"
191 static PetscErrorCode PCBDDCSetCoarseningRatio_BDDC(PC pc,PetscInt k)
192 {
193   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
194 
195   PetscFunctionBegin;
196   pcbddc->coarsening_ratio = k;
197   PetscFunctionReturn(0);
198 }
199 
200 #undef __FUNCT__
201 #define __FUNCT__ "PCBDDCSetCoarseningRatio"
202 /*@
203  PCBDDCSetCoarseningRatio - Set coarsening ratio used in multilevel
204 
205    Logically collective on PC
206 
207    Input Parameters:
208 +  pc - the preconditioning context
209 -  k - coarsening ratio (H/h at the coarser level)
210 
211    Approximatively k subdomains at the finer level will be aggregated into a single subdomain at the coarser level
212 
213    Level: intermediate
214 
215    Notes:
216 
217 .seealso: PCBDDC
218 @*/
219 PetscErrorCode PCBDDCSetCoarseningRatio(PC pc,PetscInt k)
220 {
221   PetscErrorCode ierr;
222 
223   PetscFunctionBegin;
224   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
225   PetscValidLogicalCollectiveInt(pc,k,2);
226   ierr = PetscTryMethod(pc,"PCBDDCSetCoarseningRatio_C",(PC,PetscInt),(pc,k));CHKERRQ(ierr);
227   PetscFunctionReturn(0);
228 }
229 
230 /* The following functions (PCBDDCSetUseExactDirichlet PCBDDCSetLevel) are not public */
231 #undef __FUNCT__
232 #define __FUNCT__ "PCBDDCSetUseExactDirichlet_BDDC"
233 static PetscErrorCode PCBDDCSetUseExactDirichlet_BDDC(PC pc,PetscBool flg)
234 {
235   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
236 
237   PetscFunctionBegin;
238   pcbddc->use_exact_dirichlet_trick = flg;
239   PetscFunctionReturn(0);
240 }
241 
242 #undef __FUNCT__
243 #define __FUNCT__ "PCBDDCSetUseExactDirichlet"
244 PetscErrorCode PCBDDCSetUseExactDirichlet(PC pc,PetscBool flg)
245 {
246   PetscErrorCode ierr;
247 
248   PetscFunctionBegin;
249   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
250   PetscValidLogicalCollectiveBool(pc,flg,2);
251   ierr = PetscTryMethod(pc,"PCBDDCSetUseExactDirichlet_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
252   PetscFunctionReturn(0);
253 }
254 
255 #undef __FUNCT__
256 #define __FUNCT__ "PCBDDCSetLevel_BDDC"
257 static PetscErrorCode PCBDDCSetLevel_BDDC(PC pc,PetscInt level)
258 {
259   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
260 
261   PetscFunctionBegin;
262   pcbddc->current_level = level;
263   PetscFunctionReturn(0);
264 }
265 
266 #undef __FUNCT__
267 #define __FUNCT__ "PCBDDCSetLevel"
268 PetscErrorCode PCBDDCSetLevel(PC pc,PetscInt level)
269 {
270   PetscErrorCode ierr;
271 
272   PetscFunctionBegin;
273   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
274   PetscValidLogicalCollectiveInt(pc,level,2);
275   ierr = PetscTryMethod(pc,"PCBDDCSetLevel_C",(PC,PetscInt),(pc,level));CHKERRQ(ierr);
276   PetscFunctionReturn(0);
277 }
278 
279 #undef __FUNCT__
280 #define __FUNCT__ "PCBDDCSetLevels_BDDC"
281 static PetscErrorCode PCBDDCSetLevels_BDDC(PC pc,PetscInt levels)
282 {
283   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
284 
285   PetscFunctionBegin;
286   pcbddc->max_levels = levels;
287   PetscFunctionReturn(0);
288 }
289 
290 #undef __FUNCT__
291 #define __FUNCT__ "PCBDDCSetLevels"
292 /*@
293  PCBDDCSetLevels - Sets the maximum number of levels for multilevel
294 
295    Logically collective on PC
296 
297    Input Parameters:
298 +  pc - the preconditioning context
299 -  levels - the maximum number of levels (max 9)
300 
301    Default value is 0, i.e. traditional one-level BDDC
302 
303    Level: intermediate
304 
305    Notes:
306 
307 .seealso: PCBDDC
308 @*/
309 PetscErrorCode PCBDDCSetLevels(PC pc,PetscInt levels)
310 {
311   PetscErrorCode ierr;
312 
313   PetscFunctionBegin;
314   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
315   PetscValidLogicalCollectiveInt(pc,levels,2);
316   if (levels > 99) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Maximum number of levels for bddc is 99\n");
317   ierr = PetscTryMethod(pc,"PCBDDCSetLevels_C",(PC,PetscInt),(pc,levels));CHKERRQ(ierr);
318   PetscFunctionReturn(0);
319 }
320 /* -------------------------------------------------------------------------- */
321 
322 #undef __FUNCT__
323 #define __FUNCT__ "PCBDDCSetNullSpace_BDDC"
324 static PetscErrorCode PCBDDCSetNullSpace_BDDC(PC pc,MatNullSpace NullSpace)
325 {
326   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
327   PetscErrorCode ierr;
328 
329   PetscFunctionBegin;
330   ierr = PetscObjectReference((PetscObject)NullSpace);CHKERRQ(ierr);
331   ierr = MatNullSpaceDestroy(&pcbddc->NullSpace);CHKERRQ(ierr);
332   pcbddc->NullSpace = NullSpace;
333   PetscFunctionReturn(0);
334 }
335 
336 #undef __FUNCT__
337 #define __FUNCT__ "PCBDDCSetNullSpace"
338 /*@
339  PCBDDCSetNullSpace - Set nullspace for BDDC operator
340 
341    Logically collective on PC and MatNullSpace
342 
343    Input Parameters:
344 +  pc - the preconditioning context
345 -  NullSpace - Null space of the linear operator to be preconditioned (Pmat)
346 
347    Level: intermediate
348 
349    Notes:
350 
351 .seealso: PCBDDC
352 @*/
353 PetscErrorCode PCBDDCSetNullSpace(PC pc,MatNullSpace NullSpace)
354 {
355   PetscErrorCode ierr;
356 
357   PetscFunctionBegin;
358   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
359   PetscValidHeaderSpecific(NullSpace,MAT_NULLSPACE_CLASSID,2);
360   PetscCheckSameComm(pc,1,NullSpace,2);
361   ierr = PetscTryMethod(pc,"PCBDDCSetNullSpace_C",(PC,MatNullSpace),(pc,NullSpace));CHKERRQ(ierr);
362   PetscFunctionReturn(0);
363 }
364 /* -------------------------------------------------------------------------- */
365 
366 #undef __FUNCT__
367 #define __FUNCT__ "PCBDDCSetDirichletBoundaries_BDDC"
368 static PetscErrorCode PCBDDCSetDirichletBoundaries_BDDC(PC pc,IS DirichletBoundaries)
369 {
370   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
371   PetscErrorCode ierr;
372 
373   PetscFunctionBegin;
374   /* last user setting takes precendence -> destroy any other customization */
375   ierr = ISDestroy(&pcbddc->DirichletBoundariesLocal);CHKERRQ(ierr);
376   ierr = ISDestroy(&pcbddc->DirichletBoundaries);CHKERRQ(ierr);
377   ierr = PetscObjectReference((PetscObject)DirichletBoundaries);CHKERRQ(ierr);
378   pcbddc->DirichletBoundaries = DirichletBoundaries;
379   pcbddc->recompute_topography = PETSC_TRUE;
380   PetscFunctionReturn(0);
381 }
382 
383 #undef __FUNCT__
384 #define __FUNCT__ "PCBDDCSetDirichletBoundaries"
385 /*@
386  PCBDDCSetDirichletBoundaries - Set IS defining Dirichlet boundaries for the global problem.
387 
388    Collective
389 
390    Input Parameters:
391 +  pc - the preconditioning context
392 -  DirichletBoundaries - parallel IS defining the Dirichlet boundaries
393 
394    Level: intermediate
395 
396    Notes: Any process can list any global node
397 
398 .seealso: PCBDDC
399 @*/
400 PetscErrorCode PCBDDCSetDirichletBoundaries(PC pc,IS DirichletBoundaries)
401 {
402   PetscErrorCode ierr;
403 
404   PetscFunctionBegin;
405   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
406   PetscValidHeaderSpecific(DirichletBoundaries,IS_CLASSID,2);
407   PetscCheckSameComm(pc,1,DirichletBoundaries,2);
408   ierr = PetscTryMethod(pc,"PCBDDCSetDirichletBoundaries_C",(PC,IS),(pc,DirichletBoundaries));CHKERRQ(ierr);
409   PetscFunctionReturn(0);
410 }
411 /* -------------------------------------------------------------------------- */
412 
413 #undef __FUNCT__
414 #define __FUNCT__ "PCBDDCSetDirichletBoundariesLocal_BDDC"
415 static PetscErrorCode PCBDDCSetDirichletBoundariesLocal_BDDC(PC pc,IS DirichletBoundaries)
416 {
417   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
418   PetscErrorCode ierr;
419 
420   PetscFunctionBegin;
421   /* last user setting takes precendence -> destroy any other customization */
422   ierr = ISDestroy(&pcbddc->DirichletBoundariesLocal);CHKERRQ(ierr);
423   ierr = ISDestroy(&pcbddc->DirichletBoundaries);CHKERRQ(ierr);
424   ierr = PetscObjectReference((PetscObject)DirichletBoundaries);CHKERRQ(ierr);
425   pcbddc->DirichletBoundariesLocal = DirichletBoundaries;
426   pcbddc->recompute_topography = PETSC_TRUE;
427   PetscFunctionReturn(0);
428 }
429 
430 #undef __FUNCT__
431 #define __FUNCT__ "PCBDDCSetDirichletBoundariesLocal"
432 /*@
433  PCBDDCSetDirichletBoundariesLocal - Set IS defining Dirichlet boundaries for the global problem in local ordering.
434 
435    Collective
436 
437    Input Parameters:
438 +  pc - the preconditioning context
439 -  DirichletBoundaries - parallel IS defining the Dirichlet boundaries (in local ordering)
440 
441    Level: intermediate
442 
443    Notes:
444 
445 .seealso: PCBDDC
446 @*/
447 PetscErrorCode PCBDDCSetDirichletBoundariesLocal(PC pc,IS DirichletBoundaries)
448 {
449   PetscErrorCode ierr;
450 
451   PetscFunctionBegin;
452   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
453   PetscValidHeaderSpecific(DirichletBoundaries,IS_CLASSID,2);
454   PetscCheckSameComm(pc,1,DirichletBoundaries,2);
455   ierr = PetscTryMethod(pc,"PCBDDCSetDirichletBoundariesLocal_C",(PC,IS),(pc,DirichletBoundaries));CHKERRQ(ierr);
456   PetscFunctionReturn(0);
457 }
458 /* -------------------------------------------------------------------------- */
459 
460 #undef __FUNCT__
461 #define __FUNCT__ "PCBDDCSetNeumannBoundaries_BDDC"
462 static PetscErrorCode PCBDDCSetNeumannBoundaries_BDDC(PC pc,IS NeumannBoundaries)
463 {
464   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
465   PetscErrorCode ierr;
466 
467   PetscFunctionBegin;
468   /* last user setting takes precendence -> destroy any other customization */
469   ierr = ISDestroy(&pcbddc->NeumannBoundariesLocal);CHKERRQ(ierr);
470   ierr = ISDestroy(&pcbddc->NeumannBoundaries);CHKERRQ(ierr);
471   ierr = PetscObjectReference((PetscObject)NeumannBoundaries);CHKERRQ(ierr);
472   pcbddc->NeumannBoundaries = NeumannBoundaries;
473   pcbddc->recompute_topography = PETSC_TRUE;
474   PetscFunctionReturn(0);
475 }
476 
477 #undef __FUNCT__
478 #define __FUNCT__ "PCBDDCSetNeumannBoundaries"
479 /*@
480  PCBDDCSetNeumannBoundaries - Set IS defining Neumann boundaries for the global problem.
481 
482    Collective
483 
484    Input Parameters:
485 +  pc - the preconditioning context
486 -  NeumannBoundaries - parallel IS defining the Neumann boundaries
487 
488    Level: intermediate
489 
490    Notes: Any process can list any global node
491 
492 .seealso: PCBDDC
493 @*/
494 PetscErrorCode PCBDDCSetNeumannBoundaries(PC pc,IS NeumannBoundaries)
495 {
496   PetscErrorCode ierr;
497 
498   PetscFunctionBegin;
499   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
500   PetscValidHeaderSpecific(NeumannBoundaries,IS_CLASSID,2);
501   PetscCheckSameComm(pc,1,NeumannBoundaries,2);
502   ierr = PetscTryMethod(pc,"PCBDDCSetNeumannBoundaries_C",(PC,IS),(pc,NeumannBoundaries));CHKERRQ(ierr);
503   PetscFunctionReturn(0);
504 }
505 /* -------------------------------------------------------------------------- */
506 
507 #undef __FUNCT__
508 #define __FUNCT__ "PCBDDCSetNeumannBoundariesLocal_BDDC"
509 static PetscErrorCode PCBDDCSetNeumannBoundariesLocal_BDDC(PC pc,IS NeumannBoundaries)
510 {
511   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
512   PetscErrorCode ierr;
513 
514   PetscFunctionBegin;
515   /* last user setting takes precendence -> destroy any other customization */
516   ierr = ISDestroy(&pcbddc->NeumannBoundariesLocal);CHKERRQ(ierr);
517   ierr = ISDestroy(&pcbddc->NeumannBoundaries);CHKERRQ(ierr);
518   ierr = PetscObjectReference((PetscObject)NeumannBoundaries);CHKERRQ(ierr);
519   pcbddc->NeumannBoundariesLocal = NeumannBoundaries;
520   pcbddc->recompute_topography = PETSC_TRUE;
521   PetscFunctionReturn(0);
522 }
523 
524 #undef __FUNCT__
525 #define __FUNCT__ "PCBDDCSetNeumannBoundariesLocal"
526 /*@
527  PCBDDCSetNeumannBoundariesLocal - Set IS defining Neumann boundaries for the global problem in local ordering.
528 
529    Collective
530 
531    Input Parameters:
532 +  pc - the preconditioning context
533 -  NeumannBoundaries - parallel IS defining the subdomain part of Neumann boundaries (in local ordering)
534 
535    Level: intermediate
536 
537    Notes:
538 
539 .seealso: PCBDDC
540 @*/
541 PetscErrorCode PCBDDCSetNeumannBoundariesLocal(PC pc,IS NeumannBoundaries)
542 {
543   PetscErrorCode ierr;
544 
545   PetscFunctionBegin;
546   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
547   PetscValidHeaderSpecific(NeumannBoundaries,IS_CLASSID,2);
548   PetscCheckSameComm(pc,1,NeumannBoundaries,2);
549   ierr = PetscTryMethod(pc,"PCBDDCSetNeumannBoundariesLocal_C",(PC,IS),(pc,NeumannBoundaries));CHKERRQ(ierr);
550   PetscFunctionReturn(0);
551 }
552 /* -------------------------------------------------------------------------- */
553 
554 #undef __FUNCT__
555 #define __FUNCT__ "PCBDDCGetDirichletBoundaries_BDDC"
556 static PetscErrorCode PCBDDCGetDirichletBoundaries_BDDC(PC pc,IS *DirichletBoundaries)
557 {
558   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
559 
560   PetscFunctionBegin;
561   *DirichletBoundaries = pcbddc->DirichletBoundaries;
562   PetscFunctionReturn(0);
563 }
564 
565 #undef __FUNCT__
566 #define __FUNCT__ "PCBDDCGetDirichletBoundaries"
567 /*@
568  PCBDDCGetDirichletBoundaries - Get parallel IS for Dirichlet boundaries
569 
570    Collective
571 
572    Input Parameters:
573 .  pc - the preconditioning context
574 
575    Output Parameters:
576 .  DirichletBoundaries - index set defining the Dirichlet boundaries
577 
578    Level: intermediate
579 
580    Notes: The IS returned (if any) is the same passed in earlier by the user with PCBDDCSetDirichletBoundaries
581 
582 .seealso: PCBDDC
583 @*/
584 PetscErrorCode PCBDDCGetDirichletBoundaries(PC pc,IS *DirichletBoundaries)
585 {
586   PetscErrorCode ierr;
587 
588   PetscFunctionBegin;
589   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
590   ierr = PetscUseMethod(pc,"PCBDDCGetDirichletBoundaries_C",(PC,IS*),(pc,DirichletBoundaries));CHKERRQ(ierr);
591   PetscFunctionReturn(0);
592 }
593 /* -------------------------------------------------------------------------- */
594 
595 #undef __FUNCT__
596 #define __FUNCT__ "PCBDDCGetDirichletBoundariesLocal_BDDC"
597 static PetscErrorCode PCBDDCGetDirichletBoundariesLocal_BDDC(PC pc,IS *DirichletBoundaries)
598 {
599   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
600 
601   PetscFunctionBegin;
602   *DirichletBoundaries = pcbddc->DirichletBoundariesLocal;
603   PetscFunctionReturn(0);
604 }
605 
606 #undef __FUNCT__
607 #define __FUNCT__ "PCBDDCGetDirichletBoundariesLocal"
608 /*@
609  PCBDDCGetDirichletBoundariesLocal - Get parallel IS for Dirichlet boundaries (in local ordering)
610 
611    Collective
612 
613    Input Parameters:
614 .  pc - the preconditioning context
615 
616    Output Parameters:
617 .  DirichletBoundaries - index set defining the subdomain part of Dirichlet boundaries
618 
619    Level: intermediate
620 
621    Notes:
622 
623 .seealso: PCBDDC
624 @*/
625 PetscErrorCode PCBDDCGetDirichletBoundariesLocal(PC pc,IS *DirichletBoundaries)
626 {
627   PetscErrorCode ierr;
628 
629   PetscFunctionBegin;
630   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
631   ierr = PetscUseMethod(pc,"PCBDDCGetDirichletBoundariesLocal_C",(PC,IS*),(pc,DirichletBoundaries));CHKERRQ(ierr);
632   PetscFunctionReturn(0);
633 }
634 /* -------------------------------------------------------------------------- */
635 
636 #undef __FUNCT__
637 #define __FUNCT__ "PCBDDCGetNeumannBoundaries_BDDC"
638 static PetscErrorCode PCBDDCGetNeumannBoundaries_BDDC(PC pc,IS *NeumannBoundaries)
639 {
640   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
641 
642   PetscFunctionBegin;
643   *NeumannBoundaries = pcbddc->NeumannBoundaries;
644   PetscFunctionReturn(0);
645 }
646 
647 #undef __FUNCT__
648 #define __FUNCT__ "PCBDDCGetNeumannBoundaries"
649 /*@
650  PCBDDCGetNeumannBoundaries - Get parallel IS for Neumann boundaries
651 
652    Collective
653 
654    Input Parameters:
655 .  pc - the preconditioning context
656 
657    Output Parameters:
658 .  NeumannBoundaries - index set defining the Neumann boundaries
659 
660    Level: intermediate
661 
662    Notes: The IS returned (if any) is the same passed in earlier by the user with PCBDDCSetNeumannBoundaries
663 
664 .seealso: PCBDDC
665 @*/
666 PetscErrorCode PCBDDCGetNeumannBoundaries(PC pc,IS *NeumannBoundaries)
667 {
668   PetscErrorCode ierr;
669 
670   PetscFunctionBegin;
671   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
672   ierr = PetscUseMethod(pc,"PCBDDCGetNeumannBoundaries_C",(PC,IS*),(pc,NeumannBoundaries));CHKERRQ(ierr);
673   PetscFunctionReturn(0);
674 }
675 /* -------------------------------------------------------------------------- */
676 
677 #undef __FUNCT__
678 #define __FUNCT__ "PCBDDCGetNeumannBoundariesLocal_BDDC"
679 static PetscErrorCode PCBDDCGetNeumannBoundariesLocal_BDDC(PC pc,IS *NeumannBoundaries)
680 {
681   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
682 
683   PetscFunctionBegin;
684   *NeumannBoundaries = pcbddc->NeumannBoundariesLocal;
685   PetscFunctionReturn(0);
686 }
687 
688 #undef __FUNCT__
689 #define __FUNCT__ "PCBDDCGetNeumannBoundariesLocal"
690 /*@
691  PCBDDCGetNeumannBoundariesLocal - Get parallel IS for Neumann boundaries (in local ordering)
692 
693    Collective
694 
695    Input Parameters:
696 .  pc - the preconditioning context
697 
698    Output Parameters:
699 .  NeumannBoundaries - index set defining the subdomain part of Neumann boundaries
700 
701    Level: intermediate
702 
703    Notes:
704 
705 .seealso: PCBDDC
706 @*/
707 PetscErrorCode PCBDDCGetNeumannBoundariesLocal(PC pc,IS *NeumannBoundaries)
708 {
709   PetscErrorCode ierr;
710 
711   PetscFunctionBegin;
712   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
713   ierr = PetscUseMethod(pc,"PCBDDCGetNeumannBoundariesLocal_C",(PC,IS*),(pc,NeumannBoundaries));CHKERRQ(ierr);
714   PetscFunctionReturn(0);
715 }
716 /* -------------------------------------------------------------------------- */
717 
718 #undef __FUNCT__
719 #define __FUNCT__ "PCBDDCSetLocalAdjacencyGraph_BDDC"
720 static PetscErrorCode PCBDDCSetLocalAdjacencyGraph_BDDC(PC pc, PetscInt nvtxs,const PetscInt xadj[],const PetscInt adjncy[], PetscCopyMode copymode)
721 {
722   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
723   PCBDDCGraph    mat_graph = pcbddc->mat_graph;
724   PetscErrorCode ierr;
725 
726   PetscFunctionBegin;
727   /* free old CSR */
728   ierr = PCBDDCGraphResetCSR(mat_graph);CHKERRQ(ierr);
729   /* TODO: PCBDDCGraphSetAdjacency */
730   /* get CSR into graph structure */
731   if (copymode == PETSC_COPY_VALUES) {
732     ierr = PetscMalloc1(nvtxs+1,&mat_graph->xadj);CHKERRQ(ierr);
733     ierr = PetscMalloc1(xadj[nvtxs],&mat_graph->adjncy);CHKERRQ(ierr);
734     ierr = PetscMemcpy(mat_graph->xadj,xadj,(nvtxs+1)*sizeof(PetscInt));CHKERRQ(ierr);
735     ierr = PetscMemcpy(mat_graph->adjncy,adjncy,xadj[nvtxs]*sizeof(PetscInt));CHKERRQ(ierr);
736   } else if (copymode == PETSC_OWN_POINTER) {
737     mat_graph->xadj = (PetscInt*)xadj;
738     mat_graph->adjncy = (PetscInt*)adjncy;
739   }
740   mat_graph->nvtxs_csr = nvtxs;
741   PetscFunctionReturn(0);
742 }
743 
744 #undef __FUNCT__
745 #define __FUNCT__ "PCBDDCSetLocalAdjacencyGraph"
746 /*@
747  PCBDDCSetLocalAdjacencyGraph - Set adjacency structure (CSR graph) of the local Neumann matrix
748 
749    Not collective
750 
751    Input Parameters:
752 +  pc - the preconditioning context
753 .  nvtxs - number of local vertices of the graph (i.e., the local size of your problem)
754 .  xadj, adjncy - the CSR graph
755 -  copymode - either PETSC_COPY_VALUES or PETSC_OWN_POINTER.
756 
757    Level: intermediate
758 
759    Notes:
760 
761 .seealso: PCBDDC,PetscCopyMode
762 @*/
763 PetscErrorCode PCBDDCSetLocalAdjacencyGraph(PC pc,PetscInt nvtxs,const PetscInt xadj[],const PetscInt adjncy[], PetscCopyMode copymode)
764 {
765   void (*f)(void) = 0;
766   PetscErrorCode ierr;
767 
768   PetscFunctionBegin;
769   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
770   PetscValidIntPointer(xadj,3);
771   PetscValidIntPointer(adjncy,4);
772   if (copymode != PETSC_COPY_VALUES && copymode != PETSC_OWN_POINTER) {
773     SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported copy mode %d in %s\n",copymode,__FUNCT__);
774   }
775   ierr = PetscTryMethod(pc,"PCBDDCSetLocalAdjacencyGraph_C",(PC,PetscInt,const PetscInt[],const PetscInt[],PetscCopyMode),(pc,nvtxs,xadj,adjncy,copymode));CHKERRQ(ierr);
776   /* free arrays if PCBDDC is not the PC type */
777   ierr = PetscObjectQueryFunction((PetscObject)pc,"PCBDDCSetLocalAdjacencyGraph_C",&f);CHKERRQ(ierr);
778   if (!f && copymode == PETSC_OWN_POINTER) {
779     ierr = PetscFree(xadj);CHKERRQ(ierr);
780     ierr = PetscFree(adjncy);CHKERRQ(ierr);
781   }
782   PetscFunctionReturn(0);
783 }
784 /* -------------------------------------------------------------------------- */
785 
786 #undef __FUNCT__
787 #define __FUNCT__ "PCBDDCSetDofsSplittingLocal_BDDC"
788 static PetscErrorCode PCBDDCSetDofsSplittingLocal_BDDC(PC pc,PetscInt n_is, IS ISForDofs[])
789 {
790   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
791   PetscInt i;
792   PetscErrorCode ierr;
793 
794   PetscFunctionBegin;
795   /* Destroy ISes if they were already set */
796   for (i=0;i<pcbddc->n_ISForDofsLocal;i++) {
797     ierr = ISDestroy(&pcbddc->ISForDofsLocal[i]);CHKERRQ(ierr);
798   }
799   ierr = PetscFree(pcbddc->ISForDofsLocal);CHKERRQ(ierr);
800   /* last user setting takes precendence -> destroy any other customization */
801   for (i=0;i<pcbddc->n_ISForDofs;i++) {
802     ierr = ISDestroy(&pcbddc->ISForDofs[i]);CHKERRQ(ierr);
803   }
804   ierr = PetscFree(pcbddc->ISForDofs);CHKERRQ(ierr);
805   pcbddc->n_ISForDofs = 0;
806   /* allocate space then set */
807   if (n_is) {
808     ierr = PetscMalloc1(n_is,&pcbddc->ISForDofsLocal);CHKERRQ(ierr);
809   }
810   for (i=0;i<n_is;i++) {
811     ierr = PetscObjectReference((PetscObject)ISForDofs[i]);CHKERRQ(ierr);
812     pcbddc->ISForDofsLocal[i]=ISForDofs[i];
813   }
814   pcbddc->n_ISForDofsLocal=n_is;
815   if (n_is) pcbddc->user_provided_isfordofs = PETSC_TRUE;
816   pcbddc->recompute_topography = PETSC_TRUE;
817   PetscFunctionReturn(0);
818 }
819 
820 #undef __FUNCT__
821 #define __FUNCT__ "PCBDDCSetDofsSplittingLocal"
822 /*@
823  PCBDDCSetDofsSplittingLocal - Set index sets defining fields of the local subdomain matrix
824 
825    Collective
826 
827    Input Parameters:
828 +  pc - the preconditioning context
829 -  n_is - number of index sets defining the fields
830 .  ISForDofs - array of IS describing the fields in local ordering
831 
832    Level: intermediate
833 
834    Notes: n_is should be the same among processes. Not all nodes need to be listed: unlisted nodes will belong to a different field.
835 
836 .seealso: PCBDDC
837 @*/
838 PetscErrorCode PCBDDCSetDofsSplittingLocal(PC pc,PetscInt n_is, IS ISForDofs[])
839 {
840   PetscInt       i;
841   PetscErrorCode ierr;
842 
843   PetscFunctionBegin;
844   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
845   PetscValidLogicalCollectiveInt(pc,n_is,2);
846   for (i=0;i<n_is;i++) {
847     PetscCheckSameComm(pc,1,ISForDofs[i],3);
848     PetscValidHeaderSpecific(ISForDofs[i],IS_CLASSID,3);
849   }
850   ierr = PetscTryMethod(pc,"PCBDDCSetDofsSplittingLocal_C",(PC,PetscInt,IS[]),(pc,n_is,ISForDofs));CHKERRQ(ierr);
851   PetscFunctionReturn(0);
852 }
853 /* -------------------------------------------------------------------------- */
854 
855 #undef __FUNCT__
856 #define __FUNCT__ "PCBDDCSetDofsSplitting_BDDC"
857 static PetscErrorCode PCBDDCSetDofsSplitting_BDDC(PC pc,PetscInt n_is, IS ISForDofs[])
858 {
859   PC_BDDC  *pcbddc = (PC_BDDC*)pc->data;
860   PetscInt i;
861   PetscErrorCode ierr;
862 
863   PetscFunctionBegin;
864   /* Destroy ISes if they were already set */
865   for (i=0;i<pcbddc->n_ISForDofs;i++) {
866     ierr = ISDestroy(&pcbddc->ISForDofs[i]);CHKERRQ(ierr);
867   }
868   ierr = PetscFree(pcbddc->ISForDofs);CHKERRQ(ierr);
869   /* last user setting takes precendence -> destroy any other customization */
870   for (i=0;i<pcbddc->n_ISForDofsLocal;i++) {
871     ierr = ISDestroy(&pcbddc->ISForDofsLocal[i]);CHKERRQ(ierr);
872   }
873   ierr = PetscFree(pcbddc->ISForDofsLocal);CHKERRQ(ierr);
874   pcbddc->n_ISForDofsLocal = 0;
875   /* allocate space then set */
876   if (n_is) {
877     ierr = PetscMalloc1(n_is,&pcbddc->ISForDofs);CHKERRQ(ierr);
878   }
879   for (i=0;i<n_is;i++) {
880     ierr = PetscObjectReference((PetscObject)ISForDofs[i]);CHKERRQ(ierr);
881     pcbddc->ISForDofs[i]=ISForDofs[i];
882   }
883   pcbddc->n_ISForDofs=n_is;
884   if (n_is) pcbddc->user_provided_isfordofs = PETSC_TRUE;
885   pcbddc->recompute_topography = PETSC_TRUE;
886   PetscFunctionReturn(0);
887 }
888 
889 #undef __FUNCT__
890 #define __FUNCT__ "PCBDDCSetDofsSplitting"
891 /*@
892  PCBDDCSetDofsSplitting - Set index sets defining fields of the global matrix
893 
894    Collective
895 
896    Input Parameters:
897 +  pc - the preconditioning context
898 -  n_is - number of index sets defining the fields
899 .  ISForDofs - array of IS describing the fields in global ordering
900 
901    Level: intermediate
902 
903    Notes: Any process can list any global node. Not all nodes need to be listed: unlisted nodes will belong to a different field.
904 
905 .seealso: PCBDDC
906 @*/
907 PetscErrorCode PCBDDCSetDofsSplitting(PC pc,PetscInt n_is, IS ISForDofs[])
908 {
909   PetscInt       i;
910   PetscErrorCode ierr;
911 
912   PetscFunctionBegin;
913   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
914   PetscValidLogicalCollectiveInt(pc,n_is,2);
915   for (i=0;i<n_is;i++) {
916     PetscCheckSameComm(pc,1,ISForDofs[i],3);
917     PetscValidHeaderSpecific(ISForDofs[i],IS_CLASSID,3);
918   }
919   ierr = PetscTryMethod(pc,"PCBDDCSetDofsSplitting_C",(PC,PetscInt,IS[]),(pc,n_is,ISForDofs));CHKERRQ(ierr);
920   PetscFunctionReturn(0);
921 }
922 
923 /* -------------------------------------------------------------------------- */
924 #undef __FUNCT__
925 #define __FUNCT__ "PCPreSolve_BDDC"
926 /* -------------------------------------------------------------------------- */
927 /*
928    PCPreSolve_BDDC - Changes the right hand side and (if necessary) the initial
929                      guess if a transformation of basis approach has been selected.
930 
931    Input Parameter:
932 +  pc - the preconditioner contex
933 
934    Application Interface Routine: PCPreSolve()
935 
936    Notes:
937    The interface routine PCPreSolve() is not usually called directly by
938    the user, but instead is called by KSPSolve().
939 */
940 static PetscErrorCode PCPreSolve_BDDC(PC pc, KSP ksp, Vec rhs, Vec x)
941 {
942   PetscErrorCode ierr;
943   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
944   PC_IS          *pcis = (PC_IS*)(pc->data);
945   Vec            used_vec;
946   PetscBool      copy_rhs = PETSC_TRUE;
947 
948   PetscFunctionBegin;
949   /* if we are working with cg, one dirichlet solve can be avoided during Krylov iterations */
950   if (ksp) {
951     PetscBool iscg;
952     ierr = PetscObjectTypeCompare((PetscObject)ksp,KSPCG,&iscg);CHKERRQ(ierr);
953     if (!iscg) {
954       ierr = PCBDDCSetUseExactDirichlet(pc,PETSC_FALSE);CHKERRQ(ierr);
955     }
956   }
957   /* Creates parallel work vectors used in presolve */
958   if (!pcbddc->original_rhs) {
959     ierr = VecDuplicate(pcis->vec1_global,&pcbddc->original_rhs);CHKERRQ(ierr);
960   }
961   if (!pcbddc->temp_solution) {
962     ierr = VecDuplicate(pcis->vec1_global,&pcbddc->temp_solution);CHKERRQ(ierr);
963   }
964 
965   if (x) {
966     ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);
967     used_vec = x;
968   } else { /* it can only happen when calling PCBDDCMatFETIDPGetRHS */
969     ierr = PetscObjectReference((PetscObject)pcbddc->temp_solution);CHKERRQ(ierr);
970     used_vec = pcbddc->temp_solution;
971     ierr = VecSet(used_vec,0.0);CHKERRQ(ierr);
972   }
973 
974   /* hack into ksp data structure since PCPreSolve comes earlier than setting to zero the guess in src/ksp/ksp/interface/itfunc.c */
975   if (ksp) {
976     ierr = KSPGetInitialGuessNonzero(ksp,&pcbddc->ksp_guess_nonzero);CHKERRQ(ierr);
977     if (!pcbddc->ksp_guess_nonzero) {
978       ierr = VecSet(used_vec,0.0);CHKERRQ(ierr);
979     }
980   }
981 
982   pcbddc->rhs_change = PETSC_FALSE;
983 
984   /* Take into account zeroed rows -> change rhs and store solution removed */
985   if (rhs && pcbddc->DirichletBoundariesLocal) {
986     IS dirIS = NULL;
987 
988     /* DirichletBoundariesLocal may not be consistent among neighbours */
989     ierr = PCBDDCGraphGetDirichletDofs(pcbddc->mat_graph,&dirIS);CHKERRQ(ierr);
990     if (dirIS) {
991       Mat_IS            *matis = (Mat_IS*)pc->pmat->data;
992       PetscInt          dirsize,i,*is_indices;
993       PetscScalar       *array_x;
994       const PetscScalar *array_diagonal;
995 
996       ierr = MatGetDiagonal(pc->pmat,pcis->vec1_global);CHKERRQ(ierr);
997       ierr = VecPointwiseDivide(pcis->vec1_global,rhs,pcis->vec1_global);CHKERRQ(ierr);
998       ierr = VecScatterBegin(matis->ctx,pcis->vec1_global,pcis->vec2_N,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
999       ierr = VecScatterEnd(matis->ctx,pcis->vec1_global,pcis->vec2_N,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1000       ierr = VecScatterBegin(matis->ctx,used_vec,pcis->vec1_N,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1001       ierr = VecScatterEnd(matis->ctx,used_vec,pcis->vec1_N,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1002       ierr = ISGetLocalSize(dirIS,&dirsize);CHKERRQ(ierr);
1003       ierr = VecGetArray(pcis->vec1_N,&array_x);CHKERRQ(ierr);
1004       ierr = VecGetArrayRead(pcis->vec2_N,&array_diagonal);CHKERRQ(ierr);
1005       ierr = ISGetIndices(dirIS,(const PetscInt**)&is_indices);CHKERRQ(ierr);
1006       for (i=0; i<dirsize; i++) array_x[is_indices[i]] = array_diagonal[is_indices[i]];
1007       ierr = ISRestoreIndices(dirIS,(const PetscInt**)&is_indices);CHKERRQ(ierr);
1008       ierr = VecRestoreArrayRead(pcis->vec2_N,&array_diagonal);CHKERRQ(ierr);
1009       ierr = VecRestoreArray(pcis->vec1_N,&array_x);CHKERRQ(ierr);
1010       ierr = VecScatterBegin(matis->ctx,pcis->vec1_N,used_vec,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1011       ierr = VecScatterEnd(matis->ctx,pcis->vec1_N,used_vec,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1012       pcbddc->rhs_change = PETSC_TRUE;
1013     }
1014     ierr = ISDestroy(&dirIS);CHKERRQ(ierr);
1015   }
1016 
1017   /* remove the computed solution or the initial guess from the rhs */
1018   if (pcbddc->rhs_change || (ksp && pcbddc->ksp_guess_nonzero) ) {
1019     /* store the original rhs */
1020     if (copy_rhs) {
1021       ierr = VecCopy(rhs,pcbddc->original_rhs);CHKERRQ(ierr);
1022       copy_rhs = PETSC_FALSE;
1023     }
1024     pcbddc->rhs_change = PETSC_TRUE;
1025     ierr = VecScale(used_vec,-1.0);CHKERRQ(ierr);
1026     ierr = MatMultAdd(pc->pmat,used_vec,rhs,rhs);CHKERRQ(ierr);
1027     ierr = VecScale(used_vec,-1.0);CHKERRQ(ierr);
1028     ierr = VecCopy(used_vec,pcbddc->temp_solution);CHKERRQ(ierr);
1029   }
1030   ierr = VecDestroy(&used_vec);CHKERRQ(ierr);
1031 
1032   /* store partially computed solution and set initial guess */
1033   if (x && pcbddc->use_exact_dirichlet_trick) {
1034     ierr = VecSet(x,0.0);CHKERRQ(ierr);
1035     ierr = VecScatterBegin(pcis->global_to_D,rhs,pcis->vec1_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1036     ierr = VecScatterEnd(pcis->global_to_D,rhs,pcis->vec1_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1037     ierr = KSPSolve(pcbddc->ksp_D,pcis->vec1_D,pcis->vec2_D);CHKERRQ(ierr);
1038     ierr = VecScatterBegin(pcis->global_to_D,pcis->vec2_D,x,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1039     ierr = VecScatterEnd(pcis->global_to_D,pcis->vec2_D,x,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1040     if (ksp && !pcbddc->ksp_guess_nonzero) {
1041       ierr = KSPSetInitialGuessNonzero(ksp,PETSC_TRUE);CHKERRQ(ierr);
1042     }
1043   }
1044 
1045   if (pcbddc->ChangeOfBasisMatrix) {
1046     PCBDDCChange_ctx change_ctx;
1047 
1048     /* get change ctx */
1049     ierr = MatShellGetContext(pcbddc->new_global_mat,&change_ctx);CHKERRQ(ierr);
1050 
1051     /* set current iteration matrix inside change context (change of basis has been already set into the ctx during PCSetUp) */
1052     ierr = MatDestroy(&change_ctx->original_mat);CHKERRQ(ierr);
1053     ierr = PetscObjectReference((PetscObject)pc->mat);CHKERRQ(ierr);
1054     change_ctx->original_mat = pc->mat;
1055 
1056     /* change iteration matrix */
1057     ierr = MatDestroy(&pc->mat);CHKERRQ(ierr);
1058     ierr = PetscObjectReference((PetscObject)pcbddc->new_global_mat);CHKERRQ(ierr);
1059     pc->mat = pcbddc->new_global_mat;
1060 
1061     /* store the original rhs */
1062     if (copy_rhs) {
1063       ierr = VecCopy(rhs,pcbddc->original_rhs);CHKERRQ(ierr);
1064       copy_rhs = PETSC_FALSE;
1065     }
1066 
1067     /* change rhs */
1068     ierr = MatMultTranspose(change_ctx->global_change,rhs,pcis->vec1_global);CHKERRQ(ierr);
1069     ierr = VecCopy(pcis->vec1_global,rhs);CHKERRQ(ierr);
1070     pcbddc->rhs_change = PETSC_TRUE;
1071   }
1072 
1073   /* remove nullspace if present */
1074   if (ksp && x && pcbddc->NullSpace) {
1075     ierr = MatNullSpaceRemove(pcbddc->NullSpace,x);CHKERRQ(ierr);
1076     /* store the original rhs */
1077     if (copy_rhs) {
1078       ierr = VecCopy(rhs,pcbddc->original_rhs);CHKERRQ(ierr);
1079       copy_rhs = PETSC_FALSE;
1080     }
1081     pcbddc->rhs_change = PETSC_TRUE;
1082     ierr = MatNullSpaceRemove(pcbddc->NullSpace,rhs);CHKERRQ(ierr);
1083   }
1084   PetscFunctionReturn(0);
1085 }
1086 
1087 /* -------------------------------------------------------------------------- */
1088 #undef __FUNCT__
1089 #define __FUNCT__ "PCPostSolve_BDDC"
1090 /* -------------------------------------------------------------------------- */
1091 /*
1092    PCPostSolve_BDDC - Changes the computed solution if a transformation of basis
1093                      approach has been selected. Also, restores rhs to its original state.
1094 
1095    Input Parameter:
1096 +  pc - the preconditioner contex
1097 
1098    Application Interface Routine: PCPostSolve()
1099 
1100    Notes:
1101    The interface routine PCPostSolve() is not usually called directly by
1102    the user, but instead is called by KSPSolve().
1103 */
1104 static PetscErrorCode PCPostSolve_BDDC(PC pc, KSP ksp, Vec rhs, Vec x)
1105 {
1106   PetscErrorCode ierr;
1107   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
1108 
1109   PetscFunctionBegin;
1110   if (pcbddc->ChangeOfBasisMatrix) {
1111     PCBDDCChange_ctx change_ctx;
1112 
1113     /* get change ctx */
1114     ierr = MatShellGetContext(pcbddc->new_global_mat,&change_ctx);CHKERRQ(ierr);
1115 
1116     /* restore iteration matrix */
1117     ierr = MatDestroy(&pc->mat);CHKERRQ(ierr);
1118     ierr = PetscObjectReference((PetscObject)change_ctx->original_mat);CHKERRQ(ierr);
1119     pc->mat = change_ctx->original_mat;
1120 
1121     /* get solution in original basis */
1122     if (x) {
1123       PC_IS *pcis = (PC_IS*)(pc->data);
1124       ierr = MatMult(change_ctx->global_change,x,pcis->vec1_global);CHKERRQ(ierr);
1125       ierr = VecCopy(pcis->vec1_global,x);CHKERRQ(ierr);
1126     }
1127   }
1128 
1129   /* add solution removed in presolve */
1130   if (x && pcbddc->rhs_change) {
1131     ierr = VecAXPY(x,1.0,pcbddc->temp_solution);CHKERRQ(ierr);
1132   }
1133 
1134   /* restore rhs to its original state */
1135   if (rhs && pcbddc->rhs_change) {
1136     ierr = VecCopy(pcbddc->original_rhs,rhs);CHKERRQ(ierr);
1137   }
1138   pcbddc->rhs_change = PETSC_FALSE;
1139 
1140   /* restore ksp guess state */
1141   if (ksp) {
1142     ierr = KSPSetInitialGuessNonzero(ksp,pcbddc->ksp_guess_nonzero);CHKERRQ(ierr);
1143   }
1144   PetscFunctionReturn(0);
1145 }
1146 /* -------------------------------------------------------------------------- */
1147 #undef __FUNCT__
1148 #define __FUNCT__ "PCSetUp_BDDC"
1149 /* -------------------------------------------------------------------------- */
1150 /*
1151    PCSetUp_BDDC - Prepares for the use of the BDDC preconditioner
1152                   by setting data structures and options.
1153 
1154    Input Parameter:
1155 +  pc - the preconditioner context
1156 
1157    Application Interface Routine: PCSetUp()
1158 
1159    Notes:
1160    The interface routine PCSetUp() is not usually called directly by
1161    the user, but instead is called by PCApply() if necessary.
1162 */
1163 PetscErrorCode PCSetUp_BDDC(PC pc)
1164 {
1165   PetscErrorCode ierr;
1166   PC_BDDC*       pcbddc = (PC_BDDC*)pc->data;
1167   Mat_IS*        matis;
1168   MatNullSpace   nearnullspace;
1169   PetscBool      computetopography,computesolvers,computesubschurs;
1170   PetscBool      computeconstraintsmatrix;
1171   PetscBool      new_nearnullspace_provided,ismatis;
1172 
1173   PetscFunctionBegin;
1174   ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATIS,&ismatis);CHKERRQ(ierr);
1175   if (!ismatis) {
1176     SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG,"PCBDDC preconditioner requires matrix of type MATIS");
1177   }
1178   matis = (Mat_IS*)pc->pmat->data;
1179   /* the following lines of code should be replaced by a better logic between PCIS, PCNN, PCBDDC and other future nonoverlapping preconditioners */
1180   /* For BDDC we need to define a local "Neumann" problem different to that defined in PCISSetup
1181      Also, BDDC directly build the Dirichlet problem */
1182   /* split work */
1183   if (pc->setupcalled) {
1184     if (pc->flag == SAME_NONZERO_PATTERN) {
1185       computetopography = PETSC_FALSE;
1186       computesolvers = PETSC_TRUE;
1187     } else { /* DIFFERENT_NONZERO_PATTERN */
1188       computetopography = PETSC_TRUE;
1189       computesolvers = PETSC_TRUE;
1190     }
1191   } else {
1192     computetopography = PETSC_TRUE;
1193     computesolvers = PETSC_TRUE;
1194   }
1195   if (pcbddc->recompute_topography) {
1196     computetopography = PETSC_TRUE;
1197   }
1198   computeconstraintsmatrix = PETSC_FALSE;
1199   pcbddc->adaptive_selection = (PetscBool)(pcbddc->adaptive_threshold > 0.0);
1200   computesubschurs = (PetscBool)(pcbddc->use_deluxe_scaling || pcbddc->adaptive_selection);
1201 
1202   /* Get stdout for dbg */
1203   if (pcbddc->dbg_flag) {
1204     if (!pcbddc->dbg_viewer) {
1205       pcbddc->dbg_viewer = PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)pc));
1206       ierr = PetscViewerASCIISynchronizedAllow(pcbddc->dbg_viewer,PETSC_TRUE);CHKERRQ(ierr);
1207     }
1208     ierr = PetscViewerASCIIAddTab(pcbddc->dbg_viewer,2*pcbddc->current_level);CHKERRQ(ierr);
1209   }
1210 
1211   /*ierr = MatIsSymmetric(pc->pmat,0.,&pcbddc->issym);CHKERRQ(ierr);*/
1212   { /* this is a temporary workaround since seqbaij matrices does not have support for symmetry checking */
1213     PetscBool setsym;
1214     ierr = MatIsSymmetricKnown(pc->pmat,&setsym,&pcbddc->issym);CHKERRQ(ierr);
1215     if (!setsym) pcbddc->issym = PETSC_FALSE;
1216   }
1217 
1218   if (pcbddc->user_ChangeOfBasisMatrix) {
1219     /* use_change_of_basis flag is used to automatically compute a change of basis from constraints */
1220     pcbddc->use_change_of_basis = PETSC_FALSE;
1221     ierr = PCBDDCComputeLocalMatrix(pc,pcbddc->user_ChangeOfBasisMatrix);CHKERRQ(ierr);
1222   } else {
1223     ierr = MatDestroy(&pcbddc->local_mat);CHKERRQ(ierr);
1224     ierr = PetscObjectReference((PetscObject)matis->A);CHKERRQ(ierr);
1225     pcbddc->local_mat = matis->A;
1226   }
1227 
1228   /* Set up all the "iterative substructuring" common block without computing solvers */
1229   {
1230     Mat temp_mat;
1231 
1232     temp_mat = matis->A;
1233     matis->A = pcbddc->local_mat;
1234     ierr = PCISSetUp(pc,PETSC_FALSE);CHKERRQ(ierr);
1235     pcbddc->local_mat = matis->A;
1236     matis->A = temp_mat;
1237   }
1238 
1239   /* Analyze interface and setup sub_schurs data */
1240   if (computetopography) {
1241     ierr = PCBDDCAnalyzeInterface(pc);CHKERRQ(ierr);
1242     computeconstraintsmatrix = PETSC_TRUE;
1243   }
1244 
1245   /* Setup local dirichlet solver ksp_D and sub_schurs solvers */
1246   if (computesolvers) {
1247     ierr = PCBDDCSetUpLocalSolvers(pc,PETSC_TRUE,PETSC_FALSE);CHKERRQ(ierr);
1248     if (computesubschurs) {
1249       if (computetopography) {
1250         ierr = PCBDDCInitSubSchurs(pc);CHKERRQ(ierr);
1251       }
1252       ierr = PCBDDCSetUpSubSchurs(pc);CHKERRQ(ierr);
1253       if (pcbddc->adaptive_selection) {
1254         ierr = PCBDDCAdaptiveSelection(pc);CHKERRQ(ierr);
1255         computeconstraintsmatrix = PETSC_TRUE;
1256       }
1257     }
1258   }
1259 
1260   /* infer if NullSpace object attached to Mat via MatSetNearNullSpace has changed */
1261   new_nearnullspace_provided = PETSC_FALSE;
1262   ierr = MatGetNearNullSpace(pc->pmat,&nearnullspace);CHKERRQ(ierr);
1263   if (pcbddc->onearnullspace) { /* already used nearnullspace */
1264     if (!nearnullspace) { /* near null space attached to mat has been destroyed */
1265       new_nearnullspace_provided = PETSC_TRUE;
1266     } else {
1267       /* determine if the two nullspaces are different (should be lightweight) */
1268       if (nearnullspace != pcbddc->onearnullspace) {
1269         new_nearnullspace_provided = PETSC_TRUE;
1270       } else { /* maybe the user has changed the content of the nearnullspace so check vectors ObjectStateId */
1271         PetscInt         i;
1272         const Vec        *nearnullvecs;
1273         PetscObjectState state;
1274         PetscInt         nnsp_size;
1275         ierr = MatNullSpaceGetVecs(nearnullspace,NULL,&nnsp_size,&nearnullvecs);CHKERRQ(ierr);
1276         for (i=0;i<nnsp_size;i++) {
1277           ierr = PetscObjectStateGet((PetscObject)nearnullvecs[i],&state);CHKERRQ(ierr);
1278           if (pcbddc->onearnullvecs_state[i] != state) {
1279             new_nearnullspace_provided = PETSC_TRUE;
1280             break;
1281           }
1282         }
1283       }
1284     }
1285   } else {
1286     if (!nearnullspace) { /* both nearnullspaces are null */
1287       new_nearnullspace_provided = PETSC_FALSE;
1288     } else { /* nearnullspace attached later */
1289       new_nearnullspace_provided = PETSC_TRUE;
1290     }
1291   }
1292 
1293   /* Setup constraints and related work vectors */
1294   /* reset primal space flags */
1295   pcbddc->new_primal_space = PETSC_FALSE;
1296   pcbddc->new_primal_space_local = PETSC_FALSE;
1297   if (computeconstraintsmatrix || new_nearnullspace_provided) {
1298     /* It also sets the primal space flags */
1299     ierr = PCBDDCConstraintsSetUp(pc);CHKERRQ(ierr);
1300     /* Allocate needed local vectors (which depends on quantities defined during ConstraintsSetUp) */
1301     ierr = PCBDDCSetUpLocalWorkVectors(pc);CHKERRQ(ierr);
1302   }
1303 
1304   if (computesolvers || pcbddc->new_primal_space) {
1305     if (pcbddc->use_change_of_basis) {
1306       PC_IS *pcis = (PC_IS*)(pc->data);
1307 
1308       ierr = PCBDDCComputeLocalMatrix(pc,pcbddc->ChangeOfBasisMatrix);CHKERRQ(ierr);
1309       /* get submatrices */
1310       ierr = MatDestroy(&pcis->A_IB);CHKERRQ(ierr);
1311       ierr = MatDestroy(&pcis->A_BI);CHKERRQ(ierr);
1312       ierr = MatDestroy(&pcis->A_BB);CHKERRQ(ierr);
1313       ierr = MatGetSubMatrix(pcbddc->local_mat,pcis->is_B_local,pcis->is_B_local,MAT_INITIAL_MATRIX,&pcis->A_BB);CHKERRQ(ierr);
1314       ierr = MatGetSubMatrix(pcbddc->local_mat,pcis->is_I_local,pcis->is_B_local,MAT_INITIAL_MATRIX,&pcis->A_IB);CHKERRQ(ierr);
1315       ierr = MatGetSubMatrix(pcbddc->local_mat,pcis->is_B_local,pcis->is_I_local,MAT_INITIAL_MATRIX,&pcis->A_BI);CHKERRQ(ierr);
1316       /* set flag in pcis to not reuse submatrices during PCISCreate */
1317       pcis->reusesubmatrices = PETSC_FALSE;
1318     } else if (!pcbddc->user_ChangeOfBasisMatrix) {
1319       ierr = MatDestroy(&pcbddc->local_mat);CHKERRQ(ierr);
1320       ierr = PetscObjectReference((PetscObject)matis->A);CHKERRQ(ierr);
1321       pcbddc->local_mat = matis->A;
1322     }
1323     /* SetUp coarse and local Neumann solvers */
1324     ierr = PCBDDCSetUpSolvers(pc);CHKERRQ(ierr);
1325     /* SetUp Scaling operator */
1326     ierr = PCBDDCScalingSetUp(pc);CHKERRQ(ierr);
1327   }
1328 
1329   if (pcbddc->dbg_flag) {
1330     ierr = PetscViewerASCIISubtractTab(pcbddc->dbg_viewer,2*pcbddc->current_level);CHKERRQ(ierr);
1331   }
1332   PetscFunctionReturn(0);
1333 }
1334 
1335 /* -------------------------------------------------------------------------- */
1336 /*
1337    PCApply_BDDC - Applies the BDDC operator to a vector.
1338 
1339    Input Parameters:
1340 .  pc - the preconditioner context
1341 .  r - input vector (global)
1342 
1343    Output Parameter:
1344 .  z - output vector (global)
1345 
1346    Application Interface Routine: PCApply()
1347  */
1348 #undef __FUNCT__
1349 #define __FUNCT__ "PCApply_BDDC"
1350 PetscErrorCode PCApply_BDDC(PC pc,Vec r,Vec z)
1351 {
1352   PC_IS             *pcis = (PC_IS*)(pc->data);
1353   PC_BDDC           *pcbddc = (PC_BDDC*)(pc->data);
1354   PetscInt          n_B = pcis->n_B, n_D = pcis->n - n_B;
1355   PetscErrorCode    ierr;
1356   const PetscScalar one = 1.0;
1357   const PetscScalar m_one = -1.0;
1358   const PetscScalar zero = 0.0;
1359 
1360 /* This code is similar to that provided in nn.c for PCNN
1361    NN interface preconditioner changed to BDDC
1362    Added support for M_3 preconditioner in the reference article (code is active if pcbddc->switch_static == PETSC_TRUE) */
1363 
1364   PetscFunctionBegin;
1365   if (!pcbddc->use_exact_dirichlet_trick) {
1366     ierr = VecCopy(r,z);CHKERRQ(ierr);
1367     /* First Dirichlet solve */
1368     ierr = VecScatterBegin(pcis->global_to_D,r,pcis->vec1_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1369     ierr = VecScatterEnd(pcis->global_to_D,r,pcis->vec1_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1370     /*
1371       Assembling right hand side for BDDC operator
1372       - pcis->vec1_D for the Dirichlet part (if needed, i.e. pcbddc->switch_static == PETSC_TRUE)
1373       - pcis->vec1_B the interface part of the global vector z
1374     */
1375     if (n_D) {
1376       ierr = KSPSolve(pcbddc->ksp_D,pcis->vec1_D,pcis->vec2_D);CHKERRQ(ierr);
1377       ierr = VecScale(pcis->vec2_D,m_one);CHKERRQ(ierr);
1378       if (pcbddc->switch_static) { ierr = MatMultAdd(pcis->A_II,pcis->vec2_D,pcis->vec1_D,pcis->vec1_D);CHKERRQ(ierr); }
1379       ierr = MatMult(pcis->A_BI,pcis->vec2_D,pcis->vec1_B);CHKERRQ(ierr);
1380     } else {
1381       ierr = VecSet(pcis->vec1_B,zero);CHKERRQ(ierr);
1382     }
1383     ierr = VecScatterBegin(pcis->global_to_B,pcis->vec1_B,z,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1384     ierr = VecScatterEnd(pcis->global_to_B,pcis->vec1_B,z,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1385     ierr = PCBDDCScalingRestriction(pc,z,pcis->vec1_B);CHKERRQ(ierr);
1386   } else {
1387     if (pcbddc->switch_static) {
1388       ierr = VecSet(pcis->vec1_D,zero);CHKERRQ(ierr);
1389     }
1390     ierr = PCBDDCScalingRestriction(pc,r,pcis->vec1_B);CHKERRQ(ierr);
1391   }
1392 
1393   /* Apply interface preconditioner
1394      input/output vecs: pcis->vec1_B and pcis->vec1_D */
1395   ierr = PCBDDCApplyInterfacePreconditioner(pc,PETSC_FALSE);CHKERRQ(ierr);
1396 
1397   /* Apply transpose of partition of unity operator */
1398   ierr = PCBDDCScalingExtension(pc,pcis->vec1_B,z);CHKERRQ(ierr);
1399 
1400   /* Second Dirichlet solve and assembling of output */
1401   ierr = VecScatterBegin(pcis->global_to_B,z,pcis->vec1_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1402   ierr = VecScatterEnd(pcis->global_to_B,z,pcis->vec1_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1403   if (n_B) {
1404     ierr = MatMult(pcis->A_IB,pcis->vec1_B,pcis->vec3_D);CHKERRQ(ierr);
1405     if (pcbddc->switch_static) { ierr = MatMultAdd(pcis->A_II,pcis->vec1_D,pcis->vec3_D,pcis->vec3_D);CHKERRQ(ierr); }
1406   } else if (pcbddc->switch_static) {
1407     ierr = MatMult(pcis->A_II,pcis->vec1_D,pcis->vec3_D);CHKERRQ(ierr);
1408   }
1409   ierr = KSPSolve(pcbddc->ksp_D,pcis->vec3_D,pcis->vec4_D);CHKERRQ(ierr);
1410   if (!pcbddc->use_exact_dirichlet_trick) {
1411     if (pcbddc->switch_static) {
1412       ierr = VecAXPBYPCZ(pcis->vec2_D,m_one,one,m_one,pcis->vec4_D,pcis->vec1_D);CHKERRQ(ierr);
1413     } else {
1414       ierr = VecAXPBY(pcis->vec2_D,m_one,m_one,pcis->vec4_D);CHKERRQ(ierr);
1415     }
1416     ierr = VecScatterBegin(pcis->global_to_D,pcis->vec2_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1417     ierr = VecScatterEnd(pcis->global_to_D,pcis->vec2_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1418   } else {
1419     if (pcbddc->switch_static) {
1420       ierr = VecAXPBY(pcis->vec4_D,one,m_one,pcis->vec1_D);CHKERRQ(ierr);
1421     } else {
1422       ierr = VecScale(pcis->vec4_D,m_one);CHKERRQ(ierr);
1423     }
1424     ierr = VecScatterBegin(pcis->global_to_D,pcis->vec4_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1425     ierr = VecScatterEnd(pcis->global_to_D,pcis->vec4_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1426   }
1427   PetscFunctionReturn(0);
1428 }
1429 
1430 /* -------------------------------------------------------------------------- */
1431 /*
1432    PCApplyTranspose_BDDC - Applies the transpose of the BDDC operator to a vector.
1433 
1434    Input Parameters:
1435 .  pc - the preconditioner context
1436 .  r - input vector (global)
1437 
1438    Output Parameter:
1439 .  z - output vector (global)
1440 
1441    Application Interface Routine: PCApplyTranspose()
1442  */
1443 #undef __FUNCT__
1444 #define __FUNCT__ "PCApplyTranspose_BDDC"
1445 PetscErrorCode PCApplyTranspose_BDDC(PC pc,Vec r,Vec z)
1446 {
1447   PC_IS             *pcis = (PC_IS*)(pc->data);
1448   PC_BDDC           *pcbddc = (PC_BDDC*)(pc->data);
1449   PetscInt          n_B = pcis->n_B, n_D = pcis->n - n_B;
1450   PetscErrorCode    ierr;
1451   const PetscScalar one = 1.0;
1452   const PetscScalar m_one = -1.0;
1453   const PetscScalar zero = 0.0;
1454 
1455   PetscFunctionBegin;
1456   if (!pcbddc->use_exact_dirichlet_trick) {
1457     ierr = VecCopy(r,z);CHKERRQ(ierr);
1458     /* First Dirichlet solve */
1459     ierr = VecScatterBegin(pcis->global_to_D,r,pcis->vec1_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1460     ierr = VecScatterEnd(pcis->global_to_D,r,pcis->vec1_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1461     /*
1462       Assembling right hand side for BDDC operator
1463       - pcis->vec1_D for the Dirichlet part (if needed, i.e. pcbddc->switch_static == PETSC_TRUE)
1464       - pcis->vec1_B the interface part of the global vector z
1465     */
1466     if (n_D) {
1467       ierr = KSPSolveTranspose(pcbddc->ksp_D,pcis->vec1_D,pcis->vec2_D);CHKERRQ(ierr);
1468       ierr = VecScale(pcis->vec2_D,m_one);CHKERRQ(ierr);
1469       if (pcbddc->switch_static) { ierr = MatMultTransposeAdd(pcis->A_II,pcis->vec2_D,pcis->vec1_D,pcis->vec1_D);CHKERRQ(ierr); }
1470       ierr = MatMultTranspose(pcis->A_IB,pcis->vec2_D,pcis->vec1_B);CHKERRQ(ierr);
1471     } else {
1472       ierr = VecSet(pcis->vec1_B,zero);CHKERRQ(ierr);
1473     }
1474     ierr = VecScatterBegin(pcis->global_to_B,pcis->vec1_B,z,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1475     ierr = VecScatterEnd(pcis->global_to_B,pcis->vec1_B,z,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1476     ierr = PCBDDCScalingRestriction(pc,z,pcis->vec1_B);CHKERRQ(ierr);
1477   } else {
1478     if (pcbddc->switch_static) {
1479       ierr = VecSet(pcis->vec1_D,zero);CHKERRQ(ierr);
1480     }
1481     ierr = PCBDDCScalingRestriction(pc,r,pcis->vec1_B);CHKERRQ(ierr);
1482   }
1483 
1484   /* Apply interface preconditioner
1485      input/output vecs: pcis->vec1_B and pcis->vec1_D */
1486   ierr = PCBDDCApplyInterfacePreconditioner(pc,PETSC_TRUE);CHKERRQ(ierr);
1487 
1488   /* Apply transpose of partition of unity operator */
1489   ierr = PCBDDCScalingExtension(pc,pcis->vec1_B,z);CHKERRQ(ierr);
1490 
1491   /* Second Dirichlet solve and assembling of output */
1492   ierr = VecScatterBegin(pcis->global_to_B,z,pcis->vec1_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1493   ierr = VecScatterEnd(pcis->global_to_B,z,pcis->vec1_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1494   if (n_B) {
1495     ierr = MatMultTranspose(pcis->A_BI,pcis->vec1_B,pcis->vec3_D);CHKERRQ(ierr);
1496     if (pcbddc->switch_static) { ierr = MatMultTransposeAdd(pcis->A_II,pcis->vec1_D,pcis->vec3_D,pcis->vec3_D);CHKERRQ(ierr); }
1497   } else if (pcbddc->switch_static) {
1498     ierr = MatMultTranspose(pcis->A_II,pcis->vec1_D,pcis->vec3_D);CHKERRQ(ierr);
1499   }
1500   ierr = KSPSolveTranspose(pcbddc->ksp_D,pcis->vec3_D,pcis->vec4_D);CHKERRQ(ierr);
1501   if (!pcbddc->use_exact_dirichlet_trick) {
1502     if (pcbddc->switch_static) {
1503       ierr = VecAXPBYPCZ(pcis->vec2_D,m_one,one,m_one,pcis->vec4_D,pcis->vec1_D);CHKERRQ(ierr);
1504     } else {
1505       ierr = VecAXPBY(pcis->vec2_D,m_one,m_one,pcis->vec4_D);CHKERRQ(ierr);
1506     }
1507     ierr = VecScatterBegin(pcis->global_to_D,pcis->vec2_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1508     ierr = VecScatterEnd(pcis->global_to_D,pcis->vec2_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1509   } else {
1510     if (pcbddc->switch_static) {
1511       ierr = VecAXPBY(pcis->vec4_D,one,m_one,pcis->vec1_D);CHKERRQ(ierr);
1512     } else {
1513       ierr = VecScale(pcis->vec4_D,m_one);CHKERRQ(ierr);
1514     }
1515     ierr = VecScatterBegin(pcis->global_to_D,pcis->vec4_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1516     ierr = VecScatterEnd(pcis->global_to_D,pcis->vec4_D,z,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1517   }
1518   PetscFunctionReturn(0);
1519 }
1520 /* -------------------------------------------------------------------------- */
1521 
1522 #undef __FUNCT__
1523 #define __FUNCT__ "PCDestroy_BDDC"
1524 PetscErrorCode PCDestroy_BDDC(PC pc)
1525 {
1526   PC_BDDC        *pcbddc = (PC_BDDC*)pc->data;
1527   PetscErrorCode ierr;
1528 
1529   PetscFunctionBegin;
1530   /* free data created by PCIS */
1531   ierr = PCISDestroy(pc);CHKERRQ(ierr);
1532   /* free BDDC custom data  */
1533   ierr = PCBDDCResetCustomization(pc);CHKERRQ(ierr);
1534   /* destroy objects related to topography */
1535   ierr = PCBDDCResetTopography(pc);CHKERRQ(ierr);
1536   /* free allocated graph structure */
1537   ierr = PetscFree(pcbddc->mat_graph);CHKERRQ(ierr);
1538   /* free allocated sub schurs structure */
1539   ierr = PetscFree(pcbddc->sub_schurs);CHKERRQ(ierr);
1540   /* destroy objects for scaling operator */
1541   ierr = PCBDDCScalingDestroy(pc);CHKERRQ(ierr);
1542   ierr = PetscFree(pcbddc->deluxe_ctx);CHKERRQ(ierr);
1543   /* free solvers stuff */
1544   ierr = PCBDDCResetSolvers(pc);CHKERRQ(ierr);
1545   /* free global vectors needed in presolve */
1546   ierr = VecDestroy(&pcbddc->temp_solution);CHKERRQ(ierr);
1547   ierr = VecDestroy(&pcbddc->original_rhs);CHKERRQ(ierr);
1548   /* free stuff for change of basis hooks */
1549   if (pcbddc->new_global_mat) {
1550     PCBDDCChange_ctx change_ctx;
1551     ierr = MatShellGetContext(pcbddc->new_global_mat,&change_ctx);CHKERRQ(ierr);
1552     ierr = MatDestroy(&change_ctx->original_mat);CHKERRQ(ierr);
1553     ierr = MatDestroy(&change_ctx->global_change);CHKERRQ(ierr);
1554     ierr = VecDestroyVecs(2,&change_ctx->work);CHKERRQ(ierr);
1555     ierr = PetscFree(change_ctx);CHKERRQ(ierr);
1556   }
1557   ierr = MatDestroy(&pcbddc->new_global_mat);CHKERRQ(ierr);
1558   /* remove functions */
1559   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetChangeOfBasisMat_C",NULL);CHKERRQ(ierr);
1560   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetPrimalVerticesLocalIS_C",NULL);CHKERRQ(ierr);
1561   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetCoarseningRatio_C",NULL);CHKERRQ(ierr);
1562   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetLevel_C",NULL);CHKERRQ(ierr);
1563   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetUseExactDirichlet_C",NULL);CHKERRQ(ierr);
1564   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetLevels_C",NULL);CHKERRQ(ierr);
1565   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetNullSpace_C",NULL);CHKERRQ(ierr);
1566   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDirichletBoundaries_C",NULL);CHKERRQ(ierr);
1567   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDirichletBoundariesLocal_C",NULL);CHKERRQ(ierr);
1568   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetNeumannBoundaries_C",NULL);CHKERRQ(ierr);
1569   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetNeumannBoundariesLocal_C",NULL);CHKERRQ(ierr);
1570   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetDirichletBoundaries_C",NULL);CHKERRQ(ierr);
1571   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetDirichletBoundariesLocal_C",NULL);CHKERRQ(ierr);
1572   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetNeumannBoundaries_C",NULL);CHKERRQ(ierr);
1573   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetNeumannBoundariesLocal_C",NULL);CHKERRQ(ierr);
1574   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDofsSplitting_C",NULL);CHKERRQ(ierr);
1575   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDofsSplittingLocal_C",NULL);CHKERRQ(ierr);
1576   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetLocalAdjacencyGraph_C",NULL);CHKERRQ(ierr);
1577   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCCreateFETIDPOperators_C",NULL);CHKERRQ(ierr);
1578   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCMatFETIDPGetRHS_C",NULL);CHKERRQ(ierr);
1579   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCMatFETIDPGetSolution_C",NULL);CHKERRQ(ierr);
1580   /* Free the private data structure */
1581   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1582   PetscFunctionReturn(0);
1583 }
1584 /* -------------------------------------------------------------------------- */
1585 
1586 #undef __FUNCT__
1587 #define __FUNCT__ "PCBDDCMatFETIDPGetRHS_BDDC"
1588 static PetscErrorCode PCBDDCMatFETIDPGetRHS_BDDC(Mat fetidp_mat, Vec standard_rhs, Vec fetidp_flux_rhs)
1589 {
1590   FETIDPMat_ctx  mat_ctx;
1591   Vec            copy_standard_rhs;
1592   PC_IS*         pcis;
1593   PC_BDDC*       pcbddc;
1594   PetscErrorCode ierr;
1595 
1596   PetscFunctionBegin;
1597   ierr = MatShellGetContext(fetidp_mat,&mat_ctx);CHKERRQ(ierr);
1598   pcis = (PC_IS*)mat_ctx->pc->data;
1599   pcbddc = (PC_BDDC*)mat_ctx->pc->data;
1600 
1601   /*
1602      change of basis for physical rhs if needed
1603      It also changes the rhs in case of dirichlet boundaries
1604      TODO: better management when FETIDP will have its own class
1605   */
1606   ierr = VecDuplicate(standard_rhs,&copy_standard_rhs);CHKERRQ(ierr);
1607   ierr = VecCopy(standard_rhs,copy_standard_rhs);CHKERRQ(ierr);
1608   ierr = PCPreSolve_BDDC(mat_ctx->pc,NULL,copy_standard_rhs,NULL);CHKERRQ(ierr);
1609   /* store vectors for computation of fetidp final solution */
1610   ierr = VecScatterBegin(pcis->global_to_D,copy_standard_rhs,mat_ctx->temp_solution_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1611   ierr = VecScatterEnd(pcis->global_to_D,copy_standard_rhs,mat_ctx->temp_solution_D,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1612   /* scale rhs since it should be unassembled */
1613   /* TODO use counter scaling? (also below) */
1614   ierr = VecScatterBegin(pcis->global_to_B,copy_standard_rhs,mat_ctx->temp_solution_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1615   ierr = VecScatterEnd(pcis->global_to_B,copy_standard_rhs,mat_ctx->temp_solution_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1616   /* Apply partition of unity */
1617   ierr = VecPointwiseMult(mat_ctx->temp_solution_B,pcis->D,mat_ctx->temp_solution_B);CHKERRQ(ierr);
1618   /* ierr = PCBDDCScalingRestriction(mat_ctx->pc,copy_standard_rhs,mat_ctx->temp_solution_B);CHKERRQ(ierr); */
1619   if (!pcbddc->switch_static) {
1620     /* compute partially subassembled Schur complement right-hand side */
1621     ierr = KSPSolve(pcbddc->ksp_D,mat_ctx->temp_solution_D,pcis->vec1_D);CHKERRQ(ierr);
1622     ierr = MatMult(pcis->A_BI,pcis->vec1_D,pcis->vec1_B);CHKERRQ(ierr);
1623     ierr = VecAXPY(mat_ctx->temp_solution_B,-1.0,pcis->vec1_B);CHKERRQ(ierr);
1624     ierr = VecSet(copy_standard_rhs,0.0);CHKERRQ(ierr);
1625     ierr = VecScatterBegin(pcis->global_to_B,mat_ctx->temp_solution_B,copy_standard_rhs,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1626     ierr = VecScatterEnd(pcis->global_to_B,mat_ctx->temp_solution_B,copy_standard_rhs,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1627     /* ierr = PCBDDCScalingRestriction(mat_ctx->pc,copy_standard_rhs,mat_ctx->temp_solution_B);CHKERRQ(ierr); */
1628     ierr = VecScatterBegin(pcis->global_to_B,copy_standard_rhs,mat_ctx->temp_solution_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1629     ierr = VecScatterEnd(pcis->global_to_B,copy_standard_rhs,mat_ctx->temp_solution_B,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1630     ierr = VecPointwiseMult(mat_ctx->temp_solution_B,pcis->D,mat_ctx->temp_solution_B);CHKERRQ(ierr);
1631   }
1632   ierr = VecDestroy(&copy_standard_rhs);CHKERRQ(ierr);
1633   /* BDDC rhs */
1634   ierr = VecCopy(mat_ctx->temp_solution_B,pcis->vec1_B);CHKERRQ(ierr);
1635   if (pcbddc->switch_static) {
1636     ierr = VecCopy(mat_ctx->temp_solution_D,pcis->vec1_D);CHKERRQ(ierr);
1637   }
1638   /* apply BDDC */
1639   ierr = PCBDDCApplyInterfacePreconditioner(mat_ctx->pc,PETSC_FALSE);CHKERRQ(ierr);
1640   /* Application of B_delta and assembling of rhs for fetidp fluxes */
1641   ierr = VecSet(fetidp_flux_rhs,0.0);CHKERRQ(ierr);
1642   ierr = MatMult(mat_ctx->B_delta,pcis->vec1_B,mat_ctx->lambda_local);CHKERRQ(ierr);
1643   ierr = VecScatterBegin(mat_ctx->l2g_lambda,mat_ctx->lambda_local,fetidp_flux_rhs,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1644   ierr = VecScatterEnd(mat_ctx->l2g_lambda,mat_ctx->lambda_local,fetidp_flux_rhs,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1645   PetscFunctionReturn(0);
1646 }
1647 
1648 #undef __FUNCT__
1649 #define __FUNCT__ "PCBDDCMatFETIDPGetRHS"
1650 /*@
1651  PCBDDCMatFETIDPGetRHS - Compute the right-hand side for FETIDP linear system
1652 
1653    Collective
1654 
1655    Input Parameters:
1656 +  fetidp_mat   - the FETIDP matrix object obtained by calling PCBDDCCreateFETIDPOperators
1657 .  standard_rhs - the right-hand side for your linear system
1658 
1659    Output Parameters:
1660 -  fetidp_flux_rhs   - the right-hand side for the FETIDP linear system
1661 
1662    Level: developer
1663 
1664    Notes:
1665 
1666 .seealso: PCBDDC,PCBDDCCreateFETIDPOperators
1667 @*/
1668 PetscErrorCode PCBDDCMatFETIDPGetRHS(Mat fetidp_mat, Vec standard_rhs, Vec fetidp_flux_rhs)
1669 {
1670   FETIDPMat_ctx  mat_ctx;
1671   PetscErrorCode ierr;
1672 
1673   PetscFunctionBegin;
1674   ierr = MatShellGetContext(fetidp_mat,&mat_ctx);CHKERRQ(ierr);
1675   ierr = PetscTryMethod(mat_ctx->pc,"PCBDDCMatFETIDPGetRHS_C",(Mat,Vec,Vec),(fetidp_mat,standard_rhs,fetidp_flux_rhs));CHKERRQ(ierr);
1676   PetscFunctionReturn(0);
1677 }
1678 /* -------------------------------------------------------------------------- */
1679 
1680 #undef __FUNCT__
1681 #define __FUNCT__ "PCBDDCMatFETIDPGetSolution_BDDC"
1682 static PetscErrorCode PCBDDCMatFETIDPGetSolution_BDDC(Mat fetidp_mat, Vec fetidp_flux_sol, Vec standard_sol)
1683 {
1684   FETIDPMat_ctx  mat_ctx;
1685   PC_IS*         pcis;
1686   PC_BDDC*       pcbddc;
1687   PetscErrorCode ierr;
1688 
1689   PetscFunctionBegin;
1690   ierr = MatShellGetContext(fetidp_mat,&mat_ctx);CHKERRQ(ierr);
1691   pcis = (PC_IS*)mat_ctx->pc->data;
1692   pcbddc = (PC_BDDC*)mat_ctx->pc->data;
1693 
1694   /* apply B_delta^T */
1695   ierr = VecScatterBegin(mat_ctx->l2g_lambda,fetidp_flux_sol,mat_ctx->lambda_local,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1696   ierr = VecScatterEnd  (mat_ctx->l2g_lambda,fetidp_flux_sol,mat_ctx->lambda_local,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1697   ierr = MatMultTranspose(mat_ctx->B_delta,mat_ctx->lambda_local,pcis->vec1_B);CHKERRQ(ierr);
1698   /* compute rhs for BDDC application */
1699   ierr = VecAYPX(pcis->vec1_B,-1.0,mat_ctx->temp_solution_B);CHKERRQ(ierr);
1700   if (pcbddc->switch_static) {
1701     ierr = VecCopy(mat_ctx->temp_solution_D,pcis->vec1_D);CHKERRQ(ierr);
1702   }
1703   /* apply BDDC */
1704   ierr = PCBDDCApplyInterfacePreconditioner(mat_ctx->pc,PETSC_FALSE);CHKERRQ(ierr);
1705   /* put values into standard global vector */
1706   ierr = VecScatterBegin(pcis->global_to_B,pcis->vec1_B,standard_sol,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1707   ierr = VecScatterEnd  (pcis->global_to_B,pcis->vec1_B,standard_sol,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1708   if (!pcbddc->switch_static) {
1709     /* compute values into the interior if solved for the partially subassembled Schur complement */
1710     ierr = MatMult(pcis->A_IB,pcis->vec1_B,pcis->vec1_D);CHKERRQ(ierr);
1711     ierr = VecAXPY(mat_ctx->temp_solution_D,-1.0,pcis->vec1_D);CHKERRQ(ierr);
1712     ierr = KSPSolve(pcbddc->ksp_D,mat_ctx->temp_solution_D,pcis->vec1_D);CHKERRQ(ierr);
1713   }
1714   ierr = VecScatterBegin(pcis->global_to_D,pcis->vec1_D,standard_sol,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1715   ierr = VecScatterEnd  (pcis->global_to_D,pcis->vec1_D,standard_sol,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1716   /* final change of basis if needed
1717      Is also sums the dirichlet part removed during RHS assembling */
1718   ierr = PCPostSolve_BDDC(mat_ctx->pc,NULL,NULL,standard_sol);CHKERRQ(ierr);
1719   PetscFunctionReturn(0);
1720 }
1721 
1722 #undef __FUNCT__
1723 #define __FUNCT__ "PCBDDCMatFETIDPGetSolution"
1724 /*@
1725  PCBDDCMatFETIDPGetSolution - Compute the physical solution from the solution of the FETIDP linear system
1726 
1727    Collective
1728 
1729    Input Parameters:
1730 +  fetidp_mat        - the FETIDP matrix obtained by calling PCBDDCCreateFETIDPOperators
1731 .  fetidp_flux_sol - the solution of the FETIDP linear system
1732 
1733    Output Parameters:
1734 -  standard_sol      - the solution defined on the physical domain
1735 
1736    Level: developer
1737 
1738    Notes:
1739 
1740 .seealso: PCBDDC,PCBDDCCreateFETIDPOperators
1741 @*/
1742 PetscErrorCode PCBDDCMatFETIDPGetSolution(Mat fetidp_mat, Vec fetidp_flux_sol, Vec standard_sol)
1743 {
1744   FETIDPMat_ctx  mat_ctx;
1745   PetscErrorCode ierr;
1746 
1747   PetscFunctionBegin;
1748   ierr = MatShellGetContext(fetidp_mat,&mat_ctx);CHKERRQ(ierr);
1749   ierr = PetscTryMethod(mat_ctx->pc,"PCBDDCMatFETIDPGetSolution_C",(Mat,Vec,Vec),(fetidp_mat,fetidp_flux_sol,standard_sol));CHKERRQ(ierr);
1750   PetscFunctionReturn(0);
1751 }
1752 /* -------------------------------------------------------------------------- */
1753 
1754 extern PetscErrorCode FETIDPMatMult(Mat,Vec,Vec);
1755 extern PetscErrorCode FETIDPMatMultTranspose(Mat,Vec,Vec);
1756 extern PetscErrorCode PCBDDCDestroyFETIDPMat(Mat);
1757 extern PetscErrorCode FETIDPPCApply(PC,Vec,Vec);
1758 extern PetscErrorCode FETIDPPCApplyTranspose(PC,Vec,Vec);
1759 extern PetscErrorCode PCBDDCDestroyFETIDPPC(PC);
1760 
1761 #undef __FUNCT__
1762 #define __FUNCT__ "PCBDDCCreateFETIDPOperators_BDDC"
1763 static PetscErrorCode PCBDDCCreateFETIDPOperators_BDDC(PC pc, Mat *fetidp_mat, PC *fetidp_pc)
1764 {
1765 
1766   FETIDPMat_ctx  fetidpmat_ctx;
1767   Mat            newmat;
1768   FETIDPPC_ctx   fetidppc_ctx;
1769   PC             newpc;
1770   MPI_Comm       comm;
1771   PetscErrorCode ierr;
1772 
1773   PetscFunctionBegin;
1774   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
1775   /* FETIDP linear matrix */
1776   ierr = PCBDDCCreateFETIDPMatContext(pc,&fetidpmat_ctx);CHKERRQ(ierr);
1777   ierr = PCBDDCSetupFETIDPMatContext(fetidpmat_ctx);CHKERRQ(ierr);
1778   ierr = MatCreateShell(comm,PETSC_DECIDE,PETSC_DECIDE,fetidpmat_ctx->n_lambda,fetidpmat_ctx->n_lambda,fetidpmat_ctx,&newmat);CHKERRQ(ierr);
1779   ierr = MatShellSetOperation(newmat,MATOP_MULT,(void (*)(void))FETIDPMatMult);CHKERRQ(ierr);
1780   ierr = MatShellSetOperation(newmat,MATOP_MULT_TRANSPOSE,(void (*)(void))FETIDPMatMultTranspose);CHKERRQ(ierr);
1781   ierr = MatShellSetOperation(newmat,MATOP_DESTROY,(void (*)(void))PCBDDCDestroyFETIDPMat);CHKERRQ(ierr);
1782   ierr = MatSetUp(newmat);CHKERRQ(ierr);
1783   /* FETIDP preconditioner */
1784   ierr = PCBDDCCreateFETIDPPCContext(pc,&fetidppc_ctx);CHKERRQ(ierr);
1785   ierr = PCBDDCSetupFETIDPPCContext(newmat,fetidppc_ctx);CHKERRQ(ierr);
1786   ierr = PCCreate(comm,&newpc);CHKERRQ(ierr);
1787   ierr = PCSetType(newpc,PCSHELL);CHKERRQ(ierr);
1788   ierr = PCShellSetContext(newpc,fetidppc_ctx);CHKERRQ(ierr);
1789   ierr = PCShellSetApply(newpc,FETIDPPCApply);CHKERRQ(ierr);
1790   ierr = PCShellSetApplyTranspose(newpc,FETIDPPCApplyTranspose);CHKERRQ(ierr);
1791   ierr = PCShellSetDestroy(newpc,PCBDDCDestroyFETIDPPC);CHKERRQ(ierr);
1792   ierr = PCSetOperators(newpc,newmat,newmat);CHKERRQ(ierr);
1793   ierr = PCSetUp(newpc);CHKERRQ(ierr);
1794   /* return pointers for objects created */
1795   *fetidp_mat=newmat;
1796   *fetidp_pc=newpc;
1797   PetscFunctionReturn(0);
1798 }
1799 
1800 #undef __FUNCT__
1801 #define __FUNCT__ "PCBDDCCreateFETIDPOperators"
1802 /*@
1803  PCBDDCCreateFETIDPOperators - Create operators for FETIDP
1804 
1805    Collective
1806 
1807    Input Parameters:
1808 +  pc - the BDDC preconditioning context already setup
1809 
1810    Output Parameters:
1811 .  fetidp_mat - shell FETIDP matrix object
1812 .  fetidp_pc  - shell Dirichlet preconditioner for FETIDP matrix
1813 
1814    Options Database Keys:
1815 -    -fetidp_fullyredundant: use or not a fully redundant set of Lagrange multipliers
1816 
1817    Level: developer
1818 
1819    Notes:
1820      Currently the only operation provided for FETIDP matrix is MatMult
1821 
1822 .seealso: PCBDDC
1823 @*/
1824 PetscErrorCode PCBDDCCreateFETIDPOperators(PC pc, Mat *fetidp_mat, PC *fetidp_pc)
1825 {
1826   PetscErrorCode ierr;
1827 
1828   PetscFunctionBegin;
1829   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1830   if (pc->setupcalled) {
1831     ierr = PetscUseMethod(pc,"PCBDDCCreateFETIDPOperators_C",(PC,Mat*,PC*),(pc,fetidp_mat,fetidp_pc));CHKERRQ(ierr);
1832   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You must call PCSetup_BDDC() first \n");
1833   PetscFunctionReturn(0);
1834 }
1835 /* -------------------------------------------------------------------------- */
1836 /*MC
1837    PCBDDC - Balancing Domain Decomposition by Constraints.
1838 
1839    An implementation of the BDDC preconditioner based on
1840 
1841 .vb
1842    [1] C. R. Dohrmann. "An approximate BDDC preconditioner", Numerical Linear Algebra with Applications Volume 14, Issue 2, pages 149-168, March 2007
1843    [2] A. Klawonn and O. B. Widlund. "Dual-Primal FETI Methods for Linear Elasticity", http://cs.nyu.edu/csweb/Research/TechReports/TR2004-855/TR2004-855.pdf
1844    [3] J. Mandel, B. Sousedik, C. R. Dohrmann. "Multispace and Multilevel BDDC", http://arxiv.org/abs/0712.3977
1845 .ve
1846 
1847    The matrix to be preconditioned (Pmat) must be of type MATIS.
1848 
1849    Currently works with MATIS matrices with local Neumann matrices of type MATSEQAIJ, MATSEQBAIJ or MATSEQSBAIJ, either with real or complex numbers.
1850 
1851    It also works with unsymmetric and indefinite problems.
1852 
1853    Unlike 'conventional' interface preconditioners, PCBDDC iterates over all degrees of freedom, not just those on the interface. This allows the use of approximate solvers on the subdomains.
1854 
1855    Approximate local solvers are automatically adapted for singular linear problems (see [1]) if the user has provided the nullspace using PCBDDCSetNullSpace
1856 
1857    Boundary nodes are split in vertices, edges and faces using information from the local to global mapping of dofs and the local connectivity graph of nodes. The latter can be customized by using PCBDDCSetLocalAdjacencyGraph()
1858 
1859    Constraints can be customized by attaching a MatNullSpace object to the MATIS matrix via MatSetNearNullSpace().
1860 
1861    Change of basis is performed similarly to [2] when requested. When more the one constraint is present on a single connected component (i.e. an edge or a face), a robust method based on local QR factorizations is used.
1862 
1863    The PETSc implementation also supports multilevel BDDC [3]. Coarse grids are partitioned using MatPartitioning object.
1864 
1865    Options Database Keys:
1866 
1867 .    -pc_bddc_use_vertices <1> - use or not vertices in primal space
1868 .    -pc_bddc_use_edges <1> - use or not edges in primal space
1869 .    -pc_bddc_use_faces <0> - use or not faces in primal space
1870 .    -pc_bddc_use_change_of_basis <0> - use change of basis approach (on edges only)
1871 .    -pc_bddc_use_change_on_faces <0> - use change of basis approach on faces if change of basis has been requested
1872 .    -pc_bddc_switch_static <0> - switches from M_2 to M_3 operator (see reference article [1])
1873 .    -pc_bddc_levels <0> - maximum number of levels for multilevel
1874 .    -pc_bddc_coarsening_ratio - H/h ratio at the coarser level
1875 -    -pc_bddc_check_level <0> - set verbosity level of debugging output
1876 
1877    Options for Dirichlet, Neumann or coarse solver can be set with
1878 .vb
1879       -pc_bddc_dirichlet_
1880       -pc_bddc_neumann_
1881       -pc_bddc_coarse_
1882 .ve
1883    e.g -pc_bddc_dirichlet_ksp_type richardson -pc_bddc_dirichlet_pc_type gamg
1884 
1885    When using a multilevel approach, solvers' options at the N-th level can be specified as
1886 .vb
1887       -pc_bddc_dirichlet_lN_
1888       -pc_bddc_neumann_lN_
1889       -pc_bddc_coarse_lN_
1890 .ve
1891    Note that level number ranges from the finest 0 to the coarsest N.
1892 
1893    Level: intermediate
1894 
1895    Developer notes:
1896 
1897    New deluxe scaling operator will be available soon.
1898 
1899    Contributed by Stefano Zampini
1900 
1901 .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,  MATIS
1902 M*/
1903 
1904 #undef __FUNCT__
1905 #define __FUNCT__ "PCCreate_BDDC"
1906 PETSC_EXTERN PetscErrorCode PCCreate_BDDC(PC pc)
1907 {
1908   PetscErrorCode      ierr;
1909   PC_BDDC             *pcbddc;
1910 
1911   PetscFunctionBegin;
1912   /* Creates the private data structure for this preconditioner and attach it to the PC object. */
1913   ierr      = PetscNewLog(pc,&pcbddc);CHKERRQ(ierr);
1914   pc->data  = (void*)pcbddc;
1915 
1916   /* create PCIS data structure */
1917   ierr = PCISCreate(pc);CHKERRQ(ierr);
1918 
1919   /* BDDC customization */
1920   pcbddc->use_local_adj       = PETSC_TRUE;
1921   pcbddc->use_vertices        = PETSC_TRUE;
1922   pcbddc->use_edges           = PETSC_TRUE;
1923   pcbddc->use_faces           = PETSC_FALSE;
1924   pcbddc->use_change_of_basis = PETSC_FALSE;
1925   pcbddc->use_change_on_faces = PETSC_FALSE;
1926   pcbddc->switch_static       = PETSC_FALSE;
1927   pcbddc->use_nnsp_true       = PETSC_FALSE;
1928   pcbddc->use_qr_single       = PETSC_FALSE;
1929   pcbddc->dbg_flag            = 0;
1930   /* private */
1931   pcbddc->issym                      = PETSC_FALSE;
1932   pcbddc->local_primal_size          = 0;
1933   pcbddc->n_vertices                 = 0;
1934   pcbddc->n_actual_vertices          = 0;
1935   pcbddc->n_constraints              = 0;
1936   pcbddc->primal_indices_local_idxs  = 0;
1937   pcbddc->recompute_topography       = PETSC_FALSE;
1938   pcbddc->coarse_size                = -1;
1939   pcbddc->new_primal_space           = PETSC_FALSE;
1940   pcbddc->new_primal_space_local     = PETSC_FALSE;
1941   pcbddc->global_primal_indices      = 0;
1942   pcbddc->onearnullspace             = 0;
1943   pcbddc->onearnullvecs_state        = 0;
1944   pcbddc->user_primal_vertices       = 0;
1945   pcbddc->NullSpace                  = 0;
1946   pcbddc->temp_solution              = 0;
1947   pcbddc->original_rhs               = 0;
1948   pcbddc->local_mat                  = 0;
1949   pcbddc->ChangeOfBasisMatrix        = 0;
1950   pcbddc->user_ChangeOfBasisMatrix   = 0;
1951   pcbddc->new_global_mat             = 0;
1952   pcbddc->coarse_vec                 = 0;
1953   pcbddc->coarse_ksp                 = 0;
1954   pcbddc->coarse_phi_B               = 0;
1955   pcbddc->coarse_phi_D               = 0;
1956   pcbddc->coarse_psi_B               = 0;
1957   pcbddc->coarse_psi_D               = 0;
1958   pcbddc->vec1_P                     = 0;
1959   pcbddc->vec1_R                     = 0;
1960   pcbddc->vec2_R                     = 0;
1961   pcbddc->local_auxmat1              = 0;
1962   pcbddc->local_auxmat2              = 0;
1963   pcbddc->R_to_B                     = 0;
1964   pcbddc->R_to_D                     = 0;
1965   pcbddc->ksp_D                      = 0;
1966   pcbddc->ksp_R                      = 0;
1967   pcbddc->NeumannBoundaries          = 0;
1968   pcbddc->NeumannBoundariesLocal     = 0;
1969   pcbddc->DirichletBoundaries        = 0;
1970   pcbddc->DirichletBoundariesLocal   = 0;
1971   pcbddc->user_provided_isfordofs    = PETSC_FALSE;
1972   pcbddc->n_ISForDofs                = 0;
1973   pcbddc->n_ISForDofsLocal           = 0;
1974   pcbddc->ISForDofs                  = 0;
1975   pcbddc->ISForDofsLocal             = 0;
1976   pcbddc->ConstraintMatrix           = 0;
1977   pcbddc->use_exact_dirichlet_trick  = PETSC_TRUE;
1978   pcbddc->coarse_loc_to_glob         = 0;
1979   pcbddc->coarsening_ratio           = 8;
1980   pcbddc->current_level              = 0;
1981   pcbddc->max_levels                 = 0;
1982   pcbddc->use_coarse_estimates       = PETSC_FALSE;
1983   pcbddc->redistribute_coarse        = 0;
1984   pcbddc->coarse_subassembling       = 0;
1985   pcbddc->coarse_subassembling_init  = 0;
1986 
1987   /* create local graph structure */
1988   ierr = PCBDDCGraphCreate(&pcbddc->mat_graph);CHKERRQ(ierr);
1989 
1990   /* scaling */
1991   pcbddc->work_scaling          = 0;
1992   pcbddc->use_deluxe_scaling    = PETSC_FALSE;
1993 
1994   /* create sub schurs structure */
1995   ierr = PCBDDCSubSchursCreate(&pcbddc->sub_schurs);CHKERRQ(ierr);
1996   pcbddc->sub_schurs_threshold   = -1;
1997   pcbddc->sub_schurs_rebuild     = PETSC_FALSE;
1998   pcbddc->sub_schurs_layers      = -1;
1999   pcbddc->sub_schurs_use_useradj = PETSC_FALSE;
2000 
2001   pcbddc->computed_rowadj = PETSC_FALSE;
2002 
2003   /* adaptivity */
2004   pcbddc->adaptive_threshold      = -1.0;
2005   pcbddc->adaptive_invert_Stildas = PETSC_TRUE;
2006   pcbddc->adaptive_nmax           = 0;
2007   pcbddc->adaptive_nmin           = -1;
2008 
2009   /* function pointers */
2010   pc->ops->apply               = PCApply_BDDC;
2011   pc->ops->applytranspose      = PCApplyTranspose_BDDC;
2012   pc->ops->setup               = PCSetUp_BDDC;
2013   pc->ops->destroy             = PCDestroy_BDDC;
2014   pc->ops->setfromoptions      = PCSetFromOptions_BDDC;
2015   pc->ops->view                = 0;
2016   pc->ops->applyrichardson     = 0;
2017   pc->ops->applysymmetricleft  = 0;
2018   pc->ops->applysymmetricright = 0;
2019   pc->ops->presolve            = PCPreSolve_BDDC;
2020   pc->ops->postsolve           = PCPostSolve_BDDC;
2021 
2022   /* composing function */
2023   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetChangeOfBasisMat_C",PCBDDCSetChangeOfBasisMat_BDDC);CHKERRQ(ierr);
2024   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetPrimalVerticesLocalIS_C",PCBDDCSetPrimalVerticesLocalIS_BDDC);CHKERRQ(ierr);
2025   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetCoarseningRatio_C",PCBDDCSetCoarseningRatio_BDDC);CHKERRQ(ierr);
2026   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetLevel_C",PCBDDCSetLevel_BDDC);CHKERRQ(ierr);
2027   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetUseExactDirichlet_C",PCBDDCSetUseExactDirichlet_BDDC);CHKERRQ(ierr);
2028   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetLevels_C",PCBDDCSetLevels_BDDC);CHKERRQ(ierr);
2029   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetNullSpace_C",PCBDDCSetNullSpace_BDDC);CHKERRQ(ierr);
2030   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDirichletBoundaries_C",PCBDDCSetDirichletBoundaries_BDDC);CHKERRQ(ierr);
2031   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDirichletBoundariesLocal_C",PCBDDCSetDirichletBoundariesLocal_BDDC);CHKERRQ(ierr);
2032   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetNeumannBoundaries_C",PCBDDCSetNeumannBoundaries_BDDC);CHKERRQ(ierr);
2033   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetNeumannBoundariesLocal_C",PCBDDCSetNeumannBoundariesLocal_BDDC);CHKERRQ(ierr);
2034   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetDirichletBoundaries_C",PCBDDCGetDirichletBoundaries_BDDC);CHKERRQ(ierr);
2035   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetDirichletBoundariesLocal_C",PCBDDCGetDirichletBoundariesLocal_BDDC);CHKERRQ(ierr);
2036   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetNeumannBoundaries_C",PCBDDCGetNeumannBoundaries_BDDC);CHKERRQ(ierr);
2037   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCGetNeumannBoundariesLocal_C",PCBDDCGetNeumannBoundariesLocal_BDDC);CHKERRQ(ierr);
2038   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDofsSplitting_C",PCBDDCSetDofsSplitting_BDDC);CHKERRQ(ierr);
2039   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetDofsSplittingLocal_C",PCBDDCSetDofsSplittingLocal_BDDC);CHKERRQ(ierr);
2040   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCSetLocalAdjacencyGraph_C",PCBDDCSetLocalAdjacencyGraph_BDDC);CHKERRQ(ierr);
2041   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCCreateFETIDPOperators_C",PCBDDCCreateFETIDPOperators_BDDC);CHKERRQ(ierr);
2042   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCMatFETIDPGetRHS_C",PCBDDCMatFETIDPGetRHS_BDDC);CHKERRQ(ierr);
2043   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCBDDCMatFETIDPGetSolution_C",PCBDDCMatFETIDPGetSolution_BDDC);CHKERRQ(ierr);
2044   PetscFunctionReturn(0);
2045 }
2046 
2047