"Fossies" - the Fresh Open Source Software Archive

Member "petsc-3.12.4/docs/manualpages/Sys/PetscObjectComm.html" (4 Feb 2020, 4010 Bytes) of package /linux/misc/petsc-3.12.4.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
    2 <HTML>
    3 <HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscObjectComm.html" />
    4 <META NAME="GENERATOR" CONTENT="DOCTEXT">
    5 <TITLE>PetscObjectComm</TITLE>
    6 </HEAD>
    7 <BODY BGCOLOR="FFFFFF">
    8    <div id="version" align=right><b>petsc-3.12.4 2020-02-04</b></div>
    9    <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.12.4 v3.12.4 docs/manualpages/Sys/PetscObjectComm.html "><small>Report Typos and Errors</small></a></div>
   10 <A NAME="PetscObjectComm"><H1>PetscObjectComm</H1></A>
   11 Gets the MPI communicator for any <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>   regardless of the type. 
   12 <H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
   13 <PRE>
   14 #include "petscsys.h"    
   15 <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>  <A HREF="../Sys/PetscObjectComm.html#PetscObjectComm">PetscObjectComm</A>(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> obj)
   16 </PRE>
   17 Not Collective
   18 <P>
   19 <H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
   20 <DT><B>obj </B> -any PETSc object, for example a <A HREF="../Vec/Vec.html#Vec">Vec</A>, <A HREF="../Mat/Mat.html#Mat">Mat</A> or <A HREF="../KSP/KSP.html#KSP">KSP</A>. Thus must be
   21 cast with a (<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>), for example,
   22 <A HREF="../Sys/SETERRQ.html#SETERRQ">SETERRQ</A>(<A HREF="../Sys/PetscObjectComm.html#PetscObjectComm">PetscObjectComm</A>((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)mat,...);
   23 <br>
   24 <P>
   25 <H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
   26 <DT><B>comm </B> -the MPI communicator or MPI_COMM_NULL if object is not valid
   27 <br>
   28 <P>
   29 
   30 <P>
   31 <H3><FONT COLOR="#CC3333">Notes</FONT></H3>
   32 Never use this in the form
   33 <pre>
   34       comm = <A HREF="../Sys/PetscObjectComm.html#PetscObjectComm">PetscObjectComm</A>((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)obj); 
   35 </pre>
   36 instead use <A HREF="../Sys/PetscObjectGetComm.html#PetscObjectGetComm">PetscObjectGetComm</A>()
   37 <P>
   38 <P>
   39 <H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   40  <A HREF="../Sys/PetscObjectGetComm.html#PetscObjectGetComm">PetscObjectGetComm</A>()
   41 <BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
   42 <H3><FONT COLOR="#CC3333">Location</FONT></H3>
   43 </B><A HREF="../../../src/sys/objects/gcomm.c.html#PetscObjectComm">src/sys/objects/gcomm.c</A>
   44 <P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
   45 <A HREF="../../../src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html">src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html</A><BR>
   46 <A HREF="../../../src/vec/is/sf/examples/tutorials/ex1.c.html">src/vec/is/sf/examples/tutorials/ex1.c.html</A><BR>
   47 <A HREF="../../../src/mat/examples/tutorials/ex8.c.html">src/mat/examples/tutorials/ex8.c.html</A><BR>
   48 <A HREF="../../../src/dm/impls/plex/examples/tutorials/ex5.c.html">src/dm/impls/plex/examples/tutorials/ex5.c.html</A><BR>
   49 <A HREF="../../../src/dm/field/examples/tutorials/ex1.c.html">src/dm/field/examples/tutorials/ex1.c.html</A><BR>
   50 <A HREF="../../../src/ksp/ksp/examples/tutorials/ex49.c.html">src/ksp/ksp/examples/tutorials/ex49.c.html</A><BR>
   51 <A HREF="../../../src/ksp/ksp/examples/tutorials/ex59.c.html">src/ksp/ksp/examples/tutorials/ex59.c.html</A><BR>
   52 <A HREF="../../../src/ksp/ksp/examples/tutorials/ex65.c.html">src/ksp/ksp/examples/tutorials/ex65.c.html</A><BR>
   53 <A HREF="../../../src/ksp/ksp/examples/tutorials/ex73.c.html">src/ksp/ksp/examples/tutorials/ex73.c.html</A><BR>
   54 <A HREF="../../../src/snes/examples/tutorials/ex12.c.html">src/snes/examples/tutorials/ex12.c.html</A><BR>
   55 <A HREF="../../../src/snes/examples/tutorials/ex15.c.html">src/snes/examples/tutorials/ex15.c.html</A><BR>
   56 <BR><A HREF="./index.html">Index of all Sys routines</A>
   57 <BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
   58 <BR><A HREF="../singleindex.html">Index of all manual pages</A>
   59 </BODY></HTML>