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
|
<!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/PetscLayoutReference.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscLayoutReference</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/IS/PetscLayoutReference.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscLayoutReference"><H1>PetscLayoutReference</H1></A>
Causes a PETSc <A HREF="../Vec/Vec.html#Vec">Vec</A> or <A HREF="../Mat/Mat.html#Mat">Mat</A> to share a <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> with one that already exists. Used by <A HREF="../Vec/Vec.html#Vec">Vec</A>/MatDuplicate_XXX()
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../IS/PetscLayoutReference.html#PetscLayoutReference">PetscLayoutReference</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> in,<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> *out)
</PRE>
Collective on <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>in </B></TD><TD>- input <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> to be copied
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>out </B></TD><TD>- the reference location
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../IS/PetscLayoutSetUp.html#PetscLayoutSetUp">PetscLayoutSetUp</A>() does not need to be called on the resulting <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>
<P>
If the out location already contains a <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> it is destroyed
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../IS/PetscLayoutCreate.html#PetscLayoutCreate">PetscLayoutCreate</A>(), <A HREF="../IS/PetscLayoutDestroy.html#PetscLayoutDestroy">PetscLayoutDestroy</A>(), <A HREF="../IS/PetscLayoutSetUp.html#PetscLayoutSetUp">PetscLayoutSetUp</A>(), <A HREF="../IS/PetscLayoutDuplicate.html#PetscLayoutDuplicate">PetscLayoutDuplicate</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/is/utils/pmap.c.html#PetscLayoutReference">src/vec/is/utils/pmap.c</A>
<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>
|