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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMPLEX/DMPlexIsInterpolated.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMPlexIsInterpolated</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/DMPLEX/DMPlexIsInterpolated.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMPlexIsInterpolated"><H1>DMPlexIsInterpolated</H1></A>
Find out to what extent the DMPlex is topologically interpolated.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmplex.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMPLEX/DMPlexIsInterpolated.html#DMPlexIsInterpolated">DMPlexIsInterpolated</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPlexInterpolatedFlag</A> *interpolated)
</PRE>
Not Collective
<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>dm </B></TD><TD>- The <A HREF="../DM/DM.html#DM">DM</A> object
</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>interpolated </B></TD><TD>- Flag whether the <A HREF="../DM/DM.html#DM">DM</A> is interpolated
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Unlike <A HREF="../DMPLEX/DMPlexIsInterpolatedCollective.html#DMPlexIsInterpolatedCollective">DMPlexIsInterpolatedCollective</A>(), this is NOT collective
so the results can be different on different ranks in special cases.
However, <A HREF="../DMPLEX/DMPlexInterpolate.html#DMPlexInterpolate">DMPlexInterpolate</A>() guarantees the result is the same on all.
<P>
Unlike <A HREF="../DMPLEX/DMPlexIsInterpolatedCollective.html#DMPlexIsInterpolatedCollective">DMPlexIsInterpolatedCollective</A>(), this cannot return <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_MIXED</A>.
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
Initially, plex->interpolated = <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_INVALID</A>.
<P>
If plex->interpolated == <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_INVALID</A>, DMPlexIsInterpolated_Internal() is called.
It checks the actual topology and sets plex->interpolated on each rank separately to one of
<A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_NONE</A>, <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_PARTIAL</A> or <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_FULL</A>.
<P>
If plex->interpolated != <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_INVALID</A>, this function just returns plex->interpolated.
<P>
<A HREF="../DMPLEX/DMPlexInterpolate.html#DMPlexInterpolate">DMPlexInterpolate</A>() sets plex->interpolated = <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_FULL</A>,
and <A HREF="../DMPLEX/DMPlexUninterpolate.html#DMPlexUninterpolate">DMPlexUninterpolate</A>() sets plex->interpolated = <A HREF="../DM/DMPlexInterpolatedFlag.html#DMPlexInterpolatedFlag">DMPLEX_INTERPOLATED_NONE</A>.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMPLEX/DMPlexInterpolate.html#DMPlexInterpolate">DMPlexInterpolate</A>(), <A HREF="../DMPLEX/DMPlexIsInterpolatedCollective.html#DMPlexIsInterpolatedCollective">DMPlexIsInterpolatedCollective</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/plex/plexinterpolate.c.html#DMPlexIsInterpolated">src/dm/impls/plex/plexinterpolate.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/plex/plexinterpolate.c.html#DMPlexIsInterpolated_Internal">DMPlexIsInterpolated_Internal in src/dm/impls/plex/plexinterpolate.c</A><BR>
<BR><A HREF="./index.html">Index of all DMPLEX 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>
|
