File: slepc4py.SLEPc.ST.html

package info (click to toggle)
slepc 3.24.3%2Bdfsg1-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 123,084 kB
sloc: ansic: 104,372; javascript: 13,128; python: 7,079; f90: 3,312; cpp: 1,528; makefile: 761; xml: 693; sh: 347
file content (1963 lines) | stat: -rw-r--r-- 164,702 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.ST &#8212; slepc4py 3.24.3 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=9775c356" />
  
  <!-- 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=58358ab5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'reference/slepc4py.SLEPc.ST';</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="slepc4py.SLEPc.ST.FilterDamping" href="slepc4py.SLEPc.ST.FilterDamping.html" />
    <link rel="prev" title="slepc4py.SLEPc.RG.Type" href="slepc4py.SLEPc.RG.Type.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  <meta name="docsearch:version" content="3.24" />
    <meta name="docbuild:last-update" content="2026-03-09T10:12:57+0100 (v3.24.3)"/>
  </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">slepc4py 3.24.3 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 ">
  <a class="nav-link nav-internal" href="../changes.html">
    CHANGES
  </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="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 ">
  <a class="nav-link nav-internal" href="../changes.html">
    CHANGES
  </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.PEPEigenvalueComparison.html">slepc4py.typing.PEPEigenvalueComparison</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.NEPEigenvalueComparison.html">slepc4py.typing.NEPEigenvalueComparison</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.SVDMethod.html">slepc4py.SLEPc.BV.SVDMethod</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 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 has-children"><a class="reference internal" href="slepc4py.SLEPc.FN.html">slepc4py.SLEPc.FN</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.CombineType.html">slepc4py.SLEPc.FN.CombineType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.ParallelType.html">slepc4py.SLEPc.FN.ParallelType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.Type.html">slepc4py.SLEPc.FN.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.LME.html">slepc4py.SLEPc.LME</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.ConvergedReason.html">slepc4py.SLEPc.LME.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.ProblemType.html">slepc4py.SLEPc.LME.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.Type.html">slepc4py.SLEPc.LME.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.MFN.html">slepc4py.SLEPc.MFN</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.MFN.ConvergedReason.html">slepc4py.SLEPc.MFN.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.MFN.Type.html">slepc4py.SLEPc.MFN.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.NEP.html">slepc4py.SLEPc.NEP</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.CISSExtraction.html">slepc4py.SLEPc.NEP.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Conv.html">slepc4py.SLEPc.NEP.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ConvergedReason.html">slepc4py.SLEPc.NEP.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ErrorType.html">slepc4py.SLEPc.NEP.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ProblemType.html">slepc4py.SLEPc.NEP.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Refine.html">slepc4py.SLEPc.NEP.Refine</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.RefineScheme.html">slepc4py.SLEPc.NEP.RefineScheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Stop.html">slepc4py.SLEPc.NEP.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Type.html">slepc4py.SLEPc.NEP.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Which.html">slepc4py.SLEPc.NEP.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.PEP.html">slepc4py.SLEPc.PEP</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Basis.html">slepc4py.SLEPc.PEP.Basis</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.CISSExtraction.html">slepc4py.SLEPc.PEP.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Conv.html">slepc4py.SLEPc.PEP.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ConvergedReason.html">slepc4py.SLEPc.PEP.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ErrorType.html">slepc4py.SLEPc.PEP.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Extract.html">slepc4py.SLEPc.PEP.Extract</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.JDProjection.html">slepc4py.SLEPc.PEP.JDProjection</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ProblemType.html">slepc4py.SLEPc.PEP.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Refine.html">slepc4py.SLEPc.PEP.Refine</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html">slepc4py.SLEPc.PEP.RefineScheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html">slepc4py.SLEPc.PEP.Scale</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Stop.html">slepc4py.SLEPc.PEP.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Type.html">slepc4py.SLEPc.PEP.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Which.html">slepc4py.SLEPc.PEP.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.RG.html">slepc4py.SLEPc.RG</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.RG.QuadRule.html">slepc4py.SLEPc.RG.QuadRule</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.RG.Type.html">slepc4py.SLEPc.RG.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 current active has-children"><a class="current reference internal" href="#">slepc4py.SLEPc.ST</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html">slepc4py.SLEPc.ST.FilterDamping</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html">slepc4py.SLEPc.ST.FilterType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html">slepc4py.SLEPc.ST.MatMode</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.Type.html">slepc4py.SLEPc.ST.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.SVD.html">slepc4py.SLEPc.SVD</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Conv.html">slepc4py.SLEPc.SVD.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ConvergedReason.html">slepc4py.SLEPc.SVD.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ErrorType.html">slepc4py.SLEPc.SVD.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ProblemType.html">slepc4py.SLEPc.SVD.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Stop.html">slepc4py.SLEPc.SVD.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.TRLanczosGBidiag.html">slepc4py.SLEPc.SVD.TRLanczosGBidiag</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Type.html">slepc4py.SLEPc.SVD.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Which.html">slepc4py.SLEPc.SVD.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.Sys.html">slepc4py.SLEPc.Sys</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.Util.html">slepc4py.SLEPc.Util</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DECIDE.html">slepc4py.SLEPc.DECIDE</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DEFAULT.html">slepc4py.SLEPc.DEFAULT</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DETERMINE.html">slepc4py.SLEPc.DETERMINE</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.CURRENT.html">slepc4py.SLEPc.CURRENT</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
    </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
      <div class="sidebar-primary-item">
<div id="ethical-ad-placement"
      class="flat"
      data-ea-publisher="readthedocs"
      data-ea-type="readthedocs-sidebar"
      data-ea-manual="true">
</div></div>
  </div>


      </div>
      
      <main id="main-content" class="bd-main" role="main">
        
        
          <div class="bd-content">
            <div class="bd-article-container">
              
              <div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
  
    <div class="header-article-items__start">
      
        <div class="header-article-item">

<nav aria-label="Breadcrumb" class="d-print-none">
  <ul class="bd-breadcrumbs">
    
    <li class="breadcrumb-item breadcrumb-home">
      <a href="../index.html" class="nav-link" aria-label="Home">
        <i class="fa-solid fa-home"></i>
      </a>
    </li>
    
    <li class="breadcrumb-item"><a href="../reference.html" class="nav-link">Reference</a></li>
    
    
    <li class="breadcrumb-item"><a href="slepc4py.SLEPc.html" class="nav-link">slepc4py.SLEPc</a></li>
    
    <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">slepc4py.SLEPc.ST</span></li>
  </ul>
</nav>
</div>
      
    </div>
  
  
</div>
</div>
              
              
              
                
<div id="searchbox"></div>
                <article class="bd-article">
                  
  <section id="slepc4py-slepc-st">
