File: DMLocatePoints.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 (79 lines) | stat: -rw-r--r-- 5,383 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
73
74
75
76
77
78
79
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMLocatePoints.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMLocatePoints</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/DM/DMLocatePoints.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMLocatePoints"><H1>DMLocatePoints</H1></A>
Locate the points in v in the mesh and return a <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A> of the containing cells 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdm.h"          
#include "petscdmlabel.h"     
#include "petscds.h"     
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DM/DMLocatePoints.html#DMLocatePoints">DMLocatePoints</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, <A HREF="../Vec/Vec.html#Vec">Vec</A> v, <A HREF="../DM/DMPointLocationType.html#DMPointLocationType">DMPointLocationType</A> ltype, <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A> *cellSF)
</PRE>
Collective on v (see explanation below)
<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>dm </B></TD><TD>- The <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>v </B></TD><TD>- The <A HREF="../Vec/Vec.html#Vec">Vec</A> of points
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ltype </B></TD><TD>- The type of point location, e.g. <A HREF="../DM/DMPointLocationType.html#DMPointLocationType">DM_POINTLOCATION_NONE</A> or <A HREF="../DM/DMPointLocationType.html#DMPointLocationType">DM_POINTLOCATION_NEAREST</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cells </B></TD><TD>- Points to either NULL, or a <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A> with guesses for which cells contain each point.
</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>v </B></TD><TD>- The <A HREF="../Vec/Vec.html#Vec">Vec</A> of points, which now contains the nearest mesh points to the given points if <A HREF="../DM/DMPointLocationType.html#DMPointLocationType">DM_POINTLOCATION_NEAREST</A> is used
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cells </B></TD><TD>- The <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A> containing the ranks and local indices of the containing points.
</TD></TR></TABLE>
<P>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
To do a search of the local cells of the mesh, v should have <A HREF="../Sys/PETSC_COMM_SELF.html#PETSC_COMM_SELF">PETSC_COMM_SELF</A> as its communicator.
To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
<P>
If *cellSF is NULL on input, a <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A> will be created.
If *cellSF is not NULL on input, it should point to an existing <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A>, whose graph will be used as initial guesses.
<P>
An array that maps each point to its containing cell can be obtained with
<P>
<pre>
   const <A HREF="../PetscSF/PetscSFNode.html#PetscSFNode">PetscSFNode</A> *cells;
</pre>
<pre>
   <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>           nFound;
</pre>
<pre>
   const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>    *found;
</pre>
<pre>
</pre>
<pre>
   <A HREF="../PetscSF/PetscSFGetGraph.html#PetscSFGetGraph">PetscSFGetGraph</A>(cellSF,NULL,&amp;nFound,&amp;found,&amp;cells);
</pre>
<P>
Where cells[i].rank is the rank of the cell containing point found[i] (or i if found == NULL), and cells[i].index is
the index of the cell in its rank's local numbering.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DM/DMSetCoordinates.html#DMSetCoordinates">DMSetCoordinates</A>(), <A HREF="../DM/DMSetCoordinatesLocal.html#DMSetCoordinatesLocal">DMSetCoordinatesLocal</A>(), <A HREF="../DM/DMGetCoordinates.html#DMGetCoordinates">DMGetCoordinates</A>(), <A HREF="../DM/DMGetCoordinatesLocal.html#DMGetCoordinatesLocal">DMGetCoordinatesLocal</A>(), <A HREF="../DM/DMPointLocationType.html#DMPointLocationType">DMPointLocationType</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/dm/interface/dm.c.html#DMLocatePoints">src/dm/interface/dm.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/da/dageometry.c.html#DMLocatePoints_DA_Regular">DMLocatePoints_DA_Regular in src/dm/impls/da/dageometry.c</A><BR>
<A HREF="../../../src/dm/impls/plex/plexgeometry.c.html#DMLocatePoints_Plex">DMLocatePoints_Plex in src/dm/impls/plex/plexgeometry.c</A><BR>
<BR><A HREF="./index.html">Index of all DM 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>