File: ISColoringCreate.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (57 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/IS/ISColoringCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISColoringCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/IS/ISColoringCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="ISColoringCreate"><H1>ISColoringCreate</H1></A>
Generates an <A HREF="../IS/ISColoring.html#ISColoring">ISColoring</A> context from lists (provided by each processor) of colors for each node. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"  
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../IS/ISColoringCreate.html#ISColoringCreate">ISColoringCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> ncolors,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n,const ISColoringValue colors[],<A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PetscCopyMode</A> mode,<A HREF="../IS/ISColoring.html#ISColoring">ISColoring</A> *iscoloring)
</PRE>
Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>
<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>comm </B></TD><TD>- communicator for the processors creating the coloring
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ncolors </B></TD><TD>- max color value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- number of nodes on this processor
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>colors </B></TD><TD>- array containing the colors for this processor, color numbers begin at 0.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mode </B></TD><TD>- see <A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PetscCopyMode</A> for meaning of this flag.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>iscoloring </B> -the resulting coloring data structure
<br>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<DT><B>-is_coloring_view </B> -Activates <A HREF="../IS/ISColoringView.html#ISColoringView">ISColoringView</A>()
<br>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
By default sets coloring type to  <A HREF="../IS/ISColoringType.html#ISColoringType">IS_COLORING_GLOBAL</A>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../MatOrderings/MatColoringCreate.html#MatColoringCreate">MatColoringCreate</A>(), <A HREF="../IS/ISColoringView.html#ISColoringView">ISColoringView</A>(), <A HREF="../IS/ISColoringDestroy.html#ISColoringDestroy">ISColoringDestroy</A>(), ISColoringSetType()
<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/vec/is/is/utils/iscoloring.c.html#ISColoringCreate">src/vec/is/is/utils/iscoloring.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex5s.c.html">src/snes/examples/tutorials/ex5s.c.html</A><BR>
<BR><A HREF="./index.html">Index of all IS 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>