<h1>slepc4py.SLEPc.ST<a class="headerlink" href="#slepc4py-slepc-st" title="Link to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">slepc4py.SLEPc.</span></span><span class="sig-name descname"><span class="pre">ST</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Object.html#petsc4py.PETSc.Object" title="(in petsc4py v3.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Object</span></code></a></p>
<p>Spectral Transformation.</p>
<p>The Spectral Transformation (<a class="reference internal" href="#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST</span></code></a>) class encapsulates the functionality
required for acceleration techniques based on the transformation of the
spectrum. The eigensolvers implemented in <a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS" title="slepc4py.SLEPc.EPS"><code class="xref any py py-class docutils literal notranslate"><span class="pre">EPS</span></code></a> work by applying an
operator to a set of vectors and this operator can adopt different forms.
The <a class="reference internal" href="#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 handles all the different possibilities in a uniform way,
so that the solver can proceed without knowing which transformation has
been selected. Polynomial eigensolvers in <a class="reference internal" href="slepc4py.SLEPc.PEP.html#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a> also support spectral
transformation.</p>
<p class="rubric">Enumerations</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html#slepc4py.SLEPc.ST.FilterDamping" title="slepc4py.SLEPc.ST.FilterDamping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FilterDamping</span></code></a></p></td>
<td><p>ST filter damping.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType" title="slepc4py.SLEPc.ST.FilterType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FilterType</span></code></a></p></td>
<td><p>ST filter type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode" title="slepc4py.SLEPc.ST.MatMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MatMode</span></code></a></p></td>
<td><p>ST matrix mode.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type" title="slepc4py.SLEPc.ST.Type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Type</span></code></a></p></td>
<td><p>ST type.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Methods Summary</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.appendOptionsPrefix" title="slepc4py.SLEPc.ST.appendOptionsPrefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">appendOptionsPrefix</span></code></a>([prefix])</p></td>
<td><p>Append to the prefix used for searching for all ST options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply</span></code></a>(x, y)</p></td>
<td><p>Apply the spectral transformation operator to a vector.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyHermitianTranspose" title="slepc4py.SLEPc.ST.applyHermitianTranspose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyHermitianTranspose</span></code></a>(x, y)</p></td>
<td><p>Apply the Hermitian-transpose of the operator to a vector.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyMat" title="slepc4py.SLEPc.ST.applyMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyMat</span></code></a>(X, Y)</p></td>
<td><p>Apply the spectral transformation operator to a matrix.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyTranspose" title="slepc4py.SLEPc.ST.applyTranspose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyTranspose</span></code></a>(x, y)</p></td>
<td><p>Apply the transpose of the operator to a vector.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.create" title="slepc4py.SLEPc.ST.create"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create</span></code></a>([comm])</p></td>
<td><p>Create the ST object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.destroy" title="slepc4py.SLEPc.ST.destroy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">destroy</span></code></a>()</p></td>
<td><p>Destroy the ST object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getCayleyAntishift" title="slepc4py.SLEPc.ST.getCayleyAntishift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCayleyAntishift</span></code></a>()</p></td>
<td><p>Get the value of the anti-shift for the Cayley spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterDamping" title="slepc4py.SLEPc.ST.getFilterDamping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterDamping</span></code></a>()</p></td>
<td><p>Get the type of damping used in the polynomial filter.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterDegree" title="slepc4py.SLEPc.ST.getFilterDegree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterDegree</span></code></a>()</p></td>
<td><p>Get the degree of the filter polynomial.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterInterval" title="slepc4py.SLEPc.ST.getFilterInterval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterInterval</span></code></a>()</p></td>
<td><p>Get the interval containing the desired eigenvalues.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterRange" title="slepc4py.SLEPc.ST.getFilterRange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterRange</span></code></a>()</p></td>
<td><p>Get the interval containing all eigenvalues.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterType" title="slepc4py.SLEPc.ST.getFilterType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFilterType</span></code></a>()</p></td>
<td><p>Get the method to be used to build the polynomial filter.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getKSP" title="slepc4py.SLEPc.ST.getKSP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getKSP</span></code></a>()</p></td>
<td><p>Get the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatMode" title="slepc4py.SLEPc.ST.getMatMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatMode</span></code></a>()</p></td>
<td><p>Get a flag that indicates how the matrix is being shifted.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatStructure" title="slepc4py.SLEPc.ST.getMatStructure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatStructure</span></code></a>()</p></td>
<td><p>Get the internal matrix structure attribute.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatrices" title="slepc4py.SLEPc.ST.getMatrices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatrices</span></code></a>()</p></td>
<td><p>Get the matrices associated with the eigenvalue problem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getOperator" title="slepc4py.SLEPc.ST.getOperator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOperator</span></code></a>()</p></td>
<td><p>Get a shell matrix that represents the operator of the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getOptionsPrefix" title="slepc4py.SLEPc.ST.getOptionsPrefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOptionsPrefix</span></code></a>()</p></td>
<td><p>Get the prefix used for searching for all ST options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getPreconditionerMat" title="slepc4py.SLEPc.ST.getPreconditionerMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getPreconditionerMat</span></code></a>()</p></td>
<td><p>Get the matrix previously set by <a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setPreconditionerMat()</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getShift" title="slepc4py.SLEPc.ST.getShift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getShift</span></code></a>()</p></td>
<td><p>Get the shift associated with the spectral transformation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getSplitPreconditioner" title="slepc4py.SLEPc.ST.getSplitPreconditioner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSplitPreconditioner</span></code></a>()</p></td>
<td><p>Get the matrices to be used to build the preconditioner.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getTransform" title="slepc4py.SLEPc.ST.getTransform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTransform</span></code></a>()</p></td>
<td><p>Get the flag indicating whether the transformed matrices are computed or not.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.getType" title="slepc4py.SLEPc.ST.getType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getType</span></code></a>()</p></td>
<td><p>Get the ST type of this object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.reset" title="slepc4py.SLEPc.ST.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td>
<td><p>Reset the ST object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.restoreOperator" title="slepc4py.SLEPc.ST.restoreOperator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">restoreOperator</span></code></a>(op)</p></td>
<td><p>Restore the previously seized operator matrix.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setCayleyAntishift" title="slepc4py.SLEPc.ST.setCayleyAntishift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCayleyAntishift</span></code></a>(mu)</p></td>
<td><p>Set the value of the anti-shift for the Cayley spectral transformation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterDamping" title="slepc4py.SLEPc.ST.setFilterDamping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterDamping</span></code></a>(damping)</p></td>
<td><p>Set the type of damping to be used in the polynomial filter.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterDegree" title="slepc4py.SLEPc.ST.setFilterDegree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterDegree</span></code></a>(deg)</p></td>
<td><p>Set the degree of the filter polynomial.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterInterval" title="slepc4py.SLEPc.ST.setFilterInterval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterInterval</span></code></a>(inta, intb)</p></td>
<td><p>Set the interval containing the desired eigenvalues.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterRange" title="slepc4py.SLEPc.ST.setFilterRange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterRange</span></code></a>(left, right)</p></td>
<td><p>Set the numerical range (or field of values) of the matrix.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterType" title="slepc4py.SLEPc.ST.setFilterType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFilterType</span></code></a>(filter_type)</p></td>
<td><p>Set the method to be used to build the polynomial filter.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFromOptions" title="slepc4py.SLEPc.ST.setFromOptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFromOptions</span></code></a>()</p></td>
<td><p>Set ST options from the options database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setKSP" title="slepc4py.SLEPc.ST.setKSP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setKSP</span></code></a>(ksp)</p></td>
<td><p>Set the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatMode" title="slepc4py.SLEPc.ST.setMatMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatMode</span></code></a>(mode)</p></td>
<td><p>Set a flag related to management of transformed matrices.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatStructure</span></code></a>(structure)</p></td>
<td><p>Set the matrix structure attribute.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatrices</span></code></a>(operators)</p></td>
<td><p>Set the matrices associated with the eigenvalue problem.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="slepc4py.SLEPc.ST.setOptionsPrefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setOptionsPrefix</span></code></a>([prefix])</p></td>
<td><p>Set the prefix used for searching for all ST options in the database.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPreconditionerMat</span></code></a>([P])</p></td>
<td><p>Set the matrix to be used to build the preconditioner.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setShift</span></code></a>(shift)</p></td>
<td><p>Set the shift associated with the spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setSplitPreconditioner" title="slepc4py.SLEPc.ST.setSplitPreconditioner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSplitPreconditioner</span></code></a>(operators[, structure])</p></td>
<td><p>Set the matrices to be used to build the preconditioner.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setTransform" title="slepc4py.SLEPc.ST.setTransform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTransform</span></code></a>([flag])</p></td>
<td><p>Set a flag to indicate whether the transformed matrices are computed or not.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setType" title="slepc4py.SLEPc.ST.setType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setType</span></code></a>(st_type)</p></td>
<td><p>Set the particular spectral transformation to be used.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setUp</span></code></a>()</p></td>
<td><p>Prepare for the use of a spectral transformation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.view" title="slepc4py.SLEPc.ST.view"><code class="xref py py-obj docutils literal notranslate"><span class="pre">view</span></code></a>([viewer])</p></td>
<td><p>Print the ST data structure.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Attributes Summary</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.ksp" title="slepc4py.SLEPc.ST.ksp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ksp</span></code></a></p></td>
<td><p>KSP object associated with the spectral transformation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.mat_mode" title="slepc4py.SLEPc.ST.mat_mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mat_mode</span></code></a></p></td>
<td><p>How the transformed matrices are being stored in the ST.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.mat_structure" title="slepc4py.SLEPc.ST.mat_structure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mat_structure</span></code></a></p></td>
<td><p>Relation of the sparsity pattern of all ST matrices.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.shift" title="slepc4py.SLEPc.ST.shift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shift</span></code></a></p></td>
<td><p>Value of the shift.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.ST.transform" title="slepc4py.SLEPc.ST.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transform</span></code></a></p></td>
<td><p>If the transformed matrices are computed.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Methods Documentation</p>
<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.appendOptionsPrefix">
<span class="sig-name descname"><span class="pre">appendOptionsPrefix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.appendOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Append to the prefix used for searching for all ST options in the database.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The prefix string to prepend to all ST option requests.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="slepc4py.SLEPc.ST.setOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setOptionsPrefix</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.getOptionsPrefix" title="slepc4py.SLEPc.ST.getOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getOptionsPrefix</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STAppendOptionsPrefix.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STAppendOptionsPrefix</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L256">Source code at slepc4py/SLEPc/ST.pyx:256</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.apply">
<span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.apply" title="Link to this definition">#</a></dt>
<dd><p>Apply the spectral transformation operator to a vector.</p>
<p>Collective.</p>
<p>Apply the spectral transformation operator to a vector, for instance
<span class="math notranslate nohighlight">\(y=(A-\sigma B)^{-1}Bx\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in petsc4py v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in petsc4py v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.applyTranspose" title="slepc4py.SLEPc.ST.applyTranspose"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">applyTranspose</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.applyHermitianTranspose" title="slepc4py.SLEPc.ST.applyHermitianTranspose"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">applyHermitianTranspose</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.applyMat" title="slepc4py.SLEPc.ST.applyMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">applyMat</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STApply.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STApply</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L758">Source code at slepc4py/SLEPc/ST.pyx:758</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.applyHermitianTranspose">
<span class="sig-name descname"><span class="pre">applyHermitianTranspose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.applyHermitianTranspose" title="Link to this definition">#</a></dt>
<dd><p>Apply the Hermitian-transpose of the operator to a vector.</p>
<p>Collective.</p>
<p>Apply the Hermitian-transpose of the operator to a vector, for instance
<span class="math notranslate nohighlight">\(y=B^*(A - \sigma B)^{-*}x\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in petsc4py v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in petsc4py v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">apply</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.applyTranspose" title="slepc4py.SLEPc.ST.applyTranspose"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">applyTranspose</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STApplyHermitianTranspose.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STApplyHermitianTranspose</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L804">Source code at slepc4py/SLEPc/ST.pyx:804</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.applyMat">
<span class="sig-name descname"><span class="pre">applyMat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.applyMat" title="Link to this definition">#</a></dt>
<dd><p>Apply the spectral transformation operator to a matrix.</p>
<p>Collective.</p>
<p>Apply the spectral transformation operator to a matrix, for instance
<span class="math notranslate nohighlight">\(Y=(A-\sigma B)^{-1}BX\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>X</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><em>Mat</em></a>) – The input matrix.</p></li>
<li><p><strong>Y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><em>Mat</em></a>) – The result matrix.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">apply</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STApplyMat.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STApplyMat</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L827">Source code at slepc4py/SLEPc/ST.pyx:827</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.applyTranspose">
<span class="sig-name descname"><span class="pre">applyTranspose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.applyTranspose" title="Link to this definition">#</a></dt>
<dd><p>Apply the transpose of the operator to a vector.</p>
<p>Collective.</p>
<p>Apply the transpose of the operator to a vector, for instance
<span class="math notranslate nohighlight">\(y=B^T(A-\sigma B)^{-T}x\)</span> in the case of the shift-and-invert
transformation and generalized eigenproblem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in petsc4py v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in petsc4py v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">apply</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.applyHermitianTranspose" title="slepc4py.SLEPc.ST.applyHermitianTranspose"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">applyHermitianTranspose</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STApplyTranspose.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STApplyTranspose</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L781">Source code at slepc4py/SLEPc/ST.pyx:781</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.create" title="Link to this definition">#</a></dt>
<dd><p>Create the ST object.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>comm</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Comm.html#petsc4py.PETSc.Comm" title="(in petsc4py 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>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STCreate.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STCreate</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L145">Source code at slepc4py/SLEPc/ST.pyx:145</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.destroy">
<span class="sig-name descname"><span class="pre">destroy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.destroy" title="Link to this definition">#</a></dt>
<dd><p>Destroy the ST object.</p>
<p>Collective.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STDestroy.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STDestroy</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L119">Source code at slepc4py/SLEPc/ST.pyx:119</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.14)"><em>Self</em></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getCayleyAntishift">
<span class="sig-name descname"><span class="pre">getCayleyAntishift</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getCayleyAntishift" title="Link to this definition">#</a></dt>
<dd><p>Get the value of the anti-shift for the Cayley spectral transformation.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The anti-shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><code class="xref any py py-data docutils literal notranslate"><span class="pre">Scalar</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setCayleyAntishift" title="slepc4py.SLEPc.ST.setCayleyAntishift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setCayleyAntishift</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STCayleyGetAntishift.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STCayleyGetAntishift</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L942">Source code at slepc4py/SLEPc/ST.pyx:942</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterDamping">
<span class="sig-name descname"><span class="pre">getFilterDamping</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterDamping" title="Link to this definition">#</a></dt>
<dd><p>Get the type of damping used in the polynomial filter.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The type of damping.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html#slepc4py.SLEPc.ST.FilterDamping" title="slepc4py.SLEPc.ST.FilterDamping"><code class="xref any py py-class docutils literal notranslate"><span class="pre">FilterDamping</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterDamping" title="slepc4py.SLEPc.ST.setFilterDamping"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterDamping</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterGetDamping.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterGetDamping</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1164">Source code at slepc4py/SLEPc/ST.pyx:1164</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterDegree">
<span class="sig-name descname"><span class="pre">getFilterDegree</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterDegree" title="Link to this definition">#</a></dt>
<dd><p>Get the degree of the filter polynomial.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The polynomial degree.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterDegree" title="slepc4py.SLEPc.ST.setFilterDegree"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterDegree</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterGetDegree.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterGetDegree</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1123">Source code at slepc4py/SLEPc/ST.pyx:1123</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterInterval">
<span class="sig-name descname"><span class="pre">getFilterInterval</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterInterval" title="Link to this definition">#</a></dt>
<dd><p>Get the interval containing the desired eigenvalues.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><strong>inta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The left end of the interval.</p></li>
<li><p><strong>intb</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The right end of the interval.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>]</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterInterval" title="slepc4py.SLEPc.ST.setFilterInterval"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterInterval</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterGetInterval.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterGetInterval</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1031">Source code at slepc4py/SLEPc/ST.pyx:1031</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterRange">
<span class="sig-name descname"><span class="pre">getFilterRange</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterRange" title="Link to this definition">#</a></dt>
<dd><p>Get the interval containing all eigenvalues.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><strong>left</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The left end of the spectral range.</p></li>
<li><p><strong>right</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a>) – The right end of the spectral range.</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>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterInterval" title="slepc4py.SLEPc.ST.getFilterInterval"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getFilterInterval</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterGetRange.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterGetRange</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1083">Source code at slepc4py/SLEPc/ST.pyx:1083</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getFilterType">
<span class="sig-name descname"><span class="pre">getFilterType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getFilterType" title="Link to this definition">#</a></dt>
<dd><p>Get the method to be used to build the polynomial filter.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The type of filter.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType" title="slepc4py.SLEPc.ST.FilterType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">FilterType</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterType" title="slepc4py.SLEPc.ST.setFilterType"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterType</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterGetType.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterGetType</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L979">Source code at slepc4py/SLEPc/ST.pyx:979</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getKSP">
<span class="sig-name descname"><span class="pre">getKSP</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getKSP" title="Link to this definition">#</a></dt>
<dd><p>Get the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The linear solver object.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.KSP.html#petsc4py.PETSc.KSP" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.KSP</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setKSP" title="slepc4py.SLEPc.ST.setKSP"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setKSP</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetKSP.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetKSP</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L585">Source code at slepc4py/SLEPc/ST.pyx:585</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getMatMode">
<span class="sig-name descname"><span class="pre">getMatMode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getMatMode" title="Link to this definition">#</a></dt>
<dd><p>Get a flag that indicates how the matrix is being shifted.</p>
<p>Not collective.</p>
<p>Get a flag that indicates how the matrix is being shifted in
the shift-and-invert and Cayley spectral transformations.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The mode flag.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode" title="slepc4py.SLEPc.ST.MatMode"><code class="xref any py py-class docutils literal notranslate"><span class="pre">MatMode</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatMode" title="slepc4py.SLEPc.ST.setMatMode"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatMode</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetMatMode.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetMatMode</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L430">Source code at slepc4py/SLEPc/ST.pyx:430</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getMatStructure">
<span class="sig-name descname"><span class="pre">getMatStructure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getMatStructure" title="Link to this definition">#</a></dt>
<dd><p>Get the internal matrix structure attribute.</p>
<p>Not collective.</p>
<p>Get the internal <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat.Structure</span></code></a> attribute to
indicate which is the relation of the sparsity pattern of the
matrices.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The structure flag.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat.Structure</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatStructure</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetMatStructure.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetMatStructure</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L545">Source code at slepc4py/SLEPc/ST.pyx:545</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getMatrices">
<span class="sig-name descname"><span class="pre">getMatrices</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getMatrices" title="Link to this definition">#</a></dt>
<dd><p>Get the matrices associated with the eigenvalue problem.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The matrices associated with the eigensystem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatrices</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetNumMatrices.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetNumMatrices</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetMatrix.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetMatrix</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L486">Source code at slepc4py/SLEPc/ST.pyx:486</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getOperator">
<span class="sig-name descname"><span class="pre">getOperator</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getOperator" title="Link to this definition">#</a></dt>
<dd><p>Get a shell matrix that represents the operator of the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Operator matrix.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The operator is defined in linear eigenproblems only, not in
polynomial ones, so the call will fail if more than 2 matrices
were passed in <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatrices()</span></code></a>.</p>
<p>The returned shell matrix is essentially a wrapper to the <a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">apply()</span></code></a>
and <a class="reference internal" href="#slepc4py.SLEPc.ST.applyTranspose" title="slepc4py.SLEPc.ST.applyTranspose"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">applyTranspose()</span></code></a> operations. The operator can often be expressed as</p>
<div class="math notranslate nohighlight">
\[Op = D K^{-1} M D^{-1}\]</div>
<p>where <span class="math notranslate nohighlight">\(D\)</span> is the balancing matrix, and <span class="math notranslate nohighlight">\(M\)</span> and <span class="math notranslate nohighlight">\(K\)</span> are
two matrices corresponding to the numerator and denominator for spectral
transformations that represent a rational matrix function.</p>
<p>The preconditioner matrix <span class="math notranslate nohighlight">\(K\)</span> typically depends on the value of the
shift, and its inverse is handled via an internal <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object. Normal
usage does not require explicitly calling <a class="reference internal" href="#slepc4py.SLEPc.ST.getOperator" title="slepc4py.SLEPc.ST.getOperator"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getOperator()</span></code></a>, but it can be
used to force the creation of <span class="math notranslate nohighlight">\(K\)</span> and <span class="math notranslate nohighlight">\(M\)</span>, and then <span class="math notranslate nohighlight">\(K\)</span>
is passed to the <code class="docutils literal notranslate"><span class="pre">KSP</span></code>. This is useful for setting options associated
with the <code class="docutils literal notranslate"><span class="pre">PCFactor</span></code> (to set MUMPS options, for instance).</p>
<p>The returned matrix must NOT be destroyed by the user. Instead, when no
longer needed it must be returned with <a class="reference internal" href="#slepc4py.SLEPc.ST.restoreOperator" title="slepc4py.SLEPc.ST.restoreOperator"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">restoreOperator()</span></code></a>. In particular,
this is required before modifying the <a class="reference internal" href="#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST</span></code></a> matrices or the shift.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">apply</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatrices</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setShift</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.restoreOperator" title="slepc4py.SLEPc.ST.restoreOperator"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">restoreOperator</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetOperator.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetOperator</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L850">Source code at slepc4py/SLEPc/ST.pyx:850</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getOptionsPrefix">
<span class="sig-name descname"><span class="pre">getOptionsPrefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Get the prefix used for searching for all ST options in the database.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The prefix string set for this ST object.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="slepc4py.SLEPc.ST.setOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setOptionsPrefix</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.appendOptionsPrefix" title="slepc4py.SLEPc.ST.appendOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">appendOptionsPrefix</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetOptionsPrefix.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetOptionsPrefix</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L237">Source code at slepc4py/SLEPc/ST.pyx:237</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getPreconditionerMat">
<span class="sig-name descname"><span class="pre">getPreconditionerMat</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getPreconditionerMat" title="Link to this definition">#</a></dt>
<dd><p>Get the matrix previously set by <a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setPreconditionerMat()</span></code></a>.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The matrix that will be used in constructing the preconditioner.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setPreconditionerMat</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetPreconditionerMat.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetPreconditionerMat</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L649">Source code at slepc4py/SLEPc/ST.pyx:649</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getShift">
<span class="sig-name descname"><span class="pre">getShift</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getShift" title="Link to this definition">#</a></dt>
<dd><p>Get the shift associated with the spectral transformation.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The value of the shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><code class="xref any py py-data docutils literal notranslate"><span class="pre">Scalar</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setShift</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetShift.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetShift</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L323">Source code at slepc4py/SLEPc/ST.pyx:323</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getSplitPreconditioner">
<span class="sig-name descname"><span class="pre">getSplitPreconditioner</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getSplitPreconditioner" title="Link to this definition">#</a></dt>
<dd><p>Get the matrices to be used to build the preconditioner.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a> – The list of matrices associated with the preconditioner.</p></li>
<li><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat.Structure</span></code></a> – The structure flag.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)">list</a>[<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)">petsc4py.PETSc.Mat</a>], <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)">petsc4py.PETSc.Mat.Structure</a>]</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetSplitPreconditionerInfo.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetSplitPreconditionerInfo</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetSplitPreconditionerTerm.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetSplitPreconditionerTerm</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L716">Source code at slepc4py/SLEPc/ST.pyx:716</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getTransform">
<span class="sig-name descname"><span class="pre">getTransform</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getTransform" title="Link to this definition">#</a></dt>
<dd><p>Get the flag indicating whether the transformed matrices are computed or not.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>This flag is intended for the case of polynomial
eigenproblems solved via linearization.
If this flag is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default) the spectral transformation
is applied to the linearization (handled by the eigensolver),
otherwise it is applied to the original problem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setTransform" title="slepc4py.SLEPc.ST.setTransform"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setTransform</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetTransform.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetTransform</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L364">Source code at slepc4py/SLEPc/ST.pyx:364</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.getType">
<span class="sig-name descname"><span class="pre">getType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.getType" title="Link to this definition">#</a></dt>
<dd><p>Get the ST type of this object.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The spectral transformation currently being used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setType" title="slepc4py.SLEPc.ST.setType"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setType</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetType.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetType</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L193">Source code at slepc4py/SLEPc/ST.pyx:193</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.reset">
<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.reset" title="Link to this definition">#</a></dt>
<dd><p>Reset the ST object.</p>
<p>Collective.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STReset.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STReset</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L133">Source code at slepc4py/SLEPc/ST.pyx:133</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.restoreOperator">
<span class="sig-name descname"><span class="pre">restoreOperator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.restoreOperator" title="Link to this definition">#</a></dt>
<dd><p>Restore the previously seized operator matrix.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>op</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><em>Mat</em></a>) – Operator matrix previously obtained with <a class="reference internal" href="#slepc4py.SLEPc.ST.getOperator" title="slepc4py.SLEPc.ST.getOperator"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getOperator()</span></code></a>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getOperator" title="slepc4py.SLEPc.ST.getOperator"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getOperator</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STRestoreOperator.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STRestoreOperator</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L898">Source code at slepc4py/SLEPc/ST.pyx:898</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setCayleyAntishift">
<span class="sig-name descname"><span class="pre">setCayleyAntishift</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mu</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setCayleyAntishift" title="Link to this definition">#</a></dt>
<dd><p>Set the value of the anti-shift for the Cayley spectral transformation.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mu</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – The anti-shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>In the generalized Cayley transform, the operator can be expressed as
<span class="math notranslate nohighlight">\((A - \sigma B)^{-1}(A + \mu B)\)</span>. This function sets the value
of <span class="math notranslate nohighlight">\(mu\)</span>.  Use <a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setShift()</span></code></a> for setting <span class="math notranslate nohighlight">\(\sigma\)</span>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setShift</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.getCayleyAntishift" title="slepc4py.SLEPc.ST.getCayleyAntishift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getCayleyAntishift</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STCayleySetAntishift.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STCayleySetAntishift</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L918">Source code at slepc4py/SLEPc/ST.pyx:918</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterDamping">
<span class="sig-name descname"><span class="pre">setFilterDamping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">damping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterDamping" title="Link to this definition">#</a></dt>
<dd><p>Set the type of damping to be used in the polynomial filter.</p>
<p>Logically collective.</p>
<section id="parameter">
<h2>Parameter<a class="headerlink" href="#parameter" title="Link to this heading">#</a></h2>
<dl class="simple">
<dt>damping</dt><dd><p>The type of damping.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Only used in <a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType.CHEBYSHEV" title="slepc4py.SLEPc.ST.FilterType.CHEBYSHEV"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">FilterType.CHEBYSHEV</span></code></a> filters.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterDamping" title="slepc4py.SLEPc.ST.getFilterDamping"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getFilterDamping</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterSetDamping.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterSetDamping</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1142">Source code at slepc4py/SLEPc/ST.pyx:1142</a></p>
</section>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>damping</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html#slepc4py.SLEPc.ST.FilterDamping" title="slepc4py.SLEPc.ST.FilterDamping"><em>FilterDamping</em></a>)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterDegree">
<span class="sig-name descname"><span class="pre">setFilterDegree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterDegree" title="Link to this definition">#</a></dt>
<dd><p>Set the degree of the filter polynomial.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>deg</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The polynomial degree.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterDegree" title="slepc4py.SLEPc.ST.getFilterDegree"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getFilterDegree</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterSetDegree.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterSetDegree</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1105">Source code at slepc4py/SLEPc/ST.pyx:1105</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterInterval">
<span class="sig-name descname"><span class="pre">setFilterInterval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intb</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterInterval" title="Link to this definition">#</a></dt>
<dd><p>Set the interval containing the desired eigenvalues.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The left end of the interval.</p></li>
<li><p><strong>intb</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The right end of the interval.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The filter will be configured to emphasize eigenvalues contained
in the given interval, and damp out eigenvalues outside it. If the
interval is open, then the filter is low- or high-pass, otherwise
it is mid-pass.</p>
<p>Common usage is to set the interval in <a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS" title="slepc4py.SLEPc.EPS"><code class="xref any py py-class docutils literal notranslate"><span class="pre">EPS</span></code></a> with <a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS.setInterval" title="slepc4py.SLEPc.EPS.setInterval"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">EPS.setInterval()</span></code></a>.</p>
<p>The interval must be contained within the numerical range of the
matrix, see <a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterRange" title="slepc4py.SLEPc.ST.setFilterRange"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterRange()</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterInterval" title="slepc4py.SLEPc.ST.getFilterInterval"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getFilterInterval</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterRange" title="slepc4py.SLEPc.ST.setFilterRange"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterRange</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterSetInterval.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterSetInterval</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L998">Source code at slepc4py/SLEPc/ST.pyx:998</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterRange">
<span class="sig-name descname"><span class="pre">setFilterRange</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">left</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterRange" title="Link to this definition">#</a></dt>
<dd><p>Set the numerical range (or field of values) of the matrix.</p>
<p>Logically collective.</p>
<p>Set the numerical range (or field of values) of the matrix, that is,
the interval containing all eigenvalues.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>left</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The left end of the spectral range.</p></li>
<li><p><strong>right</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The right end of the spectral range.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The filter will be most effective if the numerical range is tight,
that is, <code class="docutils literal notranslate"><span class="pre">left</span></code> and <code class="docutils literal notranslate"><span class="pre">right</span></code> are good approximations to the
leftmost and rightmost eigenvalues, respectively.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setFilterInterval" title="slepc4py.SLEPc.ST.setFilterInterval"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFilterInterval</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterRange" title="slepc4py.SLEPc.ST.getFilterRange"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getFilterRange</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterSetRange.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterSetRange</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1053">Source code at slepc4py/SLEPc/ST.pyx:1053</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFilterType">
<span class="sig-name descname"><span class="pre">setFilterType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFilterType" title="Link to this definition">#</a></dt>
<dd><p>Set the method to be used to build the polynomial filter.</p>
<p>Logically collective.</p>
<section id="id1">
<h2>Parameter<a class="headerlink" href="#id1" title="Link to this heading">#</a></h2>
<dl class="simple">
<dt>filter_type</dt><dd><p>The type of filter.</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getFilterType" title="slepc4py.SLEPc.ST.getFilterType"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getFilterType</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STFilterSetType.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STFilterSetType</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L961">Source code at slepc4py/SLEPc/ST.pyx:961</a></p>
</section>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html#slepc4py.SLEPc.ST.FilterType" title="slepc4py.SLEPc.ST.FilterType"><em>FilterType</em></a>)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setFromOptions">
<span class="sig-name descname"><span class="pre">setFromOptions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setFromOptions" title="Link to this definition">#</a></dt>
<dd><p>Set ST options from the options database.</p>
<p>Collective.</p>
<p class="rubric">Notes</p>
<p>To see all options, run your program with the <code class="docutils literal notranslate"><span class="pre">-help</span></code> option.</p>
<p>This routine must be called before <a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp()</span></code></a> if the user is to be
allowed to set the solver type.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="slepc4py.SLEPc.ST.setOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setOptionsPrefix</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetFromOptions.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetFromOptions</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L275">Source code at slepc4py/SLEPc/ST.pyx:275</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setKSP">
<span class="sig-name descname"><span class="pre">setKSP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ksp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setKSP" title="Link to this definition">#</a></dt>
<dd><p>Set the <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object associated with the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ksp</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.KSP.html#petsc4py.PETSc.KSP" title="(in petsc4py v3.24)"><em>KSP</em></a>) – 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://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getKSP" title="slepc4py.SLEPc.ST.getKSP"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getKSP</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetKSP.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetKSP</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L568">Source code at slepc4py/SLEPc/ST.pyx:568</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setMatMode">
<span class="sig-name descname"><span class="pre">setMatMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setMatMode" title="Link to this definition">#</a></dt>
<dd><p>Set a flag related to management of transformed matrices.</p>
<p>Logically collective.</p>
<p>The flag indicates how the transformed matrices are being
stored in the spectral transformation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode" title="slepc4py.SLEPc.ST.MatMode"><em>MatMode</em></a>) – The mode flag.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>By default (<a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode.COPY" title="slepc4py.SLEPc.ST.MatMode.COPY"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.MatMode.COPY</span></code></a>), a copy of matrix <span class="math notranslate nohighlight">\(A\)</span> is made
and then this copy is modified explicitly, e.g.,
<span class="math notranslate nohighlight">\(A \leftarrow (A - \sigma B)\)</span>.</p>
<p>With <a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode.INPLACE" title="slepc4py.SLEPc.ST.MatMode.INPLACE"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.MatMode.INPLACE</span></code></a>, the original matrix <span class="math notranslate nohighlight">\(A\)</span> is modified at
<a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp()</span></code></a> and reverted at the end of the computations. With respect to
the previous one, this mode avoids a copy of matrix <span class="math notranslate nohighlight">\(A\)</span>. However,
a backdraw is that the recovered matrix might be slightly different
from the original one (due to roundoff).</p>
<p>With <a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html#slepc4py.SLEPc.ST.MatMode.SHELL" title="slepc4py.SLEPc.ST.MatMode.SHELL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">ST.MatMode.SHELL</span></code></a>, the solver works with an implicit shell matrix
that represents the shifted matrix. This mode is the most efficient in
creating the transformed matrix but it places serious limitations to the
linear solves performed in each iteration of the eigensolver
(typically, only iterative solvers with Jacobi preconditioning can be
used).</p>
<p>In the two first modes the efficiency of this computation can be
controlled with <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatStructure()</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatrices</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatStructure</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.getMatMode" title="slepc4py.SLEPc.ST.getMatMode"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMatMode</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetMatMode.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetMatMode</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L387">Source code at slepc4py/SLEPc/ST.pyx:387</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setMatStructure">
<span class="sig-name descname"><span class="pre">setMatStructure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structure</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setMatStructure" title="Link to this definition">#</a></dt>
<dd><p>Set the matrix structure attribute.</p>
<p>Logically collective.</p>
<p>Set an internal <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat.Structure</span></code></a> attribute to indicate
which is the relation of the sparsity pattern of all the <a class="reference internal" href="#slepc4py.SLEPc.ST" title="slepc4py.SLEPc.ST"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ST</span></code></a> matrices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>structure</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)"><em>petsc4py.PETSc.Mat.Structure</em></a>) – The matrix structure specification.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>By default, the sparsity patterns are assumed to be
different. If the patterns are equal or a subset then it is
recommended to set this attribute for efficiency reasons (in
particular, for internal <code class="docutils literal notranslate"><span class="pre">Mat.axpy()</span></code> operations).</p>
<p>This function has no effect in the case of standard eigenproblems.</p>
<p>In case of polynomial eigenproblems, the flag applies to all
matrices relative to the first one.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatStructure" title="slepc4py.SLEPc.ST.getMatStructure"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMatStructure</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatrices</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetMatStructure.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetMatStructure</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L512">Source code at slepc4py/SLEPc/ST.pyx:512</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setMatrices">
<span class="sig-name descname"><span class="pre">setMatrices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operators</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setMatrices" title="Link to this definition">#</a></dt>
<dd><p>Set the matrices associated with the eigenvalue problem.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>operators</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em>[</em><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py 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 class="rubric">Notes</p>
<p>It must be called before <a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp()</span></code></a>. If it is called again after
<a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp()</span></code></a> then the <a class="reference internal" href="#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 is reset.</p>
<p>In standard eigenproblems only one matrix is passed, while in
generalized problems two matrices are provided. The number of
matrices is larger in polynomial eigenproblems.</p>
<p>In normal usage, matrices are provided via the corresponding
<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> of <a class="reference internal" href="slepc4py.SLEPc.PEP.html#slepc4py.SLEPc.PEP" title="slepc4py.SLEPc.PEP"><code class="xref any py py-class docutils literal notranslate"><span class="pre">PEP</span></code></a> interface function.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getMatrices" title="slepc4py.SLEPc.ST.getMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMatrices</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setUp" title="slepc4py.SLEPc.ST.setUp"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setUp</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.reset" title="slepc4py.SLEPc.ST.reset"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">reset</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetMatrices.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetMatrices</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L452">Source code at slepc4py/SLEPc/ST.pyx:452</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setOptionsPrefix">
<span class="sig-name descname"><span class="pre">setOptionsPrefix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Set the prefix used for searching for all ST options in the database.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The prefix string to prepend to all ST option requests.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>A hyphen (<code class="docutils literal notranslate"><span class="pre">-</span></code>) must NOT be given at the beginning of the
prefix name.  The first character of all runtime options is
AUTOMATICALLY the hyphen.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.appendOptionsPrefix" title="slepc4py.SLEPc.ST.appendOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">appendOptionsPrefix</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.getOptionsPrefix" title="slepc4py.SLEPc.ST.getOptionsPrefix"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getOptionsPrefix</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STGetOptionsPrefix.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STGetOptionsPrefix</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L212">Source code at slepc4py/SLEPc/ST.pyx:212</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setPreconditionerMat">
<span class="sig-name descname"><span class="pre">setPreconditionerMat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">P</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="Link to this definition">#</a></dt>
<dd><p>Set the matrix to be used to build the preconditioner.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>P</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><em>Mat</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The matrix that will be used in constructing the preconditioner.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This matrix will be passed to the internal <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object (via the last
argument of <code class="docutils literal notranslate"><span class="pre">KSP.setOperators()</span></code>) as the matrix to be
used when constructing the preconditioner. If no matrix is set then
<span class="math notranslate nohighlight">\(A-\sigma B\)</span> will be used to build the preconditioner, being
<span class="math notranslate nohighlight">\(\sigma\)</span> the value set by <a class="reference internal" href="#slepc4py.SLEPc.ST.setShift" title="slepc4py.SLEPc.ST.setShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setShift()</span></code></a>.</p>
<p>More precisely, this is relevant for spectral transformations that
represent a rational matrix function, and use a <code class="docutils literal notranslate"><span class="pre">KSP</span></code> object for the
denominator. It includes also the <a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type.PRECOND" title="slepc4py.SLEPc.ST.Type.PRECOND"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">PRECOND</span></code></a> case. If the user has a
good approximation to matrix that can be used to build a cheap
preconditioner, it can be passed with this function. Note that it
affects only the <code class="docutils literal notranslate"><span class="pre">Pmat</span></code> argument of <code class="docutils literal notranslate"><span class="pre">KSP.setOperators()</span></code>,
not the <code class="docutils literal notranslate"><span class="pre">Amat</span></code> argument.</p>
<p>If a preconditioner matrix is set, the default is to use an iterative
<code class="docutils literal notranslate"><span class="pre">KSP</span></code> rather than a direct method.</p>
<p>An alternative to pass an approximation of <span class="math notranslate nohighlight">\(A-\sigma B\)</span> with this
function is to provide approximations of <span class="math notranslate nohighlight">\(A\)</span> and <span class="math notranslate nohighlight">\(B\)</span> via
<a class="reference internal" href="#slepc4py.SLEPc.ST.setSplitPreconditioner" title="slepc4py.SLEPc.ST.setSplitPreconditioner"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setSplitPreconditioner()</span></code></a>. The difference is that when <span class="math notranslate nohighlight">\(\sigma\)</span>
changes the preconditioner is recomputed.</p>
<p>A call with no matrix argument will remove a previously set matrix.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getPreconditionerMat" title="slepc4py.SLEPc.ST.getPreconditionerMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getPreconditionerMat</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetPreconditionerMat.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetPreconditionerMat</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L605">Source code at slepc4py/SLEPc/ST.pyx:605</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setShift">
<span class="sig-name descname"><span class="pre">setShift</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shift</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setShift" title="Link to this definition">#</a></dt>
<dd><p>Set the shift associated with the spectral transformation.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>shift</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – The value of the shift.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>In some spectral transformations, changing the shift may have
associated a lot of work, for example recomputing a
factorization.</p>
<p>This function is normally not directly called by users, since the
shift is indirectly set by <a class="reference internal" href="slepc4py.SLEPc.EPS.html#slepc4py.SLEPc.EPS.setTarget" title="slepc4py.SLEPc.EPS.setTarget"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">EPS.setTarget()</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getShift" title="slepc4py.SLEPc.ST.getShift"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getShift</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetShift.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetShift</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L296">Source code at slepc4py/SLEPc/ST.pyx:296</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setSplitPreconditioner">
<span class="sig-name descname"><span class="pre">setSplitPreconditioner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operators</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">structure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setSplitPreconditioner" title="Link to this definition">#</a></dt>
<dd><p>Set the matrices to be used to build the preconditioner.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>operators</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em>[</em><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in petsc4py v3.24)"><em>petsc4py.PETSc.Mat</em></a><em>]</em>) – The matrices associated with the preconditioner.</p></li>
<li><p><strong>structure</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.Structure.html#petsc4py.PETSc.Mat.Structure" title="(in petsc4py v3.24)"><em>petsc4py.PETSc.Mat.Structure</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – The matrix structure specification.</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 number of matrices passed here must be the same as in <a class="reference internal" href="#slepc4py.SLEPc.ST.setMatrices" title="slepc4py.SLEPc.ST.setMatrices"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatrices()</span></code></a>.</p>
<p>For linear eigenproblems, the preconditioner matrix is computed as
<span class="math notranslate nohighlight">\(P(\sigma) = A_0-\sigma B_0\)</span>, where <span class="math notranslate nohighlight">\(A_0,B_0\)</span> are
approximations of <span class="math notranslate nohighlight">\(A,B\)</span> (the eigenproblem matrices) provided via the
<code class="docutils literal notranslate"><span class="pre">operators</span></code> argument in this function. Compared to <a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setPreconditionerMat()</span></code></a>,
this function allows setting a preconditioner in a way that is independent
of the shift <span class="math notranslate nohighlight">\(\sigma\)</span>. Whenever the value of <span class="math notranslate nohighlight">\(\sigma\)</span> changes
the preconditioner is recomputed.</p>
<p>Similarly, for polynomial eigenproblems the matrix for the preconditioner
is expressed as <span class="math notranslate nohighlight">\(P(\sigma) = \sum_i P_i \phi_i(\sigma)\)</span>, for
<span class="math notranslate nohighlight">\(i=1,\dots,n\)</span>, where <span class="math notranslate nohighlight">\(P_i\)</span> are given in <code class="docutils literal notranslate"><span class="pre">operators</span></code> and the
<span class="math notranslate nohighlight">\(\phi_i\)</span>’s are the polynomial basis functions.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">structure</span></code> flag provides information about the relative nonzero
pattern of the <code class="docutils literal notranslate"><span class="pre">operators</span></code> matrices, in the same way as in
<a class="reference internal" href="#slepc4py.SLEPc.ST.setMatStructure" title="slepc4py.SLEPc.ST.setMatStructure"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setMatStructure()</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getSplitPreconditioner" title="slepc4py.SLEPc.ST.getSplitPreconditioner"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getSplitPreconditioner</span></code></a>, <a class="reference internal" href="#slepc4py.SLEPc.ST.setPreconditionerMat" title="slepc4py.SLEPc.ST.setPreconditionerMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setPreconditionerMat</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetSplitPreconditioner.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetSplitPreconditioner</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L669">Source code at slepc4py/SLEPc/ST.pyx:669</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setTransform">
<span class="sig-name descname"><span class="pre">setTransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setTransform" title="Link to this definition">#</a></dt>
<dd><p>Set a flag to indicate whether the transformed matrices are computed or not.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>flag</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – This flag is intended for the case of polynomial
eigenproblems solved via linearization.
If this flag is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default) the spectral transformation
is applied to the linearization (handled by the eigensolver),
otherwise it is applied to the original problem.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getTransform" title="slepc4py.SLEPc.ST.getTransform"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getTransform</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetTransform.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetTransform</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L342">Source code at slepc4py/SLEPc/ST.pyx:342</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setType">
<span class="sig-name descname"><span class="pre">setType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">st_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setType" title="Link to this definition">#</a></dt>
<dd><p>Set the particular spectral transformation to be used.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>st_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type" title="slepc4py.SLEPc.ST.Type"><em>Type</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The spectral transformation to be used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The default is <a class="reference internal" href="slepc4py.SLEPc.ST.Type.html#slepc4py.SLEPc.ST.Type.SHIFT" title="slepc4py.SLEPc.ST.Type.SHIFT"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">SHIFT</span></code></a> with a zero shift. Normally, it is best
to use <a class="reference internal" href="#slepc4py.SLEPc.ST.setFromOptions" title="slepc4py.SLEPc.ST.setFromOptions"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">setFromOptions()</span></code></a> and then set the ST type from the
options database rather than by using this routine. Using the
options database provides the user with maximum flexibility in
evaluating the different available methods.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.getType" title="slepc4py.SLEPc.ST.getType"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getType</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetType.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetType</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L166">Source code at slepc4py/SLEPc/ST.pyx:166</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.setUp" title="Link to this definition">#</a></dt>
<dd><p>Prepare for the use of a spectral transformation.</p>
<p>Collective.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#slepc4py.SLEPc.ST.apply" title="slepc4py.SLEPc.ST.apply"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">apply</span></code></a>, <a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STSetUp.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STSetUp</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L746">Source code at slepc4py/SLEPc/ST.pyx:746</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.view">
<span class="sig-name descname"><span class="pre">view</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">viewer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.ST.view" title="Link to this definition">#</a></dt>
<dd><p>Print the ST data structure.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>viewer</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Viewer.html#petsc4py.PETSc.Viewer" title="(in petsc4py 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>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference external" href="https://slepc.upv.es/release/manualpages/ST/STView.html" title="(in SLEPc v3.24)"><code class="docutils literal notranslate"><span class="pre">STView</span></code></a></p>
</div>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L100">Source code at slepc4py/SLEPc/ST.pyx:100</a></p>
</dd></dl>

