File: slepc4py.SLEPc.BV.html

package info (click to toggle)
slepc 3.24.1%2Bdfsg1-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 122,028 kB
sloc: ansic: 104,353; javascript: 12,732; python: 5,958; f90: 3,312; cpp: 1,528; makefile: 761; xml: 679; sh: 347
file content (2385 lines) | stat: -rw-r--r-- 193,209 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.BV &#8212; Python 3.24.1 documentation</title>
  
  
  
  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
  </script>
  <!--
    this give us a css class that will be invisible only if js is disabled
  -->
  <noscript>
    <style>
      .pst-js-only { display: none !important; }

    </style>
  </noscript>
  
  <!-- Loaded before other Sphinx assets -->
  <link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
    <link rel="stylesheet" type="text/css" href="../_static/css/slepc.css?v=d285b177" />
  
  <!-- So that users can add custom icons -->
  <script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

    <script src="../_static/documentation_options.js?v=d1c46438"></script>
    <script src="../_static/doctools.js?v=9a2dae69"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'reference/slepc4py.SLEPc.BV';</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="slepc4py.SLEPc.BV.MatMultType" href="slepc4py.SLEPc.BV.MatMultType.html" />
    <link rel="prev" title="slepc4py.SLEPc" href="slepc4py.SLEPc.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  <meta name="docsearch:version" content="3.24" />
    <meta name="docbuild:last-update" content="2025-11-07T09:28:35+0100 (v3.24.1)"/>
  </head>
  
  
  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">

  
  
  <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
  
  <div id="pst-scroll-pixel-helper"></div>
  
  <button type="button" class="btn rounded-pill" id="pst-back-to-top">
    <i class="fa-solid fa-arrow-up"></i>Back to top</button>

  
  <dialog id="pst-search-dialog">
    
<form class="bd-search d-flex align-items-center"
      action="../search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         placeholder="Search the docs ..."
         aria-label="Search the docs ..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
  </dialog>

  <div class="pst-async-banner-revealer d-none">
  <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>

  
    <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
  <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
    <span class="fa-solid fa-bars"></span>
  </button>
  
  
  <div class="col-lg-3 navbar-header-items__start">
    
      <div class="navbar-item">

  
    
  

<a class="navbar-brand logo" href="../index.html">
  
  
  
  
  
  
    <p class="title logo__title">Python 3.24.1 documentation</p>
  
</a></div>
    
  </div>
  
  <div class="col-lg-9 navbar-header-items">
    
    <div class="me-auto navbar-header-items__center">
      
        <div class="navbar-item">
<nav>
  <ul class="bd-navbar-elements navbar-nav">
    
<li class="nav-item ">
  <a class="nav-link nav-internal" href="../overview.html">
    Overview
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../tutorial.html">
    Tutorial
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../install.html">
    Installation
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../citing.html">
    Citations
  </a>
</li>


<li class="nav-item current active">
  <a class="nav-link nav-internal" href="../reference.html">
    Reference
  </a>
</li>

            <li class="nav-item dropdown">
                <button class="btn dropdown-toggle nav-item" type="button"
                data-bs-toggle="dropdown" aria-expanded="false"
                aria-controls="pst-nav-more-links">
                    More
                </button>
                <ul id="pst-nav-more-links" class="dropdown-menu">
                    
<li class=" ">
  <a class="nav-link dropdown-item nav-internal" href="../demo/demo.html">
    slepc4py demos
  </a>
</li>

                </ul>
            </li>
            
  </ul>
</nav></div>
      
    </div>
    
    
    <div class="navbar-header-items__end">
      
        <div class="navbar-item navbar-persistent--container">
          

<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
 <i class="fa-solid fa-magnifying-glass"></i>
 <span class="search-button__default-text">Search</span>
 <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
        </div>
      
      
        <div class="navbar-item">

<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
  <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
  <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
</button></div>
      
    </div>
    
  </div>
  
  
    <div class="navbar-persistent--mobile">

<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
 <i class="fa-solid fa-magnifying-glass"></i>
 <span class="search-button__default-text">Search</span>
 <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
    </div>
  

  
    <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
      <span class="fa-solid fa-outdent"></span>
    </button>
  
</div>

    </header>
  

  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">
      
      
      
      <dialog id="pst-primary-sidebar-modal"></dialog>
      <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
        

  
  <div class="sidebar-header-items sidebar-primary__section">
    
    
      <div class="sidebar-header-items__center">
        
          
          
            <div class="navbar-item">
<nav>
  <ul class="bd-navbar-elements navbar-nav">
    
<li class="nav-item ">
  <a class="nav-link nav-internal" href="../overview.html">
    Overview
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../tutorial.html">
    Tutorial
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../install.html">
    Installation
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../citing.html">
    Citations
  </a>
</li>


<li class="nav-item current active">
  <a class="nav-link nav-internal" href="../reference.html">
    Reference
  </a>
</li>


<li class="nav-item ">
  <a class="nav-link nav-internal" href="../demo/demo.html">
    slepc4py demos
  </a>
</li>

  </ul>
</nav></div>
          
        
      </div>
    
    
    
      <div class="sidebar-header-items__end">
        
          <div class="navbar-item">

<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
  <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
  <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
</button></div>
        
      </div>
    
  </div>
  
    <div class="sidebar-primary-items__start sidebar-primary__section">
        <div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
     aria-label="Section Navigation">
  <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="slepc4py.html">slepc4py</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.get_config.html">slepc4py.get_config</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.get_include.html">slepc4py.get_include</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.init.html">slepc4py.init</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="slepc4py.typing.html">slepc4py.typing</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.Scalar.html">slepc4py.typing.Scalar</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayInt.html">slepc4py.typing.ArrayInt</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayReal.html">slepc4py.typing.ArrayReal</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayComplex.html">slepc4py.typing.ArrayComplex</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.ArrayScalar.html">slepc4py.typing.ArrayScalar</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.LayoutSizeSpec.html">slepc4py.typing.LayoutSizeSpec</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSStoppingFunction.html">slepc4py.typing.EPSStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSArbitraryFunction.html">slepc4py.typing.EPSArbitraryFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSEigenvalueComparison.html">slepc4py.typing.EPSEigenvalueComparison</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.EPSMonitorFunction.html">slepc4py.typing.EPSMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.PEPStoppingFunction.html">slepc4py.typing.PEPStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.PEPMonitorFunction.html">slepc4py.typing.PEPMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPStoppingFunction.html">slepc4py.typing.NEPStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPMonitorFunction.html">slepc4py.typing.NEPMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPFunction.html">slepc4py.typing.NEPFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.NEPJacobian.html">slepc4py.typing.NEPJacobian</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.SVDStoppingFunction.html">slepc4py.typing.SVDStoppingFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.SVDMonitorFunction.html">slepc4py.typing.SVDMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.MFNMonitorFunction.html">slepc4py.typing.MFNMonitorFunction</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.typing.LMEMonitorFunction.html">slepc4py.typing.LMEMonitorFunction</a></li>
