GCC Code Coverage Report

Directory: ./
File: src/eps/tutorials/ex43.c
Date: 2025-10-04 04:19:13
Exec Total Coverage
Lines: 64 68 94.1%
Functions: 1 1 100.0%
Branches: 193 314 61.5%
Line Branch Exec Source
1 /*
2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3 SLEPc - Scalable Library for Eigenvalue Problem Computations
4 Copyright (c) 2002-, Universitat Politecnica de Valencia, Spain
5
6 This file is part of SLEPc.
7 SLEPc is distributed under a 2-clause BSD license (see LICENSE).
8 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
9 */
10
11 static char help[] = "Generalized eigenproblem, illustrates setting MUMPS options.\n\n"
12 "The problem is Ax = lambda Bx, with:\n"
13 " A = Laplacian operator in 2-D\n"
14 " B = diagonal matrix with all values equal to 4\n\n"
15 "The command line options are:\n"
16 " -n <n>, where <n> = number of grid subdivisions in x dimension.\n"
17 " -m <m>, where <m> = number of grid subdivisions in y dimension.\n\n";
18
19 #include <slepceps.h>
20
21 14 int main(int argc,char **argv)
22 {
23 14 Mat A,B;
24 #if defined(PETSC_HAVE_MUMPS)
25 6 Mat K;
26 #endif
27 14 EPS eps;
28 14 EPSType type;
29 14 ST st;
30 14 KSP ksp;
31 14 PC pc;
32 14 PetscInt N,n=10,m=12,Istart,Iend,II,nev,i,j;
33 14 PetscBool flag,terse;
34
35
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
 14 PetscFunctionBeginUser;
36
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(SlepcInitialize(&argc,&argv,NULL,help));
37
38
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PetscOptionsGetInt(NULL,NULL,"-n",&n,NULL));
39
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PetscOptionsGetInt(NULL,NULL,"-m",&m,&flag));
40 14 N = n*m;
41
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PetscPrintf(PETSC_COMM_WORLD,"\nGeneralized Eigenproblem, N=%" PetscInt_FMT " (%" PetscInt_FMT "x%" PetscInt_FMT " grid)\n\n",N,n,m));
42
43 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
44 Compute the matrices that define the eigensystem, Ax=kBx
45 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
46
47
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatCreate(PETSC_COMM_WORLD,&A));
48
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatSetSizes(A,PETSC_DECIDE,PETSC_DECIDE,N,N));
49
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatSetFromOptions(A));
50
51
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatCreate(PETSC_COMM_WORLD,&B));
52
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatSetSizes(B,PETSC_DECIDE,PETSC_DECIDE,N,N));
53
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatSetFromOptions(B));
54
55
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatGetOwnershipRange(A,&Istart,&Iend));
56
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
 1454 for (II=Istart;II<Iend;II++) {
57 1440 i = II/n; j = II-i*n;
58
6/8
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
 1440 if (i>0) PetscCall(MatSetValue(A,II,II-n,-1.0,INSERT_VALUES));
59
6/8
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
 1440 if (i<m-1) PetscCall(MatSetValue(A,II,II+n,-1.0,INSERT_VALUES));
60
6/8
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
 1440 if (j>0) PetscCall(MatSetValue(A,II,II-1,-1.0,INSERT_VALUES));
61
6/8
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
 1440 if (j<n-1) PetscCall(MatSetValue(A,II,II+1,-1.0,INSERT_VALUES));
62
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 1440 PetscCall(MatSetValue(A,II,II,4.0,INSERT_VALUES));
63
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 1440 PetscCall(MatSetValue(B,II,II,4.0,INSERT_VALUES));
64 }
65
66
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY));
67
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY));
68
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY));
69
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY));
70
71 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
72 Create the eigensolver and set various options
73 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
74
75 /*
76 Create eigensolver context
77 */
78
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSCreate(PETSC_COMM_WORLD,&eps));
79
80 /*
81 Set operators. In this case, it is a generalized eigenvalue problem
82 */
83
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSSetOperators(eps,A,B));
84
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSSetProblemType(eps,EPS_GNHEP));
85
86 /*
87 Set some solver options
88 */
89
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSSetTarget(eps,1.3));
90
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSSetDimensions(eps,2,PETSC_DETERMINE,PETSC_DETERMINE));
91
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSGetST(eps,&st));
92
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(STSetType(st,STSINVERT));
93
94
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(STGetKSP(st,&ksp));
95
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(KSPSetType(ksp,KSPPREONLY));
96
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(KSPGetPC(ksp,&pc));
97
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PCSetType(pc,PCLU));
98
99 /*
100 Set MUMPS options if available
101 */
102 #if defined(PETSC_HAVE_MUMPS)
103
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 6 PetscCall(PCFactorSetMatSolverType(pc,MATSOLVERMUMPS));
104 /* the next line is required to force the creation of the ST operator and its passing to KSP */
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 6 PetscCall(STGetOperator(st,NULL));
106
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 6 PetscCall(PCFactorSetUpMatSolverType(pc));
107
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 6 PetscCall(PCFactorGetMatrix(pc,&K));
108
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 6 PetscCall(MatMumpsSetIcntl(K,14,50));
109
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 6 PetscCall(MatMumpsSetCntl(K,3,1e-12));
110 #endif
111
112 /*
113 Let the user change settings at runtime
114 */
115
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSSetFromOptions(eps));
116
117 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
118 Solve the eigensystem
119 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
120
121
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSSolve(eps));
122
123 /*
124 Optional: Get some information from the solver and display it
125 */
126
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSGetType(eps,&type));
127
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PetscPrintf(PETSC_COMM_WORLD," Solution method: %s\n\n",type));
128
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSGetDimensions(eps,&nev,NULL,NULL));
129
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PetscPrintf(PETSC_COMM_WORLD," Number of requested eigenvalues: %" PetscInt_FMT "\n",nev));
130
131 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
132 Display solution and clean up
133 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
134
135 /* show detailed info unless -terse option is given by user */
136
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(PetscOptionsHasName(NULL,NULL,"-terse",&terse));
137
5/8
✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 8 times.
✓ Branch 4 taken 2 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 2 times.
 14 if (terse) PetscCall(EPSErrorView(eps,EPS_ERROR_RELATIVE,NULL));
138 else {
139 ✗ PetscCall(PetscViewerPushFormat(PETSC_VIEWER_STDOUT_WORLD,PETSC_VIEWER_ASCII_INFO_DETAIL));
140 ✗ PetscCall(EPSConvergedReasonView(eps,PETSC_VIEWER_STDOUT_WORLD));
141 ✗ PetscCall(EPSErrorView(eps,EPS_ERROR_RELATIVE,PETSC_VIEWER_STDOUT_WORLD));
142 ✗ PetscCall(PetscViewerPopFormat(PETSC_VIEWER_STDOUT_WORLD));
143 }
144
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(EPSDestroy(&eps));
145
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatDestroy(&A));
146
4/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 8 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
 14 PetscCall(MatDestroy(&B));
147
3/6
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 14 PetscCall(SlepcFinalize());
148 return 0;
149 }
150
151 /*TEST
152
153 testset:
154 args: -terse
155 output_file: output/ex43_1.out
156 test:
157 suffix: 1
158 test:
159 suffix: 2
160 nsize: 2
161 args: -st_pc_factor_mat_solver_type mumps
162 requires: mumps
163
164 TEST*/
165