<p class="rubric">Attributes Documentation</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.ksp">
<span class="sig-name descname"><span class="pre">ksp</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.ksp" title="Link to this definition">#</a></dt>
<dd><p>KSP object associated with the spectral transformation.</p>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1213">Source code at slepc4py/SLEPc/ST.pyx:1213</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.mat_mode">
<span class="sig-name descname"><span class="pre">mat_mode</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.mat_mode" title="Link to this definition">#</a></dt>
<dd><p>How the transformed matrices are being stored in the ST.</p>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1199">Source code at slepc4py/SLEPc/ST.pyx:1199</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.mat_structure">
<span class="sig-name descname"><span class="pre">mat_structure</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.mat_structure" title="Link to this definition">#</a></dt>
<dd><p>Relation of the sparsity pattern of all ST matrices.</p>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1206">Source code at slepc4py/SLEPc/ST.pyx:1206</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.shift">
<span class="sig-name descname"><span class="pre">shift</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.shift" title="Link to this definition">#</a></dt>
<dd><p>Value of the shift.</p>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1185">Source code at slepc4py/SLEPc/ST.pyx:1185</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.ST.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><a class="headerlink" href="#slepc4py.SLEPc.ST.transform" title="Link to this definition">#</a></dt>
<dd><p>If the transformed matrices are computed.</p>
<p><a class="extlink-sources reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/ST.pyx#L1192">Source code at slepc4py/SLEPc/ST.pyx:1192</a></p>
</dd></dl>

