1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
|
<!DOCTYPE html>
<html lang="en" data-content_root="../" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>slepc4py.SLEPc.ST — Python 3.24.1 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/css/slepc.css?v=d285b177" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=d1c46438"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'reference/slepc4py.SLEPc.ST';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="slepc4py.SLEPc.ST.FilterDamping" href="slepc4py.SLEPc.ST.FilterDamping.html" />
<link rel="prev" title="slepc4py.SLEPc.RG.Type" href="slepc4py.SLEPc.RG.Type.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="3.24" />
<meta name="docbuild:last-update" content="2025-11-07T09:28:35+0100 (v3.24.1)"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../index.html">
<p class="title logo__title">Python 3.24.1 documentation</p>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../overview.html">
Overview
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../tutorial.html">
Tutorial
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../install.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../citing.html">
Citations
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../reference.html">
Reference
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../demo/demo.html">
slepc4py demos
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../overview.html">
Overview
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../tutorial.html">
Tutorial
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../install.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../citing.html">
Citations
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../reference.html">
Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../demo/demo.html">
slepc4py demos
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="slepc4py.html">slepc4py</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.get_config.html">slepc4py.get_config</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.get_include.html">slepc4py.get_include</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.init.html">slepc4py.init</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="slepc4py.typing.html">slepc4py.typing</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.Scalar.html">slepc4py.typing.Scalar</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayInt.html">slepc4py.typing.ArrayInt</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayReal.html">slepc4py.typing.ArrayReal</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayComplex.html">slepc4py.typing.ArrayComplex</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayScalar.html">slepc4py.typing.ArrayScalar</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.LayoutSizeSpec.html">slepc4py.typing.LayoutSizeSpec</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSStoppingFunction.html">slepc4py.typing.EPSStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSArbitraryFunction.html">slepc4py.typing.EPSArbitraryFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSEigenvalueComparison.html">slepc4py.typing.EPSEigenvalueComparison</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSMonitorFunction.html">slepc4py.typing.EPSMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.PEPStoppingFunction.html">slepc4py.typing.PEPStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.PEPMonitorFunction.html">slepc4py.typing.PEPMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPStoppingFunction.html">slepc4py.typing.NEPStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPMonitorFunction.html">slepc4py.typing.NEPMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPFunction.html">slepc4py.typing.NEPFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPJacobian.html">slepc4py.typing.NEPJacobian</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.SVDStoppingFunction.html">slepc4py.typing.SVDStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.SVDMonitorFunction.html">slepc4py.typing.SVDMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.MFNMonitorFunction.html">slepc4py.typing.MFNMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.LMEMonitorFunction.html">slepc4py.typing.LMEMonitorFunction</a></li>
</ul>
</details></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="slepc4py.SLEPc.html">slepc4py.SLEPc</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.BV.html">slepc4py.SLEPc.BV</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.MatMultType.html">slepc4py.SLEPc.BV.MatMultType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogBlockType.html">slepc4py.SLEPc.BV.OrthogBlockType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html">slepc4py.SLEPc.BV.OrthogRefineType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html">slepc4py.SLEPc.BV.OrthogType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.Type.html">slepc4py.SLEPc.BV.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.BVSVDMethod.html">slepc4py.SLEPc.BVSVDMethod</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.DS.html">slepc4py.SLEPc.DS</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.MatType.html">slepc4py.SLEPc.DS.MatType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.ParallelType.html">slepc4py.SLEPc.DS.ParallelType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.StateType.html">slepc4py.SLEPc.DS.StateType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.Type.html">slepc4py.SLEPc.DS.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.EPS.html">slepc4py.SLEPc.EPS</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Balance.html">slepc4py.SLEPc.EPS.Balance</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.CISSExtraction.html">slepc4py.SLEPc.EPS.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.CISSQuadRule.html">slepc4py.SLEPc.EPS.CISSQuadRule</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Conv.html">slepc4py.SLEPc.EPS.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.ConvergedReason.html">slepc4py.SLEPc.EPS.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.ErrorType.html">slepc4py.SLEPc.EPS.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Extraction.html">slepc4py.SLEPc.EPS.Extraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.KrylovSchurBSEType.html">slepc4py.SLEPc.EPS.KrylovSchurBSEType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.LanczosReorthogType.html">slepc4py.SLEPc.EPS.LanczosReorthogType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.PowerShiftType.html">slepc4py.SLEPc.EPS.PowerShiftType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.ProblemType.html">slepc4py.SLEPc.EPS.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Stop.html">slepc4py.SLEPc.EPS.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Type.html">slepc4py.SLEPc.EPS.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Which.html">slepc4py.SLEPc.EPS.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.EPSKrylovSchurBSEType.html">slepc4py.SLEPc.EPSKrylovSchurBSEType</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.FN.html">slepc4py.SLEPc.FN</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.CombineType.html">slepc4py.SLEPc.FN.CombineType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.ParallelType.html">slepc4py.SLEPc.FN.ParallelType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.Type.html">slepc4py.SLEPc.FN.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.LME.html">slepc4py.SLEPc.LME</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.ConvergedReason.html">slepc4py.SLEPc.LME.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.ProblemType.html">slepc4py.SLEPc.LME.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.Type.html">slepc4py.SLEPc.LME.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.MFN.html">slepc4py.SLEPc.MFN</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.MFN.ConvergedReason.html">slepc4py.SLEPc.MFN.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.MFN.Type.html">slepc4py.SLEPc.MFN.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.NEP.html">slepc4py.SLEPc.NEP</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.CISSExtraction.html">slepc4py.SLEPc.NEP.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Conv.html">slepc4py.SLEPc.NEP.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ConvergedReason.html">slepc4py.SLEPc.NEP.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ErrorType.html">slepc4py.SLEPc.NEP.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ProblemType.html">slepc4py.SLEPc.NEP.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Refine.html">slepc4py.SLEPc.NEP.Refine</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.RefineScheme.html">slepc4py.SLEPc.NEP.RefineScheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Stop.html">slepc4py.SLEPc.NEP.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Type.html">slepc4py.SLEPc.NEP.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Which.html">slepc4py.SLEPc.NEP.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.PEP.html">slepc4py.SLEPc.PEP</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Basis.html">slepc4py.SLEPc.PEP.Basis</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.CISSExtraction.html">slepc4py.SLEPc.PEP.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Conv.html">slepc4py.SLEPc.PEP.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ConvergedReason.html">slepc4py.SLEPc.PEP.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ErrorType.html">slepc4py.SLEPc.PEP.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Extract.html">slepc4py.SLEPc.PEP.Extract</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.JDProjection.html">slepc4py.SLEPc.PEP.JDProjection</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ProblemType.html">slepc4py.SLEPc.PEP.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Refine.html">slepc4py.SLEPc.PEP.Refine</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html">slepc4py.SLEPc.PEP.RefineScheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html">slepc4py.SLEPc.PEP.Scale</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Stop.html">slepc4py.SLEPc.PEP.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Type.html">slepc4py.SLEPc.PEP.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Which.html">slepc4py.SLEPc.PEP.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.RG.html">slepc4py.SLEPc.RG</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.RG.QuadRule.html">slepc4py.SLEPc.RG.QuadRule</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.RG.Type.html">slepc4py.SLEPc.RG.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 current active has-children"><a class="current reference internal" href="#">slepc4py.SLEPc.ST</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html">slepc4py.SLEPc.ST.FilterDamping</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html">slepc4py.SLEPc.ST.FilterType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html">slepc4py.SLEPc.ST.MatMode</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.Type.html">slepc4py.SLEPc.ST.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.STFilterDamping.html">slepc4py.SLEPc.STFilterDamping</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.STFilterType.html">slepc4py.SLEPc.STFilterType</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.SVD.html">slepc4py.SLEPc.SVD</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Conv.html">slepc4py.SLEPc.SVD.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ConvergedReason.html">slepc4py.SLEPc.SVD.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ErrorType.html">slepc4py.SLEPc.SVD.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ProblemType.html">slepc4py.SLEPc.SVD.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Stop.html">slepc4py.SLEPc.SVD.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.TRLanczosGBidiag.html">slepc4py.SLEPc.SVD.TRLanczosGBidiag</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Type.html">slepc4py.SLEPc.SVD.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Which.html">slepc4py.SLEPc.SVD.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.Sys.html">slepc4py.SLEPc.Sys</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.Util.html">slepc4py.SLEPc.Util</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DECIDE.html">slepc4py.SLEPc.DECIDE</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DEFAULT.html">slepc4py.SLEPc.DEFAULT</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DETERMINE.html">slepc4py.SLEPc.DETERMINE</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.CURRENT.html">slepc4py.SLEPc.CURRENT</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="../reference.html" class="nav-link">Reference</a></li>
<li class="breadcrumb-item"><a href="slepc4py.SLEPc.html" class="nav-link">slepc4py.SLEPc</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">slepc4py.SLEPc.ST</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="slepc4py-slepc-st">
<h1>slepc4py.SLEPc.ST<a class="headerlink" href="#slepc4py-slepc-st" title="Link to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">slepc4py.SLEPc.</span></span><span class="sig-name descname"><span class="pre">ST</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Object.html#petsc4py.PETSc.Object" title="(in Python v3.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Object</span></code></a></p>
<p>ST.</p>
<p class="rubric">Enumerations</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html#slepc4py.SLEPc.ST.FilterDamping" title="slepc4py.SLEPc.ST.FilterDamping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FilterDamping</span></code></a></p></td>
<td><p>ST filter damping.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType" title="slepc4py.SLEPc.ST.FilterType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FilterType</span></code></a></p></td>
<td><p>ST filter type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode" title="slepc4py.SLEPc.ST.MatMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MatMode</span></code></a></p></td>
<td><p>ST matrix mode.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type" title="slepc4py.SLEPc.ST.Type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Type</span></code></a></p></td>
<td><p>ST types.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Methods Summary</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.appendOptionsPrefix" title="slepc4py.SLEPc.ST.appendOptionsPrefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">appendOptionsPrefix</span></code></a>([prefix])</p></td>
<td><p>Append to the prefix used for searching for all ST options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply</span></code></a>(x, y)</p></td>
<td><p>Apply the spectral transformation operator to a vector.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyHermitianTranspose" title="slepc4py.SLEPc.ST.applyHermitianTranspose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyHermitianTranspose</span></code></a>(x, y)</p></td>
<td><p>Apply the hermitian-transpose of the operator to a vector.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyMat" title="slepc4py.SLEPc.ST.applyMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyMat</span></code></a>(x, y)</p></td>
<td><p>Apply the spectral transformation operator to a matrix.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyTranspose" title="slepc4py.SLEPc.ST.applyTranspose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyTranspose</span></code></a>(x, y)</p></td>
<td><p>Apply the transpose of the operator to a vector.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.create" title="slepc4py.SLEPc.ST.create"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create</span></code></a>([comm])</p></td>
<td><p>Create the ST object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.destroy" title="slepc4py.SLEPc.ST.destroy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">destroy</span></code></a>()</p></td>
<td><p>Destroy the ST object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getCayleyAntishift" title="slepc4py.SLEPc.ST.getCayleyAntishift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCayleyAntishift</span></code></a>()</p></td>
<td><p>Get the value of the anti-shift for the Cayley spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterDamping" title="slepc4py.SLEPc.ST.getFilterDamping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterDamping</span></code></a>()</p></td>
<td><p>Get the type of damping used in the polynomial filter.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterDegree" title="slepc4py.SLEPc.ST.getFilterDegree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterDegree</span></code></a>()</p></td>
<td><p>Get the degree of the filter polynomial.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterInterval" title="slepc4py.SLEPc.ST.getFilterInterval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterInterval</span></code></a>()</p></td>
<td><p>Get the interval containing the desired eigenvalues.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterRange" title="slepc4py.SLEPc.ST.getFilterRange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterRange</span></code></a>()</p></td>
<td><p>Get the interval containing all eigenvalues.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterType" title="slepc4py.SLEPc.ST.getFilterType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterType</span></code></a>()</p></td>
<td><p>Get the method to be used to build the polynomial filter.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getKSP" title="slepc4py.SLEPc.ST.getKSP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getKSP</span></code></a>()</p></td>
<td><p>Get the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatMode" title="slepc4py.SLEPc.ST.getMatMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatMode</span></code></a>()</p></td>
<td><p>Get a flag that indicates how the matrix is being shifted.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatStructure" title="slepc4py.SLEPc.ST.getMatStructure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatStructure</span></code></a>()</p></td>
<td><p>Get the internal Mat.Structure attribute.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatrices" title="slepc4py.SLEPc.ST.getMatrices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatrices</span></code></a>()</p></td>
<td><p>Get the matrices associated with the eigenvalue problem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getOperator" title="slepc4py.SLEPc.ST.getOperator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOperator</span></code></a>()</p></td>
<td><p>Get a shell matrix that represents the operator of the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getOptionsPrefix" title="slepc4py.SLEPc.ST.getOptionsPrefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOptionsPrefix</span></code></a>()</p></td>
<td><p>Get the prefix used for searching for all ST options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getPreconditionerMat" title="slepc4py.SLEPc.ST.getPreconditionerMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getPreconditionerMat</span></code></a>()</p></td>
<td><p>Get the matrix previously set by setPreconditionerMat().</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getShift" title="slepc4py.SLEPc.ST.getShift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getShift</span></code></a>()</p></td>
<td><p>Get the shift associated with the spectral transformation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getSplitPreconditioner" title="slepc4py.SLEPc.ST.getSplitPreconditioner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSplitPreconditioner</span></code></a>()</p></td>
<td><p>Get the matrices to be used to build the preconditioner.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getTransform" title="slepc4py.SLEPc.ST.getTransform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTransform</span></code></a>()</p></td>
<td><p>Get the flag indicating whether the transformed matrices are computed or not.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getType" title="slepc4py.SLEPc.ST.getType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getType</span></code></a>()</p></td>
<td><p>Get the ST type of this object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.reset" title="slepc4py.SLEPc.ST.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td>
<td><p>Reset the ST object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.restoreOperator" title="slepc4py.SLEPc.ST.restoreOperator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">restoreOperator</span></code></a>(op)</p></td>
<td><p>Restore the previously seized operator matrix.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setCayleyAntishift" title="slepc4py.SLEPc.ST.setCayleyAntishift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCayleyAntishift</span></code></a>(tau)</p></td>
<td><p>Set the value of the anti-shift for the Cayley spectral transformation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterDamping" title="slepc4py.SLEPc.ST.setFilterDamping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterDamping</span></code></a>(damping)</p></td>
<td><p>Set the type of damping to be used in the polynomial filter.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterDegree" title="slepc4py.SLEPc.ST.setFilterDegree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterDegree</span></code></a>(deg)</p></td>
<td><p>Set the degree of the filter polynomial.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterInterval" title="slepc4py.SLEPc.ST.setFilterInterval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterInterval</span></code></a>(inta, intb)</p></td>
<td><p>Set the interval containing the desired eigenvalues.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterRange" title="slepc4py.SLEPc.ST.setFilterRange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterRange</span></code></a>(left, right)</p></td>
<td><p>Set the numerical range (or field of values) of the matrix.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterType" title="slepc4py.SLEPc.ST.setFilterType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterType</span></code></a>(filter_type)</p></td>
<td><p>Set the method to be used to build the polynomial filter.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFromOptions" title="slepc4py.SLEPc.ST.setFromOptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFromOptions</span></code></a>()</p></td>
<td><p>Set ST options from the options database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setKSP" title="slepc4py.SLEPc.ST.setKSP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setKSP</span></code></a>(ksp)</p></td>
<td><p>Set the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatMode" title="slepc4py.SLEPc.ST.setMatMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatMode</span></code></a>(mode)</p></td>
<td><p>Set a flag to indicate how the matrix is being shifted.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatStructure</span></code></a>(structure)</p></td>
<td><p>Set an internal Mat.Structure attribute.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatrices</span></code></a>(operators)</p></td>
<td><p>Set the matrices associated with the eigenvalue problem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="slepc4py.SLEPc.ST.setOptionsPrefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setOptionsPrefix</span></code></a>([prefix])</p></td>
<td><p>Set the prefix used for searching for all ST options in the database.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPreconditionerMat</span></code></a>([P])</p></td>
<td><p>Set the matrix to be used to build the preconditioner.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setShift</span></code></a>(shift)</p></td>
<td><p>Set the shift associated with the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setSplitPreconditioner" title="slepc4py.SLEPc.ST.setSplitPreconditioner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSplitPreconditioner</span></code></a>(operators[, structure])</p></td>
<td><p>Set the matrices to be used to build the preconditioner.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setTransform" title="slepc4py.SLEPc.ST.setTransform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTransform</span></code></a>([flag])</p></td>
<td><p>Set a flag to indicate whether the transformed matrices are computed or not.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setType" title="slepc4py.SLEPc.ST.setType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setType</span></code></a>(st_type)</p></td>
<td><p>Set the particular spectral transformation to be used.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setUp</span></code></a>()</p></td>
<td><p>Prepare for the use of a spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.view" title="slepc4py.SLEPc.ST.view"><code class="xref py py-obj docutils literal notranslate"><span class="pre">view</span></code></a>([viewer])</p></td>
<td><p>Print the ST data structure.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Attributes Summary</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.ksp" title="slepc4py.SLEPc.ST.ksp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ksp</span></code></a></p></td>
<td><p>KSP object associated with the spectral transformation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.mat_mode" title="slepc4py.SLEPc.ST.mat_mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mat_mode</span></code></a></p></td>
<td><p>How the transformed matrices are being stored in the ST.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.mat_structure" title="slepc4py.SLEPc.ST.mat_structure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mat_structure</span></code></a></p></td>
<td><p>Relation of the sparsity pattern of all ST matrices.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.shift" title="slepc4py.SLEPc.ST.shift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shift</span></code></a></p></td>
<td><p>Value of the shift.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.transform" title="slepc4py.SLEPc.ST.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transform</span></code></a></p></td>
<td><p>If the transformed matrices are computed.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Methods Documentation</p>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.appendOptionsPrefix">
<span class="sig-name descname"><span class="pre">appendOptionsPrefix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.appendOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Append to the prefix used for searching for all ST options in the database.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The prefix string to prepend to all ST option requests.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L198">Source code at slepc4py/SLEPc/ST.pyx:198</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.apply">
<span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.apply" title="Link to this definition">#</a></dt>
<dd><p>Apply the spectral transformation operator to a vector.</p>
<p>Collective.</p>
<p>Apply the spectral transformation operator to a vector, for instance
<span class="math notranslate nohighlight">\((A - s B)^{-1} B\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L563">Source code at slepc4py/SLEPc/ST.pyx:563</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.applyHermitianTranspose">
<span class="sig-name descname"><span class="pre">applyHermitianTranspose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.applyHermitianTranspose" title="Link to this definition">#</a></dt>
<dd><p>Apply the hermitian-transpose of the operator to a vector.</p>
<p>Collective.</p>
<p>Apply the hermitian-transpose of the operator to a vector, for instance
<span class="math notranslate nohighlight">\(B^H(A - s B)^{-H}\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L601">Source code at slepc4py/SLEPc/ST.pyx:601</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.applyMat">
<span class="sig-name descname"><span class="pre">applyMat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.applyMat" title="Link to this definition">#</a></dt>
<dd><p>Apply the spectral transformation operator to a matrix.</p>
<p>Collective.</p>
<p>Apply the spectral transformation operator to a matrix, for instance
<span class="math notranslate nohighlight">\((A - s B)^{-1} B\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The input matrix.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The result matrix.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L620">Source code at slepc4py/SLEPc/ST.pyx:620</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.applyTranspose">
<span class="sig-name descname"><span class="pre">applyTranspose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.applyTranspose" title="Link to this definition">#</a></dt>
<dd><p>Apply the transpose of the operator to a vector.</p>
<p>Collective.</p>
<p>Apply the transpose of the operator to a vector, for instance
<span class="math notranslate nohighlight">\(B^T(A - s B)^{-T}\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L582">Source code at slepc4py/SLEPc/ST.pyx:582</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.create" title="Link to this definition">#</a></dt>
<dd><p>Create the ST object.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>comm</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Comm.html#petsc4py.PETSc.Comm" title="(in Python v3.24)"><em>Comm</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – MPI communicator; if not provided, it defaults to all processes.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.14)"><em>Self</em></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L106">Source code at slepc4py/SLEPc/ST.pyx:106</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.destroy">
<span class="sig-name descname"><span class="pre">destroy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.destroy" title="Link to this definition">#</a></dt>
<dd><p>Destroy the ST object.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L88">Source code at slepc4py/SLEPc/ST.pyx:88</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.14)"><em>Self</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getCayleyAntishift">
<span class="sig-name descname"><span class="pre">getCayleyAntishift</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getCayleyAntishift" title="Link to this definition">#</a></dt>
<dd><p>Get the value of the anti-shift for the Cayley spectral transformation.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The anti-shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><code class="xref any py py-data docutils literal notranslate"><span class="pre">Scalar</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L692">Source code at slepc4py/SLEPc/ST.pyx:692</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterDamping">
<span class="sig-name descname"><span class="pre">getFilterDamping</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterDamping" title="Link to this definition">#</a></dt>
<dd><p>Get the type of damping used in the polynomial filter.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The type of damping.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html#slepc4py.SLEPc.ST.FilterDamping" title="slepc4py.SLEPc.ST.FilterDamping"><code class="xref any py py-class docutils literal notranslate"><span class="pre">FilterDamping</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L870">Source code at slepc4py/SLEPc/ST.pyx:870</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterDegree">
<span class="sig-name descname"><span class="pre">getFilterDegree</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterDegree" title="Link to this definition">#</a></dt>
<dd><p>Get the degree of the filter polynomial.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The polynomial degree.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L841">Source code at slepc4py/SLEPc/ST.pyx:841</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterInterval">
<span class="sig-name descname"><span class="pre">getFilterInterval</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterInterval" title="Link to this definition">#</a></dt>
<dd><p>Get the interval containing the desired eigenvalues.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><strong>inta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The left end of the interval.</p></li>
<li><p><strong>intb</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The right end of the interval.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L765">Source code at slepc4py/SLEPc/ST.pyx:765</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterRange">
<span class="sig-name descname"><span class="pre">getFilterRange</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterRange" title="Link to this definition">#</a></dt>
<dd><p>Get the interval containing all eigenvalues.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><strong>left</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The left end of the interval.</p></li>
<li><p><strong>right</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The right end of the interval.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L809">Source code at slepc4py/SLEPc/ST.pyx:809</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterType">
<span class="sig-name descname"><span class="pre">getFilterType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterType" title="Link to this definition">#</a></dt>
<dd><p>Get the method to be used to build the polynomial filter.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The type of filter.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType" title="slepc4py.SLEPc.ST.FilterType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">FilterType</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L721">Source code at slepc4py/SLEPc/ST.pyx:721</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getKSP">
<span class="sig-name descname"><span class="pre">getKSP</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getKSP" title="Link to this definition">#</a></dt>
<dd><p>Get the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The linear solver object.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.KSP.html#petsc4py.PETSc.KSP" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.KSP</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>On output, the internal value of <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.KSP.html#petsc4py.PETSc.KSP" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.KSP</span></code></a> can be <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if the
combination of eigenproblem type and selected transformation
does not require to solve a linear system of equations.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L458">Source code at slepc4py/SLEPc/ST.pyx:458</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getMatMode">
<span class="sig-name descname"><span class="pre">getMatMode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getMatMode" title="Link to this definition">#</a></dt>
<dd><p>Get a flag that indicates how the matrix is being shifted.</p>
<p>Not collective.</p>
<p>Get a flag that indicates how the matrix is being shifted in
the shift-and-invert and Cayley spectral transformations.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The mode flag.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode" title="slepc4py.SLEPc.ST.MatMode"><code class="xref any py py-class docutils literal notranslate"><span class="pre">MatMode</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L342">Source code at slepc4py/SLEPc/ST.pyx:342</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getMatStructure">
<span class="sig-name descname"><span class="pre">getMatStructure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getMatStructure" title="Link to this definition">#</a></dt>
<dd><p>Get the internal Mat.Structure attribute.</p>
<p>Not collective.</p>
<p>Get the internal Mat.Structure attribute to indicate which is
the relation of the sparsity pattern of the matrices.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The structure flag.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat.Structure</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L427">Source code at slepc4py/SLEPc/ST.pyx:427</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getMatrices">
<span class="sig-name descname"><span class="pre">getMatrices</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getMatrices" title="Link to this definition">#</a></dt>
<dd><p>Get the matrices associated with the eigenvalue problem.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The matrices associated with the eigensystem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L378">Source code at slepc4py/SLEPc/ST.pyx:378</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getOperator">
<span class="sig-name descname"><span class="pre">getOperator</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getOperator" title="Link to this definition">#</a></dt>
<dd><p>Get a shell matrix that represents the operator of the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Operator matrix.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L639">Source code at slepc4py/SLEPc/ST.pyx:639</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getOptionsPrefix">
<span class="sig-name descname"><span class="pre">getOptionsPrefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Get the prefix used for searching for all ST options in the database.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The prefix string set for this ST object.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L183">Source code at slepc4py/SLEPc/ST.pyx:183</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getPreconditionerMat">
<span class="sig-name descname"><span class="pre">getPreconditionerMat</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getPreconditionerMat" title="Link to this definition">#</a></dt>
<dd><p>Get the matrix previously set by setPreconditionerMat().</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The matrix that will be used in constructing the preconditioner.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L494">Source code at slepc4py/SLEPc/ST.pyx:494</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getShift">
<span class="sig-name descname"><span class="pre">getShift</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getShift" title="Link to this definition">#</a></dt>
<dd><p>Get the shift associated with the spectral transformation.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The value of the shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><code class="xref any py py-data docutils literal notranslate"><span class="pre">Scalar</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L250">Source code at slepc4py/SLEPc/ST.pyx:250</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getSplitPreconditioner">
<span class="sig-name descname"><span class="pre">getSplitPreconditioner</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getSplitPreconditioner" title="Link to this definition">#</a></dt>
<dd><p>Get the matrices to be used to build the preconditioner.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a> – The list of matrices associated with the preconditioner.</p></li>
<li><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat.Structure</span></code></a> – The structure flag.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)">list</a>[<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)">petsc4py.PETSc.Mat</a>], <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in Python v3.24)">petsc4py.PETSc.Mat.Structure</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L529">Source code at slepc4py/SLEPc/ST.pyx:529</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getTransform">
<span class="sig-name descname"><span class="pre">getTransform</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getTransform" title="Link to this definition">#</a></dt>
<dd><p>Get the flag indicating whether the transformed matrices are computed or not.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>This flag is intended for the case of polynomial
eigenproblems solved via linearization.
If this flag is False (default) the spectral transformation
is applied to the linearization (handled by the eigensolver),
otherwise it is applied to the original problem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L283">Source code at slepc4py/SLEPc/ST.pyx:283</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getType">
<span class="sig-name descname"><span class="pre">getType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getType" title="Link to this definition">#</a></dt>
<dd><p>Get the ST type of this object.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The spectral transformation currently being used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L147">Source code at slepc4py/SLEPc/ST.pyx:147</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.reset">
<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.reset" title="Link to this definition">#</a></dt>
<dd><p>Reset the ST object.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L98">Source code at slepc4py/SLEPc/ST.pyx:98</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.restoreOperator">
<span class="sig-name descname"><span class="pre">restoreOperator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.restoreOperator" title="Link to this definition">#</a></dt>
<dd><p>Restore the previously seized operator matrix.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>op</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – Operator matrix previously obtained with getOperator().</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L655">Source code at slepc4py/SLEPc/ST.pyx:655</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setCayleyAntishift">
<span class="sig-name descname"><span class="pre">setCayleyAntishift</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tau</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setCayleyAntishift" title="Link to this definition">#</a></dt>
<dd><p>Set the value of the anti-shift for the Cayley spectral transformation.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>tau</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – The anti-shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>In the generalized Cayley transform, the operator can be expressed as
<span class="math notranslate nohighlight">\(OP = inv(A - \sigma B) (A + tau B)\)</span>. This function sets
the value of <span class="math notranslate nohighlight">\(tau\)</span>. Use <a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setShift()</span></code></a> for setting
<span class="math notranslate nohighlight">\(\sigma\)</span>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L671">Source code at slepc4py/SLEPc/ST.pyx:671</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterDamping">
<span class="sig-name descname"><span class="pre">setFilterDamping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">damping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterDamping" title="Link to this definition">#</a></dt>
<dd><p>Set the type of damping to be used in the polynomial filter.</p>
<p>Logically collective.</p>
<section id="parameter">
<h2>Parameter<a class="headerlink" href="#parameter" title="Link to this heading">#</a></h2>
<dl class="simple">
<dt>damping</dt><dd><p>The type of damping.</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L856">Source code at slepc4py/SLEPc/ST.pyx:856</a></p>
</section>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>damping</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html#slepc4py.SLEPc.ST.FilterDamping" title="slepc4py.SLEPc.ST.FilterDamping"><em>FilterDamping</em></a>)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterDegree">
<span class="sig-name descname"><span class="pre">setFilterDegree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterDegree" title="Link to this definition">#</a></dt>
<dd><p>Set the degree of the filter polynomial.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>deg</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The polynomial degree.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L827">Source code at slepc4py/SLEPc/ST.pyx:827</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterInterval">
<span class="sig-name descname"><span class="pre">setFilterInterval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intb</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterInterval" title="Link to this definition">#</a></dt>
<dd><p>Set the interval containing the desired eigenvalues.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The left end of the interval.</p></li>
<li><p><strong>intb</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The right end of the interval.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The filter will be configured to emphasize eigenvalues contained
in the given interval, and damp out eigenvalues outside it. If the
interval is open, then the filter is low- or high-pass, otherwise
it is mid-pass.</p>
<p>Common usage is to set the interval in <a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS" title="slepc4py.SLEPc.EPS"><code class="xref any py py-class docutils literal notranslate"><span class="pre">EPS</span></code></a> with <a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS.setInterval" title="slepc4py.SLEPc.EPS.setInterval"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">EPS.setInterval()</span></code></a>.</p>
<p>The interval must be contained within the numerical range of the
matrix, see <a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterRange" title="slepc4py.SLEPc.ST.setFilterRange"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">ST.setFilterRange()</span></code></a>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L736">Source code at slepc4py/SLEPc/ST.pyx:736</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterRange">
<span class="sig-name descname"><span class="pre">setFilterRange</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">left</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterRange" title="Link to this definition">#</a></dt>
<dd><p>Set the numerical range (or field of values) of the matrix.</p>
<p>Logically collective.</p>
<p>Set the numerical range (or field of values) of the matrix, that is,
the interval containing all eigenvalues.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>left</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The left end of the interval.</p></li>
<li><p><strong>right</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The right end of the interval.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The filter will be most effective if the numerical range is tight,
that is, left and right are good approximations to the leftmost and
rightmost eigenvalues, respectively.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L783">Source code at slepc4py/SLEPc/ST.pyx:783</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterType">
<span class="sig-name descname"><span class="pre">setFilterType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterType" title="Link to this definition">#</a></dt>
<dd><p>Set the method to be used to build the polynomial filter.</p>
<p>Logically collective.</p>
<section id="id1">
<h2>Parameter<a class="headerlink" href="#id1" title="Link to this heading">#</a></h2>
<dl class="simple">
<dt>filter_type</dt><dd><p>The type of filter.</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L707">Source code at slepc4py/SLEPc/ST.pyx:707</a></p>
</section>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType" title="slepc4py.SLEPc.ST.FilterType"><em>FilterType</em></a>)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFromOptions">
<span class="sig-name descname"><span class="pre">setFromOptions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFromOptions" title="Link to this definition">#</a></dt>
<dd><p>Set ST options from the options database.</p>
<p>Collective.</p>
<p>This routine must be called before <a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp()</span></code></a> if the user is to be
allowed to set the solver type.</p>
<p class="rubric">Notes</p>
<p>To see all options, run your program with the -help option.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L213">Source code at slepc4py/SLEPc/ST.pyx:213</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setKSP">
<span class="sig-name descname"><span class="pre">setKSP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ksp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setKSP" title="Link to this definition">#</a></dt>
<dd><p>Set the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>petsc4py.PETSc.KSP</strong> – The linear solver object.</p></li>
<li><p><strong>ksp</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.KSP.html#petsc4py.PETSc.KSP" title="(in Python v3.24)"><em>petsc4py.PETSc.KSP</em></a>)</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L445">Source code at slepc4py/SLEPc/ST.pyx:445</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setMatMode">
<span class="sig-name descname"><span class="pre">setMatMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setMatMode" title="Link to this definition">#</a></dt>
<dd><p>Set a flag to indicate how the matrix is being shifted.</p>
<p>Logically collective.</p>
<p>Set a flag to indicate how the matrix is being shifted in the
shift-and-invert and Cayley spectral transformations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode" title="slepc4py.SLEPc.ST.MatMode"><em>MatMode</em></a>) – The mode flag.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>By default (<a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode.COPY" title="slepc4py.SLEPc.ST.MatMode.COPY"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.MatMode.COPY</span></code></a>), a copy of matrix <span class="math notranslate nohighlight">\(A\)</span> is made
and then this copy is shifted explicitly, e.g.
<span class="math notranslate nohighlight">\(A \leftarrow (A - s B)\)</span>.</p>
<p>With <a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode.INPLACE" title="slepc4py.SLEPc.ST.MatMode.INPLACE"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.MatMode.INPLACE</span></code></a>, the original matrix <span class="math notranslate nohighlight">\(A\)</span> is shifted at
<a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp()</span></code></a> and unshifted at the end of the computations. With respect to
the previous one, this mode avoids a copy of matrix <span class="math notranslate nohighlight">\(A\)</span>. However,
a backdraw is that the recovered matrix might be slightly different
from the original one (due to roundoff).</p>
<p>With <a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode.SHELL" title="slepc4py.SLEPc.ST.MatMode.SHELL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.MatMode.SHELL</span></code></a>, the solver works with an implicit shell matrix
that represents the shifted matrix. This mode is the most efficient in
creating the shifted matrix but it places serious limitations to the
linear solves performed in each iteration of the eigensolver
(typically, only iterative solvers with Jacobi preconditioning can be
used).</p>
<p>In the case of generalized problems, in the two first modes the matrix
<span class="math notranslate nohighlight">\(A - s B\)</span> has to be computed explicitly. The efficiency of
this computation can be controlled with <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatStructure()</span></code></a>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L302">Source code at slepc4py/SLEPc/ST.pyx:302</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setMatStructure">
<span class="sig-name descname"><span class="pre">setMatStructure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structure</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setMatStructure" title="Link to this definition">#</a></dt>
<dd><p>Set an internal Mat.Structure attribute.</p>
<p>Logically collective.</p>
<p>Set an internal Mat.Structure attribute to indicate which is the
relation of the sparsity pattern of the two matrices <span class="math notranslate nohighlight">\(A\)</span> and
<span class="math notranslate nohighlight">\(B\)</span> constituting the generalized eigenvalue problem. This
function has no effect in the case of standard eigenproblems.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>structure</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in Python v3.24)"><em>petsc4py.PETSc.Mat.Structure</em></a>) – Either same, different, or a subset of the non-zero
sparsity pattern.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>By default, the sparsity patterns are assumed to be
different. If the patterns are equal or a subset then it is
recommended to set this attribute for efficiency reasons (in
particular, for internal <em>AXPY()</em> matrix operations).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L400">Source code at slepc4py/SLEPc/ST.pyx:400</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setMatrices">
<span class="sig-name descname"><span class="pre">setMatrices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operators</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setMatrices" title="Link to this definition">#</a></dt>
<dd><p>Set the matrices associated with the eigenvalue problem.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>operators</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em>[</em><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a><em>]</em>) – The matrices associated with the eigensystem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L360">Source code at slepc4py/SLEPc/ST.pyx:360</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setOptionsPrefix">
<span class="sig-name descname"><span class="pre">setOptionsPrefix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Set the prefix used for searching for all ST options in the database.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The prefix string to prepend to all ST option requests.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>A hyphen (<code class="docutils literal notranslate"><span class="pre">-</span></code>) must NOT be given at the beginning of the
prefix name. The first character of all runtime options is
AUTOMATICALLY the hyphen.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L162">Source code at slepc4py/SLEPc/ST.pyx:162</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setPreconditionerMat">
<span class="sig-name descname"><span class="pre">setPreconditionerMat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">P</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="Link to this definition">#</a></dt>
<dd><p>Set the matrix to be used to build the preconditioner.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>P</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The matrix that will be used in constructing the preconditioner.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L480">Source code at slepc4py/SLEPc/ST.pyx:480</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setShift">
<span class="sig-name descname"><span class="pre">setShift</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shift</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setShift" title="Link to this definition">#</a></dt>
<dd><p>Set the shift associated with the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>shift</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – The value of the shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>In some spectral transformations, changing the shift may have
associated a lot of work, for example recomputing a
factorization.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L230">Source code at slepc4py/SLEPc/ST.pyx:230</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setSplitPreconditioner">
<span class="sig-name descname"><span class="pre">setSplitPreconditioner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operators</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">structure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setSplitPreconditioner" title="Link to this definition">#</a></dt>
<dd><p>Set the matrices to be used to build the preconditioner.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>operators</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em>[</em><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>petsc4py.PETSc.Mat</em></a><em>]</em>) – The matrices associated with the preconditioner.</p></li>
<li><p><strong>structure</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in Python v3.24)"><em>petsc4py.PETSc.Mat.Structure</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>)</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L510">Source code at slepc4py/SLEPc/ST.pyx:510</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setTransform">
<span class="sig-name descname"><span class="pre">setTransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setTransform" title="Link to this definition">#</a></dt>
<dd><p>Set a flag to indicate whether the transformed matrices are computed or not.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>flag</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – This flag is intended for the case of polynomial
eigenproblems solved via linearization.
If this flag is False (default) the spectral transformation
is applied to the linearization (handled by the eigensolver),
otherwise it is applied to the original problem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L265">Source code at slepc4py/SLEPc/ST.pyx:265</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setType">
<span class="sig-name descname"><span class="pre">setType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">st_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setType" title="Link to this definition">#</a></dt>
<dd><p>Set the particular spectral transformation to be used.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>st_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type" title="slepc4py.SLEPc.ST.Type"><em>Type</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The spectral transformation to be used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>See <a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type" title="slepc4py.SLEPc.ST.Type"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST.Type</span></code></a> for available methods. The default is
<a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type.SHIFT" title="slepc4py.SLEPc.ST.Type.SHIFT"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.Type.SHIFT</span></code></a> with a zero shift. Normally, it is best to
use <a class="reference internal" href="#slepc4py.SLEPc.ST.setFromOptions" title="slepc4py.SLEPc.ST.setFromOptions"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFromOptions()</span></code></a> and then set the ST type from the
options database rather than by using this routine. Using the
options database provides the user with maximum flexibility in
evaluating the different available methods.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L123">Source code at slepc4py/SLEPc/ST.pyx:123</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setUp" title="Link to this definition">#</a></dt>
<dd><p>Prepare for the use of a spectral transformation.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L555">Source code at slepc4py/SLEPc/ST.pyx:555</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.view">
<span class="sig-name descname"><span class="pre">view</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">viewer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.view" title="Link to this definition">#</a></dt>
<dd><p>Print the ST data structure.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>viewer</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Viewer.html#petsc4py.PETSc.Viewer" title="(in Python v3.24)"><em>Viewer</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – Visualization context; if not provided, the standard
output is used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L73">Source code at slepc4py/SLEPc/ST.pyx:73</a></p>
</dd></dl>
<p class="rubric">Attributes Documentation</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.ksp">
<span class="sig-name descname"><span class="pre">ksp</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.ksp" title="Link to this definition">#</a></dt>
<dd><p>KSP object associated with the spectral transformation.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L915">Source code at slepc4py/SLEPc/ST.pyx:915</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.mat_mode">
<span class="sig-name descname"><span class="pre">mat_mode</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.mat_mode" title="Link to this definition">#</a></dt>
<dd><p>How the transformed matrices are being stored in the ST.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L901">Source code at slepc4py/SLEPc/ST.pyx:901</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.mat_structure">
<span class="sig-name descname"><span class="pre">mat_structure</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.mat_structure" title="Link to this definition">#</a></dt>
<dd><p>Relation of the sparsity pattern of all ST matrices.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L908">Source code at slepc4py/SLEPc/ST.pyx:908</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.shift">
<span class="sig-name descname"><span class="pre">shift</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.shift" title="Link to this definition">#</a></dt>
<dd><p>Value of the shift.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L887">Source code at slepc4py/SLEPc/ST.pyx:887</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.transform" title="Link to this definition">#</a></dt>
<dd><p>If the transformed matrices are computed.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L894">Source code at slepc4py/SLEPc/ST.pyx:894</a></p>
</dd></dl>
</dd></dl>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="slepc4py.SLEPc.RG.Type.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">slepc4py.SLEPc.RG.Type</p>
</div>
</a>
<a class="right-next"
href="slepc4py.SLEPc.ST.FilterDamping.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">slepc4py.SLEPc.ST.FilterDamping</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/slepc4py.SLEPc.ST.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
<div class="footer-item"><p class="last-updated">
Last updated on 2025-11-07T09:28:35+0100 (v3.24.1).
<br/>
</p></div>
</div>
</div>
</footer>
</body>
</html>
|
