File: slepc4py.SLEPc.PEP.html

package info (click to toggle)
slepc 3.24.1%2Bdfsg1-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 122,028 kB
sloc: ansic: 104,353; javascript: 12,732; python: 5,958; f90: 3,312; cpp: 1,528; makefile: 761; xml: 679; sh: 347
file content (3070 lines) | stat: -rw-r--r-- 258,854 bytes

<!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.PEP &#8212; 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.PEP';</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="slepc4py.SLEPc.PEP.Basis" href="slepc4py.SLEPc.PEP.Basis.html" />
    <link rel="prev" title="slepc4py.SLEPc.NEP.Which" href="slepc4py.SLEPc.NEP.Which.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 current active has-children"><a class="current reference internal" href="#">slepc4py.SLEPc.PEP</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.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 has-children"><a class="reference internal" href="slepc4py.SLEPc.ST.html">slepc4py.SLEPc.ST</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.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.PEP</span></li>
  </ul>
</nav>
</div>
      
    </div>
  
  
</div>
</div>
              
              
              
                
<div id="searchbox"></div>
                <article class="bd-article">
                  
  <section id="slepc4py-slepc-pep">
<h1>slepc4py.SLEPc.PEP<a class="headerlink" href="#slepc4py-slepc-pep" title="Link to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP">
<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">PEP</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP" 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>PEP.</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.PEP.Basis.html#slepc4py.SLEPc.PEP.Basis" title="slepc4py.SLEPc.PEP.Basis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Basis</span></code></a></p></td>
<td><p>PEP basis type for the representation of the polynomial.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.CISSExtraction.html#slepc4py.SLEPc.PEP.CISSExtraction" title="slepc4py.SLEPc.PEP.CISSExtraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CISSExtraction</span></code></a></p></td>
<td><p>PEP CISS extraction technique.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Conv.html#slepc4py.SLEPc.PEP.Conv" title="slepc4py.SLEPc.PEP.Conv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Conv</span></code></a></p></td>
<td><p>PEP convergence test.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.ConvergedReason.html#slepc4py.SLEPc.PEP.ConvergedReason" title="slepc4py.SLEPc.PEP.ConvergedReason"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConvergedReason</span></code></a></p></td>
<td><p>PEP convergence reasons.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.ErrorType.html#slepc4py.SLEPc.PEP.ErrorType" title="slepc4py.SLEPc.PEP.ErrorType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ErrorType</span></code></a></p></td>
<td><p>PEP error type to assess accuracy of computed solutions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Extract.html#slepc4py.SLEPc.PEP.Extract" title="slepc4py.SLEPc.PEP.Extract"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Extract</span></code></a></p></td>
<td><p>PEP extraction strategy used.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.JDProjection.html#slepc4py.SLEPc.PEP.JDProjection" title="slepc4py.SLEPc.PEP.JDProjection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JDProjection</span></code></a></p></td>
<td><p>PEP type of projection to be used in the Jacobi-Davidson solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.ProblemType.html#slepc4py.SLEPc.PEP.ProblemType" title="slepc4py.SLEPc.PEP.ProblemType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ProblemType</span></code></a></p></td>
<td><p>PEP problem type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Refine.html#slepc4py.SLEPc.PEP.Refine" title="slepc4py.SLEPc.PEP.Refine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Refine</span></code></a></p></td>
<td><p>PEP refinement strategy.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html#slepc4py.SLEPc.PEP.RefineScheme" title="slepc4py.SLEPc.PEP.RefineScheme"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RefineScheme</span></code></a></p></td>
<td><p>PEP scheme for solving linear systems during iterative refinement.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html#slepc4py.SLEPc.PEP.Scale" title="slepc4py.SLEPc.PEP.Scale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scale</span></code></a></p></td>
<td><p>PEP scaling strategy.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Stop.html#slepc4py.SLEPc.PEP.Stop" title="slepc4py.SLEPc.PEP.Stop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Stop</span></code></a></p></td>
<td><p>PEP stopping test.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Type.html#slepc4py.SLEPc.PEP.Type" title="slepc4py.SLEPc.PEP.Type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Type</span></code></a></p></td>
<td><p>PEP type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.PEP.Which.html#slepc4py.SLEPc.PEP.Which" title="slepc4py.SLEPc.PEP.Which"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Which</span></code></a></p></td>
<td><p>PEP desired part of spectrum.</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.PEP.appendOptionsPrefix" title="slepc4py.SLEPc.PEP.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 PEP options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.cancelMonitor" title="slepc4py.SLEPc.PEP.cancelMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cancelMonitor</span></code></a>()</p></td>
<td><p>Clear all monitors for a <a class="reference internal" href="#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a> object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.computeError" title="slepc4py.SLEPc.PEP.computeError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">computeError</span></code></a>(i[, etype])</p></td>
<td><p>Compute the error associated with the i-th computed eigenpair.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.create" title="slepc4py.SLEPc.PEP.create"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create</span></code></a>([comm])</p></td>
<td><p>Create the PEP object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.destroy" title="slepc4py.SLEPc.PEP.destroy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">destroy</span></code></a>()</p></td>
<td><p>Destroy the PEP object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.errorView" title="slepc4py.SLEPc.PEP.errorView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">errorView</span></code></a>([etype, viewer])</p></td>
<td><p>Display the errors associated with the computed solution.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getBV" title="slepc4py.SLEPc.PEP.getBV"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getBV</span></code></a>()</p></td>
<td><p>Get the basis vectors object associated to the eigensolver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getBasis" title="slepc4py.SLEPc.PEP.getBasis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getBasis</span></code></a>()</p></td>
<td><p>Get the type of polynomial basis used.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getCISSExtraction" title="slepc4py.SLEPc.PEP.getCISSExtraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCISSExtraction</span></code></a>()</p></td>
<td><p>Get the extraction technique used in the CISS solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getCISSKSPs" title="slepc4py.SLEPc.PEP.getCISSKSPs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCISSKSPs</span></code></a>()</p></td>
<td><p>Get the array of linear solver objects associated with the CISS solver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getCISSRefinement" title="slepc4py.SLEPc.PEP.getCISSRefinement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCISSRefinement</span></code></a>()</p></td>
<td><p>Get the values of various refinement parameters in the CISS solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getCISSSizes" title="slepc4py.SLEPc.PEP.getCISSSizes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCISSSizes</span></code></a>()</p></td>
<td><p>Get the values of various size parameters in the CISS solver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getCISSThreshold" title="slepc4py.SLEPc.PEP.getCISSThreshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCISSThreshold</span></code></a>()</p></td>
<td><p>Get the values of various threshold parameters in the CISS solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getConverged" title="slepc4py.SLEPc.PEP.getConverged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getConverged</span></code></a>()</p></td>
<td><p>Get the number of converged eigenpairs.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getConvergedReason" title="slepc4py.SLEPc.PEP.getConvergedReason"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getConvergedReason</span></code></a>()</p></td>
<td><p>Get the reason why the <a class="reference internal" href="#slepc4py.SLEPc.PEP.solve" title="slepc4py.SLEPc.PEP.solve"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">solve()</span></code></a> iteration was stopped.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getConvergenceTest" title="slepc4py.SLEPc.PEP.getConvergenceTest"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getConvergenceTest</span></code></a>()</p></td>
<td><p>Get the method used to compute the error estimate used in the convergence test.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getDS" title="slepc4py.SLEPc.PEP.getDS"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getDS</span></code></a>()</p></td>
<td><p>Get the direct solver associated to the eigensolver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getDimensions" title="slepc4py.SLEPc.PEP.getDimensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getDimensions</span></code></a>()</p></td>
<td><p>Get the number of eigenvalues to compute and the dimension of the subspace.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getEigenpair" title="slepc4py.SLEPc.PEP.getEigenpair"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getEigenpair</span></code></a>(i[, Vr, Vi])</p></td>
<td><p>Get the i-th solution of the eigenproblem as computed by <a class="reference internal" href="#slepc4py.SLEPc.PEP.solve" title="slepc4py.SLEPc.PEP.solve"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">solve()</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getErrorEstimate" title="slepc4py.SLEPc.PEP.getErrorEstimate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getErrorEstimate</span></code></a>(i)</p></td>
<td><p>Get the error estimate associated to the i-th computed eigenpair.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getExtract" title="slepc4py.SLEPc.PEP.getExtract"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getExtract</span></code></a>()</p></td>
<td><p>Get the extraction technique used by the <a class="reference internal" href="#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a> object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getInterval" title="slepc4py.SLEPc.PEP.getInterval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getInterval</span></code></a>()</p></td>
<td><p>Get the computational interval for spectrum slicing.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getIterationNumber" title="slepc4py.SLEPc.PEP.getIterationNumber"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getIterationNumber</span></code></a>()</p></td>
<td><p>Get the current iteration number.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getJDFix" title="slepc4py.SLEPc.PEP.getJDFix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getJDFix</span></code></a>()</p></td>
<td><p>Get threshold for changing the target in the correction equation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getJDMinimalityIndex" title="slepc4py.SLEPc.PEP.getJDMinimalityIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getJDMinimalityIndex</span></code></a>()</p></td>
<td><p>Get the maximum allowed value of the minimality index.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getJDProjection" title="slepc4py.SLEPc.PEP.getJDProjection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getJDProjection</span></code></a>()</p></td>
<td><p>Get the type of projection to be used in the Jacobi-Davidson solver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getJDRestart" title="slepc4py.SLEPc.PEP.getJDRestart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getJDRestart</span></code></a>()</p></td>
<td><p>Get the restart parameter used in the Jacobi-Davidson method.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getJDReusePreconditioner" title="slepc4py.SLEPc.PEP.getJDReusePreconditioner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getJDReusePreconditioner</span></code></a>()</p></td>
<td><p>Get the flag for reusing the preconditioner.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getLinearEPS" title="slepc4py.SLEPc.PEP.getLinearEPS"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLinearEPS</span></code></a>()</p></td>
<td><p>Get the eigensolver object associated to the polynomial eigenvalue solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getLinearExplicitMatrix" title="slepc4py.SLEPc.PEP.getLinearExplicitMatrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLinearExplicitMatrix</span></code></a>()</p></td>
<td><p>Get if the matrices A and B for the linearization are built explicitly.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getLinearLinearization" title="slepc4py.SLEPc.PEP.getLinearLinearization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLinearLinearization</span></code></a>()</p></td>
<td><p>Get the coeffs.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getMonitor" title="slepc4py.SLEPc.PEP.getMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMonitor</span></code></a>()</p></td>
<td><p>Get the list of monitor functions.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getOperators" title="slepc4py.SLEPc.PEP.getOperators"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOperators</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.PEP.getOptionsPrefix" title="slepc4py.SLEPc.PEP.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 PEP options in the database.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getProblemType" title="slepc4py.SLEPc.PEP.getProblemType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getProblemType</span></code></a>()</p></td>
<td><p>Get the problem type from the PEP object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getQArnoldiLocking" title="slepc4py.SLEPc.PEP.getQArnoldiLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getQArnoldiLocking</span></code></a>()</p></td>
<td><p>Get the locking flag used in the Q-Arnoldi method.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getQArnoldiRestart" title="slepc4py.SLEPc.PEP.getQArnoldiRestart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getQArnoldiRestart</span></code></a>()</p></td>
<td><p>Get the restart parameter used in the Q-Arnoldi method.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getRG" title="slepc4py.SLEPc.PEP.getRG"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getRG</span></code></a>()</p></td>
<td><p>Get the region object associated to the eigensolver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getRefine" title="slepc4py.SLEPc.PEP.getRefine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getRefine</span></code></a>()</p></td>
<td><p>Get the refinement strategy used by the PEP object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getRefineKSP" title="slepc4py.SLEPc.PEP.getRefineKSP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getRefineKSP</span></code></a>()</p></td>
<td><p>Get the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object used by the eigensolver in the refinement phase.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getST" title="slepc4py.SLEPc.PEP.getST"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getST</span></code></a>()</p></td>
<td><p>Get the <a class="reference internal" href="slepc4py.SLEPc.ST.html#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST</span></code></a> object associated to the eigensolver object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getSTOARCheckEigenvalueType" title="slepc4py.SLEPc.PEP.getSTOARCheckEigenvalueType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSTOARCheckEigenvalueType</span></code></a>()</p></td>
<td><p>Get the flag for the eigenvalue type check in spectrum slicing.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getSTOARDetectZeros" title="slepc4py.SLEPc.PEP.getSTOARDetectZeros"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSTOARDetectZeros</span></code></a>()</p></td>
<td><p>Get the flag that enforces zero detection in spectrum slicing.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getSTOARDimensions" title="slepc4py.SLEPc.PEP.getSTOARDimensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSTOARDimensions</span></code></a>()</p></td>
<td><p>Get the dimensions used for each subsolve step.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getSTOARInertias" title="slepc4py.SLEPc.PEP.getSTOARInertias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSTOARInertias</span></code></a>()</p></td>
<td><p>Get the values of the shifts and their corresponding inertias.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getSTOARLinearization" title="slepc4py.SLEPc.PEP.getSTOARLinearization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSTOARLinearization</span></code></a>()</p></td>
<td><p>Get the coefficients that define the linearization of a quadratic eigenproblem.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getSTOARLocking" title="slepc4py.SLEPc.PEP.getSTOARLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSTOARLocking</span></code></a>()</p></td>
<td><p>Get the locking flag used in the STOAR method.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getScale" title="slepc4py.SLEPc.PEP.getScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getScale</span></code></a>([Dl, Dr])</p></td>
<td><p>Get the strategy used for scaling the polynomial eigenproblem.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getStoppingTest" title="slepc4py.SLEPc.PEP.getStoppingTest"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getStoppingTest</span></code></a>()</p></td>
<td><p>Get the stopping function.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getTOARLocking" title="slepc4py.SLEPc.PEP.getTOARLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTOARLocking</span></code></a>()</p></td>
<td><p>Get the locking flag used in the TOAR method.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getTOARRestart" title="slepc4py.SLEPc.PEP.getTOARRestart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTOARRestart</span></code></a>()</p></td>
<td><p>Get the restart parameter used in the TOAR method.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getTarget" title="slepc4py.SLEPc.PEP.getTarget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTarget</span></code></a>()</p></td>
<td><p>Get the value of the target.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getTolerances" title="slepc4py.SLEPc.PEP.getTolerances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTolerances</span></code></a>()</p></td>
<td><p>Get the tolerance and maximum iteration count.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getTrackAll" title="slepc4py.SLEPc.PEP.getTrackAll"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTrackAll</span></code></a>()</p></td>
<td><p>Get the flag indicating whether all residual norms must be computed.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getType" title="slepc4py.SLEPc.PEP.getType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getType</span></code></a>()</p></td>
<td><p>Get the PEP type of this object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.getWhichEigenpairs" title="slepc4py.SLEPc.PEP.getWhichEigenpairs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getWhichEigenpairs</span></code></a>()</p></td>
<td><p>Get which portion of the spectrum is to be sought.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.reset" title="slepc4py.SLEPc.PEP.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td>
<td><p>Reset the PEP object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setBV" title="slepc4py.SLEPc.PEP.setBV"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setBV</span></code></a>(bv)</p></td>
<td><p>Set a basis vectors object associated to the eigensolver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setBasis" title="slepc4py.SLEPc.PEP.setBasis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setBasis</span></code></a>(basis)</p></td>
<td><p>Set the type of polynomial basis used.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setCISSExtraction" title="slepc4py.SLEPc.PEP.setCISSExtraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCISSExtraction</span></code></a>(extraction)</p></td>
<td><p>Set the extraction technique used in the CISS solver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setCISSRefinement" title="slepc4py.SLEPc.PEP.setCISSRefinement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCISSRefinement</span></code></a>([inner, blsize])</p></td>
<td><p>Set the values of various refinement parameters in the CISS solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setCISSSizes" title="slepc4py.SLEPc.PEP.setCISSSizes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCISSSizes</span></code></a>([ip, bs, ms, npart, bsmax, ...])</p></td>
<td><p>Set the values of various size parameters in the CISS solver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setCISSThreshold" title="slepc4py.SLEPc.PEP.setCISSThreshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCISSThreshold</span></code></a>([delta, spur])</p></td>
<td><p>Set the values of various threshold parameters in the CISS solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setConvergenceTest" title="slepc4py.SLEPc.PEP.setConvergenceTest"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setConvergenceTest</span></code></a>(conv)</p></td>
<td><p>Set how to compute the error estimate used in the convergence test.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setDS" title="slepc4py.SLEPc.PEP.setDS"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setDS</span></code></a>(ds)</p></td>
<td><p>Set a direct solver object associated to the eigensolver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setDimensions" title="slepc4py.SLEPc.PEP.setDimensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setDimensions</span></code></a>([nev, ncv, mpd])</p></td>
<td><p>Set the number of eigenvalues to compute and the dimension of the subspace.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setExtract" title="slepc4py.SLEPc.PEP.setExtract"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setExtract</span></code></a>(extract)</p></td>
<td><p>Set the extraction strategy to be used.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setFromOptions" title="slepc4py.SLEPc.PEP.setFromOptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFromOptions</span></code></a>()</p></td>
<td><p>Set PEP options from the options database.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setInitialSpace" title="slepc4py.SLEPc.PEP.setInitialSpace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setInitialSpace</span></code></a>(space)</p></td>
<td><p>Set the initial space from which the eigensolver starts to iterate.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setInterval" title="slepc4py.SLEPc.PEP.setInterval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setInterval</span></code></a>(inta, intb)</p></td>
<td><p>Set the computational interval for spectrum slicing.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setJDFix" title="slepc4py.SLEPc.PEP.setJDFix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setJDFix</span></code></a>(fix)</p></td>
<td><p>Set the threshold for changing the target in the correction equation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setJDMinimalityIndex" title="slepc4py.SLEPc.PEP.setJDMinimalityIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setJDMinimalityIndex</span></code></a>(flag)</p></td>
<td><p>Set the maximum allowed value for the minimality index.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setJDProjection" title="slepc4py.SLEPc.PEP.setJDProjection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setJDProjection</span></code></a>(proj)</p></td>
<td><p>Set the type of projection to be used in the Jacobi-Davidson solver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setJDRestart" title="slepc4py.SLEPc.PEP.setJDRestart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setJDRestart</span></code></a>(keep)</p></td>
<td><p>Set the restart parameter for the Jacobi-Davidson method.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setJDReusePreconditioner" title="slepc4py.SLEPc.PEP.setJDReusePreconditioner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setJDReusePreconditioner</span></code></a>(flag)</p></td>
<td><p>Set a flag indicating whether the preconditioner must be reused or not.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setLinearEPS" title="slepc4py.SLEPc.PEP.setLinearEPS"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setLinearEPS</span></code></a>(eps)</p></td>
<td><p>Set an eigensolver object associated to the polynomial eigenvalue solver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setLinearExplicitMatrix" title="slepc4py.SLEPc.PEP.setLinearExplicitMatrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setLinearExplicitMatrix</span></code></a>(flag)</p></td>
<td><p>Set flag to explicitly build the matrices A and B.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setLinearLinearization" title="slepc4py.SLEPc.PEP.setLinearLinearization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setLinearLinearization</span></code></a>([alpha, beta])</p></td>
<td><p>Set the coefficients that define the linearization of a quadratic eigenproblem.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setMonitor" title="slepc4py.SLEPc.PEP.setMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMonitor</span></code></a>(monitor[, args, kargs])</p></td>
<td><p>Append a monitor function to the list of monitors.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setOperators" title="slepc4py.SLEPc.PEP.setOperators"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setOperators</span></code></a>(operators)</p></td>
<td><p>Set the matrices associated with the eigenvalue problem.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setOptionsPrefix" title="slepc4py.SLEPc.PEP.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 PEP options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setProblemType" title="slepc4py.SLEPc.PEP.setProblemType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setProblemType</span></code></a>(problem_type)</p></td>
<td><p>Set the type of the eigenvalue problem.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setQArnoldiLocking" title="slepc4py.SLEPc.PEP.setQArnoldiLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setQArnoldiLocking</span></code></a>(lock)</p></td>
<td><p>Toggle between locking and non-locking variants of the Q-Arnoldi method.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setQArnoldiRestart" title="slepc4py.SLEPc.PEP.setQArnoldiRestart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setQArnoldiRestart</span></code></a>(keep)</p></td>
<td><p>Set the restart parameter for the Q-Arnoldi method.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setRG" title="slepc4py.SLEPc.PEP.setRG"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRG</span></code></a>(rg)</p></td>
<td><p>Set a region object associated to the eigensolver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setRefine" title="slepc4py.SLEPc.PEP.setRefine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRefine</span></code></a>(ref[, npart, tol, its, scheme])</p></td>
<td><p>Set the refinement strategy used by the PEP object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setST" title="slepc4py.SLEPc.PEP.setST"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setST</span></code></a>(st)</p></td>
<td><p>Set a spectral transformation object associated to the eigensolver.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setSTOARCheckEigenvalueType" title="slepc4py.SLEPc.PEP.setSTOARCheckEigenvalueType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSTOARCheckEigenvalueType</span></code></a>(flag)</p></td>
<td><p>Set flag to check if all eigenvalues have the same definite type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setSTOARDetectZeros" title="slepc4py.SLEPc.PEP.setSTOARDetectZeros"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSTOARDetectZeros</span></code></a>(detect)</p></td>
<td><p>Set flag to enforce detection of zeros during the factorizations.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setSTOARDimensions" title="slepc4py.SLEPc.PEP.setSTOARDimensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSTOARDimensions</span></code></a>([nev, ncv, mpd])</p></td>
<td><p>Set the dimensions used for each subsolve step.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setSTOARLinearization" title="slepc4py.SLEPc.PEP.setSTOARLinearization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSTOARLinearization</span></code></a>([alpha, beta])</p></td>
<td><p>Set the coefficients that define the linearization of a quadratic eigenproblem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setSTOARLocking" title="slepc4py.SLEPc.PEP.setSTOARLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSTOARLocking</span></code></a>(lock)</p></td>
<td><p>Toggle between locking and non-locking variants of the STOAR method.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setScale" title="slepc4py.SLEPc.PEP.setScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setScale</span></code></a>(scale[, alpha, Dl, Dr, its, lbda])</p></td>
<td><p>Set the scaling strategy to be used.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setStoppingTest" title="slepc4py.SLEPc.PEP.setStoppingTest"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setStoppingTest</span></code></a>(stopping[, args, kargs])</p></td>
<td><p>Set a function to decide when to stop the outer iteration of the eigensolver.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setTOARLocking" title="slepc4py.SLEPc.PEP.setTOARLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTOARLocking</span></code></a>(lock)</p></td>
<td><p>Toggle between locking and non-locking variants of the TOAR method.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setTOARRestart" title="slepc4py.SLEPc.PEP.setTOARRestart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTOARRestart</span></code></a>(keep)</p></td>
<td><p>Set the restart parameter for the TOAR method.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setTarget" title="slepc4py.SLEPc.PEP.setTarget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTarget</span></code></a>(target)</p></td>
<td><p>Set the value of the target.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setTolerances" title="slepc4py.SLEPc.PEP.setTolerances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTolerances</span></code></a>([tol, max_it])</p></td>
<td><p>Set the tolerance and maximum iteration count.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setTrackAll" title="slepc4py.SLEPc.PEP.setTrackAll"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTrackAll</span></code></a>(trackall)</p></td>
<td><p>Set flag to compute the residual of all approximate eigenpairs.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setType" title="slepc4py.SLEPc.PEP.setType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setType</span></code></a>(pep_type)</p></td>
<td><p>Set the particular solver to be used in the PEP object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setUp" title="slepc4py.SLEPc.PEP.setUp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setUp</span></code></a>()</p></td>
<td><p>Set up all the necessary internal data structures.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.setWhichEigenpairs" title="slepc4py.SLEPc.PEP.setWhichEigenpairs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setWhichEigenpairs</span></code></a>(which)</p></td>
<td><p>Set which portion of the spectrum is to be sought.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.solve" title="slepc4py.SLEPc.PEP.solve"><code class="xref py py-obj docutils literal notranslate"><span class="pre">solve</span></code></a>()</p></td>
<td><p>Solve the eigensystem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.valuesView" title="slepc4py.SLEPc.PEP.valuesView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">valuesView</span></code></a>([viewer])</p></td>
<td><p>Display the computed eigenvalues in a viewer.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.vectorsView" title="slepc4py.SLEPc.PEP.vectorsView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vectorsView</span></code></a>([viewer])</p></td>
<td><p>Output computed eigenvectors to a viewer.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.view" title="slepc4py.SLEPc.PEP.view"><code class="xref py py-obj docutils literal notranslate"><span class="pre">view</span></code></a>([viewer])</p></td>
<td><p>Print the PEP 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.PEP.bv" title="slepc4py.SLEPc.PEP.bv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bv</span></code></a></p></td>
<td><p>The basis vectors (BV) object associated.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.ds" title="slepc4py.SLEPc.PEP.ds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ds</span></code></a></p></td>
<td><p>The direct solver (DS) object associated.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.extract" title="slepc4py.SLEPc.PEP.extract"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extract</span></code></a></p></td>
<td><p>The type of extraction technique to be employed.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.max_it" title="slepc4py.SLEPc.PEP.max_it"><code class="xref py py-obj docutils literal notranslate"><span class="pre">max_it</span></code></a></p></td>
<td><p>The maximum iteration count.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.problem_type" title="slepc4py.SLEPc.PEP.problem_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">problem_type</span></code></a></p></td>
<td><p>The type of the eigenvalue problem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.rg" title="slepc4py.SLEPc.PEP.rg"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rg</span></code></a></p></td>
<td><p>The region (RG) object associated.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.st" title="slepc4py.SLEPc.PEP.st"><code class="xref py py-obj docutils literal notranslate"><span class="pre">st</span></code></a></p></td>
<td><p>The spectral transformation (ST) object associated.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.target" title="slepc4py.SLEPc.PEP.target"><code class="xref py py-obj docutils literal notranslate"><span class="pre">target</span></code></a></p></td>
<td><p>The value of the target.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.tol" title="slepc4py.SLEPc.PEP.tol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tol</span></code></a></p></td>
<td><p>The tolerance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.track_all" title="slepc4py.SLEPc.PEP.track_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">track_all</span></code></a></p></td>
<td><p>Compute the residual norm of all approximate eigenpairs.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.PEP.which" title="slepc4py.SLEPc.PEP.which"><code class="xref py py-obj docutils literal notranslate"><span class="pre">which</span></code></a></p></td>
<td><p>The portion of the spectrum to be sought.</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.PEP.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.PEP.appendOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Append to the prefix used for searching for all PEP 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 PEP 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/PEP.pyx#L353">Source code at slepc4py/SLEPc/PEP.pyx:353</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.cancelMonitor">
<span class="sig-name descname"><span class="pre">cancelMonitor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.cancelMonitor" title="Link to this definition">#</a></dt>
<dd><p>Clear all monitors for a <a class="reference internal" href="#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a> object.</p>
<p>Logically collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1162">Source code at slepc4py/SLEPc/PEP.pyx:1162</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.PEP.computeError">
<span class="sig-name descname"><span class="pre">computeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">etype</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.PEP.computeError" title="Link to this definition">#</a></dt>
<dd><p>Compute the error associated with the i-th computed eigenpair.</p>
<p>Collective.</p>
<p>Compute the error (based on the residual norm) associated with the i-th
computed eigenpair.</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>i</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of the solution to be considered.</p></li>
<li><p><strong>etype</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.ErrorType.html#slepc4py.SLEPc.PEP.ErrorType" title="slepc4py.SLEPc.PEP.ErrorType"><em>ErrorType</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 error type to compute.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The error bound, computed in various ways from the residual norm
<span class="math notranslate nohighlight">\(||P(l)x||_2\)</span> where <span class="math notranslate nohighlight">\(l\)</span> is the eigenvalue and <span class="math notranslate nohighlight">\(x\)</span>
is the eigenvector.</p>
</dd>
<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/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The index <code class="docutils literal notranslate"><span class="pre">i</span></code> should be a value between <code class="docutils literal notranslate"><span class="pre">0</span></code> and
<code class="docutils literal notranslate"><span class="pre">nconv-1</span></code> (see <a class="reference internal" href="#slepc4py.SLEPc.PEP.getConverged" title="slepc4py.SLEPc.PEP.getConverged"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getConverged()</span></code></a>).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1290">Source code at slepc4py/SLEPc/PEP.pyx:1290</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.create" title="Link to this definition">#</a></dt>
<dd><p>Create the PEP 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/PEP.pyx#L276">Source code at slepc4py/SLEPc/PEP.pyx:276</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.destroy" title="Link to this definition">#</a></dt>
<dd><p>Destroy the PEP object.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L258">Source code at slepc4py/SLEPc/PEP.pyx:258</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.PEP.errorView">
<span class="sig-name descname"><span class="pre">errorView</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">etype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <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.PEP.errorView" title="Link to this definition">#</a></dt>
<dd><p>Display the errors associated with the computed solution.</p>
<p>Collective.</p>
<p>Display the errors and the 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>etype</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.ErrorType.html#slepc4py.SLEPc.PEP.ErrorType" title="slepc4py.SLEPc.PEP.ErrorType"><em>ErrorType</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 error type to compute.</p></li>
<li><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>petsc4py.PETSc.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></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>By default, this function checks the error of all eigenpairs and prints
the eigenvalues if all of them are below the requested tolerance.
If the viewer has format <code class="docutils literal notranslate"><span class="pre">ASCII_INFO_DETAIL</span></code> then a table with
eigenvalues and corresponding errors is printed.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1324">Source code at slepc4py/SLEPc/PEP.pyx:1324</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getBV">
<span class="sig-name descname"><span class="pre">getBV</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getBV" title="Link to this definition">#</a></dt>
<dd><p>Get the basis vectors object associated to the eigensolver.</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 basis vectors context.</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.BV.html#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><code class="xref any py py-class docutils literal notranslate"><span class="pre">BV</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/PEP.pyx#L954">Source code at slepc4py/SLEPc/PEP.pyx:954</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getBasis">
<span class="sig-name descname"><span class="pre">getBasis</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getBasis" title="Link to this definition">#</a></dt>
<dd><p>Get the type of polynomial basis used.</p>
<p>Not collective.</p>
<p>Get the type of polynomial basis used to describe the polynomial
eigenvalue problem.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The basis that was previously set.</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.PEP.Basis.html#slepc4py.SLEPc.PEP.Basis" title="slepc4py.SLEPc.PEP.Basis"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Basis</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/PEP.pyx#L379">Source code at slepc4py/SLEPc/PEP.pyx:379</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getCISSExtraction">
<span class="sig-name descname"><span class="pre">getCISSExtraction</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getCISSExtraction" title="Link to this definition">#</a></dt>
<dd><p>Get the extraction technique used in the CISS solver.</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 extraction technique.</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.PEP.CISSExtraction.html#slepc4py.SLEPc.PEP.CISSExtraction" title="slepc4py.SLEPc.PEP.CISSExtraction"><code class="xref any py py-class docutils literal notranslate"><span class="pre">CISSExtraction</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/PEP.pyx#L2049">Source code at slepc4py/SLEPc/PEP.pyx:2049</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getCISSKSPs">
<span class="sig-name descname"><span class="pre">getCISSKSPs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getCISSKSPs" title="Link to this definition">#</a></dt>
<dd><p>Get the array of linear solver objects associated with the CISS solver.</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 objects.</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.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>The number 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> solvers is equal to the number of
integration points divided by the number of partitions. This value is
halved in the case of real matrices with a region centered at the real
axis.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2218">Source code at slepc4py/SLEPc/PEP.pyx:2218</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getCISSRefinement">
<span class="sig-name descname"><span class="pre">getCISSRefinement</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getCISSRefinement" title="Link to this definition">#</a></dt>
<dd><p>Get the values of various refinement parameters in the CISS solver.</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>inner</strong> (<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>) – Number of iterative refinement iterations (inner loop).</p></li>
<li><p><strong>blsize</strong> (<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>) – Number of iterative refinement iterations (blocksize loop).</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#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2200">Source code at slepc4py/SLEPc/PEP.pyx:2200</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getCISSSizes">
<span class="sig-name descname"><span class="pre">getCISSSizes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getCISSSizes" title="Link to this definition">#</a></dt>
<dd><p>Get the values of various size parameters in the CISS solver.</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>ip</strong> (<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>) – Number of integration points.</p></li>
<li><p><strong>bs</strong> (<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>) – Block size.</p></li>
<li><p><strong>ms</strong> (<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>) – Moment size.</p></li>
<li><p><strong>npart</strong> (<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>) – Number of partitions when splitting the communicator.</p></li>
<li><p><strong>bsmax</strong> (<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>) – Maximum block size.</p></li>
<li><p><strong>realmats</strong> (<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>) – True if A and B are real.</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#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2114">Source code at slepc4py/SLEPc/PEP.pyx:2114</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getCISSThreshold">
<span class="sig-name descname"><span class="pre">getCISSThreshold</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getCISSThreshold" title="Link to this definition">#</a></dt>
<dd><p>Get the values of various threshold parameters in the CISS solver.</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>delta</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>) – Threshold for numerical rank.</p></li>
<li><p><strong>spur</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>) – Spurious threshold (to discard spurious eigenpairs.</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/PEP.pyx#L2163">Source code at slepc4py/SLEPc/PEP.pyx:2163</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getConverged">
<span class="sig-name descname"><span class="pre">getConverged</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getConverged" title="Link to this definition">#</a></dt>
<dd><p>Get the number of converged eigenpairs.</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>Number of converged eigenpairs.</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/PEP.pyx#L1226">Source code at slepc4py/SLEPc/PEP.pyx:1226</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getConvergedReason">
<span class="sig-name descname"><span class="pre">getConvergedReason</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getConvergedReason" title="Link to this definition">#</a></dt>
<dd><p>Get the reason why the <a class="reference internal" href="#slepc4py.SLEPc.PEP.solve" title="slepc4py.SLEPc.PEP.solve"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">solve()</span></code></a> iteration was stopped.</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>Negative value indicates diverged, positive value
converged.</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.PEP.ConvergedReason.html#slepc4py.SLEPc.PEP.ConvergedReason" title="slepc4py.SLEPc.PEP.ConvergedReason"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ConvergedReason</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/PEP.pyx#L1210">Source code at slepc4py/SLEPc/PEP.pyx:1210</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getConvergenceTest">
<span class="sig-name descname"><span class="pre">getConvergenceTest</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getConvergenceTest" title="Link to this definition">#</a></dt>
<dd><p>Get the method used to compute the error estimate used in the convergence test.</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 method used to compute the error estimate
used in the convergence test.</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.PEP.Conv.html#slepc4py.SLEPc.PEP.Conv" title="slepc4py.SLEPc.PEP.Conv"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Conv</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/PEP.pyx#L601">Source code at slepc4py/SLEPc/PEP.pyx:601</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getDS">
<span class="sig-name descname"><span class="pre">getDS</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getDS" title="Link to this definition">#</a></dt>
<dd><p>Get the direct solver associated to the eigensolver.</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 direct solver context.</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.DS.html#slepc4py.SLEPc.DS" title="slepc4py.SLEPc.DS"><code class="xref any py py-class docutils literal notranslate"><span class="pre">DS</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/PEP.pyx#L1012">Source code at slepc4py/SLEPc/PEP.pyx:1012</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getDimensions">
<span class="sig-name descname"><span class="pre">getDimensions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getDimensions" title="Link to this definition">#</a></dt>
<dd><p>Get the number of eigenvalues to compute and the dimension of the subspace.</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>nev</strong> (<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>) – Number of eigenvalues to compute.</p></li>
<li><p><strong>ncv</strong> (<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>) – Maximum dimension of the subspace to be used by the solver.</p></li>
<li><p><strong>mpd</strong> (<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>) – Maximum dimension allowed for the projected problem.</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#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L779">Source code at slepc4py/SLEPc/PEP.pyx:779</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getEigenpair">
<span class="sig-name descname"><span class="pre">getEigenpair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Vr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Vi</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.PEP.getEigenpair" title="Link to this definition">#</a></dt>
<dd><p>Get the i-th solution of the eigenproblem as computed by <a class="reference internal" href="#slepc4py.SLEPc.PEP.solve" title="slepc4py.SLEPc.PEP.solve"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">solve()</span></code></a>.</p>
<p>Collective.</p>
<p>The solution consists of both the eigenvalue and the eigenvector.</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>i</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of the solution to be obtained.</p></li>
<li><p><strong>Vr</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><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>) – Placeholder for the returned eigenvector (real part).</p></li>
<li><p><strong>Vi</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><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>) – Placeholder for the returned eigenvector (imaginary part).</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The computed eigenvalue.</p>
</dd>
<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/functions.html#complex" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">complex</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/PEP.pyx#L1241">Source code at slepc4py/SLEPc/PEP.pyx:1241</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getErrorEstimate">
<span class="sig-name descname"><span class="pre">getErrorEstimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getErrorEstimate" title="Link to this definition">#</a></dt>
<dd><p>Get the error estimate associated to the i-th computed eigenpair.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>i</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of the solution to be considered.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Error estimate.</p>
</dd>
<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/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</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/PEP.pyx#L1270">Source code at slepc4py/SLEPc/PEP.pyx:1270</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getExtract">
<span class="sig-name descname"><span class="pre">getExtract</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getExtract" title="Link to this definition">#</a></dt>
<dd><p>Get the extraction technique used by the <a class="reference internal" href="#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a> 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 extraction strategy.</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.PEP.Extract.html#slepc4py.SLEPc.PEP.Extract" title="slepc4py.SLEPc.PEP.Extract"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Extract</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/PEP.pyx#L732">Source code at slepc4py/SLEPc/PEP.pyx:732</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getInterval">
<span class="sig-name descname"><span class="pre">getInterval</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getInterval" title="Link to this definition">#</a></dt>
<dd><p>Get the computational interval for spectrum slicing.</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 class="rubric">Notes</p>
<p>If the interval was not set by the user, then zeros are returned.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L554">Source code at slepc4py/SLEPc/PEP.pyx:554</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getIterationNumber">
<span class="sig-name descname"><span class="pre">getIterationNumber</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getIterationNumber" title="Link to this definition">#</a></dt>
<dd><p>Get the current iteration number.</p>
<p>Not collective.</p>
<p>If the call to <a class="reference internal" href="#slepc4py.SLEPc.PEP.solve" title="slepc4py.SLEPc.PEP.solve"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">solve()</span></code></a> is complete, then it returns the number of
iterations carried out by the solution method.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Iteration number.</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/PEP.pyx#L1192">Source code at slepc4py/SLEPc/PEP.pyx:1192</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getJDFix">
<span class="sig-name descname"><span class="pre">getJDFix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getJDFix" title="Link to this definition">#</a></dt>
<dd><p>Get threshold for changing the target in the correction equation.</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 threshold for changing the target.</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#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</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/PEP.pyx#L1931">Source code at slepc4py/SLEPc/PEP.pyx:1931</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getJDMinimalityIndex">
<span class="sig-name descname"><span class="pre">getJDMinimalityIndex</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getJDMinimalityIndex" title="Link to this definition">#</a></dt>
<dd><p>Get the maximum allowed value of the minimality index.</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 maximum minimality index.</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/PEP.pyx#L1989">Source code at slepc4py/SLEPc/PEP.pyx:1989</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getJDProjection">
<span class="sig-name descname"><span class="pre">getJDProjection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getJDProjection" title="Link to this definition">#</a></dt>
<dd><p>Get the type of projection to be used in the Jacobi-Davidson solver.</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 projection.</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.PEP.JDProjection.html#slepc4py.SLEPc.PEP.JDProjection" title="slepc4py.SLEPc.PEP.JDProjection"><code class="xref any py py-class docutils literal notranslate"><span class="pre">JDProjection</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/PEP.pyx#L2018">Source code at slepc4py/SLEPc/PEP.pyx:2018</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getJDRestart">
<span class="sig-name descname"><span class="pre">getJDRestart</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getJDRestart" title="Link to this definition">#</a></dt>
<dd><p>Get the restart parameter used in the Jacobi-Davidson method.</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 number of vectors to be kept at restart.</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#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</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/PEP.pyx#L1896">Source code at slepc4py/SLEPc/PEP.pyx:1896</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getJDReusePreconditioner">
<span class="sig-name descname"><span class="pre">getJDReusePreconditioner</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getJDReusePreconditioner" title="Link to this definition">#</a></dt>
<dd><p>Get the flag for reusing 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>The reuse 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/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/PEP.pyx#L1960">Source code at slepc4py/SLEPc/PEP.pyx:1960</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getLinearEPS">
<span class="sig-name descname"><span class="pre">getLinearEPS</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getLinearEPS" title="Link to this definition">#</a></dt>
<dd><p>Get the eigensolver object associated to the polynomial eigenvalue solver.</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 eigensolver.</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.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></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1398">Source code at slepc4py/SLEPc/PEP.pyx:1398</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getLinearExplicitMatrix">
<span class="sig-name descname"><span class="pre">getLinearExplicitMatrix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getLinearExplicitMatrix" title="Link to this definition">#</a></dt>
<dd><p>Get if the matrices A and B for the linearization are built explicitly.</p>
<p>Not collective.</p>
<p>Get the flag indicating if the matrices A and B for the linearization
are built explicitly.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Boolean flag indicating if the matrices are built explicitly.</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/PEP.pyx#L1472">Source code at slepc4py/SLEPc/PEP.pyx:1472</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getLinearLinearization">
<span class="sig-name descname"><span class="pre">getLinearLinearization</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getLinearLinearization" title="Link to this definition">#</a></dt>
<dd><p>Get the coeffs. defining the linearization of a quadratic eigenproblem.</p>
<p>Not collective.</p>
<p>Return the coefficients that define the linearization of a quadratic
eigenproblem.</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>alpha</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>) – First parameter of the linearization.</p></li>
<li><p><strong>beta</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>) – Second parameter of the linearization.</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/PEP.pyx#L1434">Source code at slepc4py/SLEPc/PEP.pyx:1434</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getMonitor">
<span class="sig-name descname"><span class="pre">getMonitor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getMonitor" title="Link to this definition">#</a></dt>
<dd><p>Get the list of monitor functions.</p>
<p>Not collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1154">Source code at slepc4py/SLEPc/PEP.pyx:1154</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 internal" href="slepc4py.typing.PEPMonitorFunction.html#slepc4py.typing.PEPMonitorFunction" title="slepc4py.typing.PEPMonitorFunction"><em>PEPMonitorFunction</em></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getOperators">
<span class="sig-name descname"><span class="pre">getOperators</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getOperators" 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/PEP.pyx#L1041">Source code at slepc4py/SLEPc/PEP.pyx:1041</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.getOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Get the prefix used for searching for all PEP 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 PEP 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/PEP.pyx#L323">Source code at slepc4py/SLEPc/PEP.pyx:323</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getProblemType">
<span class="sig-name descname"><span class="pre">getProblemType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getProblemType" title="Link to this definition">#</a></dt>
<dd><p>Get the problem type from the PEP 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 problem type that was previously set.</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.PEP.ProblemType.html#slepc4py.SLEPc.PEP.ProblemType" title="slepc4py.SLEPc.PEP.ProblemType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ProblemType</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/PEP.pyx#L414">Source code at slepc4py/SLEPc/PEP.pyx:414</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getQArnoldiLocking">
<span class="sig-name descname"><span class="pre">getQArnoldiLocking</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getQArnoldiLocking" title="Link to this definition">#</a></dt>
<dd><p>Get the locking flag used in the Q-Arnoldi method.</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 locking 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/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/PEP.pyx#L1550">Source code at slepc4py/SLEPc/PEP.pyx:1550</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getQArnoldiRestart">
<span class="sig-name descname"><span class="pre">getQArnoldiRestart</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getQArnoldiRestart" title="Link to this definition">#</a></dt>
<dd><p>Get the restart parameter used in the Q-Arnoldi method.</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 number of vectors to be kept at restart.</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#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</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/PEP.pyx#L1514">Source code at slepc4py/SLEPc/PEP.pyx:1514</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getRG">
<span class="sig-name descname"><span class="pre">getRG</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getRG" title="Link to this definition">#</a></dt>
<dd><p>Get the region object associated to the eigensolver.</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 region context.</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.RG.html#slepc4py.SLEPc.RG" title="slepc4py.SLEPc.RG"><code class="xref any py py-class docutils literal notranslate"><span class="pre">RG</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/PEP.pyx#L983">Source code at slepc4py/SLEPc/PEP.pyx:983</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getRefine">
<span class="sig-name descname"><span class="pre">getRefine</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getRefine" title="Link to this definition">#</a></dt>
<dd><p>Get the refinement strategy used by the PEP object.</p>
<p>Not collective.</p>
<p>Get the refinement strategy used by the PEP object, and the associated
parameters.</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>ref</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Refine.html#slepc4py.SLEPc.PEP.Refine" title="slepc4py.SLEPc.PEP.Refine"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Refine</span></code></a>) – The refinement type.</p></li>
<li><p><strong>npart</strong> (<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>) – The number of partitions of the communicator.</p></li>
<li><p><strong>tol</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 convergence tolerance.</p></li>
<li><p><strong>its</strong> (<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>) – The maximum number of refinement iterations.</p></li>
<li><p><strong>scheme</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html#slepc4py.SLEPc.PEP.RefineScheme" title="slepc4py.SLEPc.PEP.RefineScheme"><code class="xref any py py-class docutils literal notranslate"><span class="pre">RefineScheme</span></code></a>) – Scheme for solving linear systems</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 internal" href="slepc4py.SLEPc.PEP.Refine.html#slepc4py.SLEPc.PEP.Refine" title="slepc4py.SLEPc.PEP.Refine">Refine</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</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#int" title="(in Python v3.14)">int</a>, <a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html#slepc4py.SLEPc.PEP.RefineScheme" title="slepc4py.SLEPc.PEP.RefineScheme">RefineScheme</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L632">Source code at slepc4py/SLEPc/PEP.pyx:632</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getRefineKSP">
<span class="sig-name descname"><span class="pre">getRefineKSP</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getRefineKSP" title="Link to this definition">#</a></dt>
<dd><p>Get the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object used by the eigensolver in the refinement phase.</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><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L702">Source code at slepc4py/SLEPc/PEP.pyx:702</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getST">
<span class="sig-name descname"><span class="pre">getST</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getST" title="Link to this definition">#</a></dt>
<dd><p>Get the <a class="reference internal" href="slepc4py.SLEPc.ST.html#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST</span></code></a> object associated to the eigensolver object.</p>
<p>Not collective.</p>
<p>Get the spectral transformation object associated to the eigensolver
object.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The spectral transformation.</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.html#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST</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/PEP.pyx#L828">Source code at slepc4py/SLEPc/PEP.pyx:828</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getSTOARCheckEigenvalueType">
<span class="sig-name descname"><span class="pre">getSTOARCheckEigenvalueType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getSTOARCheckEigenvalueType" title="Link to this definition">#</a></dt>
<dd><p>Get the flag for the eigenvalue type check in spectrum slicing.</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>Whether the eigenvalue type is checked or not.</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/PEP.pyx#L1857">Source code at slepc4py/SLEPc/PEP.pyx:1857</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getSTOARDetectZeros">
<span class="sig-name descname"><span class="pre">getSTOARDetectZeros</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getSTOARDetectZeros" title="Link to this definition">#</a></dt>
<dd><p>Get the flag that enforces zero detection in spectrum slicing.</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 zero detection 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/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/PEP.pyx#L1739">Source code at slepc4py/SLEPc/PEP.pyx:1739</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getSTOARDimensions">
<span class="sig-name descname"><span class="pre">getSTOARDimensions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getSTOARDimensions" title="Link to this definition">#</a></dt>
<dd><p>Get the dimensions used for each subsolve step.</p>
<p>Not collective.</p>
<p>Get the dimensions used for each subsolve step in case of doing
spectrum slicing for a computational interval.</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>nev</strong> (<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>) – Number of eigenvalues to compute.</p></li>
<li><p><strong>ncv</strong> (<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>) – Maximum dimension of the subspace to be used by the solver.</p></li>
<li><p><strong>mpd</strong> (<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>) – Maximum dimension allowed for the projected problem.</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#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1786">Source code at slepc4py/SLEPc/PEP.pyx:1786</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getSTOARInertias">
<span class="sig-name descname"><span class="pre">getSTOARInertias</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getSTOARInertias" title="Link to this definition">#</a></dt>
<dd><p>Get the values of the shifts and their corresponding inertias.</p>
<p>Not collective.</p>
<p>Get the values of the shifts and their corresponding inertias
in case of doing spectrum slicing for a computational interval.</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>shifts</strong> (<a class="reference internal" href="slepc4py.typing.ArrayReal.html#slepc4py.typing.ArrayReal" title="slepc4py.typing.ArrayReal"><code class="xref any py py-data docutils literal notranslate"><span class="pre">ArrayReal</span></code></a>) – The values of the shifts used internally in the solver.</p></li>
<li><p><strong>inertias</strong> (<a class="reference internal" href="slepc4py.typing.ArrayInt.html#slepc4py.typing.ArrayInt" title="slepc4py.typing.ArrayInt"><code class="xref any py py-data docutils literal notranslate"><span class="pre">ArrayInt</span></code></a>) – The values of the inertia in each shift.</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 internal" href="slepc4py.typing.ArrayReal.html#slepc4py.typing.ArrayReal" title="slepc4py.typing.ArrayReal"><em>ArrayReal</em></a>, <a class="reference internal" href="slepc4py.typing.ArrayInt.html#slepc4py.typing.ArrayInt" title="slepc4py.typing.ArrayInt"><em>ArrayInt</em></a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1810">Source code at slepc4py/SLEPc/PEP.pyx:1810</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getSTOARLinearization">
<span class="sig-name descname"><span class="pre">getSTOARLinearization</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getSTOARLinearization" title="Link to this definition">#</a></dt>
<dd><p>Get the coefficients that define the linearization of a quadratic eigenproblem.</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>alpha</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>) – First parameter of the linearization.</p></li>
<li><p><strong>beta</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>) – Second parameter of the linearization.</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/PEP.pyx#L1659">Source code at slepc4py/SLEPc/PEP.pyx:1659</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getSTOARLocking">
<span class="sig-name descname"><span class="pre">getSTOARLocking</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getSTOARLocking" title="Link to this definition">#</a></dt>
<dd><p>Get the locking flag used in the STOAR method.</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 locking 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/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/PEP.pyx#L1698">Source code at slepc4py/SLEPc/PEP.pyx:1698</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getScale">
<span class="sig-name descname"><span class="pre">getScale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Dl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dr</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.PEP.getScale" title="Link to this definition">#</a></dt>
<dd><p>Get the strategy used for scaling the polynomial eigenproblem.</p>
<p>Not 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>Dl</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>petsc4py.PETSc.Vec</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>) – Placeholder for the returned left diagonal matrix.</p></li>
<li><p><strong>Dr</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>petsc4py.PETSc.Vec</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>) – Placeholder for the returned right diagonal matrix.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>scale</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html#slepc4py.SLEPc.PEP.Scale" title="slepc4py.SLEPc.PEP.Scale"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Scale</span></code></a>) – The scaling strategy.</p></li>
<li><p><strong>alpha</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 scaling factor.</p></li>
<li><p><strong>its</strong> (<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>) – The number of iteration of diagonal scaling.</p></li>
<li><p><strong>lbda</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>) – Approximation of the wanted eigenvalues (modulus).</p></li>
</ul>
</p>
</dd>
<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/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html#slepc4py.SLEPc.PEP.Scale" title="slepc4py.SLEPc.PEP.Scale">Scale</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#int" title="(in Python v3.14)">int</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/PEP.pyx#L860">Source code at slepc4py/SLEPc/PEP.pyx:860</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getStoppingTest">
<span class="sig-name descname"><span class="pre">getStoppingTest</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getStoppingTest" title="Link to this definition">#</a></dt>
<dd><p>Get the stopping function.</p>
<p>Not collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1123">Source code at slepc4py/SLEPc/PEP.pyx:1123</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 internal" href="slepc4py.typing.PEPStoppingFunction.html#slepc4py.typing.PEPStoppingFunction" title="slepc4py.typing.PEPStoppingFunction"><em>PEPStoppingFunction</em></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getTOARLocking">
<span class="sig-name descname"><span class="pre">getTOARLocking</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getTOARLocking" title="Link to this definition">#</a></dt>
<dd><p>Get the locking flag used in the TOAR method.</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 locking 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/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/PEP.pyx#L1625">Source code at slepc4py/SLEPc/PEP.pyx:1625</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getTOARRestart">
<span class="sig-name descname"><span class="pre">getTOARRestart</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getTOARRestart" title="Link to this definition">#</a></dt>
<dd><p>Get the restart parameter used in the TOAR method.</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 number of vectors to be kept at restart.</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#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</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/PEP.pyx#L1589">Source code at slepc4py/SLEPc/PEP.pyx:1589</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getTarget">
<span class="sig-name descname"><span class="pre">getTarget</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getTarget" title="Link to this definition">#</a></dt>
<dd><p>Get the value of the target.</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 target.</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 class="rubric">Notes</p>
<p>If the target was not set by the user, then zero is returned.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L472">Source code at slepc4py/SLEPc/PEP.pyx:472</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getTolerances">
<span class="sig-name descname"><span class="pre">getTolerances</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getTolerances" title="Link to this definition">#</a></dt>
<dd><p>Get the tolerance and maximum iteration count.</p>
<p>Not collective.</p>
<p>Get the tolerance and maximum iteration count used by the default PEP
convergence tests.</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>tol</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 convergence tolerance.</p></li>
<li><p><strong>max_it</strong> (<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>) – The maximum number of iterations</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#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L511">Source code at slepc4py/SLEPc/PEP.pyx:511</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getTrackAll">
<span class="sig-name descname"><span class="pre">getTrackAll</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getTrackAll" title="Link to this definition">#</a></dt>
<dd><p>Get the flag indicating whether all residual norms must be computed.</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>Whether the solver compute all residuals or not.</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/PEP.pyx#L747">Source code at slepc4py/SLEPc/PEP.pyx:747</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.getType" title="Link to this definition">#</a></dt>
<dd><p>Get the PEP 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 solver 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/PEP.pyx#L308">Source code at slepc4py/SLEPc/PEP.pyx:308</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.getWhichEigenpairs">
<span class="sig-name descname"><span class="pre">getWhichEigenpairs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.getWhichEigenpairs" title="Link to this definition">#</a></dt>
<dd><p>Get which portion of the spectrum is to be sought.</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 portion of the spectrum to be sought by the solver.</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.PEP.Which.html#slepc4py.SLEPc.PEP.Which" title="slepc4py.SLEPc.PEP.Which"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Which</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/PEP.pyx#L443">Source code at slepc4py/SLEPc/PEP.pyx:443</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.reset" title="Link to this definition">#</a></dt>
<dd><p>Reset the PEP object.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L268">Source code at slepc4py/SLEPc/PEP.pyx:268</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.PEP.setBV">
<span class="sig-name descname"><span class="pre">setBV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bv</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setBV" title="Link to this definition">#</a></dt>
<dd><p>Set a basis vectors object associated to the eigensolver.</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>bv</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.html#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a>) – The basis vectors context.</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/PEP.pyx#L970">Source code at slepc4py/SLEPc/PEP.pyx:970</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setBasis">
<span class="sig-name descname"><span class="pre">setBasis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">basis</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setBasis" title="Link to this definition">#</a></dt>
<dd><p>Set the type of polynomial basis used.</p>
<p>Logically collective.</p>
<p>Set the type of polynomial basis used to describe the polynomial
eigenvalue problem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>basis</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Basis.html#slepc4py.SLEPc.PEP.Basis" title="slepc4py.SLEPc.PEP.Basis"><em>Basis</em></a>) – The basis to be set.</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/PEP.pyx#L397">Source code at slepc4py/SLEPc/PEP.pyx:397</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setCISSExtraction">
<span class="sig-name descname"><span class="pre">setCISSExtraction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extraction</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setCISSExtraction" title="Link to this definition">#</a></dt>
<dd><p>Set the extraction technique used in the CISS solver.</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>extraction</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.CISSExtraction.html#slepc4py.SLEPc.PEP.CISSExtraction" title="slepc4py.SLEPc.PEP.CISSExtraction"><em>CISSExtraction</em></a>) – The extraction technique.</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/PEP.pyx#L2035">Source code at slepc4py/SLEPc/PEP.pyx:2035</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setCISSRefinement">
<span class="sig-name descname"><span class="pre">setCISSRefinement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blsize</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.PEP.setCISSRefinement" title="Link to this definition">#</a></dt>
<dd><p>Set the values of various refinement parameters in the CISS solver.</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>inner</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Number of iterative refinement iterations (inner loop).</p></li>
<li><p><strong>blsize</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Number of iterative refinement iterations (blocksize loop).</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/PEP.pyx#L2181">Source code at slepc4py/SLEPc/PEP.pyx:2181</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setCISSSizes">
<span class="sig-name descname"><span class="pre">setCISSSizes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">npart</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bsmax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">realmats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setCISSSizes" title="Link to this definition">#</a></dt>
<dd><p>Set the values of various size parameters in the CISS solver.</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>ip</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Number of integration points.</p></li>
<li><p><strong>bs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Block size.</p></li>
<li><p><strong>ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Moment size.</p></li>
<li><p><strong>npart</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Number of partitions when splitting the communicator.</p></li>
<li><p><strong>bsmax</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Maximum block size.</p></li>
<li><p><strong>realmats</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – True if A and B are real.</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 default number of partitions is 1. This means the internal
<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> object is shared among all processes of the <a class="reference internal" href="#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a>
communicator. Otherwise, the communicator is split into npart
communicators, so that <code class="docutils literal notranslate"><span class="pre">npart</span></code> <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> solves proceed
simultaneously.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2064">Source code at slepc4py/SLEPc/PEP.pyx:2064</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setCISSThreshold">
<span class="sig-name descname"><span class="pre">setCISSThreshold</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spur</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.PEP.setCISSThreshold" title="Link to this definition">#</a></dt>
<dd><p>Set the values of various threshold parameters in the CISS solver.</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>delta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</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>) – Threshold for numerical rank.</p></li>
<li><p><strong>spur</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</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>) – Spurious threshold (to discard spurious eigenpairs).</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/PEP.pyx#L2144">Source code at slepc4py/SLEPc/PEP.pyx:2144</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setConvergenceTest">
<span class="sig-name descname"><span class="pre">setConvergenceTest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conv</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setConvergenceTest" title="Link to this definition">#</a></dt>
<dd><p>Set how to compute the error estimate used in the convergence test.</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>conv</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Conv.html#slepc4py.SLEPc.PEP.Conv" title="slepc4py.SLEPc.PEP.Conv"><em>Conv</em></a>) – The method used to compute the error estimate
used in the convergence test.</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/PEP.pyx#L617">Source code at slepc4py/SLEPc/PEP.pyx:617</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setDS">
<span class="sig-name descname"><span class="pre">setDS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setDS" title="Link to this definition">#</a></dt>
<dd><p>Set a direct solver object associated to the eigensolver.</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>ds</strong> (<a class="reference internal" href="slepc4py.SLEPc.DS.html#slepc4py.SLEPc.DS" title="slepc4py.SLEPc.DS"><em>DS</em></a>) – The direct solver context.</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/PEP.pyx#L1028">Source code at slepc4py/SLEPc/PEP.pyx:1028</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setDimensions">
<span class="sig-name descname"><span class="pre">setDimensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nev</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mpd</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.PEP.setDimensions" title="Link to this definition">#</a></dt>
<dd><p>Set the number of eigenvalues to compute and the dimension of the subspace.</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>nev</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Number of eigenvalues to compute.</p></li>
<li><p><strong>ncv</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Maximum dimension of the subspace to be used by the solver.</p></li>
<li><p><strong>mpd</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Maximum dimension allowed for the projected problem.</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/PEP.pyx#L800">Source code at slepc4py/SLEPc/PEP.pyx:800</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setExtract">
<span class="sig-name descname"><span class="pre">setExtract</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extract</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setExtract" title="Link to this definition">#</a></dt>
<dd><p>Set the extraction strategy 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>extract</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Extract.html#slepc4py.SLEPc.PEP.Extract" title="slepc4py.SLEPc.PEP.Extract"><em>Extract</em></a>) – The extraction strategy.</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/PEP.pyx#L718">Source code at slepc4py/SLEPc/PEP.pyx:718</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.setFromOptions" title="Link to this definition">#</a></dt>
<dd><p>Set PEP options from the options database.</p>
<p>Collective.</p>
<p>This routine must be called before <a class="reference internal" href="#slepc4py.SLEPc.PEP.setUp" title="slepc4py.SLEPc.PEP.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><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L368">Source code at slepc4py/SLEPc/PEP.pyx:368</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.PEP.setInitialSpace">
<span class="sig-name descname"><span class="pre">setInitialSpace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setInitialSpace" title="Link to this definition">#</a></dt>
<dd><p>Set the initial space from which the eigensolver starts to iterate.</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>space</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><em> | </em><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.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a><em>]</em>) – The initial space</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/PEP.pyx#L1083">Source code at slepc4py/SLEPc/PEP.pyx:1083</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setInterval">
<span class="sig-name descname"><span class="pre">setInterval</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.PEP.setInterval" title="Link to this definition">#</a></dt>
<dd><p>Set the computational interval for spectrum slicing.</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>Spectrum slicing is a technique employed for computing all
eigenvalues of symmetric quadratic eigenproblems in a given interval.
This function provides the interval to be considered. It must
be used in combination with <a class="reference internal" href="slepc4py.SLEPc.PEP.Which.html#slepc4py.SLEPc.PEP.Which.ALL" title="slepc4py.SLEPc.PEP.Which.ALL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">PEP.Which.ALL</span></code></a>, see
<a class="reference internal" href="#slepc4py.SLEPc.PEP.setWhichEigenpairs" title="slepc4py.SLEPc.PEP.setWhichEigenpairs"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setWhichEigenpairs()</span></code></a>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L576">Source code at slepc4py/SLEPc/PEP.pyx:576</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setJDFix">
<span class="sig-name descname"><span class="pre">setJDFix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setJDFix" title="Link to this definition">#</a></dt>
<dd><p>Set the threshold for changing the target in the correction equation.</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>fix</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – Threshold for changing the target.</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>The target in the correction equation is fixed at the first iterations.
When the norm of the residual vector is lower than the fix value,
the target is set to the corresponding eigenvalue.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1911">Source code at slepc4py/SLEPc/PEP.pyx:1911</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setJDMinimalityIndex">
<span class="sig-name descname"><span class="pre">setJDMinimalityIndex</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setJDMinimalityIndex" title="Link to this definition">#</a></dt>
<dd><p>Set the maximum allowed value for the minimality index.</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#int" title="(in Python v3.14)"><em>int</em></a>) – The maximum minimality index.</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/PEP.pyx#L1975">Source code at slepc4py/SLEPc/PEP.pyx:1975</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setJDProjection">
<span class="sig-name descname"><span class="pre">setJDProjection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setJDProjection" title="Link to this definition">#</a></dt>
<dd><p>Set the type of projection to be used in the Jacobi-Davidson solver.</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>proj</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.JDProjection.html#slepc4py.SLEPc.PEP.JDProjection" title="slepc4py.SLEPc.PEP.JDProjection"><em>JDProjection</em></a>) – The type of projection.</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/PEP.pyx#L2004">Source code at slepc4py/SLEPc/PEP.pyx:2004</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setJDRestart">
<span class="sig-name descname"><span class="pre">setJDRestart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keep</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setJDRestart" title="Link to this definition">#</a></dt>
<dd><p>Set the restart parameter for the Jacobi-Davidson method.</p>
<p>Logically collective.</p>
<p>Set the restart parameter for the Jacobi-Davidson method, in
particular the proportion of basis vectors that must be kept
after restart.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>keep</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 number of vectors to be kept at restart.</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>Allowed values are in the range [0.1,0.9]. The default is 0.5.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1874">Source code at slepc4py/SLEPc/PEP.pyx:1874</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setJDReusePreconditioner">
<span class="sig-name descname"><span class="pre">setJDReusePreconditioner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setJDReusePreconditioner" title="Link to this definition">#</a></dt>
<dd><p>Set a flag indicating whether the preconditioner must be reused 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>) – The reuse 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><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1946">Source code at slepc4py/SLEPc/PEP.pyx:1946</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setLinearEPS">
<span class="sig-name descname"><span class="pre">setLinearEPS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">eps</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setLinearEPS" title="Link to this definition">#</a></dt>
<dd><p>Set an eigensolver object associated to the polynomial eigenvalue solver.</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>eps</strong> (<a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS" title="slepc4py.SLEPc.EPS"><em>EPS</em></a>) – The linear eigensolver.</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/PEP.pyx#L1385">Source code at slepc4py/SLEPc/PEP.pyx:1385</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setLinearExplicitMatrix">
<span class="sig-name descname"><span class="pre">setLinearExplicitMatrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setLinearExplicitMatrix" title="Link to this definition">#</a></dt>
<dd><p>Set flag to explicitly build the matrices A and B.</p>
<p>Logically collective.</p>
<p>Toggle if the matrices A and B for the linearization of the problem
must be built explicitly.</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>) – Boolean flag indicating if the matrices are built explicitly.</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/PEP.pyx#L1455">Source code at slepc4py/SLEPc/PEP.pyx:1455</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setLinearLinearization">
<span class="sig-name descname"><span class="pre">setLinearLinearization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setLinearLinearization" title="Link to this definition">#</a></dt>
<dd><p>Set the coefficients that define the linearization of a quadratic eigenproblem.</p>
<p>Logically collective.</p>
<p>Set the coefficients that define the linearization of a quadratic
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>alpha</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – First parameter of the linearization.</p></li>
<li><p><strong>beta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – Second parameter of the linearization.</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/PEP.pyx#L1414">Source code at slepc4py/SLEPc/PEP.pyx:1414</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setMonitor">
<span class="sig-name descname"><span class="pre">setMonitor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">monitor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kargs</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.PEP.setMonitor" title="Link to this definition">#</a></dt>
<dd><p>Append a monitor function to the list of monitors.</p>
<p>Logically collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1133">Source code at slepc4py/SLEPc/PEP.pyx:1133</a></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>monitor</strong> (<a class="reference internal" href="slepc4py.typing.PEPMonitorFunction.html#slepc4py.typing.PEPMonitorFunction" title="slepc4py.typing.PEPMonitorFunction"><em>PEPMonitorFunction</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>
<li><p><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><em>tuple</em></a><em>[</em><em>Any</em><em>, </em><em>...</em><em>] </em><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>
<li><p><strong>kargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</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><em>, </em><em>Any</em><em>] </em><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>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setOperators">
<span class="sig-name descname"><span class="pre">setOperators</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.PEP.setOperators" 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/PEP.pyx#L1063">Source code at slepc4py/SLEPc/PEP.pyx:1063</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.setOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Set the prefix used for searching for all PEP 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 PEP 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/PEP.pyx#L338">Source code at slepc4py/SLEPc/PEP.pyx:338</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setProblemType">
<span class="sig-name descname"><span class="pre">setProblemType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">problem_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setProblemType" title="Link to this definition">#</a></dt>
<dd><p>Set the type of the eigenvalue problem.</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>problem_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.ProblemType.html#slepc4py.SLEPc.PEP.ProblemType" title="slepc4py.SLEPc.PEP.ProblemType"><em>ProblemType</em></a>) – The problem type to be set.</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/PEP.pyx#L429">Source code at slepc4py/SLEPc/PEP.pyx:429</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setQArnoldiLocking">
<span class="sig-name descname"><span class="pre">setQArnoldiLocking</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lock</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setQArnoldiLocking" title="Link to this definition">#</a></dt>
<dd><p>Toggle between locking and non-locking variants of the Q-Arnoldi method.</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>lock</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – True if the locking variant must be selected.</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>The default is to lock converged eigenpairs when the method restarts.
This behavior can be changed so that all directions are kept in the
working subspace even if already converged to working accuracy (the
non-locking variant).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1529">Source code at slepc4py/SLEPc/PEP.pyx:1529</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setQArnoldiRestart">
<span class="sig-name descname"><span class="pre">setQArnoldiRestart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keep</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setQArnoldiRestart" title="Link to this definition">#</a></dt>
<dd><p>Set the restart parameter for the Q-Arnoldi method.</p>
<p>Logically collective.</p>
<p>Set the restart parameter for the Q-Arnoldi method, in
particular the proportion of basis vectors that must be kept
after restart.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>keep</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 number of vectors to be kept at restart.</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>Allowed values are in the range [0.1,0.9]. The default is 0.5.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1492">Source code at slepc4py/SLEPc/PEP.pyx:1492</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setRG">
<span class="sig-name descname"><span class="pre">setRG</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setRG" title="Link to this definition">#</a></dt>
<dd><p>Set a region object associated to the eigensolver.</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>rg</strong> (<a class="reference internal" href="slepc4py.SLEPc.RG.html#slepc4py.SLEPc.RG" title="slepc4py.SLEPc.RG"><em>RG</em></a>) – The region context.</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/PEP.pyx#L999">Source code at slepc4py/SLEPc/PEP.pyx:999</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setRefine">
<span class="sig-name descname"><span class="pre">setRefine</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ref</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">npart</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">its</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheme</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.PEP.setRefine" title="Link to this definition">#</a></dt>
<dd><p>Set the refinement strategy used by the PEP object.</p>
<p>Logically collective.</p>
<p>Set the refinement strategy used by the PEP object, and the associated
parameters.</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>ref</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Refine.html#slepc4py.SLEPc.PEP.Refine" title="slepc4py.SLEPc.PEP.Refine"><em>Refine</em></a>) – The refinement type.</p></li>
<li><p><strong>npart</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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 number of partitions of the communicator.</p></li>
<li><p><strong>tol</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</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 convergence tolerance.</p></li>
<li><p><strong>its</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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 maximum number of refinement iterations.</p></li>
<li><p><strong>scheme</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html#slepc4py.SLEPc.PEP.RefineScheme" title="slepc4py.SLEPc.PEP.RefineScheme"><em>RefineScheme</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>) – Scheme for linear system solves</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/PEP.pyx#L662">Source code at slepc4py/SLEPc/PEP.pyx:662</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setST">
<span class="sig-name descname"><span class="pre">setST</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">st</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setST" title="Link to this definition">#</a></dt>
<dd><p>Set a spectral transformation object associated to the eigensolver.</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>st</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.html#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><em>ST</em></a>) – The spectral transformation.</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/PEP.pyx#L847">Source code at slepc4py/SLEPc/PEP.pyx:847</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setSTOARCheckEigenvalueType">
<span class="sig-name descname"><span class="pre">setSTOARCheckEigenvalueType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setSTOARCheckEigenvalueType" title="Link to this definition">#</a></dt>
<dd><p>Set flag to check if all eigenvalues have the same definite type.</p>
<p>Logically collective.</p>
<p>Set a flag to check that all the eigenvalues obtained throughout the
spectrum slicing computation have the same definite type.</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>) – Whether the eigenvalue type is checked or not.</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/PEP.pyx#L1840">Source code at slepc4py/SLEPc/PEP.pyx:1840</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setSTOARDetectZeros">
<span class="sig-name descname"><span class="pre">setSTOARDetectZeros</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">detect</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setSTOARDetectZeros" title="Link to this definition">#</a></dt>
<dd><p>Set flag to enforce detection of zeros during the factorizations.</p>
<p>Logically collective.</p>
<p>Set a flag to enforce detection of zeros during the factorizations
throughout the spectrum slicing computation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>detect</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – True if zeros must checked for.</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 zero in the factorization indicates that a shift coincides with
an eigenvalue.</p>
<p>This flag is turned off by default, and may be necessary in some cases.
This feature currently requires an external package for factorizations
with support for zero detection, e.g. MUMPS.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1713">Source code at slepc4py/SLEPc/PEP.pyx:1713</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setSTOARDimensions">
<span class="sig-name descname"><span class="pre">setSTOARDimensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nev</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mpd</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.PEP.setSTOARDimensions" title="Link to this definition">#</a></dt>
<dd><p>Set the dimensions used for each subsolve step.</p>
<p>Logically collective.</p>
<p>Set the dimensions used for each subsolve step in case of doing
spectrum slicing for a computational interval. The meaning of the
parameters is the same as in <a class="reference internal" href="#slepc4py.SLEPc.PEP.setDimensions" title="slepc4py.SLEPc.PEP.setDimensions"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setDimensions()</span></code></a>.</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>nev</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Number of eigenvalues to compute.</p></li>
<li><p><strong>ncv</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Maximum dimension of the subspace to be used by the solver.</p></li>
<li><p><strong>mpd</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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>) – Maximum dimension allowed for the projected problem.</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/PEP.pyx#L1754">Source code at slepc4py/SLEPc/PEP.pyx:1754</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setSTOARLinearization">
<span class="sig-name descname"><span class="pre">setSTOARLinearization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setSTOARLinearization" title="Link to this definition">#</a></dt>
<dd><p>Set the coefficients that define the linearization of a quadratic eigenproblem.</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>alpha</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – First parameter of the linearization.</p></li>
<li><p><strong>beta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – Second parameter of the linearization.</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/PEP.pyx#L1642">Source code at slepc4py/SLEPc/PEP.pyx:1642</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setSTOARLocking">
<span class="sig-name descname"><span class="pre">setSTOARLocking</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lock</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setSTOARLocking" title="Link to this definition">#</a></dt>
<dd><p>Toggle between locking and non-locking variants of the STOAR method.</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>lock</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – True if the locking variant must be selected.</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>The default is to lock converged eigenpairs when the method restarts.
This behavior can be changed so that all directions are kept in the
working subspace even if already converged to working accuracy (the
non-locking variant).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1677">Source code at slepc4py/SLEPc/PEP.pyx:1677</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setScale">
<span class="sig-name descname"><span class="pre">setScale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scale</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">its</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lbda</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.PEP.setScale" title="Link to this definition">#</a></dt>
<dd><p>Set the scaling strategy to be used.</p>
<p>Collective.</p>
<p>Set the scaling strategy to be used for scaling the polynomial problem
before attempting to solve.</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>scale</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html#slepc4py.SLEPc.PEP.Scale" title="slepc4py.SLEPc.PEP.Scale"><em>Scale</em></a>) – The scaling strategy.</p></li>
<li><p><strong>alpha</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</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 scaling factor.</p></li>
<li><p><strong>Dl</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>petsc4py.PETSc.Vec</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 left diagonal matrix.</p></li>
<li><p><strong>Dr</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>petsc4py.PETSc.Vec</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 right diagonal matrix.</p></li>
<li><p><strong>its</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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 number of iteration of diagonal scaling.</p></li>
<li><p><strong>lbda</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</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>) – Approximation of the wanted eigenvalues (modulus).</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/PEP.pyx#L909">Source code at slepc4py/SLEPc/PEP.pyx:909</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setStoppingTest">
<span class="sig-name descname"><span class="pre">setStoppingTest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stopping</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kargs</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.PEP.setStoppingTest" title="Link to this definition">#</a></dt>
<dd><p>Set a function to decide when to stop the outer iteration of the eigensolver.</p>
<p>Logically collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1103">Source code at slepc4py/SLEPc/PEP.pyx:1103</a></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>stopping</strong> (<a class="reference internal" href="slepc4py.typing.PEPStoppingFunction.html#slepc4py.typing.PEPStoppingFunction" title="slepc4py.typing.PEPStoppingFunction"><em>PEPStoppingFunction</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>
<li><p><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><em>tuple</em></a><em>[</em><em>Any</em><em>, </em><em>...</em><em>] </em><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>
<li><p><strong>kargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</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><em>, </em><em>Any</em><em>] </em><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>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setTOARLocking">
<span class="sig-name descname"><span class="pre">setTOARLocking</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lock</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setTOARLocking" title="Link to this definition">#</a></dt>
<dd><p>Toggle between locking and non-locking variants of the TOAR method.</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>lock</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – True if the locking variant must be selected.</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>The default is to lock converged eigenpairs when the method restarts.
This behavior can be changed so that all directions are kept in the
working subspace even if already converged to working accuracy (the
non-locking variant).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1604">Source code at slepc4py/SLEPc/PEP.pyx:1604</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setTOARRestart">
<span class="sig-name descname"><span class="pre">setTOARRestart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keep</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setTOARRestart" title="Link to this definition">#</a></dt>
<dd><p>Set the restart parameter for the TOAR method.</p>
<p>Logically collective.</p>
<p>Set the restart parameter for the TOAR method, in
particular the proportion of basis vectors that must be kept
after restart.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>keep</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 number of vectors to be kept at restart.</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>Allowed values are in the range [0.1,0.9]. The default is 0.5.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1567">Source code at slepc4py/SLEPc/PEP.pyx:1567</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setTarget">
<span class="sig-name descname"><span class="pre">setTarget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setTarget" title="Link to this definition">#</a></dt>
<dd><p>Set the value of the target.</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>target</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 target.</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>The target is a scalar value used to determine the portion of
the spectrum of interest. It is used in combination with
<a class="reference internal" href="#slepc4py.SLEPc.PEP.setWhichEigenpairs" title="slepc4py.SLEPc.PEP.setWhichEigenpairs"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setWhichEigenpairs()</span></code></a>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L491">Source code at slepc4py/SLEPc/PEP.pyx:491</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setTolerances">
<span class="sig-name descname"><span class="pre">setTolerances</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_it</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.PEP.setTolerances" title="Link to this definition">#</a></dt>
<dd><p>Set the tolerance and maximum iteration count.</p>
<p>Logically collective.</p>
<p>Set the tolerance and maximum iteration count used by the default PEP
convergence tests.</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>tol</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</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 convergence tolerance.</p></li>
<li><p><strong>max_it</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</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 maximum number of iterations</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/PEP.pyx#L532">Source code at slepc4py/SLEPc/PEP.pyx:532</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.setTrackAll">
<span class="sig-name descname"><span class="pre">setTrackAll</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trackall</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setTrackAll" title="Link to this definition">#</a></dt>
<dd><p>Set flag to compute the residual of all approximate eigenpairs.</p>
<p>Logically collective.</p>
<p>Set if the solver must compute the residual of all approximate
eigenpairs or not.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>trackall</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Whether compute all residuals or not.</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/PEP.pyx#L762">Source code at slepc4py/SLEPc/PEP.pyx:762</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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">pep_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setType" title="Link to this definition">#</a></dt>
<dd><p>Set the particular solver to be used in the PEP object.</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>pep_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Type.html#slepc4py.SLEPc.PEP.Type" title="slepc4py.SLEPc.PEP.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 solver 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><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L293">Source code at slepc4py/SLEPc/PEP.pyx:293</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.setUp" title="Link to this definition">#</a></dt>
<dd><p>Set up all the necessary internal data structures.</p>
<p>Collective.</p>
<p>Set up all the internal data structures necessary for the execution of
the eigensolver.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1173">Source code at slepc4py/SLEPc/PEP.pyx:1173</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.PEP.setWhichEigenpairs">
<span class="sig-name descname"><span class="pre">setWhichEigenpairs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">which</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.setWhichEigenpairs" title="Link to this definition">#</a></dt>
<dd><p>Set which portion of the spectrum is to be sought.</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>which</strong> (<a class="reference internal" href="slepc4py.SLEPc.PEP.Which.html#slepc4py.SLEPc.PEP.Which" title="slepc4py.SLEPc.PEP.Which"><em>Which</em></a>) – The portion of the spectrum to be sought by the solver.</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/PEP.pyx#L458">Source code at slepc4py/SLEPc/PEP.pyx:458</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.solve">
<span class="sig-name descname"><span class="pre">solve</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.PEP.solve" title="Link to this definition">#</a></dt>
<dd><p>Solve the eigensystem.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L1184">Source code at slepc4py/SLEPc/PEP.pyx:1184</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.PEP.valuesView">
<span class="sig-name descname"><span class="pre">valuesView</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.PEP.valuesView" title="Link to this definition">#</a></dt>
<dd><p>Display the computed eigenvalues in a viewer.</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/PEP.pyx#L1353">Source code at slepc4py/SLEPc/PEP.pyx:1353</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.vectorsView">
<span class="sig-name descname"><span class="pre">vectorsView</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.PEP.vectorsView" title="Link to this definition">#</a></dt>
<dd><p>Output computed eigenvectors to a viewer.</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/PEP.pyx#L1368">Source code at slepc4py/SLEPc/PEP.pyx:1368</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.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.PEP.view" title="Link to this definition">#</a></dt>
<dd><p>Print the PEP 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/PEP.pyx#L243">Source code at slepc4py/SLEPc/PEP.pyx:243</a></p>
</dd></dl>