</ul>
</details></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="slepc4py.SLEPc.html">slepc4py.SLEPc</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active has-children"><a class="current reference internal" href="#">slepc4py.SLEPc.BV</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.BV.MatMultType.html">slepc4py.SLEPc.BV.MatMultType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogBlockType.html">slepc4py.SLEPc.BV.OrthogBlockType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html">slepc4py.SLEPc.BV.OrthogRefineType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html">slepc4py.SLEPc.BV.OrthogType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.BV.Type.html">slepc4py.SLEPc.BV.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.BVSVDMethod.html">slepc4py.SLEPc.BVSVDMethod</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.DS.html">slepc4py.SLEPc.DS</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.MatType.html">slepc4py.SLEPc.DS.MatType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.ParallelType.html">slepc4py.SLEPc.DS.ParallelType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.StateType.html">slepc4py.SLEPc.DS.StateType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.DS.Type.html">slepc4py.SLEPc.DS.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.EPS.html">slepc4py.SLEPc.EPS</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Balance.html">slepc4py.SLEPc.EPS.Balance</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.CISSExtraction.html">slepc4py.SLEPc.EPS.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.CISSQuadRule.html">slepc4py.SLEPc.EPS.CISSQuadRule</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Conv.html">slepc4py.SLEPc.EPS.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.ConvergedReason.html">slepc4py.SLEPc.EPS.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.ErrorType.html">slepc4py.SLEPc.EPS.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Extraction.html">slepc4py.SLEPc.EPS.Extraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.KrylovSchurBSEType.html">slepc4py.SLEPc.EPS.KrylovSchurBSEType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.LanczosReorthogType.html">slepc4py.SLEPc.EPS.LanczosReorthogType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.PowerShiftType.html">slepc4py.SLEPc.EPS.PowerShiftType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.ProblemType.html">slepc4py.SLEPc.EPS.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Stop.html">slepc4py.SLEPc.EPS.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Type.html">slepc4py.SLEPc.EPS.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.EPS.Which.html">slepc4py.SLEPc.EPS.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.EPSKrylovSchurBSEType.html">slepc4py.SLEPc.EPSKrylovSchurBSEType</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.FN.html">slepc4py.SLEPc.FN</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.CombineType.html">slepc4py.SLEPc.FN.CombineType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.ParallelType.html">slepc4py.SLEPc.FN.ParallelType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.FN.Type.html">slepc4py.SLEPc.FN.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.LME.html">slepc4py.SLEPc.LME</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.ConvergedReason.html">slepc4py.SLEPc.LME.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.ProblemType.html">slepc4py.SLEPc.LME.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.LME.Type.html">slepc4py.SLEPc.LME.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.MFN.html">slepc4py.SLEPc.MFN</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.MFN.ConvergedReason.html">slepc4py.SLEPc.MFN.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.MFN.Type.html">slepc4py.SLEPc.MFN.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.NEP.html">slepc4py.SLEPc.NEP</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.CISSExtraction.html">slepc4py.SLEPc.NEP.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Conv.html">slepc4py.SLEPc.NEP.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ConvergedReason.html">slepc4py.SLEPc.NEP.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ErrorType.html">slepc4py.SLEPc.NEP.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.ProblemType.html">slepc4py.SLEPc.NEP.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Refine.html">slepc4py.SLEPc.NEP.Refine</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.RefineScheme.html">slepc4py.SLEPc.NEP.RefineScheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Stop.html">slepc4py.SLEPc.NEP.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Type.html">slepc4py.SLEPc.NEP.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.NEP.Which.html">slepc4py.SLEPc.NEP.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.PEP.html">slepc4py.SLEPc.PEP</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Basis.html">slepc4py.SLEPc.PEP.Basis</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.CISSExtraction.html">slepc4py.SLEPc.PEP.CISSExtraction</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Conv.html">slepc4py.SLEPc.PEP.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ConvergedReason.html">slepc4py.SLEPc.PEP.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ErrorType.html">slepc4py.SLEPc.PEP.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Extract.html">slepc4py.SLEPc.PEP.Extract</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.JDProjection.html">slepc4py.SLEPc.PEP.JDProjection</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.ProblemType.html">slepc4py.SLEPc.PEP.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Refine.html">slepc4py.SLEPc.PEP.Refine</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.RefineScheme.html">slepc4py.SLEPc.PEP.RefineScheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Scale.html">slepc4py.SLEPc.PEP.Scale</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Stop.html">slepc4py.SLEPc.PEP.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Type.html">slepc4py.SLEPc.PEP.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.PEP.Which.html">slepc4py.SLEPc.PEP.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.RG.html">slepc4py.SLEPc.RG</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.RG.QuadRule.html">slepc4py.SLEPc.RG.QuadRule</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.RG.Type.html">slepc4py.SLEPc.RG.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.ST.html">slepc4py.SLEPc.ST</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.FilterDamping.html">slepc4py.SLEPc.ST.FilterDamping</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.FilterType.html">slepc4py.SLEPc.ST.FilterType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.MatMode.html">slepc4py.SLEPc.ST.MatMode</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.ST.Type.html">slepc4py.SLEPc.ST.Type</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.STFilterDamping.html">slepc4py.SLEPc.STFilterDamping</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.STFilterType.html">slepc4py.SLEPc.STFilterType</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="slepc4py.SLEPc.SVD.html">slepc4py.SLEPc.SVD</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Conv.html">slepc4py.SLEPc.SVD.Conv</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ConvergedReason.html">slepc4py.SLEPc.SVD.ConvergedReason</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ErrorType.html">slepc4py.SLEPc.SVD.ErrorType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.ProblemType.html">slepc4py.SLEPc.SVD.ProblemType</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Stop.html">slepc4py.SLEPc.SVD.Stop</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.TRLanczosGBidiag.html">slepc4py.SLEPc.SVD.TRLanczosGBidiag</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Type.html">slepc4py.SLEPc.SVD.Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="slepc4py.SLEPc.SVD.Which.html">slepc4py.SLEPc.SVD.Which</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.Sys.html">slepc4py.SLEPc.Sys</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.Util.html">slepc4py.SLEPc.Util</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DECIDE.html">slepc4py.SLEPc.DECIDE</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DEFAULT.html">slepc4py.SLEPc.DEFAULT</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.DETERMINE.html">slepc4py.SLEPc.DETERMINE</a></li>
<li class="toctree-l2"><a class="reference internal" href="slepc4py.SLEPc.CURRENT.html">slepc4py.SLEPc.CURRENT</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
    </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
      <div class="sidebar-primary-item">
<div id="ethical-ad-placement"
      class="flat"
      data-ea-publisher="readthedocs"
      data-ea-type="readthedocs-sidebar"
      data-ea-manual="true">
</div></div>
  </div>


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

<nav aria-label="Breadcrumb" class="d-print-none">
  <ul class="bd-breadcrumbs">
    
    <li class="breadcrumb-item breadcrumb-home">
      <a href="../index.html" class="nav-link" aria-label="Home">
        <i class="fa-solid fa-home"></i>
      </a>
    </li>
    
    <li class="breadcrumb-item"><a href="../reference.html" class="nav-link">Reference</a></li>
    
    
    <li class="breadcrumb-item"><a href="slepc4py.SLEPc.html" class="nav-link">slepc4py.SLEPc</a></li>
    
    <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">slepc4py.SLEPc.BV</span></li>
  </ul>
</nav>
</div>
      
    </div>
  
  
</div>
</div>
              
              
              
                
<div id="searchbox"></div>
                <article class="bd-article">
                  
  <section id="slepc4py-slepc-bv">
