File: BVGetArrayRead.html

package info (click to toggle)
slepc 3.23.1%2Bdfsg1-1exp2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 48,276 kB
  • sloc: ansic: 103,363; python: 6,078; f90: 3,286; cpp: 1,528; makefile: 772; sh: 311
file content (48 lines) | stat: -rw-r--r-- 3,141 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/BV/BVGetArrayRead.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>BVGetArrayRead</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.23.1 2025-05-01</b></div>
   <div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.23.1 v3.23.1 /Users/jroman/tmp/slepc-3.23.1/docs/manualpages/BV/BVGetArrayRead.html "><small>Report Typos and Errors</small></a></div>
<H1>BVGetArrayRead</H1>
Returns a read-only pointer to a contiguous array that contains this processor's portion of the <A HREF="../BV/BV.html#BV">BV</A> data. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcbv.h" 
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../BV/BVGetArrayRead.html#BVGetArrayRead">BVGetArrayRead</A>(<A HREF="../BV/BV.html#BV">BV</A> bv,const <A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> **a)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bv </B></TD><TD>&nbsp;- the basis vectors context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>a  </B></TD><TD>&nbsp;- location to put pointer to the array
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
<A HREF="../BV/BVRestoreArrayRead.html#BVRestoreArrayRead">BVRestoreArrayRead</A>() must be called when access to the array is no
longer needed. This operation may imply a data copy, for <A HREF="../BV/BV.html#BV">BV</A> types that
do not store data contiguously in memory.
<P>
The pointer will normally point to the first entry of the first column,
but if the <A HREF="../BV/BV.html#BV">BV</A> has constraints then these go before the regular columns.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../BV/BVRestoreArray.html#BVRestoreArray">BVRestoreArray</A>(), <A HREF="../BV/BVInsertConstraints.html#BVInsertConstraints">BVInsertConstraints</A>(), <A HREF="../BV/BVGetLeadingDimension.html#BVGetLeadingDimension">BVGetLeadingDimension</A>(), <A HREF="../BV/BVGetArray.html#BVGetArray">BVGetArray</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/sys/classes/bv/interface/bvbasic.c.html#BVGetArrayRead">src/sys/classes/bv/interface/bvbasic.c</A>
<BR><BR><A HREF="./index.html">Index of all BV routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>