<p class="rubric">Attributes Documentation</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.bv">
<span class="sig-name descname"><span class="pre">bv</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.bv" title="Link to this definition">#</a></dt>
<dd><p>The basis vectors (BV) object associated.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2299">Source code at slepc4py/SLEPc/PEP.pyx:2299</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.ds">
<span class="sig-name descname"><span class="pre">ds</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.ds" title="Link to this definition">#</a></dt>
<dd><p>The direct solver (DS) object associated.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2313">Source code at slepc4py/SLEPc/PEP.pyx:2313</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.extract">
<span class="sig-name descname"><span class="pre">extract</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.extract" title="Link to this definition">#</a></dt>
<dd><p>The type of extraction technique to be employed.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2264">Source code at slepc4py/SLEPc/PEP.pyx:2264</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.max_it">
<span class="sig-name descname"><span class="pre">max_it</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.max_it" title="Link to this definition">#</a></dt>
<dd><p>The maximum iteration count.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2278">Source code at slepc4py/SLEPc/PEP.pyx:2278</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.problem_type">
<span class="sig-name descname"><span class="pre">problem_type</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.problem_type" title="Link to this definition">#</a></dt>
<dd><p>The type of the eigenvalue problem.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2243">Source code at slepc4py/SLEPc/PEP.pyx:2243</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.rg">
<span class="sig-name descname"><span class="pre">rg</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.rg" title="Link to this definition">#</a></dt>
<dd><p>The region (RG) object associated.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2306">Source code at slepc4py/SLEPc/PEP.pyx:2306</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.st">
<span class="sig-name descname"><span class="pre">st</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.st" title="Link to this definition">#</a></dt>
<dd><p>The spectral transformation (ST) object associated.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2292">Source code at slepc4py/SLEPc/PEP.pyx:2292</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.target">
<span class="sig-name descname"><span class="pre">target</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.target" title="Link to this definition">#</a></dt>
<dd><p>The value of the target.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2257">Source code at slepc4py/SLEPc/PEP.pyx:2257</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.tol">
<span class="sig-name descname"><span class="pre">tol</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.tol" title="Link to this definition">#</a></dt>
<dd><p>The tolerance.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2271">Source code at slepc4py/SLEPc/PEP.pyx:2271</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.track_all">
<span class="sig-name descname"><span class="pre">track_all</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.track_all" title="Link to this definition">#</a></dt>
<dd><p>Compute the residual norm of all approximate eigenpairs.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2285">Source code at slepc4py/SLEPc/PEP.pyx:2285</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.PEP.which">
<span class="sig-name descname"><span class="pre">which</span></span><a class="headerlink" href="#slepc4py.SLEPc.PEP.which" title="Link to this definition">#</a></dt>
<dd><p>The portion of the spectrum to be sought.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/PEP.pyx#L2250">Source code at slepc4py/SLEPc/PEP.pyx:2250</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.NEP.Which.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.NEP.Which</p>
      </div>
    </a>
    <a class="right-next"
       href="slepc4py.SLEPc.PEP.Basis.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">slepc4py.SLEPc.PEP.Basis</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.PEP.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>