<h1>slepc4py.SLEPc.BV<a class="headerlink" href="#slepc4py-slepc-bv" title="Link to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">slepc4py.SLEPc.</span></span><span class="sig-name descname"><span class="pre">BV</span></span><a class="headerlink" href="#slepc4py.SLEPc.BV" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Object.html#petsc4py.PETSc.Object" title="(in Python v3.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Object</span></code></a></p>
<p>BV.</p>
<p class="rubric">Enumerations</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.BV.MatMultType.html#slepc4py.SLEPc.BV.MatMultType" title="slepc4py.SLEPc.BV.MatMultType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MatMultType</span></code></a></p></td>
<td><p>BV mat-mult types.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogBlockType.html#slepc4py.SLEPc.BV.OrthogBlockType" title="slepc4py.SLEPc.BV.OrthogBlockType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OrthogBlockType</span></code></a></p></td>
<td><p>BV block-orthogonalization types.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html#slepc4py.SLEPc.BV.OrthogRefineType" title="slepc4py.SLEPc.BV.OrthogRefineType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OrthogRefineType</span></code></a></p></td>
<td><p>BV orthogonalization refinement types.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html#slepc4py.SLEPc.BV.OrthogType" title="slepc4py.SLEPc.BV.OrthogType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OrthogType</span></code></a></p></td>
<td><p>BV orthogonalization types.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="slepc4py.SLEPc.BV.Type.html#slepc4py.SLEPc.BV.Type" title="slepc4py.SLEPc.BV.Type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Type</span></code></a></p></td>
<td><p>BV type.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Methods Summary</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.appendOptionsPrefix" title="slepc4py.SLEPc.BV.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 BV options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.applyMatrix" title="slepc4py.SLEPc.BV.applyMatrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">applyMatrix</span></code></a>(x, y)</p></td>
<td><p>Multiply a vector with the matrix associated to the bilinear form.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.copy" title="slepc4py.SLEPc.BV.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>([result])</p></td>
<td><p>Copy a basis vector object into another one.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.copyColumn" title="slepc4py.SLEPc.BV.copyColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copyColumn</span></code></a>(j, i)</p></td>
<td><p>Copy the values from one of the columns to another one.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.copyVec" title="slepc4py.SLEPc.BV.copyVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copyVec</span></code></a>(j, v)</p></td>
<td><p>Copy one of the columns of a basis vectors object into a Vec.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.create" title="slepc4py.SLEPc.BV.create"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create</span></code></a>([comm])</p></td>
<td><p>Create the BV object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.createFromMat" title="slepc4py.SLEPc.BV.createFromMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createFromMat</span></code></a>(A)</p></td>
<td><p>Create a basis vectors object from a dense Mat object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.createMat" title="slepc4py.SLEPc.BV.createMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createMat</span></code></a>()</p></td>
<td><p>Create a new Mat object of dense type and copy the contents of the BV.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.createVec" title="slepc4py.SLEPc.BV.createVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createVec</span></code></a>()</p></td>
<td><p>Create a Vec with the type and dimensions of the columns of the BV.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.destroy" title="slepc4py.SLEPc.BV.destroy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">destroy</span></code></a>()</p></td>
<td><p>Destroy the BV object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.dot" title="slepc4py.SLEPc.BV.dot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dot</span></code></a>(Y)</p></td>
<td><p>Compute the 'block-dot' product of two basis vectors objects.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.dotColumn" title="slepc4py.SLEPc.BV.dotColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dotColumn</span></code></a>(j)</p></td>
<td><p>Dot products of a column against all the column vectors of a BV.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.dotVec" title="slepc4py.SLEPc.BV.dotVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dotVec</span></code></a>(v)</p></td>
<td><p>Dot products of a vector against all the column vectors of the BV.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.duplicate" title="slepc4py.SLEPc.BV.duplicate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">duplicate</span></code></a>()</p></td>
<td><p>Duplicate the BV object with the same type and dimensions.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.duplicateResize" title="slepc4py.SLEPc.BV.duplicateResize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">duplicateResize</span></code></a>(m)</p></td>
<td><p>Create a BV object of the same type and dimensions as an existing one.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getActiveColumns" title="slepc4py.SLEPc.BV.getActiveColumns"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getActiveColumns</span></code></a>()</p></td>
<td><p>Get the current active dimensions.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getColumn" title="slepc4py.SLEPc.BV.getColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getColumn</span></code></a>(j)</p></td>
<td><p>Get a Vec object with the entries of the column of the BV object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getDefiniteTolerance" title="slepc4py.SLEPc.BV.getDefiniteTolerance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getDefiniteTolerance</span></code></a>()</p></td>
<td><p>Get the tolerance to be used when checking a definite inner product.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getLeadingDimension" title="slepc4py.SLEPc.BV.getLeadingDimension"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLeadingDimension</span></code></a>()</p></td>
<td><p>Get the leading dimension.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getMat" title="slepc4py.SLEPc.BV.getMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMat</span></code></a>()</p></td>
<td><p>Get a Mat object of dense type that shares the memory of the BV object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getMatMultMethod" title="slepc4py.SLEPc.BV.getMatMultMethod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatMultMethod</span></code></a>()</p></td>
<td><p>Get the method used for the <a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">matMult()</span></code></a> operation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getMatrix" title="slepc4py.SLEPc.BV.getMatrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMatrix</span></code></a>()</p></td>
<td><p>Get the matrix representation of the inner product.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getNumConstraints" title="slepc4py.SLEPc.BV.getNumConstraints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getNumConstraints</span></code></a>()</p></td>
<td><p>Get the number of constraints.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getOptionsPrefix" title="slepc4py.SLEPc.BV.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 BV options in the database.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getOrthogonalization" title="slepc4py.SLEPc.BV.getOrthogonalization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOrthogonalization</span></code></a>()</p></td>
<td><p>Get the orthogonalization settings from the BV object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getRandomContext" title="slepc4py.SLEPc.BV.getRandomContext"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getRandomContext</span></code></a>()</p></td>
<td><p>Get the <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Random.html#petsc4py.PETSc.Random" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Random</span></code></a> object associated with the BV.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getSizes" title="slepc4py.SLEPc.BV.getSizes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSizes</span></code></a>()</p></td>
<td><p>Get the local and global sizes, and the number of columns.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getType" title="slepc4py.SLEPc.BV.getType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getType</span></code></a>()</p></td>
<td><p>Get the BV type of this object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.getVecType" title="slepc4py.SLEPc.BV.getVecType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getVecType</span></code></a>()</p></td>
<td><p>Get the vector type used by the basis vectors object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.insertConstraints" title="slepc4py.SLEPc.BV.insertConstraints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">insertConstraints</span></code></a>(C)</p></td>
<td><p>Insert a set of vectors as constraints.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.insertVec" title="slepc4py.SLEPc.BV.insertVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">insertVec</span></code></a>(j, w)</p></td>
<td><p>Insert a vector into the specified column.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.insertVecs" title="slepc4py.SLEPc.BV.insertVecs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">insertVecs</span></code></a>(s, W[, orth])</p></td>
<td><p>Insert a set of vectors into specified columns.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matMult</span></code></a>(A[, Y])</p></td>
<td><p>Compute the matrix-vector product for each column, <span class="math notranslate nohighlight">\(Y = A V\)</span>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.matMultColumn" title="slepc4py.SLEPc.BV.matMultColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matMultColumn</span></code></a>(A, j)</p></td>
<td><p>Mat-vec product for a column, storing the result in the next column.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.matMultHermitianTranspose" title="slepc4py.SLEPc.BV.matMultHermitianTranspose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matMultHermitianTranspose</span></code></a>(A[, Y])</p></td>
<td><p>Pre-multiplication with the conjugate transpose of a matrix.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.matMultHermitianTransposeColumn" title="slepc4py.SLEPc.BV.matMultHermitianTransposeColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matMultHermitianTransposeColumn</span></code></a>(A, j)</p></td>
<td><p>Conjugate-transpose matrix-vector product for a specified column.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.matMultTransposeColumn" title="slepc4py.SLEPc.BV.matMultTransposeColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matMultTransposeColumn</span></code></a>(A, j)</p></td>
<td><p>Transpose matrix-vector product for a specified column.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.matProject" title="slepc4py.SLEPc.BV.matProject"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matProject</span></code></a>(A, Y)</p></td>
<td><p>Compute the projection of a matrix onto a subspace.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.mult" title="slepc4py.SLEPc.BV.mult"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mult</span></code></a>(alpha, beta, X, Q)</p></td>
<td><p>Compute <span class="math notranslate nohighlight">\(Y = beta Y + alpha X Q\)</span>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.multColumn" title="slepc4py.SLEPc.BV.multColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">multColumn</span></code></a>(alpha, beta, j, q)</p></td>
<td><p>Compute <span class="math notranslate nohighlight">\(y = beta y + alpha X q\)</span>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.multInPlace" title="slepc4py.SLEPc.BV.multInPlace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">multInPlace</span></code></a>(Q, s, e)</p></td>
<td><p>Update a set of vectors as <span class="math notranslate nohighlight">\(V(:,s:e-1) = V Q(:,s:e-1)\)</span>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.multVec" title="slepc4py.SLEPc.BV.multVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">multVec</span></code></a>(alpha, beta, y, q)</p></td>
<td><p>Compute <span class="math notranslate nohighlight">\(y = beta y + alpha X q\)</span>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.norm" title="slepc4py.SLEPc.BV.norm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">norm</span></code></a>([norm_type])</p></td>
<td><p>Compute the matrix norm of the BV.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.normColumn" title="slepc4py.SLEPc.BV.normColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">normColumn</span></code></a>(j[, norm_type])</p></td>
<td><p>Compute the vector norm of a selected column.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.orthogonalize" title="slepc4py.SLEPc.BV.orthogonalize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">orthogonalize</span></code></a>([R])</p></td>
<td><p>Orthogonalize all columns (except leading ones) (QR decomposition).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.orthogonalizeColumn" title="slepc4py.SLEPc.BV.orthogonalizeColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">orthogonalizeColumn</span></code></a>(j)</p></td>
<td><p>Orthogonalize a column vector with respect to the previous ones.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.orthogonalizeVec" title="slepc4py.SLEPc.BV.orthogonalizeVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">orthogonalizeVec</span></code></a>(v)</p></td>
<td><p>Orthogonalize a vector with respect to a set of vectors.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.orthonormalizeColumn" title="slepc4py.SLEPc.BV.orthonormalizeColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">orthonormalizeColumn</span></code></a>(j[, replace])</p></td>
<td><p>Orthonormalize a column vector with respect to the previous ones.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.resize" title="slepc4py.SLEPc.BV.resize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">resize</span></code></a>(m[, copy])</p></td>
<td><p>Change the number of columns.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.restoreColumn" title="slepc4py.SLEPc.BV.restoreColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">restoreColumn</span></code></a>(j, v)</p></td>
<td><p>Restore a column obtained with <a class="reference internal" href="#slepc4py.SLEPc.BV.getColumn" title="slepc4py.SLEPc.BV.getColumn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getColumn()</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.restoreMat" title="slepc4py.SLEPc.BV.restoreMat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">restoreMat</span></code></a>(A)</p></td>
<td><p>Restore the Mat obtained with <a class="reference internal" href="#slepc4py.SLEPc.BV.getMat" title="slepc4py.SLEPc.BV.getMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMat()</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.scale" title="slepc4py.SLEPc.BV.scale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scale</span></code></a>(alpha)</p></td>
<td><p>Multiply the entries by a scalar value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.scaleColumn" title="slepc4py.SLEPc.BV.scaleColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scaleColumn</span></code></a>(j, alpha)</p></td>
<td><p>Scale column j by alpha.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setActiveColumns" title="slepc4py.SLEPc.BV.setActiveColumns"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setActiveColumns</span></code></a>(l, k)</p></td>
<td><p>Set the columns that will be involved in operations.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setDefiniteTolerance" title="slepc4py.SLEPc.BV.setDefiniteTolerance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setDefiniteTolerance</span></code></a>(deftol)</p></td>
<td><p>Set the tolerance to be used when checking a definite inner product.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setFromOptions" title="slepc4py.SLEPc.BV.setFromOptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFromOptions</span></code></a>()</p></td>
<td><p>Set BV options from the options database.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setLeadingDimension" title="slepc4py.SLEPc.BV.setLeadingDimension"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setLeadingDimension</span></code></a>(ld)</p></td>
<td><p>Set the leading dimension.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setMatMultMethod" title="slepc4py.SLEPc.BV.setMatMultMethod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatMultMethod</span></code></a>(method)</p></td>
<td><p>Set the method used for the <a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">matMult()</span></code></a> operation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setMatrix" title="slepc4py.SLEPc.BV.setMatrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMatrix</span></code></a>(mat[, indef])</p></td>
<td><p>Set the bilinear form to be used for inner products.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setNumConstraints" title="slepc4py.SLEPc.BV.setNumConstraints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setNumConstraints</span></code></a>(nc)</p></td>
<td><p>Set the number of constraints.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setOptionsPrefix" title="slepc4py.SLEPc.BV.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 BV options in the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setOrthogonalization" title="slepc4py.SLEPc.BV.setOrthogonalization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setOrthogonalization</span></code></a>([otype, refine, eta, block])</p></td>
<td><p>Set the method used for the (block-)orthogonalization of vectors.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setRandom" title="slepc4py.SLEPc.BV.setRandom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRandom</span></code></a>()</p></td>
<td><p>Set the active columns of the BV to random numbers.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setRandomColumn" title="slepc4py.SLEPc.BV.setRandomColumn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRandomColumn</span></code></a>(j)</p></td>
<td><p>Set one column of the BV to random numbers.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setRandomCond" title="slepc4py.SLEPc.BV.setRandomCond"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRandomCond</span></code></a>(condn)</p></td>
<td><p>Set the columns of a BV to random numbers.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setRandomContext" title="slepc4py.SLEPc.BV.setRandomContext"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRandomContext</span></code></a>(rnd)</p></td>
<td><p>Set the <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Random.html#petsc4py.PETSc.Random" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Random</span></code></a> object associated with the BV.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setRandomNormal" title="slepc4py.SLEPc.BV.setRandomNormal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRandomNormal</span></code></a>()</p></td>
<td><p>Set the active columns of the BV to normal random numbers.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setRandomSign" title="slepc4py.SLEPc.BV.setRandomSign"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRandomSign</span></code></a>()</p></td>
<td><p>Set the entries of a BV to values 1 or -1 with equal probability.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setSizes" title="slepc4py.SLEPc.BV.setSizes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSizes</span></code></a>(sizes, m)</p></td>
<td><p>Set the local and global sizes, and the number of columns.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setSizesFromVec" title="slepc4py.SLEPc.BV.setSizesFromVec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSizesFromVec</span></code></a>(w, m)</p></td>
<td><p>Set the local and global sizes, and the number of columns.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setType" title="slepc4py.SLEPc.BV.setType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setType</span></code></a>(bv_type)</p></td>
<td><p>Set the type for the BV object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.setVecType" title="slepc4py.SLEPc.BV.setVecType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setVecType</span></code></a>(vec_type)</p></td>
<td><p>Set the vector type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.view" title="slepc4py.SLEPc.BV.view"><code class="xref py py-obj docutils literal notranslate"><span class="pre">view</span></code></a>([viewer])</p></td>
<td><p>Print the BV data structure.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Attributes Summary</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.column_size" title="slepc4py.SLEPc.BV.column_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">column_size</span></code></a></p></td>
<td><p>Basis vectors column size.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.local_size" title="slepc4py.SLEPc.BV.local_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">local_size</span></code></a></p></td>
<td><p>Basis vectors local size.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.size" title="slepc4py.SLEPc.BV.size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">size</span></code></a></p></td>
<td><p>Basis vectors global size.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slepc4py.SLEPc.BV.sizes" title="slepc4py.SLEPc.BV.sizes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sizes</span></code></a></p></td>
<td><p>Basis vectors local and global sizes, and the number of columns.</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.BV.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.BV.appendOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Append to the prefix used for searching for all BV 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 BV option requests.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L413">Source code at slepc4py/SLEPc/BV.pyx:413</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.applyMatrix">
<span class="sig-name descname"><span class="pre">applyMatrix</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.BV.applyMatrix" title="Link to this definition">#</a></dt>
<dd><p>Multiply a vector with the matrix associated to the bilinear form.</p>
<p>Neighbor-wise 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>x</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The input vector.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The result vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>If the bilinear form has no associated matrix this function
copies the vector.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L605">Source code at slepc4py/SLEPc/BV.pyx:605</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.copy">
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</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.BV.copy" title="Link to this definition">#</a></dt>
<dd><p>Copy a basis vector object into another one.</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>result</strong> (<a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</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 copy.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L255">Source code at slepc4py/SLEPc/BV.pyx:255</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.copyColumn">
<span class="sig-name descname"><span class="pre">copyColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.copyColumn" title="Link to this definition">#</a></dt>
<dd><p>Copy the values from one of the columns to another one.</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>j</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 number of the source column.</p></li>
<li><p><strong>i</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The number of the destination column.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L866">Source code at slepc4py/SLEPc/BV.pyx:866</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.copyVec">
<span class="sig-name descname"><span class="pre">copyVec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.copyVec" title="Link to this definition">#</a></dt>
<dd><p>Copy one of the columns of a basis vectors object into a Vec.</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>j</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 column number to be copied.</p></li>
<li><p><strong>v</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – A vector.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L850">Source code at slepc4py/SLEPc/BV.pyx:850</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.create" title="Link to this definition">#</a></dt>
<dd><p>Create the BV object.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>comm</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Comm.html#petsc4py.PETSc.Comm" title="(in Python v3.24)"><em>Comm</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – MPI communicator; if not provided, it defaults to all
processes.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.14)"><em>Self</em></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L175">Source code at slepc4py/SLEPc/BV.pyx:175</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.createFromMat">
<span class="sig-name descname"><span class="pre">createFromMat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.createFromMat" title="Link to this definition">#</a></dt>
<dd><p>Create a basis vectors object from a dense Mat 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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – A dense tall-skinny 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://docs.python.org/3/library/typing.html#typing.Self" title="(in Python v3.14)"><em>Self</em></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L193">Source code at slepc4py/SLEPc/BV.pyx:193</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.createMat">
<span class="sig-name descname"><span class="pre">createMat</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.createMat" title="Link to this definition">#</a></dt>
<dd><p>Create a new Mat object of dense type and copy the contents of the BV.</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 new matrix.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L209">Source code at slepc4py/SLEPc/BV.pyx:209</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.createVec">
<span class="sig-name descname"><span class="pre">createVec</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.createVec" title="Link to this definition">#</a></dt>
<dd><p>Create a Vec with the type and dimensions of the columns of the BV.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>New vector.</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.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Vec</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L810">Source code at slepc4py/SLEPc/BV.pyx:810</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.destroy" title="Link to this definition">#</a></dt>
<dd><p>Destroy the BV object.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L165">Source code at slepc4py/SLEPc/BV.pyx:165</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.BV.dot">
<span class="sig-name descname"><span class="pre">dot</span></span><span class="sig-paren">(</span><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.BV.dot" title="Link to this definition">#</a></dt>
<dd><p>Compute the ‘block-dot’ product of two basis vectors objects.</p>
<p>Collective.</p>
<p><span class="math notranslate nohighlight">\(M = Y^H X\)</span> <span class="math notranslate nohighlight">\((m_{ij} = y_i^H x_j)\)</span> or
<span class="math notranslate nohighlight">\(M = Y^H B X\)</span></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Y</strong> (<a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a>) – Left basis vectors, can be the same as self, giving
<span class="math notranslate nohighlight">\(M = X^H X\)</span>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The resulting matrix.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This is the generalization of VecDot() for a collection of vectors,
<span class="math notranslate nohighlight">\(M = Y^H X\)</span>. The result is a matrix <span class="math notranslate nohighlight">\(M\)</span> whose entry
<span class="math notranslate nohighlight">\(m_{ij}\)</span> is equal to <span class="math notranslate nohighlight">\(y_i^H x_j\)</span>
(where <span class="math notranslate nohighlight">\(y_i^H\)</span> denotes the conjugate transpose of <span class="math notranslate nohighlight">\(y_i\)</span>).</p>
<p><span class="math notranslate nohighlight">\(X\)</span> and <span class="math notranslate nohighlight">\(Y\)</span> can be the same object.</p>
<p>If a non-standard inner product has been specified with setMatrix(),
then the result is <span class="math notranslate nohighlight">\(M = Y^H B X\)</span>. In this case, both
<span class="math notranslate nohighlight">\(X\)</span> and <span class="math notranslate nohighlight">\(Y\)</span> must have the same associated matrix.</p>
<p>Only rows (resp. columns) of <span class="math notranslate nohighlight">\(M\)</span> starting from <span class="math notranslate nohighlight">\(ly\)</span> (resp.
<span class="math notranslate nohighlight">\(lx\)</span>) are computed, where <span class="math notranslate nohighlight">\(ly\)</span> (resp. <span class="math notranslate nohighlight">\(lx\)</span>) is the
number of leading columns of <span class="math notranslate nohighlight">\(Y\)</span> (resp. <span class="math notranslate nohighlight">\(X\)</span>).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1064">Source code at slepc4py/SLEPc/BV.pyx:1064</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.dotColumn">
<span class="sig-name descname"><span class="pre">dotColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.dotColumn" title="Link to this definition">#</a></dt>
<dd><p>Dot products of a column against all the column vectors of a BV.</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>j</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 index of the column.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The computed values.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="slepc4py.typing.ArrayScalar.html#slepc4py.typing.ArrayScalar" title="slepc4py.typing.ArrayScalar"><code class="xref any py py-data docutils literal notranslate"><span class="pre">ArrayScalar</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L948">Source code at slepc4py/SLEPc/BV.pyx:948</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.dotVec">
<span class="sig-name descname"><span class="pre">dotVec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">v</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.dotVec" title="Link to this definition">#</a></dt>
<dd><p>Dot products of a vector against all the column vectors of the BV.</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>v</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – A vector.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The computed values.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="slepc4py.typing.ArrayScalar.html#slepc4py.typing.ArrayScalar" title="slepc4py.typing.ArrayScalar"><code class="xref any py py-data docutils literal notranslate"><span class="pre">ArrayScalar</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This is analogue to VecMDot(), but using BV to represent a collection
of vectors. The result is <span class="math notranslate nohighlight">\(m = X^H y\)</span>, so <span class="math notranslate nohighlight">\(m_i\)</span> is
equal to <span class="math notranslate nohighlight">\(x_j^H y\)</span>. Note that here <span class="math notranslate nohighlight">\(X\)</span> is transposed
as opposed to BVDot().</p>
<p>If a non-standard inner product has been specified with BVSetMatrix(),
then the result is <span class="math notranslate nohighlight">\(m = X^H B y\)</span>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L912">Source code at slepc4py/SLEPc/BV.pyx:912</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.duplicate">
<span class="sig-name descname"><span class="pre">duplicate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.duplicate" title="Link to this definition">#</a></dt>
<dd><p>Duplicate the BV object with the same type and dimensions.</p>
<p>Collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L224">Source code at slepc4py/SLEPc/BV.pyx:224</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.duplicateResize">
<span class="sig-name descname"><span class="pre">duplicateResize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">m</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.duplicateResize" title="Link to this definition">#</a></dt>
<dd><p>Create a BV object of the same type and dimensions as an existing one.</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>m</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 number of columns.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>With possibly different number of columns.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L234">Source code at slepc4py/SLEPc/BV.pyx:234</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getActiveColumns">
<span class="sig-name descname"><span class="pre">getActiveColumns</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getActiveColumns" title="Link to this definition">#</a></dt>
<dd><p>Get the current active dimensions.</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>l</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a>) – The leading number of columns.</p></li>
<li><p><strong>k</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a>) – The active number of columns.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L642">Source code at slepc4py/SLEPc/BV.pyx:642</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getColumn">
<span class="sig-name descname"><span class="pre">getColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getColumn" title="Link to this definition">#</a></dt>
<dd><p>Get a Vec object with the entries of the column of the BV object.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>j</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 index of the requested column.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The vector containing the jth column.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Vec</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Modifying the returned Vec will change the BV entries as well.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L975">Source code at slepc4py/SLEPc/BV.pyx:975</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getDefiniteTolerance">
<span class="sig-name descname"><span class="pre">getDefiniteTolerance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getDefiniteTolerance" title="Link to this definition">#</a></dt>
<dd><p>Get the tolerance to be used when checking a definite inner product.</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 tolerance.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L897">Source code at slepc4py/SLEPc/BV.pyx:897</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getLeadingDimension">
<span class="sig-name descname"><span class="pre">getLeadingDimension</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getLeadingDimension" title="Link to this definition">#</a></dt>
<dd><p>Get the leading dimension.</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 leading dimension.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L377">Source code at slepc4py/SLEPc/BV.pyx:377</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getMat">
<span class="sig-name descname"><span class="pre">getMat</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getMat" title="Link to this definition">#</a></dt>
<dd><p>Get a Mat object of dense type that shares the memory of the BV object.</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 matrix.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The returned matrix contains only the active columns. If the content
of the Mat is modified, these changes are also done in the BV object.
The user must call <a class="reference internal" href="#slepc4py.SLEPc.BV.restoreMat" title="slepc4py.SLEPc.BV.restoreMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">restoreMat()</span></code></a> when no longer needed.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1022">Source code at slepc4py/SLEPc/BV.pyx:1022</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getMatMultMethod">
<span class="sig-name descname"><span class="pre">getMatMultMethod</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getMatMultMethod" title="Link to this definition">#</a></dt>
<dd><p>Get the method used for the <a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">matMult()</span></code></a> operation.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The method for the <a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">matMult()</span></code></a> operation.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="slepc4py.SLEPc.BV.MatMultType.html#slepc4py.SLEPc.BV.MatMultType" title="slepc4py.SLEPc.BV.MatMultType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">MatMultType</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L535">Source code at slepc4py/SLEPc/BV.pyx:535</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getMatrix">
<span class="sig-name descname"><span class="pre">getMatrix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getMatrix" title="Link to this definition">#</a></dt>
<dd><p>Get the matrix representation of the inner product.</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>mat</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a>) – The matrix of the inner product</p></li>
<li><p><strong>indef</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a>) – Whether the matrix is indefinite</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://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)">petsc4py.PETSc.Mat</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a>] | <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/constants.html#None" title="(in Python v3.14)">None</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L566">Source code at slepc4py/SLEPc/BV.pyx:566</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getNumConstraints">
<span class="sig-name descname"><span class="pre">getNumConstraints</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getNumConstraints" title="Link to this definition">#</a></dt>
<dd><p>Get the number of constraints.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The number of constraints.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L795">Source code at slepc4py/SLEPc/BV.pyx:795</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.getOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Get the prefix used for searching for all BV 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 BV object.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L428">Source code at slepc4py/SLEPc/BV.pyx:428</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getOrthogonalization">
<span class="sig-name descname"><span class="pre">getOrthogonalization</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getOrthogonalization" title="Link to this definition">#</a></dt>
<dd><p>Get the orthogonalization settings from the BV 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><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html#slepc4py.SLEPc.BV.OrthogType" title="slepc4py.SLEPc.BV.OrthogType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">OrthogType</span></code></a>) – The type of orthogonalization technique.</p></li>
<li><p><strong>refine</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html#slepc4py.SLEPc.BV.OrthogRefineType" title="slepc4py.SLEPc.BV.OrthogRefineType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">OrthogRefineType</span></code></a>) – The type of refinement.</p></li>
<li><p><strong>eta</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>) – Parameter for selective refinement (used when the
refinement type is <a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html#slepc4py.SLEPc.BV.OrthogRefineType.IFNEEDED" title="slepc4py.SLEPc.BV.OrthogRefineType.IFNEEDED"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">BV.OrthogRefineType.IFNEEDED</span></code></a>).</p></li>
<li><p><strong>block</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogBlockType.html#slepc4py.SLEPc.BV.OrthogBlockType" title="slepc4py.SLEPc.BV.OrthogBlockType"><code class="xref any py py-class docutils literal notranslate"><span class="pre">OrthogBlockType</span></code></a>) – The type of block orthogonalization .</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html#slepc4py.SLEPc.BV.OrthogType" title="slepc4py.SLEPc.BV.OrthogType">OrthogType</a>, <a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html#slepc4py.SLEPc.BV.OrthogRefineType" title="slepc4py.SLEPc.BV.OrthogRefineType">OrthogRefineType</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 internal" href="slepc4py.SLEPc.BV.OrthogBlockType.html#slepc4py.SLEPc.BV.OrthogBlockType" title="slepc4py.SLEPc.BV.OrthogBlockType">OrthogBlockType</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L458">Source code at slepc4py/SLEPc/BV.pyx:458</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getRandomContext">
<span class="sig-name descname"><span class="pre">getRandomContext</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getRandomContext" title="Link to this definition">#</a></dt>
<dd><p>Get the <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Random.html#petsc4py.PETSc.Random" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Random</span></code></a> object associated with the BV.</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 random number generator context.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Random.html#petsc4py.PETSc.Random" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Random</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1554">Source code at slepc4py/SLEPc/BV.pyx:1554</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getSizes">
<span class="sig-name descname"><span class="pre">getSizes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getSizes" title="Link to this definition">#</a></dt>
<dd><p>Get the local and global sizes, and the number of columns.</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>(n, N)</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">tuple</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a>) – The local and global sizes</p></li>
<li><p><strong>m</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a>) – The number of columns.</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference internal" href="slepc4py.typing.LayoutSizeSpec.html#slepc4py.typing.LayoutSizeSpec" title="slepc4py.typing.LayoutSizeSpec"><em>LayoutSizeSpec</em></a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L346">Source code at slepc4py/SLEPc/BV.pyx:346</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.getType" title="Link to this definition">#</a></dt>
<dd><p>Get the BV 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 inner product type currently being used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L288">Source code at slepc4py/SLEPc/BV.pyx:288</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.getVecType">
<span class="sig-name descname"><span class="pre">getVecType</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.getVecType" title="Link to this definition">#</a></dt>
<dd><p>Get the vector type used by the basis vectors object.</p>
<p>Not collective.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L840">Source code at slepc4py/SLEPc/BV.pyx:840</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/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.insertConstraints">
<span class="sig-name descname"><span class="pre">insertConstraints</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">C</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.insertConstraints" title="Link to this definition">#</a></dt>
<dd><p>Insert a set of vectors as constraints.</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>C</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em>[</em><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a><em>]</em>) – Set of vectors to be inserted as constraints.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Number of constraints.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The constraints are relevant only during orthogonalization. Constraint
vectors span a subspace that is deflated in every orthogonalization
operation, so they are intended for removing those directions from the
orthogonal basis computed in regular BV columns.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L749">Source code at slepc4py/SLEPc/BV.pyx:749</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.insertVec">
<span class="sig-name descname"><span class="pre">insertVec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.insertVec" title="Link to this definition">#</a></dt>
<dd><p>Insert a vector into the specified column.</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>j</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 column to be overwritten.</p></li>
<li><p><strong>w</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The vector to be copied.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L694">Source code at slepc4py/SLEPc/BV.pyx:694</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.insertVecs">
<span class="sig-name descname"><span class="pre">insertVecs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">W</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.insertVecs" title="Link to this definition">#</a></dt>
<dd><p>Insert a set of vectors into specified columns.</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>s</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 first column to be overwritten.</p></li>
<li><p><strong>W</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em>[</em><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a><em>]</em>) – Set of vectors to be copied.</p></li>
<li><p><strong>orth</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Flag indicating if the vectors must be orthogonalized.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Number of linearly independent vectors.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Copies the contents of vectors W into self(:,s:s+n), where n is the
length of W. If orthogonalization flag is set then the vectors are
copied one by one then orthogonalized against the previous one.  If any
are linearly dependent then it is discared and the value of m is
decreased.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L710">Source code at slepc4py/SLEPc/BV.pyx:710</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.matMult">
<span class="sig-name descname"><span class="pre">matMult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</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.BV.matMult" title="Link to this definition">#</a></dt>
<dd><p>Compute the matrix-vector product for each column, <span class="math notranslate nohighlight">\(Y = A V\)</span>.</p>
<p>Neighbor-wise 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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix.</p></li>
<li><p><strong>Y</strong> (<a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The result.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><code class="xref any py py-class docutils literal notranslate"><span class="pre">BV</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Only active columns (excluding the leading ones) are processed.</p>
<p>It is possible to choose whether the computation is done column by column
or using dense matrices using the options database keys:</p>
<blockquote>
<div><p>-bv_matmult_vecs
-bv_matmult_mat</p>
</div></blockquote>
<p>The default is bv_matmult_mat.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1139">Source code at slepc4py/SLEPc/BV.pyx:1139</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.matMultColumn">
<span class="sig-name descname"><span class="pre">matMultColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.matMultColumn" title="Link to this definition">#</a></dt>
<dd><p>Mat-vec product for a column, storing the result in the next column.</p>
<p>Neighbor-wise collective.</p>
<p><span class="math notranslate nohighlight">\(v_{j+1} = A v_j\)</span>.</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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix.</p></li>
<li><p><strong>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of column.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1234">Source code at slepc4py/SLEPc/BV.pyx:1234</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.matMultHermitianTranspose">
<span class="sig-name descname"><span class="pre">matMultHermitianTranspose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</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.BV.matMultHermitianTranspose" title="Link to this definition">#</a></dt>
<dd><p>Pre-multiplication with the conjugate transpose of a matrix.</p>
<p>Neighbor-wise collective.</p>
<p><span class="math notranslate nohighlight">\(Y = A^H V\)</span>.</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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix.</p></li>
<li><p><strong>Y</strong> (<a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The result.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><code class="xref any py py-class docutils literal notranslate"><span class="pre">BV</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Only active columns (excluding the leading ones) are processed.</p>
<p>As opoosed to matMult(), this operation is always done by column by
column, with a sequence of calls to MatMultHermitianTranspose().</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1188">Source code at slepc4py/SLEPc/BV.pyx:1188</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.matMultHermitianTransposeColumn">
<span class="sig-name descname"><span class="pre">matMultHermitianTransposeColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.matMultHermitianTransposeColumn" title="Link to this definition">#</a></dt>
<dd><p>Conjugate-transpose matrix-vector product for a specified column.</p>
<p>Neighbor-wise collective.</p>
<p>Store the result in the next column: <span class="math notranslate nohighlight">\(v_{j+1} = A^H v_j\)</span>.</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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix.</p></li>
<li><p><strong>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of column.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1270">Source code at slepc4py/SLEPc/BV.pyx:1270</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.matMultTransposeColumn">
<span class="sig-name descname"><span class="pre">matMultTransposeColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.matMultTransposeColumn" title="Link to this definition">#</a></dt>
<dd><p>Transpose matrix-vector product for a specified column.</p>
<p>Neighbor-wise collective.</p>
<p>Store the result in the next column: <span class="math notranslate nohighlight">\(v_{j+1} = A^T v_j\)</span>.</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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix.</p></li>
<li><p><strong>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of column.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1252">Source code at slepc4py/SLEPc/BV.pyx:1252</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.matProject">
<span class="sig-name descname"><span class="pre">matProject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</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.BV.matProject" title="Link to this definition">#</a></dt>
<dd><p>Compute the projection of a matrix onto a subspace.</p>
<p>Collective.</p>
<p><span class="math notranslate nohighlight">\(M = Y^H A X\)</span></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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>petsc4py.PETSc.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>) – Matrix to be projected.</p></li>
<li><p><strong>Y</strong> (<a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a>) – Left basis vectors, can be the same as self, giving
<span class="math notranslate nohighlight">\(M = X^H A X\)</span>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Projection of the matrix A onto the subspace.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Mat</span></code></a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1109">Source code at slepc4py/SLEPc/BV.pyx:1109</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.mult">
<span class="sig-name descname"><span class="pre">mult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpha</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.mult" title="Link to this definition">#</a></dt>
<dd><p>Compute <span class="math notranslate nohighlight">\(Y = beta Y + alpha X Q\)</span>.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>alpha</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – Coefficient that multiplies X.</p></li>
<li><p><strong>beta</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – Coefficient that multiplies Y.</p></li>
<li><p><strong>X</strong> (<a class="reference internal" href="#slepc4py.SLEPc.BV" title="slepc4py.SLEPc.BV"><em>BV</em></a>) – Input basis vectors.</p></li>
<li><p><strong>Q</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – Input matrix, if not given the identity matrix is assumed.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1288">Source code at slepc4py/SLEPc/BV.pyx:1288</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.multColumn">
<span class="sig-name descname"><span class="pre">multColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpha</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.multColumn" title="Link to this definition">#</a></dt>
<dd><p>Compute <span class="math notranslate nohighlight">\(y = beta y + alpha X q\)</span>.</p>
<p>Logically collective.</p>
<p>Compute <span class="math notranslate nohighlight">\(y = beta y + alpha X q\)</span>, where
<span class="math notranslate nohighlight">\(y\)</span> is the <span class="math notranslate nohighlight">\(j^{th}\)</span> column.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>alpha</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – Coefficient that multiplies X.</p></li>
<li><p><strong>beta</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – Coefficient that multiplies y.</p></li>
<li><p><strong>j</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 column index.</p></li>
<li><p><strong>q</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.14)"><em>Sequence</em></a><em>[</em><a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a><em>]</em>) – Input coefficients.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1329">Source code at slepc4py/SLEPc/BV.pyx:1329</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.multInPlace">
<span class="sig-name descname"><span class="pre">multInPlace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.multInPlace" title="Link to this definition">#</a></dt>
<dd><p>Update a set of vectors as <span class="math notranslate nohighlight">\(V(:,s:e-1) = V Q(:,s:e-1)\)</span>.</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>Q</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – A sequential dense matrix.</p></li>
<li><p><strong>s</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – First column to be overwritten.</p></li>
<li><p><strong>e</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Last column to be overwritten.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1310">Source code at slepc4py/SLEPc/BV.pyx:1310</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.multVec">
<span class="sig-name descname"><span class="pre">multVec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpha</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.multVec" title="Link to this definition">#</a></dt>
<dd><p>Compute <span class="math notranslate nohighlight">\(y = beta y + alpha X q\)</span>.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>alpha</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – Coefficient that multiplies X.</p></li>
<li><p><strong>beta</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – Coefficient that multiplies y.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – Input/output vector.</p></li>
<li><p><strong>q</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.14)"><em>Sequence</em></a><em>[</em><a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a><em>]</em>) – Input coefficients.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1360">Source code at slepc4py/SLEPc/BV.pyx:1360</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.norm">
<span class="sig-name descname"><span class="pre">norm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">norm_type</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.BV.norm" title="Link to this definition">#</a></dt>
<dd><p>Compute the matrix norm of the BV.</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>norm_type</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.NormType.html#petsc4py.PETSc.NormType" title="(in Python v3.24)"><em>NormType</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 norm type.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The norm.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>All active columns (except the leading ones) are considered as a
matrix. The allowed norms are NORM_1, NORM_FROBENIUS, and
NORM_INFINITY.</p>
<p>This operation fails if a non-standard inner product has been specified
with BVSetMatrix().</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1420">Source code at slepc4py/SLEPc/BV.pyx:1420</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.normColumn">
<span class="sig-name descname"><span class="pre">normColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">norm_type</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.BV.normColumn" title="Link to this definition">#</a></dt>
<dd><p>Compute the vector norm of a selected column.</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>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of column.</p></li>
<li><p><strong>norm_type</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.NormType.html#petsc4py.PETSc.NormType" title="(in Python v3.24)"><em>NormType</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 norm type.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The norm.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The norm of <span class="math notranslate nohighlight">\(V_j\)</span> is computed (NORM_1, NORM_2, or NORM_INFINITY).</p>
<p>If a non-standard inner product has been specified with BVSetMatrix(),
then the returned value is <span class="math notranslate nohighlight">\(\sqrt{V_j^H B V_j}\)</span>,
where <span class="math notranslate nohighlight">\(B\)</span> is the inner product matrix (argument ‘type’ is
ignored).</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1387">Source code at slepc4py/SLEPc/BV.pyx:1387</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.orthogonalize">
<span class="sig-name descname"><span class="pre">orthogonalize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">R</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.orthogonalize" title="Link to this definition">#</a></dt>
<dd><p>Orthogonalize all columns (except leading ones) (QR decomposition).</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>R</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – A sequential dense matrix.</p></li>
<li><p><strong>kargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><em>Any</em></a>)</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The output satisfies <span class="math notranslate nohighlight">\(V_0 = V R\)</span> (where <span class="math notranslate nohighlight">\(V_0\)</span> represent the
input <span class="math notranslate nohighlight">\(V\)</span>) and <span class="math notranslate nohighlight">\(V' V = I\)</span>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1668">Source code at slepc4py/SLEPc/BV.pyx:1668</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.orthogonalizeColumn">
<span class="sig-name descname"><span class="pre">orthogonalizeColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.orthogonalizeColumn" title="Link to this definition">#</a></dt>
<dd><p>Orthogonalize a column vector with respect to the previous ones.</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>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of the column to be orthogonalized.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>norm</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 norm of the resulting vector.</p></li>
<li><p><strong>lindep</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a>) – Flag indicating that refinement did not improve the
quality of orthogonalization.</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference 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#bool" title="(in Python v3.14)">bool</a>]</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function applies an orthogonal projector to project vector
<span class="math notranslate nohighlight">\(V_j\)</span> onto the orthogonal complement of the span of the columns
<span class="math notranslate nohighlight">\(V[0..j-1]\)</span>, where <span class="math notranslate nohighlight">\(V[.]\)</span> are the vectors of the BV.
The columns <span class="math notranslate nohighlight">\(V[0..j-1]\)</span> are assumed to be mutually orthonormal.</p>
<p>This routine does not normalize the resulting vector.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1602">Source code at slepc4py/SLEPc/BV.pyx:1602</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.orthogonalizeVec">
<span class="sig-name descname"><span class="pre">orthogonalizeVec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">v</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.orthogonalizeVec" title="Link to this definition">#</a></dt>
<dd><p>Orthogonalize a vector with respect to a set of vectors.</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>v</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – Vector to be orthogonalized, modified on return.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>norm</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 norm of the resulting vector.</p></li>
<li><p><strong>lindep</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a>) – Flag indicating that refinement did not improve the
quality of orthogonalization.</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference 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#bool" title="(in Python v3.14)">bool</a>]</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function applies an orthogonal projector to project vector
<span class="math notranslate nohighlight">\(v\)</span> onto the orthogonal complement of the span of the columns
of the BV.</p>
<p>This routine does not normalize the resulting vector.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1570">Source code at slepc4py/SLEPc/BV.pyx:1570</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.orthonormalizeColumn">
<span class="sig-name descname"><span class="pre">orthonormalizeColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.orthonormalizeColumn" title="Link to this definition">#</a></dt>
<dd><p>Orthonormalize a column vector with respect to the previous ones.</p>
<p>Collective.</p>
<p>This is equivalent to a call to <a class="reference internal" href="#slepc4py.SLEPc.BV.orthogonalizeColumn" title="slepc4py.SLEPc.BV.orthogonalizeColumn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">orthogonalizeColumn()</span></code></a> followed by a
call to <a class="reference internal" href="#slepc4py.SLEPc.BV.scaleColumn" title="slepc4py.SLEPc.BV.scaleColumn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">scaleColumn()</span></code></a> with the reciprocal of the norm.</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>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Index of the column to be orthonormalized.</p></li>
<li><p><strong>replace</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Whether it is allowed to set the vector randomly.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>norm</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 norm of the resulting vector.</p></li>
<li><p><strong>lindep</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a>) – Flag indicating that refinement did not improve the
quality of orthogonalization.</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference 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#bool" title="(in Python v3.14)">bool</a>]</p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1636">Source code at slepc4py/SLEPc/BV.pyx:1636</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.resize">
<span class="sig-name descname"><span class="pre">resize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">m</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</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.BV.resize" title="Link to this definition">#</a></dt>
<dd><p>Change the number of columns.</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>m</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 new number of columns.</p></li>
<li><p><strong>copy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – A flag indicating whether current values should be kept.</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>Internal storage is reallocated. If copy is True, then the contents are
copied to the leading part of the new space.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1451">Source code at slepc4py/SLEPc/BV.pyx:1451</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.restoreColumn">
<span class="sig-name descname"><span class="pre">restoreColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.restoreColumn" title="Link to this definition">#</a></dt>
<dd><p>Restore a column obtained with <a class="reference internal" href="#slepc4py.SLEPc.BV.getColumn" title="slepc4py.SLEPc.BV.getColumn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getColumn()</span></code></a>.</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>j</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 index of the requested column.</p></li>
<li><p><strong>v</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The vector obtained with <a class="reference internal" href="#slepc4py.SLEPc.BV.getColumn" title="slepc4py.SLEPc.BV.getColumn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getColumn()</span></code></a>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The arguments must match the corresponding call to <a class="reference internal" href="#slepc4py.SLEPc.BV.getColumn" title="slepc4py.SLEPc.BV.getColumn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getColumn()</span></code></a>.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1001">Source code at slepc4py/SLEPc/BV.pyx:1001</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.restoreMat">
<span class="sig-name descname"><span class="pre">restoreMat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.restoreMat" title="Link to this definition">#</a></dt>
<dd><p>Restore the Mat obtained with <a class="reference internal" href="#slepc4py.SLEPc.BV.getMat" title="slepc4py.SLEPc.BV.getMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMat()</span></code></a>.</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>A</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix obtained with <a class="reference internal" href="#slepc4py.SLEPc.BV.getMat" title="slepc4py.SLEPc.BV.getMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMat()</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>
<p class="rubric">Notes</p>
<p>A call to this function must match a previous call of <a class="reference internal" href="#slepc4py.SLEPc.BV.getMat" title="slepc4py.SLEPc.BV.getMat"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">getMat()</span></code></a>.
The effect is that the contents of the Mat are copied back to the
BV internal data structures.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1044">Source code at slepc4py/SLEPc/BV.pyx:1044</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.scale">
<span class="sig-name descname"><span class="pre">scale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpha</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.scale" title="Link to this definition">#</a></dt>
<dd><p>Multiply the entries by a scalar value.</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>alpha</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – scaling factor.</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>All active columns (except the leading ones) are scaled.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L676">Source code at slepc4py/SLEPc/BV.pyx:676</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.scaleColumn">
<span class="sig-name descname"><span class="pre">scaleColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.scaleColumn" title="Link to this definition">#</a></dt>
<dd><p>Scale column j by alpha.</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>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – column number to be scaled.</p></li>
<li><p><strong>alpha</strong> (<a class="reference internal" href="slepc4py.typing.Scalar.html#slepc4py.typing.Scalar" title="slepc4py.typing.Scalar"><em>Scalar</em></a>) – scaling factor.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L659">Source code at slepc4py/SLEPc/BV.pyx:659</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setActiveColumns">
<span class="sig-name descname"><span class="pre">setActiveColumns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">l</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setActiveColumns" title="Link to this definition">#</a></dt>
<dd><p>Set the columns that will be involved in operations.</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>l</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 leading number of columns.</p></li>
<li><p><strong>k</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 active number of columns.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L625">Source code at slepc4py/SLEPc/BV.pyx:625</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setDefiniteTolerance">
<span class="sig-name descname"><span class="pre">setDefiniteTolerance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deftol</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setDefiniteTolerance" title="Link to this definition">#</a></dt>
<dd><p>Set the tolerance to be used when checking a definite inner product.</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>deftol</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 tolerance.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L883">Source code at slepc4py/SLEPc/BV.pyx:883</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.setFromOptions" title="Link to this definition">#</a></dt>
<dd><p>Set BV 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><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L443">Source code at slepc4py/SLEPc/BV.pyx:443</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.BV.setLeadingDimension">
<span class="sig-name descname"><span class="pre">setLeadingDimension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ld</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setLeadingDimension" title="Link to this definition">#</a></dt>
<dd><p>Set the leading dimension.</p>
<p>Not collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ld</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 leading dimension.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L363">Source code at slepc4py/SLEPc/BV.pyx:363</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setMatMultMethod">
<span class="sig-name descname"><span class="pre">setMatMultMethod</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setMatMultMethod" title="Link to this definition">#</a></dt>
<dd><p>Set the method used for the <a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">matMult()</span></code></a> operation.</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>method</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.MatMultType.html#slepc4py.SLEPc.BV.MatMultType" title="slepc4py.SLEPc.BV.MatMultType"><em>MatMultType</em></a>) – The method for the <a class="reference internal" href="#slepc4py.SLEPc.BV.matMult" title="slepc4py.SLEPc.BV.matMult"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">matMult()</span></code></a> operation.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L550">Source code at slepc4py/SLEPc/BV.pyx:550</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setMatrix">
<span class="sig-name descname"><span class="pre">setMatrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indef</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setMatrix" title="Link to this definition">#</a></dt>
<dd><p>Set the bilinear form to be used for inner products.</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>mat</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Mat.html#petsc4py.PETSc.Mat" title="(in Python v3.24)"><em>Mat</em></a>) – The matrix of the inner product.</p></li>
<li><p><strong>indef</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Whether the matrix is indefinite</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L588">Source code at slepc4py/SLEPc/BV.pyx:588</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setNumConstraints">
<span class="sig-name descname"><span class="pre">setNumConstraints</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nc</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setNumConstraints" title="Link to this definition">#</a></dt>
<dd><p>Set the number of constraints.</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>nc</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 number of constraints.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L781">Source code at slepc4py/SLEPc/BV.pyx:781</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.setOptionsPrefix" title="Link to this definition">#</a></dt>
<dd><p>Set the prefix used for searching for all BV 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 BV option requests.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>A hyphen (<code class="docutils literal notranslate"><span class="pre">-</span></code>) must NOT be given at the beginning of the
prefix name.  The first character of all runtime options is
AUTOMATICALLY the hyphen.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L392">Source code at slepc4py/SLEPc/BV.pyx:392</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setOrthogonalization">
<span class="sig-name descname"><span class="pre">setOrthogonalization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">otype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">refine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block</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.BV.setOrthogonalization" title="Link to this definition">#</a></dt>
<dd><p>Set the method used for the (block-)orthogonalization of vectors.</p>
<p>Logically collective.</p>
<p>Ortogonalization of vectors (classical or modified Gram-Schmidt
with or without refinement), and for the block-orthogonalization
(simultaneous orthogonalization of a set of vectors).</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>otype</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html#slepc4py.SLEPc.BV.OrthogType" title="slepc4py.SLEPc.BV.OrthogType"><em>OrthogType</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 type of orthogonalization technique.</p></li>
<li><p><strong>refine</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html#slepc4py.SLEPc.BV.OrthogRefineType" title="slepc4py.SLEPc.BV.OrthogRefineType"><em>OrthogRefineType</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 type of refinement.</p></li>
<li><p><strong>eta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – Parameter for selective refinement.</p></li>
<li><p><strong>block</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.OrthogBlockType.html#slepc4py.SLEPc.BV.OrthogBlockType" title="slepc4py.SLEPc.BV.OrthogBlockType"><em>OrthogBlockType</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 type of block orthogonalization.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The default settings work well for most problems.</p>
<p>The parameter <code class="docutils literal notranslate"><span class="pre">eta</span></code> should be a real value between <code class="docutils literal notranslate"><span class="pre">0</span></code> and
<code class="docutils literal notranslate"><span class="pre">1</span></code> (or <a class="reference internal" href="slepc4py.SLEPc.DETERMINE.html#slepc4py.SLEPc.DETERMINE" title="slepc4py.SLEPc.DETERMINE"><code class="xref any py py-data docutils literal notranslate"><span class="pre">DETERMINE</span></code></a>).  The value of <code class="docutils literal notranslate"><span class="pre">eta</span></code> is used only when
the refinement type is <a class="reference internal" href="slepc4py.SLEPc.BV.OrthogRefineType.html#slepc4py.SLEPc.BV.OrthogRefineType.IFNEEDED" title="slepc4py.SLEPc.BV.OrthogRefineType.IFNEEDED"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">BV.OrthogRefineType.IFNEEDED</span></code></a>.</p>
<p>When using several processors, <a class="reference internal" href="slepc4py.SLEPc.BV.OrthogType.html#slepc4py.SLEPc.BV.OrthogType.MGS" title="slepc4py.SLEPc.BV.OrthogType.MGS"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">BV.OrthogType.MGS</span></code></a> is likely to
result in bad scalability.</p>
<p>If the method set for block orthogonalization is GS, then the
computation is done column by column with the vector orthogonalization.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L483">Source code at slepc4py/SLEPc/BV.pyx:483</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setRandom">
<span class="sig-name descname"><span class="pre">setRandom</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setRandom" title="Link to this definition">#</a></dt>
<dd><p>Set the active columns of the BV to random numbers.</p>
<p>Logically collective.</p>
<p class="rubric">Notes</p>
<p>All active columns (except the leading ones) are modified.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1473">Source code at slepc4py/SLEPc/BV.pyx:1473</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.BV.setRandomColumn">
<span class="sig-name descname"><span class="pre">setRandomColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">j</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setRandomColumn" title="Link to this definition">#</a></dt>
<dd><p>Set one column of the BV to random numbers.</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>j</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Column number to be set.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1509">Source code at slepc4py/SLEPc/BV.pyx:1509</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setRandomCond">
<span class="sig-name descname"><span class="pre">setRandomCond</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">condn</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setRandomCond" title="Link to this definition">#</a></dt>
<dd><p>Set the columns of a BV to random numbers.</p>
<p>Logically collective.</p>
<p>The generated matrix has a prescribed condition number.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>condn</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – Condition number.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1523">Source code at slepc4py/SLEPc/BV.pyx:1523</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setRandomContext">
<span class="sig-name descname"><span class="pre">setRandomContext</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rnd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setRandomContext" title="Link to this definition">#</a></dt>
<dd><p>Set the <a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Random.html#petsc4py.PETSc.Random" title="(in Python v3.24)"><code class="xref any docutils literal notranslate"><span class="pre">petsc4py.PETSc.Random</span></code></a> object associated with the BV.</p>
<p>Collective.</p>
<p>To be used in operations that need random numbers.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rnd</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Random.html#petsc4py.PETSc.Random" title="(in Python v3.24)"><em>Random</em></a>) – The random number generator context.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1539">Source code at slepc4py/SLEPc/BV.pyx:1539</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setRandomNormal">
<span class="sig-name descname"><span class="pre">setRandomNormal</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setRandomNormal" title="Link to this definition">#</a></dt>
<dd><p>Set the active columns of the BV to normal random numbers.</p>
<p>Logically collective.</p>
<p class="rubric">Notes</p>
<p>All active columns (except the leading ones) are modified.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1485">Source code at slepc4py/SLEPc/BV.pyx:1485</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.BV.setRandomSign">
<span class="sig-name descname"><span class="pre">setRandomSign</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setRandomSign" title="Link to this definition">#</a></dt>
<dd><p>Set the entries of a BV to values 1 or -1 with equal probability.</p>
<p>Logically collective.</p>
<p class="rubric">Notes</p>
<p>All active columns (except the leading ones) are modified.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1497">Source code at slepc4py/SLEPc/BV.pyx:1497</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.BV.setSizes">
<span class="sig-name descname"><span class="pre">setSizes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sizes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">m</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setSizes" title="Link to this definition">#</a></dt>
<dd><p>Set the local and global sizes, and the number of columns.</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>sizes</strong> (<a class="reference internal" href="slepc4py.typing.LayoutSizeSpec.html#slepc4py.typing.LayoutSizeSpec" title="slepc4py.typing.LayoutSizeSpec"><em>LayoutSizeSpec</em></a>) – The global size <code class="docutils literal notranslate"><span class="pre">N</span></code> or a two-tuple <code class="docutils literal notranslate"><span class="pre">(n,</span> <span class="pre">N)</span></code>
with the local and global sizes.</p></li>
<li><p><strong>m</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 number of columns.</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>Either <code class="docutils literal notranslate"><span class="pre">n</span></code> or <code class="docutils literal notranslate"><span class="pre">N</span></code> (but not both) can be <code class="docutils literal notranslate"><span class="pre">PETSc.DECIDE</span></code>
or <code class="docutils literal notranslate"><span class="pre">None</span></code> to have it automatically set.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L303">Source code at slepc4py/SLEPc/BV.pyx:303</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setSizesFromVec">
<span class="sig-name descname"><span class="pre">setSizesFromVec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">w</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">m</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setSizesFromVec" title="Link to this definition">#</a></dt>
<dd><p>Set the local and global sizes, and the number of columns.</p>
<p>Collective.</p>
<p>Local and global sizes are specified indirectly by passing a template
vector.</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>w</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.html#petsc4py.PETSc.Vec" title="(in Python v3.24)"><em>Vec</em></a>) – The template vector.</p></li>
<li><p><strong>m</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 number of columns.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L327">Source code at slepc4py/SLEPc/BV.pyx:327</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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">bv_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setType" title="Link to this definition">#</a></dt>
<dd><p>Set the type for the BV object.</p>
<p>Logically collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>bv_type</strong> (<a class="reference internal" href="slepc4py.SLEPc.BV.Type.html#slepc4py.SLEPc.BV.Type" title="slepc4py.SLEPc.BV.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 inner product type to be used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L273">Source code at slepc4py/SLEPc/BV.pyx:273</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.setVecType">
<span class="sig-name descname"><span class="pre">setVecType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vec_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#slepc4py.SLEPc.BV.setVecType" title="Link to this definition">#</a></dt>
<dd><p>Set the vector type.</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>vec_type</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Vec.Type.html#petsc4py.PETSc.Vec.Type" title="(in Python v3.24)"><em>petsc4py.PETSc.Vec.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>) – Vector type used when creating vectors with <a class="reference internal" href="#slepc4py.SLEPc.BV.createVec" title="slepc4py.SLEPc.BV.createVec"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">createVec</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>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L825">Source code at slepc4py/SLEPc/BV.pyx:825</a></p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.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.BV.view" title="Link to this definition">#</a></dt>
<dd><p>Print the BV data structure.</p>
<p>Collective.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>viewer</strong> (<a class="reference external" href="https://petsc.org/release/petsc4py/reference/petsc4py.PETSc.Viewer.html#petsc4py.PETSc.Viewer" title="(in Python v3.24)"><em>Viewer</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><em>None</em></a>) – Visualization context; if not provided, the standard
output is used.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)">None</a></p>
</dd>
</dl>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L150">Source code at slepc4py/SLEPc/BV.pyx:150</a></p>
</dd></dl>