</dd></dl>

</section>


                </article>
              
              
              
              
              
                <footer class="prev-next-footer d-print-none">
                  
<div class="prev-next-area">
    <a class="left-prev"
       href="slepc4py.SLEPc.RG.Type.html"
       title="previous page">
      <i class="fa-solid fa-angle-left"></i>
      <div class="prev-next-info">
        <p class="prev-next-subtitle">previous</p>
        <p class="prev-next-title">slepc4py.SLEPc.RG.Type</p>
      </div>
    </a>
    <a class="right-next"
       href="slepc4py.SLEPc.ST.FilterDamping.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">slepc4py.SLEPc.ST.FilterDamping</p>
      </div>
      <i class="fa-solid fa-angle-right"></i>
    </a>
</div>
                </footer>
              
            </div>
            
            
              
                <dialog id="pst-secondary-sidebar-modal"></dialog>
                <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


  <div class="sidebar-secondary-item">
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/reference/slepc4py.SLEPc.ST.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div></div>

</div></div>
              
            
          </div>
          <footer class="bd-footer-content">
            
          </footer>
        
      </main>
    </div>
  </div>
  
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
  <script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

  <footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
  
    <div class="footer-items__start">
      
        <div class="footer-item">

  <p class="sphinx-version">
    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
    <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 2026-03-09T10:12:57+0100 (v3.24.3).
  <br/>
</p></div>
      
    </div>
  
</div>

  </footer>
  </body>
</html>