File: MatFDColoringGetPerturbedColumns.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (72 lines) | stat: -rw-r--r-- 3,690 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/MatFD/MatFDColoringGetPerturbedColumns.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatFDColoringGetPerturbedColumns</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
   <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/MatFD/MatFDColoringGetPerturbedColumns.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatFDColoringGetPerturbedColumns"><H1>MatFDColoringGetPerturbedColumns</H1></A>
Returns the indices of the columns that that are currently being perturbed. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../MatFD/MatFDColoringGetPerturbedColumns.html#MatFDColoringGetPerturbedColumns">MatFDColoringGetPerturbedColumns</A>(<A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</A> coloring,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *n,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *cols[])
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>coloring </B></TD><TD>- coloring context created with <A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- the number of local columns being perturbed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cols </B></TD><TD>- the column indices, in global numbering
</TD></TR></TABLE>
<P>

<P>
Note: IF the matrix type is BAIJ, then the block column indices are returned
<P>
<H3><FONT COLOR="#CC3333">Fortran Note</FONT></H3>
This routine has a different interface for Fortran
<pre>
    #include &lt;petsc/finclude/petscmat.h&gt;
</pre>
<pre>
         use petscmat
</pre>
<pre>
         <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>, pointer :: array(:)
</pre>
<pre>
         <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  ierr
</pre>
<pre>
         <A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</A>   i
</pre>
<pre>
         call MatFDColoringGetPerturbedColumnsF90(i,array,ierr)
</pre>
<pre>
     use the entries of array ...
</pre>
<pre>
         call MatFDColoringRestorePerturbedColumnsF90(i,array,ierr)
</pre>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>(), <A HREF="../MatFD/MatFDColoringDestroy.html#MatFDColoringDestroy">MatFDColoringDestroy</A>(), <A HREF="../MatFD/MatFDColoringView.html#MatFDColoringView">MatFDColoringView</A>(), <A HREF="../MatFD/MatFDColoringApply.html#MatFDColoringApply">MatFDColoringApply</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/matfd/fdmatrix.c.html#MatFDColoringGetPerturbedColumns">src/mat/matfd/fdmatrix.c</A>
<BR><A HREF="./index.html">Index of all MatFD routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>