<p class="rubric">Attributes Documentation</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.column_size">
<span class="sig-name descname"><span class="pre">column_size</span></span><a class="headerlink" href="#slepc4py.SLEPc.BV.column_size" title="Link to this definition">#</a></dt>
<dd><p>Basis vectors column size.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1705">Source code at slepc4py/SLEPc/BV.pyx:1705</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.local_size">
<span class="sig-name descname"><span class="pre">local_size</span></span><a class="headerlink" href="#slepc4py.SLEPc.BV.local_size" title="Link to this definition">#</a></dt>
<dd><p>Basis vectors local size.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1700">Source code at slepc4py/SLEPc/BV.pyx:1700</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.size">
<span class="sig-name descname"><span class="pre">size</span></span><a class="headerlink" href="#slepc4py.SLEPc.BV.size" title="Link to this definition">#</a></dt>
<dd><p>Basis vectors global size.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1695">Source code at slepc4py/SLEPc/BV.pyx:1695</a></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="slepc4py.SLEPc.BV.sizes">
<span class="sig-name descname"><span class="pre">sizes</span></span><a class="headerlink" href="#slepc4py.SLEPc.BV.sizes" title="Link to this definition">#</a></dt>
<dd><p>Basis vectors local and global sizes, and the number of columns.</p>
<p><a class="reference external" href="https://gitlab.com/slepc/slepc/-/tree/release/src/binding/slepc4py/src/slepc4py/SLEPc/BV.pyx#L1690">Source code at slepc4py/SLEPc/BV.pyx:1690</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.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</p>
      </div>
    </a>
    <a class="right-next"
       href="slepc4py.SLEPc.BV.MatMultType.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">slepc4py.SLEPc.BV.MatMultType</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.BV.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div></div>

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

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

  <p class="sphinx-version">
    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
    <br/>
  </p>
</div>
      
    </div>
  
  
  
    <div class="footer-items__end">
      
        <div class="footer-item">
<p class="theme-version">
  <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
  Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
      
        <div class="footer-item"><p class="last-updated">
  Last updated on 2025-11-07T09:28:35+0100 (v3.24.1).
  <br/>
</p></div>
      
    </div>
  
</div>

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