xref: /petsc/src/dm/impls/network/network.c (revision aaa8cc7d2a5c3913edcbb923e20f154fe9c4aa65)
1af0996ceSBarry Smith #include <petsc/private/dmnetworkimpl.h> /*I  "petscdmnetwork.h"  I*/
25f2c45f1SShri Abhyankar 
3e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_LayoutSetUp;
4e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_SetUpNetwork;
5e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_Distribute;
6e3b1a053SGetnet Betrie 
754dfd506SHong Zhang /*
854dfd506SHong Zhang   Creates the component header and value objects for a network point
954dfd506SHong Zhang */
10d71ae5a4SJacob Faibussowitsch static PetscErrorCode SetUpNetworkHeaderComponentValue(DM dm, DMNetworkComponentHeader header, DMNetworkComponentValue cvalue)
11d71ae5a4SJacob Faibussowitsch {
1254dfd506SHong Zhang   PetscFunctionBegin;
1354dfd506SHong Zhang   /* Allocate arrays for component information */
149566063dSJacob Faibussowitsch   PetscCall(PetscCalloc5(header->maxcomps, &header->size, header->maxcomps, &header->key, header->maxcomps, &header->offset, header->maxcomps, &header->nvar, header->maxcomps, &header->offsetvarrel));
159566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(header->maxcomps, &cvalue->data));
1654dfd506SHong Zhang 
1754dfd506SHong Zhang   /* The size of the header is the size of struct _p_DMNetworkComponentHeader. Since the struct contains PetscInt pointers we cannot use sizeof(struct). So, we need to explicitly calculate the size.
1854dfd506SHong Zhang    If the data header struct changes then this header size calculation needs to be updated. */
1954dfd506SHong Zhang   header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
2054dfd506SHong Zhang   header->hsize /= sizeof(DMNetworkComponentGenericDataType);
213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2254dfd506SHong Zhang }
2354dfd506SHong Zhang 
24d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeHeaderComponentData(DM dm)
25d71ae5a4SJacob Faibussowitsch {
26daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
27daad07d3SAidan Hamilton   PetscInt    np, p, defaultnumcomp = DMNETWORK_MAX_COMP_AT_POINT_DEFAULT;
28daad07d3SAidan Hamilton 
29daad07d3SAidan Hamilton   PetscFunctionBegin;
30daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
31daad07d3SAidan Hamilton   if (network->header)
32daad07d3SAidan Hamilton     for (p = 0; p < np; p++) {
33daad07d3SAidan Hamilton       network->header[p].maxcomps = defaultnumcomp;
34daad07d3SAidan Hamilton       PetscCall(SetUpNetworkHeaderComponentValue(dm, &network->header[p], &network->cvalue[p]));
35daad07d3SAidan Hamilton     }
36daad07d3SAidan Hamilton 
373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
38daad07d3SAidan Hamilton }
395f2c45f1SShri Abhyankar /*@
4020f4b53cSBarry Smith   DMNetworkGetPlex - Gets the `DMPLEX` associated with this `DMNETWORK`
41556ed216SShri Abhyankar 
4220f4b53cSBarry Smith   Not Collective
43556ed216SShri Abhyankar 
442fe279fdSBarry Smith   Input Parameter:
4520f4b53cSBarry Smith . dm - the `DMNETWORK` object
462bf73ac6SHong Zhang 
472fe279fdSBarry Smith   Output Parameter:
4820f4b53cSBarry Smith . plexdm - the `DMPLEX` object
49556ed216SShri Abhyankar 
5020f4b53cSBarry Smith   Level: advanced
51556ed216SShri Abhyankar 
5220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMPLEX`, `DMNetworkCreate()`
53556ed216SShri Abhyankar @*/
54d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetPlex(DM dm, DM *plexdm)
55d71ae5a4SJacob Faibussowitsch {
562bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
57556ed216SShri Abhyankar 
58556ed216SShri Abhyankar   PetscFunctionBegin;
59556ed216SShri Abhyankar   *plexdm = network->plex;
603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
61556ed216SShri Abhyankar }
62556ed216SShri Abhyankar 
63556ed216SShri Abhyankar /*@
642bf73ac6SHong Zhang   DMNetworkGetNumSubNetworks - Gets the the number of subnetworks
6572c3e9f7SHong Zhang 
6620f4b53cSBarry Smith   Not Collective
6772c3e9f7SHong Zhang 
68f899ff85SJose E. Roman   Input Parameter:
6920f4b53cSBarry Smith . dm - the `DMNETWORK` object
702bf73ac6SHong Zhang 
712bf73ac6SHong Zhang   Output Parameters:
722bf73ac6SHong Zhang + nsubnet - local number of subnetworks
732bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
7472c3e9f7SHong Zhang 
7597bb938eSShri Abhyankar   Level: beginner
7672c3e9f7SHong Zhang 
7720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
7872c3e9f7SHong Zhang @*/
79d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PetscInt *nsubnet, PetscInt *Nsubnet)
80d71ae5a4SJacob Faibussowitsch {
812bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8272c3e9f7SHong Zhang 
8372c3e9f7SHong Zhang   PetscFunctionBegin;
84daad07d3SAidan Hamilton   if (nsubnet) *nsubnet = network->cloneshared->nsubnet;
85daad07d3SAidan Hamilton   if (Nsubnet) *Nsubnet = network->cloneshared->Nsubnet;
863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8772c3e9f7SHong Zhang }
8872c3e9f7SHong Zhang 
8972c3e9f7SHong Zhang /*@
902bf73ac6SHong Zhang   DMNetworkSetNumSubNetworks - Sets the number of subnetworks
915f2c45f1SShri Abhyankar 
9220f4b53cSBarry Smith   Collective
935f2c45f1SShri Abhyankar 
945f2c45f1SShri Abhyankar   Input Parameters:
9520f4b53cSBarry Smith + dm - the `DMNETWORK` object
962bf73ac6SHong Zhang . nsubnet - local number of subnetworks
972bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
985f2c45f1SShri Abhyankar 
9997bb938eSShri Abhyankar    Level: beginner
1001b266c99SBarry Smith 
10120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetNumSubNetworks()`
1025f2c45f1SShri Abhyankar @*/
103d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetNumSubNetworks(DM dm, PetscInt nsubnet, PetscInt Nsubnet)
104d71ae5a4SJacob Faibussowitsch {
1055f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1065f2c45f1SShri Abhyankar 
1075f2c45f1SShri Abhyankar   PetscFunctionBegin;
108d5b43468SJose E. Roman   PetscCheck(network->cloneshared->Nsubnet == 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Network sizes already set, cannot resize the network");
1092bf73ac6SHong Zhang 
1105f2c45f1SShri Abhyankar   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1112bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, nsubnet, 2);
1122bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, Nsubnet, 3);
1137765340cSHong Zhang 
1142bf73ac6SHong Zhang   if (Nsubnet == PETSC_DECIDE) {
1155c6496baSHong Zhang     PetscCheck(nsubnet >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Number of local subnetworks %" PetscInt_FMT " cannot be less than 0", nsubnet);
1161c2dc1cbSBarry Smith     PetscCall(MPIU_Allreduce(&nsubnet, &Nsubnet, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
117caf410d2SHong Zhang   }
1185c6496baSHong Zhang   PetscCheck(Nsubnet >= 1, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Number of global subnetworks %" PetscInt_FMT " cannot be less than 1", Nsubnet);
119caf410d2SHong Zhang 
120daad07d3SAidan Hamilton   network->cloneshared->Nsubnet = Nsubnet;
121da81f932SPierre Jolivet   network->cloneshared->nsubnet = 0; /* initial value; will be determined by DMNetworkAddSubnetwork() */
122daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(Nsubnet, &network->cloneshared->subnet));
123caf410d2SHong Zhang 
1242bf73ac6SHong Zhang   /* num of shared vertices */
125daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0;
126daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = 0;
1273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1287765340cSHong Zhang }
1297765340cSHong Zhang 
1305f2c45f1SShri Abhyankar /*@
1312bf73ac6SHong Zhang   DMNetworkAddSubnetwork - Add a subnetwork
1325f2c45f1SShri Abhyankar 
13320f4b53cSBarry Smith   Collective
1345f2c45f1SShri Abhyankar 
1355f2c45f1SShri Abhyankar   Input Parameters:
13620f4b53cSBarry Smith + dm - the `DMNETWORK`  object
1372bf73ac6SHong Zhang . name - name of the subnetwork
1382bf73ac6SHong Zhang . ne - number of local edges of this subnetwork
13920f4b53cSBarry Smith - edgelist - list of edges for this subnetwork, this is a one dimensional array with pairs of entries being the two vertices (in global numbering
14020f4b53cSBarry Smith               of the vertices) of each edge,
1418d1cd658SBarry Smith $            [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc]
1422bf73ac6SHong Zhang 
1432fe279fdSBarry Smith   Output Parameter:
1442bf73ac6SHong Zhang . netnum - global index of the subnetwork
1455f2c45f1SShri Abhyankar 
14620f4b53cSBarry Smith   Level: beginner
14720f4b53cSBarry Smith 
1485f2c45f1SShri Abhyankar   Notes:
1495f2c45f1SShri Abhyankar   There is no copy involved in this operation, only the pointer is referenced. The edgelist should
15020f4b53cSBarry Smith   not be destroyed before the call to `DMNetworkLayoutSetUp()`
1515f2c45f1SShri Abhyankar 
15220f4b53cSBarry Smith   A network can comprise of a single subnetwork OR multiple subnetworks. For a single subnetwork, the subnetwork can be read either in serial or parallel.
15320f4b53cSBarry Smith   For a multiple subnetworks,
1548d1cd658SBarry Smith   each subnetwork topology needs to be set on a unique rank and the communicator size needs to be at least equal to the number of subnetworks.
155f11a936eSBarry Smith 
156e3e68989SHong Zhang   Example usage:
157f11a936eSBarry Smith   Consider the following networks:
158d5b43468SJose E. Roman   1) A single subnetwork:
159e3e68989SHong Zhang .vb
160f11a936eSBarry Smith  network 0:
161f11a936eSBarry Smith  rank[0]:
162f11a936eSBarry Smith    v0 --> v2; v1 --> v2
163f11a936eSBarry Smith  rank[1]:
164f11a936eSBarry Smith    v3 --> v5; v4 --> v5
165e3e68989SHong Zhang .ve
166e3e68989SHong Zhang 
167e3e68989SHong Zhang  The resulting input
168f11a936eSBarry Smith  network 0:
169f11a936eSBarry Smith  rank[0]:
170f11a936eSBarry Smith    ne = 2
171f11a936eSBarry Smith    edgelist = [0 2 | 1 2]
172f11a936eSBarry Smith  rank[1]:
173f11a936eSBarry Smith    ne = 2
174f11a936eSBarry Smith    edgelist = [3 5 | 4 5]
175f11a936eSBarry Smith 
176f11a936eSBarry Smith   2) Two subnetworks:
177f11a936eSBarry Smith .vb
178f11a936eSBarry Smith  subnetwork 0:
179f11a936eSBarry Smith  rank[0]:
180f11a936eSBarry Smith    v0 --> v2; v2 --> v1; v1 --> v3;
181f11a936eSBarry Smith  subnetwork 1:
182f11a936eSBarry Smith  rank[1]:
183f11a936eSBarry Smith    v0 --> v3; v3 --> v2; v2 --> v1;
184f11a936eSBarry Smith .ve
185f11a936eSBarry Smith 
186f11a936eSBarry Smith  The resulting input
187f11a936eSBarry Smith  subnetwork 0:
188f11a936eSBarry Smith  rank[0]:
189f11a936eSBarry Smith    ne = 3
190f11a936eSBarry Smith    edgelist = [0 2 | 2 1 | 1 3]
191f11a936eSBarry Smith  rank[1]:
192f11a936eSBarry Smith    ne = 0
193f11a936eSBarry Smith    edgelist = NULL
194f11a936eSBarry Smith 
195f11a936eSBarry Smith  subnetwork 1:
196f11a936eSBarry Smith  rank[0]:
197f11a936eSBarry Smith    ne = 0
198f11a936eSBarry Smith    edgelist = NULL
199f11a936eSBarry Smith  rank[1]:
200f11a936eSBarry Smith    edgelist = [0 3 | 3 2 | 2 1]
201e3e68989SHong Zhang 
20220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
2035f2c45f1SShri Abhyankar @*/
204d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum)
205d71ae5a4SJacob Faibussowitsch {
2065f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2075c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
208f11a936eSBarry Smith   PetscBT     table;
2095f2c45f1SShri Abhyankar 
2105f2c45f1SShri Abhyankar   PetscFunctionBegin;
211ad540459SPierre Jolivet   for (i = 0; i < ne; i++) PetscCheck(edgelist[2 * i] != edgelist[2 * i + 1], PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Edge %" PetscInt_FMT " has the same vertex %" PetscInt_FMT " at each endpoint", i, edgelist[2 * i]);
212f11a936eSBarry Smith 
2135c6496baSHong Zhang   i = 0;
2145c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2155c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2165c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2175c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2185c6496baSHong Zhang     i++;
2195c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2205c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2215c6496baSHong Zhang     i++;
2225c6496baSHong Zhang   }
2235c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2245c6496baSHong Zhang 
2255c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2269566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2279566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
228f11a936eSBarry Smith   i = 0;
229f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2309566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2319566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
232f11a936eSBarry Smith   }
233f11a936eSBarry Smith   nvtx = 0;
234f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
235f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
236f11a936eSBarry Smith   }
2375c6496baSHong Zhang 
2385c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
2391c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2405c6496baSHong Zhang   Nvtx++;
2419566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
242f11a936eSBarry Smith 
243f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
2441c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
245f11a936eSBarry Smith 
246daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
247c6a7a370SJeremy L Thompson   if (name) PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
248daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
249daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
250daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
251daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
252daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2532bf73ac6SHong Zhang 
2542bf73ac6SHong Zhang   /* ----------------------------------------------------------
2552bf73ac6SHong Zhang    p=v or e;
2562bf73ac6SHong Zhang    subnet[0].pStart   = 0
2572bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2582bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2592bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
260daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
261daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2622bf73ac6SHong Zhang 
263daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
264daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2652bf73ac6SHong Zhang 
2662bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
267daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
268daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
269daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
270daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2712bf73ac6SHong Zhang 
272c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
273daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
274daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2762bf73ac6SHong Zhang }
2772bf73ac6SHong Zhang 
2785c6496baSHong Zhang /*@C
2795c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2802bf73ac6SHong Zhang 
28120f4b53cSBarry Smith   Not Collective
2825c6496baSHong Zhang 
2835c6496baSHong Zhang   Input Parameters:
28420f4b53cSBarry Smith + dm - the `DM` object
2855c6496baSHong Zhang - v - vertex point
2865c6496baSHong Zhang 
2875c6496baSHong Zhang   Output Parameters:
2885c6496baSHong Zhang + gidx - global number of this shared vertex in the internal dmplex
2895c6496baSHong Zhang . n - number of subnetworks that share this vertex
2905c6496baSHong Zhang - sv - array of size n: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1
2915c6496baSHong Zhang 
2925c6496baSHong Zhang   Level: intermediate
2935c6496baSHong Zhang 
29420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSharedVertices()`
2955c6496baSHong Zhang @*/
296d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PetscInt *gidx, PetscInt *n, const PetscInt **sv)
297d71ae5a4SJacob Faibussowitsch {
2985c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
299daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
3005c6496baSHong Zhang   PetscInt    i, gidx_tmp;
3015c6496baSHong Zhang 
3025c6496baSHong Zhang   PetscFunctionBegin;
3039566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
304eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, gidx_tmp + 1, 0, &i));
3055c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
3065c6496baSHong Zhang 
3075c6496baSHong Zhang   i--;
3085c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3095c6496baSHong Zhang   if (n) *n = svtx[i].n;
3105c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3125c6496baSHong Zhang }
3135c6496baSHong Zhang 
3145c6496baSHong Zhang /*
3155c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3165c6496baSHong Zhang 
3175c6496baSHong Zhang   Input Parameters:
3185c6496baSHong Zhang + Nsvtx - global num of shared vertices
3195c6496baSHong Zhang . svtx - array of shared vertices (global)
3205c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3215c6496baSHong Zhang 
3225c6496baSHong Zhang   Output Parameters:
3235c6496baSHong Zhang + gidx - global index of (net,idx)
3245c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3255c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3265c6496baSHong Zhang */
327d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx)
328d71ae5a4SJacob Faibussowitsch {
3295c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3302bf73ac6SHong Zhang   SVtxType vtype;
3312bf73ac6SHong Zhang 
3322bf73ac6SHong Zhang   PetscFunctionBegin;
3333ba16761SJacob Faibussowitsch   if (!Nsvtx) PetscFunctionReturn(PETSC_SUCCESS);
3342bf73ac6SHong Zhang 
3355c6496baSHong Zhang   g_idx = -1;
3362bf73ac6SHong Zhang   vtype = SVNONE;
3375c6496baSHong Zhang 
3382bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3392bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3405c6496baSHong Zhang       g_idx = svtx[i].gidx;
3412bf73ac6SHong Zhang       vtype = SVFROM;
3422bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3432bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3442bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3452bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3462bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3475c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3482bf73ac6SHong Zhang           vtype = SVTO;
3492bf73ac6SHong Zhang         }
3502bf73ac6SHong Zhang       }
3512bf73ac6SHong Zhang     }
3522bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3532bf73ac6SHong Zhang   }
3545c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3552bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3562bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3582bf73ac6SHong Zhang }
3592bf73ac6SHong Zhang 
3602bf73ac6SHong Zhang /*
3615c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3625c6496baSHong Zhang 
3635c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3645c6496baSHong Zhang   Output: svta, tdata, ta2sv
3652bf73ac6SHong Zhang */
366eec179cfSJacob Faibussowitsch static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscHMapI svta, PetscInt *tdata, PetscInt *ta2sv)
367d71ae5a4SJacob Faibussowitsch {
3685c6496baSHong Zhang   PetscInt net, idx, gidx;
3692bf73ac6SHong Zhang 
3702bf73ac6SHong Zhang   PetscFunctionBegin;
3715c6496baSHong Zhang   net  = sedgelist[k];
3725c6496baSHong Zhang   idx  = sedgelist[k + 1];
373daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
374c76ffc5fSJacob Faibussowitsch   PetscCall(PetscHMapISet(svta, gidx + 1, *tdata + 1));
3755c6496baSHong Zhang 
3765c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3775c6496baSHong Zhang   (*tdata)++;
3783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3792bf73ac6SHong Zhang }
3802bf73ac6SHong Zhang 
3812bf73ac6SHong Zhang /*
3825c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3832bf73ac6SHong Zhang 
3842bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3852bf73ac6SHong Zhang 
3862bf73ac6SHong Zhang   Note: Output svtx is organized as
3872bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3882bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3892bf73ac6SHong Zhang                           ...
3902bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3912bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
3922bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
3932bf73ac6SHong Zhang  */
394d71ae5a4SJacob Faibussowitsch static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist)
395d71ae5a4SJacob Faibussowitsch {
3965c6496baSHong Zhang   SVtx         *svtx = NULL;
3972bf73ac6SHong Zhang   PetscInt     *sv, k, j, nsv, *tdata, **ta2sv;
398eec179cfSJacob Faibussowitsch   PetscHMapI   *svtas;
3997340ca2cSHong Zhang   PetscInt      gidx, net, idx, i, nta, ita, idx_from, idx_to, n, *net_tmp, *idx_tmp, *gidx_tmp;
4002bf73ac6SHong Zhang   DM_Network   *network = (DM_Network *)dm->data;
401eec179cfSJacob Faibussowitsch   PetscHashIter ppos;
4022bf73ac6SHong Zhang 
4032bf73ac6SHong Zhang   PetscFunctionBegin;
4045c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
4059566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
4062bf73ac6SHong Zhang 
4072bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
4087340ca2cSHong Zhang   nta = 0; /* num of svta tables created = num of groups of shared vertices */
4092bf73ac6SHong Zhang 
4102bf73ac6SHong Zhang   /* for j=0 */
411eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4129566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4132bf73ac6SHong Zhang 
4149566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4159566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4169371c9d4SSatish Balay   nta++;
4179371c9d4SSatish Balay   k += 4;
4182bf73ac6SHong Zhang 
4195c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4202bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4212bf73ac6SHong Zhang       /* vfrom */
4229371c9d4SSatish Balay       net  = sedgelist[k];
4239371c9d4SSatish Balay       idx  = sedgelist[k + 1];
424daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
425eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_from));
4262bf73ac6SHong Zhang 
4272bf73ac6SHong Zhang       /* vto */
4289371c9d4SSatish Balay       net  = sedgelist[k + 2];
4299371c9d4SSatish Balay       idx  = sedgelist[k + 3];
430daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
431eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_to));
4322bf73ac6SHong Zhang 
4332bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4349371c9d4SSatish Balay         idx_from--;
4359371c9d4SSatish Balay         idx_to--;
4362bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4379566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4382bf73ac6SHong Zhang           break;
4392bf73ac6SHong Zhang         } else if (idx_to < 0) {
4409566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4412bf73ac6SHong Zhang           break;
4422bf73ac6SHong Zhang         }
4432bf73ac6SHong Zhang       }
4442bf73ac6SHong Zhang     }
4452bf73ac6SHong Zhang 
4462bf73ac6SHong Zhang     if (ita == nta) {
447eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4489566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4492bf73ac6SHong Zhang 
4509566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4519566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4522bf73ac6SHong Zhang       nta++;
4532bf73ac6SHong Zhang     }
4542bf73ac6SHong Zhang     k += 4;
4552bf73ac6SHong Zhang   }
4562bf73ac6SHong Zhang 
4576aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
458eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(nta, &network->cloneshared->svtable));
4595c6496baSHong Zhang 
4605c6496baSHong Zhang   /* (3) Construct svtx from svtas
4617340ca2cSHong Zhang    svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1. */
4629566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4632bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4644f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
465eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetSize(svtas[nsv], &n));
4669566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4677340ca2cSHong Zhang     PetscCall(PetscMalloc3(n, &gidx_tmp, n, &net_tmp, n, &idx_tmp));
4685c6496baSHong Zhang     svtx[nsv].sv   = sv;
4695c6496baSHong Zhang     svtx[nsv].n    = n;
470daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4712bf73ac6SHong Zhang 
472eec179cfSJacob Faibussowitsch     PetscHashIterBegin(svtas[nsv], ppos);
4734f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
474eec179cfSJacob Faibussowitsch       PetscHashIterGetKey(svtas[nsv], ppos, gidx);
475eec179cfSJacob Faibussowitsch       PetscHashIterGetVal(svtas[nsv], ppos, i);
476eec179cfSJacob Faibussowitsch       PetscHashIterNext(svtas[nsv], ppos);
4779371c9d4SSatish Balay       gidx--;
4789371c9d4SSatish Balay       i--;
4795c6496baSHong Zhang       j           = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4807340ca2cSHong Zhang       net_tmp[k]  = sedgelist[j];     /* subnet number */
4817340ca2cSHong Zhang       idx_tmp[k]  = sedgelist[j + 1]; /* index on the subnet */
4827340ca2cSHong Zhang       gidx_tmp[k] = gidx;             /* gidx in un-merged dmnetwork */
4832bf73ac6SHong Zhang     }
4845c6496baSHong Zhang 
4857340ca2cSHong Zhang     /* current implementation requires sv[]=[net,idx] in ascending order of its gidx in un-merged dmnetwork */
4867340ca2cSHong Zhang     PetscCall(PetscSortIntWithArrayPair(n, gidx_tmp, net_tmp, idx_tmp));
4877340ca2cSHong Zhang     svtx[nsv].gidx = gidx_tmp[0]; /* = min(gidx) */
4887340ca2cSHong Zhang     for (k = 0; k < n; k++) {
4897340ca2cSHong Zhang       sv[2 * k]     = net_tmp[k];
4907340ca2cSHong Zhang       sv[2 * k + 1] = idx_tmp[k];
4917340ca2cSHong Zhang     }
4927340ca2cSHong Zhang     PetscCall(PetscFree3(gidx_tmp, net_tmp, idx_tmp));
4937340ca2cSHong Zhang 
4946aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
495c76ffc5fSJacob Faibussowitsch     PetscCall(PetscHMapISet(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1));
4962bf73ac6SHong Zhang   }
4972bf73ac6SHong Zhang 
4982bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
499eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(svtas + j));
5009566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
5012bf73ac6SHong Zhang   }
5029566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
5032bf73ac6SHong Zhang 
504daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
505daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
5063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5072bf73ac6SHong Zhang }
5082bf73ac6SHong Zhang 
5095c6496baSHong Zhang /*
5105c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
5115c6496baSHong Zhang 
5125c6496baSHong Zhang   Input Parameters:
5135c6496baSHong Zhang . dm - the dmnetwork object
5145c6496baSHong Zhang 
5155c6496baSHong Zhang    Output Parameters:
5165c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
5175c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
5185c6496baSHong Zhang */
519d71ae5a4SJacob Faibussowitsch static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr)
520d71ae5a4SJacob Faibussowitsch {
5212bf73ac6SHong Zhang   MPI_Comm    comm;
5222bf73ac6SHong Zhang   PetscMPIInt size, rank, *recvcounts = NULL, *displs = NULL;
523eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
524eac198afSGetnet   PetscInt    i, j, ctr, np;
525daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
526daad07d3SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist;
5275c6496baSHong Zhang   PetscInt    net, idx, gidx, nmerged, *vrange, gidx_from, net_from, sv_idx;
5282bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5295c6496baSHong Zhang   SVtx       *svtx;
5302bf73ac6SHong Zhang 
5312bf73ac6SHong Zhang   PetscFunctionBegin;
5329566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5339566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5349566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5352bf73ac6SHong Zhang 
5365c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5375c6496baSHong Zhang   /* --------------------------------------- */
538daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
539daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
540daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5412bf73ac6SHong Zhang 
542d5b43468SJose E. Roman   /* (2) Merge shared vto vertices to their vfrom vertex with same global vertex index (gidx) */
5435c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5442bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
545daad07d3SAidan Hamilton   PetscCall(PetscMalloc4(size + 1, &vrange, size, &displs, size, &recvcounts, network->cloneshared->nVertices, &vidxlTog));
5469371c9d4SSatish Balay   for (i = 0; i < size; i++) {
5479371c9d4SSatish Balay     displs[i]     = i;
5489371c9d4SSatish Balay     recvcounts[i] = 1;
5499371c9d4SSatish Balay   }
5502bf73ac6SHong Zhang 
5512bf73ac6SHong Zhang   vrange[0] = 0;
552daad07d3SAidan Hamilton   PetscCallMPI(MPI_Allgatherv(&network->cloneshared->nVertices, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
5535c6496baSHong Zhang   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
5542bf73ac6SHong Zhang 
5552bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5569371c9d4SSatish Balay   i                           = 0;
5579371c9d4SSatish Balay   gidx                        = 0;
5582bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
559daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5602bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
561daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5629566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5632bf73ac6SHong Zhang       if (svtype == SVTO) {
564daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5655c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
566daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5675c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
568daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5692bf73ac6SHong Zhang           }
5705c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5715c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5722bf73ac6SHong Zhang         }
5732bf73ac6SHong Zhang       } else {
574daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5755c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
576daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5772bf73ac6SHong Zhang         }
578daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5792bf73ac6SHong Zhang         gidx++;
5802bf73ac6SHong Zhang       }
5812bf73ac6SHong Zhang     }
5822bf73ac6SHong Zhang   }
5832bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
584daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5852bf73ac6SHong Zhang #endif
5862bf73ac6SHong Zhang 
5875c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
5889566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
589daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5902bf73ac6SHong Zhang 
5912bf73ac6SHong Zhang   ctr = 0;
5922bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
593daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5942bf73ac6SHong Zhang       /* vfrom: */
595daad07d3SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5962bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5972bf73ac6SHong Zhang 
5982bf73ac6SHong Zhang       /* vto */
599daad07d3SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
6002bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
6012bf73ac6SHong Zhang       ctr++;
6022bf73ac6SHong Zhang     }
6032bf73ac6SHong Zhang   }
6049566063dSJacob Faibussowitsch   PetscCall(PetscFree4(vrange, displs, recvcounts, vidxlTog));
6059566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
6062bf73ac6SHong Zhang 
607eac198afSGetnet   *nmerged_ptr = nmerged;
6083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6095f2c45f1SShri Abhyankar }
6105f2c45f1SShri Abhyankar 
611d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
612d71ae5a4SJacob Faibussowitsch {
613daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
614daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
615daad07d3SAidan Hamilton   MPI_Comm    comm;
616daad07d3SAidan Hamilton 
617daad07d3SAidan Hamilton   PetscFunctionBegin;
618daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
619daad07d3SAidan Hamilton 
620daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
621daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
622daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
623daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
624daad07d3SAidan Hamilton 
625daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
626daad07d3SAidan Hamilton 
627daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
628daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
629daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
630daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
631daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
632daad07d3SAidan Hamilton   }
6333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
634daad07d3SAidan Hamilton }
635daad07d3SAidan Hamilton 
6365f2c45f1SShri Abhyankar /*@
6375f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6385f2c45f1SShri Abhyankar 
639eac198afSGetnet   Not Collective
6405f2c45f1SShri Abhyankar 
6412fe279fdSBarry Smith   Input Parameter:
64220f4b53cSBarry Smith . dm - the `DMNETWORK` object
64320f4b53cSBarry Smith 
64420f4b53cSBarry Smith   Level: beginner
6455f2c45f1SShri Abhyankar 
6465f2c45f1SShri Abhyankar   Notes:
6475f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6485f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6495f2c45f1SShri Abhyankar 
6505f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6515f2c45f1SShri Abhyankar 
65220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6535f2c45f1SShri Abhyankar @*/
654d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
655d71ae5a4SJacob Faibussowitsch {
6565f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
657daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
658caf410d2SHong Zhang   const PetscInt *cone;
659caf410d2SHong Zhang   MPI_Comm        comm;
6605503a911SAidan Hamilton   PetscMPIInt     size;
661eac198afSGetnet   PetscSection    sectiong;
6625c6496baSHong Zhang   PetscInt        nmerged = 0;
6636500d4abSHong Zhang 
6646500d4abSHong Zhang   PetscFunctionBegin;
665e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
666daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6672bf73ac6SHong Zhang 
668eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
669eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6709371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6719371c9d4SSatish Balay       PetscCheck(network->cloneshared->subnet[net].nvtx == network->cloneshared->subnet[net].Nvtx, PETSC_COMM_SELF, PETSC_ERR_SUP, "subnetwork %" PetscInt_FMT " local num of vertices %" PetscInt_FMT " != %" PetscInt_FMT " global num", net,
6729371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
673eac198afSGetnet   }
674eac198afSGetnet 
6759566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6763ba16761SJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6776500d4abSHong Zhang 
678f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
679daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
680eac198afSGetnet 
681daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6829566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
683eac198afSGetnet   } else { /* subnetworks are not coupled */
6846aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
685eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapICreate(&network->cloneshared->svtable));
686caf410d2SHong Zhang     ctr = 0;
6872bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
688daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
689daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
690daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6916500d4abSHong Zhang         ctr++;
6926500d4abSHong Zhang       }
6936500d4abSHong Zhang     }
694eac198afSGetnet   }
6957765340cSHong Zhang 
6962bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6979566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
6989566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
6999566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
700eac198afSGetnet 
701daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
702daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
7036500d4abSHong Zhang 
704daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
705daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
706daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
707daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
7089566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
709caf410d2SHong Zhang 
710f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
711f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
712f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
713f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
714f11a936eSBarry Smith   */
715daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
716daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
717daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7185c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
719daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
720daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
721f11a936eSBarry Smith 
722daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
723daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7246500d4abSHong Zhang   }
725daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
726caf410d2SHong Zhang 
727caf410d2SHong Zhang   /* Get edge ownership */
728daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7295503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7305503a911SAidan Hamilton   globaledgeoff -= np;
731caf410d2SHong Zhang 
732eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7332bf73ac6SHong Zhang   e = 0;
7342bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
735f11a936eSBarry Smith     ctr = 0;
736daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7372bf73ac6SHong Zhang       /* edge e */
7385503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7392bf73ac6SHong Zhang       network->header[e].subnetid              = i;
740daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7412bf73ac6SHong Zhang 
7422bf73ac6SHong Zhang       /* connected vertices */
7439566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7442bf73ac6SHong Zhang 
7452bf73ac6SHong Zhang       /* vertex cone[0] */
746f11a936eSBarry Smith       v                           = cone[0];
747f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
748f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
749f11a936eSBarry Smith       if (Nsubnet == 1) {
750daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
751f11a936eSBarry Smith       } else {
752daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
753daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
754f11a936eSBarry Smith       }
7552bf73ac6SHong Zhang 
7562bf73ac6SHong Zhang       /* vertex cone[1] */
757f11a936eSBarry Smith       v                           = cone[1];
758f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
759f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
760f11a936eSBarry Smith       if (Nsubnet == 1) {
761daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
762f11a936eSBarry Smith       } else {
763daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
764daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
765f11a936eSBarry Smith       }
7662bf73ac6SHong Zhang 
7679371c9d4SSatish Balay       e++;
7689371c9d4SSatish Balay       ctr++;
7696500d4abSHong Zhang     }
7706500d4abSHong Zhang   }
7715503a911SAidan Hamilton   PetscCall(PetscFree(edges));
772caf410d2SHong Zhang 
773eac198afSGetnet   /* Set local vertex array for the subnetworks */
774eac198afSGetnet   j = 0;
775daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
776eac198afSGetnet     /* local shared vertex */
777eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, network->header[v].index + 1, 0, &i));
778daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7796500d4abSHong Zhang   }
780eac198afSGetnet 
781eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
782eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7839566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
784daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
785daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
786e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7885f2c45f1SShri Abhyankar }
7895f2c45f1SShri Abhyankar 
79094ef8ddeSSatish Balay /*@C
7912bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7922bf73ac6SHong Zhang 
79320f4b53cSBarry Smith   Not Collective
7942727e31bSShri Abhyankar 
7957a7aea1fSJed Brown   Input Parameters:
79620f4b53cSBarry Smith + dm - the `DMNETWORK` object
7972bf73ac6SHong Zhang - netnum - the global index of the subnetwork
7982727e31bSShri Abhyankar 
7997a7aea1fSJed Brown   Output Parameters:
8002727e31bSShri Abhyankar + nv - number of vertices (local)
8012727e31bSShri Abhyankar . ne - number of edges (local)
8022bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
8032bf73ac6SHong Zhang - edge - local edges of the subnetwork
8042727e31bSShri Abhyankar 
80506dd6b0eSSatish Balay   Level: intermediate
80606dd6b0eSSatish Balay 
80720f4b53cSBarry Smith   Notes:
80820f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
80920f4b53cSBarry Smith 
81020f4b53cSBarry Smith   The local vertices returned on each rank are determined by `DMNETWORK`. The user does not have any control over what vertices are local.
81120f4b53cSBarry Smith 
81220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8132727e31bSShri Abhyankar @*/
814d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge)
815d71ae5a4SJacob Faibussowitsch {
816caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8172727e31bSShri Abhyankar 
8182727e31bSShri Abhyankar   PetscFunctionBegin;
819daad07d3SAidan Hamilton   PetscCheck(netnum < network->cloneshared->Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Subnet index %" PetscInt_FMT " exceeds the num of subnets %" PetscInt_FMT, netnum, network->cloneshared->Nsubnet);
820daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
821daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
822daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
823daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8252bf73ac6SHong Zhang }
8262bf73ac6SHong Zhang 
8272bf73ac6SHong Zhang /*@
8282bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8292bf73ac6SHong Zhang 
83020f4b53cSBarry Smith   Collective
8312bf73ac6SHong Zhang 
8322bf73ac6SHong Zhang   Input Parameters:
83320f4b53cSBarry Smith + dm - the `DMNETWORK` object
83420f4b53cSBarry Smith . anetnum - first subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
83520f4b53cSBarry Smith . bnetnum - second subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
8362bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8372bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8382bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8392bf73ac6SHong Zhang 
8402bf73ac6SHong Zhang   Level: beginner
8412bf73ac6SHong Zhang 
84220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8432bf73ac6SHong Zhang @*/
844d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
845d71ae5a4SJacob Faibussowitsch {
8462bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
847daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8482bf73ac6SHong Zhang 
8492bf73ac6SHong Zhang   PetscFunctionBegin;
8505c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8515c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8522bf73ac6SHong Zhang   if (!Nsvtx) {
8532bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
854daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8552bf73ac6SHong Zhang   }
8562bf73ac6SHong Zhang 
857daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8582bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8599371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8609371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8619371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8629371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8632bf73ac6SHong Zhang     Nsvtx++;
8642bf73ac6SHong Zhang   }
8655c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
866daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8682727e31bSShri Abhyankar }
8692727e31bSShri Abhyankar 
8702727e31bSShri Abhyankar /*@C
8712bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8722bf73ac6SHong Zhang 
87320f4b53cSBarry Smith   Not Collective
874caf410d2SHong Zhang 
875f899ff85SJose E. Roman   Input Parameter:
87620f4b53cSBarry Smith . dm - the `DMNETWORK` object
877caf410d2SHong Zhang 
8787a7aea1fSJed Brown   Output Parameters:
8792bf73ac6SHong Zhang + nsv - number of local shared vertices
8802bf73ac6SHong Zhang - svtx - local shared vertices
881caf410d2SHong Zhang 
882caf410d2SHong Zhang   Level: intermediate
883caf410d2SHong Zhang 
88420f4b53cSBarry Smith   Notes:
88520f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
88620f4b53cSBarry Smith 
88720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
888caf410d2SHong Zhang @*/
889d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx)
890d71ae5a4SJacob Faibussowitsch {
891caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
892caf410d2SHong Zhang 
893caf410d2SHong Zhang   PetscFunctionBegin;
8945c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
895daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
896daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
8973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
898caf410d2SHong Zhang }
899caf410d2SHong Zhang 
900caf410d2SHong Zhang /*@C
9015f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
9025f2c45f1SShri Abhyankar 
90320f4b53cSBarry Smith   Logically Collective
9045f2c45f1SShri Abhyankar 
9057a7aea1fSJed Brown   Input Parameters:
90620f4b53cSBarry Smith + dm - the `DMNETWORK` object
9075f2c45f1SShri Abhyankar . name - the component name
9085f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
9095f2c45f1SShri Abhyankar 
9102fe279fdSBarry Smith    Output Parameter:
9115f2c45f1SShri Abhyankar .  key - an integer key that defines the component
9125f2c45f1SShri Abhyankar 
91320f4b53cSBarry Smith    Level: beginner
91420f4b53cSBarry Smith 
91587497f52SBarry Smith    Note:
91687497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9175f2c45f1SShri Abhyankar 
91820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9195f2c45f1SShri Abhyankar @*/
920d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
921d71ae5a4SJacob Faibussowitsch {
9225f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
92354dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9245f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9255f2c45f1SShri Abhyankar   PetscInt            i;
9265f2c45f1SShri Abhyankar 
9275f2c45f1SShri Abhyankar   PetscFunctionBegin;
92848a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
92954dfd506SHong Zhang 
9305f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9319566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9325f2c45f1SShri Abhyankar     if (flg) {
9335f2c45f1SShri Abhyankar       *key = i;
9343ba16761SJacob Faibussowitsch       PetscFunctionReturn(PETSC_SUCCESS);
9355f2c45f1SShri Abhyankar     }
9366d64e262SShri Abhyankar   }
93754dfd506SHong Zhang 
93854dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
93954dfd506SHong Zhang     /* Reached max allowed so resize component */
94054dfd506SHong Zhang     network->max_comps_registered += 2;
9419566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
94254dfd506SHong Zhang     /* Copy over the previous component info */
94354dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
944c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(newcomponent[i].name, network->component[i].name, sizeof(newcomponent[i].name)));
94554dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9465f2c45f1SShri Abhyankar     }
94754dfd506SHong Zhang     /* Free old one */
9489566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
94954dfd506SHong Zhang     /* Update pointer */
95054dfd506SHong Zhang     network->component = newcomponent;
95154dfd506SHong Zhang   }
95254dfd506SHong Zhang 
95354dfd506SHong Zhang   component = &network->component[network->ncomponent];
9545f2c45f1SShri Abhyankar 
955c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(component->name, name, sizeof(component->name)));
9565f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9575f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9585f2c45f1SShri Abhyankar   network->ncomponent++;
9593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9605f2c45f1SShri Abhyankar }
9615f2c45f1SShri Abhyankar 
9625f2c45f1SShri Abhyankar /*@
9638afb7921SAidan Hamilton   DMNetworkGetNumVertices - Get the local and global number of vertices for the entire network.
9648afb7921SAidan Hamilton 
9658afb7921SAidan Hamilton   Not Collective
9668afb7921SAidan Hamilton 
9678afb7921SAidan Hamilton   Input Parameter:
96820f4b53cSBarry Smith . dm - the `DMNETWORK` object
9698afb7921SAidan Hamilton 
9708afb7921SAidan Hamilton   Output Parameters:
9718afb7921SAidan Hamilton + nVertices - the local number of vertices
9728afb7921SAidan Hamilton - NVertices - the global number of vertices
9738afb7921SAidan Hamilton 
9748afb7921SAidan Hamilton   Level: beginner
9758afb7921SAidan Hamilton 
97620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumEdges()`
9778afb7921SAidan Hamilton @*/
9788afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumVertices(DM dm, PetscInt *nVertices, PetscInt *NVertices)
9798afb7921SAidan Hamilton {
9808afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
9818afb7921SAidan Hamilton 
9828afb7921SAidan Hamilton   PetscFunctionBegin;
9838afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
9848afb7921SAidan Hamilton   if (nVertices) {
9858afb7921SAidan Hamilton     PetscValidIntPointer(nVertices, 2);
9868afb7921SAidan Hamilton     *nVertices = network->cloneshared->nVertices;
9878afb7921SAidan Hamilton   }
9888afb7921SAidan Hamilton   if (NVertices) {
9898afb7921SAidan Hamilton     PetscValidIntPointer(NVertices, 3);
9908afb7921SAidan Hamilton     *NVertices = network->cloneshared->NVertices;
9918afb7921SAidan Hamilton   }
9923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9938afb7921SAidan Hamilton }
9948afb7921SAidan Hamilton 
9958afb7921SAidan Hamilton /*@
9968afb7921SAidan Hamilton   DMNetworkGetNumEdges - Get the local and global number of edges for the entire network.
9978afb7921SAidan Hamilton 
9988afb7921SAidan Hamilton   Not Collective
9998afb7921SAidan Hamilton 
10008afb7921SAidan Hamilton   Input Parameter:
100120f4b53cSBarry Smith . dm - the `DMNETWORK` object
10028afb7921SAidan Hamilton 
10038afb7921SAidan Hamilton   Output Parameters:
10048afb7921SAidan Hamilton + nEdges - the local number of edges
10058afb7921SAidan Hamilton -  NEdges - the global number of edges
10068afb7921SAidan Hamilton 
10078afb7921SAidan Hamilton   Level: beginner
10088afb7921SAidan Hamilton 
100920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumVertices()`
10108afb7921SAidan Hamilton @*/
10118afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumEdges(DM dm, PetscInt *nEdges, PetscInt *NEdges)
10128afb7921SAidan Hamilton {
10138afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
10148afb7921SAidan Hamilton 
10158afb7921SAidan Hamilton   PetscFunctionBegin;
10168afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
10178afb7921SAidan Hamilton   if (nEdges) {
10188afb7921SAidan Hamilton     PetscValidIntPointer(nEdges, 2);
10198afb7921SAidan Hamilton     *nEdges = network->cloneshared->nEdges;
10208afb7921SAidan Hamilton   }
10218afb7921SAidan Hamilton   if (NEdges) {
10228afb7921SAidan Hamilton     PetscValidIntPointer(NEdges, 3);
10238afb7921SAidan Hamilton     *NEdges = network->cloneshared->NEdges;
10248afb7921SAidan Hamilton   }
10253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10268afb7921SAidan Hamilton }
10278afb7921SAidan Hamilton 
10288afb7921SAidan Hamilton /*@
10292bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
10305f2c45f1SShri Abhyankar 
10315f2c45f1SShri Abhyankar   Not Collective
10325f2c45f1SShri Abhyankar 
1033f899ff85SJose E. Roman   Input Parameter:
103420f4b53cSBarry Smith . dm - the `DMNETWORK` object
10355f2c45f1SShri Abhyankar 
1036fd292e60Sprj-   Output Parameters:
10372bf73ac6SHong Zhang + vStart - the first vertex point
10382bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
10395f2c45f1SShri Abhyankar 
104097bb938eSShri Abhyankar   Level: beginner
10415f2c45f1SShri Abhyankar 
104220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeRange()`
10435f2c45f1SShri Abhyankar @*/
1044d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd)
1045d71ae5a4SJacob Faibussowitsch {
10465f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10475f2c45f1SShri Abhyankar 
10485f2c45f1SShri Abhyankar   PetscFunctionBegin;
1049daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
1050daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
10513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10525f2c45f1SShri Abhyankar }
10535f2c45f1SShri Abhyankar 
10545f2c45f1SShri Abhyankar /*@
10552bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
10565f2c45f1SShri Abhyankar 
10575f2c45f1SShri Abhyankar   Not Collective
10585f2c45f1SShri Abhyankar 
1059f899ff85SJose E. Roman   Input Parameter:
106020f4b53cSBarry Smith . dm - the `DMNETWORK` object
10615f2c45f1SShri Abhyankar 
1062fd292e60Sprj-   Output Parameters:
10635f2c45f1SShri Abhyankar + eStart - The first edge point
10645f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
10655f2c45f1SShri Abhyankar 
106697bb938eSShri Abhyankar   Level: beginner
10675f2c45f1SShri Abhyankar 
106820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetVertexRange()`
10695f2c45f1SShri Abhyankar @*/
1070d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd)
1071d71ae5a4SJacob Faibussowitsch {
10725f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10735f2c45f1SShri Abhyankar 
10745f2c45f1SShri Abhyankar   PetscFunctionBegin;
10755c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1076daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
1077daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
10783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10795f2c45f1SShri Abhyankar }
10805f2c45f1SShri Abhyankar 
1081d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index)
1082d71ae5a4SJacob Faibussowitsch {
10832bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
10845c6496baSHong Zhang 
10855c6496baSHong Zhang   PetscFunctionBegin;
10865c6496baSHong Zhang   if (network->header) {
10875c6496baSHong Zhang     *index = network->header[p].index;
10885c6496baSHong Zhang   } else {
10892bf73ac6SHong Zhang     PetscInt                 offsetp;
10902bf73ac6SHong Zhang     DMNetworkComponentHeader header;
10912bf73ac6SHong Zhang 
10929566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
10932bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
10942bf73ac6SHong Zhang     *index = header->index;
10955c6496baSHong Zhang   }
10963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10972bf73ac6SHong Zhang }
10982bf73ac6SHong Zhang 
1099d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid)
1100d71ae5a4SJacob Faibussowitsch {
1101daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1102daad07d3SAidan Hamilton 
1103daad07d3SAidan Hamilton   PetscFunctionBegin;
1104daad07d3SAidan Hamilton   if (network->header) {
1105daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1106daad07d3SAidan Hamilton   } else {
1107daad07d3SAidan Hamilton     PetscInt                 offsetp;
1108daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1109daad07d3SAidan Hamilton 
1110daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1111daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1112daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1113daad07d3SAidan Hamilton   }
11143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1115daad07d3SAidan Hamilton }
1116daad07d3SAidan Hamilton 
11177b6afd5bSHong Zhang /*@
11182bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
11197b6afd5bSHong Zhang 
11207b6afd5bSHong Zhang   Not Collective
11217b6afd5bSHong Zhang 
11227b6afd5bSHong Zhang   Input Parameters:
112320f4b53cSBarry Smith + dm - `DMNETWORK` object
1124e85e6aecSHong Zhang - p - edge point
11257b6afd5bSHong Zhang 
11262fe279fdSBarry Smith   Output Parameter:
11272bf73ac6SHong Zhang . index - the global numbering for the edge
11287b6afd5bSHong Zhang 
11297b6afd5bSHong Zhang   Level: intermediate
11307b6afd5bSHong Zhang 
113120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
11327b6afd5bSHong Zhang @*/
1133d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index)
1134d71ae5a4SJacob Faibussowitsch {
11357b6afd5bSHong Zhang   PetscFunctionBegin;
11369566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11387b6afd5bSHong Zhang }
11397b6afd5bSHong Zhang 
11405f2c45f1SShri Abhyankar /*@
11412bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1142e85e6aecSHong Zhang 
1143e85e6aecSHong Zhang   Not Collective
1144e85e6aecSHong Zhang 
1145e85e6aecSHong Zhang   Input Parameters:
114620f4b53cSBarry Smith + dm - `DMNETWORK` object
1147e85e6aecSHong Zhang - p  - vertex point
1148e85e6aecSHong Zhang 
11492fe279fdSBarry Smith   Output Parameter:
11502bf73ac6SHong Zhang . index - the global numbering for the vertex
1151e85e6aecSHong Zhang 
1152e85e6aecSHong Zhang   Level: intermediate
1153e85e6aecSHong Zhang 
115420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1155e85e6aecSHong Zhang @*/
1156d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index)
1157d71ae5a4SJacob Faibussowitsch {
1158e85e6aecSHong Zhang   PetscFunctionBegin;
11599566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11619988b915SShri Abhyankar }
11629988b915SShri Abhyankar 
11639988b915SShri Abhyankar /*@
11645f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
11655f2c45f1SShri Abhyankar 
11665f2c45f1SShri Abhyankar   Not Collective
11675f2c45f1SShri Abhyankar 
11685f2c45f1SShri Abhyankar   Input Parameters:
116920f4b53cSBarry Smith + dm - the `DMNETWORK` object
1170a2b725a8SWilliam Gropp - p - vertex/edge point
11715f2c45f1SShri Abhyankar 
11722fe279fdSBarry Smith   Output Parameter:
11735f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
11745f2c45f1SShri Abhyankar 
117597bb938eSShri Abhyankar   Level: beginner
11765f2c45f1SShri Abhyankar 
117720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
11785f2c45f1SShri Abhyankar @*/
1179d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents)
1180d71ae5a4SJacob Faibussowitsch {
11815f2c45f1SShri Abhyankar   PetscInt    offset;
11825f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
11835f2c45f1SShri Abhyankar 
11845f2c45f1SShri Abhyankar   PetscFunctionBegin;
11859566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
11865f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
11873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11885f2c45f1SShri Abhyankar }
11895f2c45f1SShri Abhyankar 
11905f2c45f1SShri Abhyankar /*@
11912bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
11925f2c45f1SShri Abhyankar 
11935f2c45f1SShri Abhyankar   Not Collective
11945f2c45f1SShri Abhyankar 
11955f2c45f1SShri Abhyankar   Input Parameters:
119620f4b53cSBarry Smith + dm - the `DMNETWORK` object
1197f2f58720SBarry Smith . p - the edge or vertex point
11982bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
11999988b915SShri Abhyankar 
12002fe279fdSBarry Smith   Output Parameter:
12012bf73ac6SHong Zhang . offset - the local offset
12029988b915SShri Abhyankar 
12039988b915SShri Abhyankar   Level: intermediate
12049988b915SShri Abhyankar 
120520f4b53cSBarry Smith   Notes:
120620f4b53cSBarry Smith     These offsets can be passed to `MatSetValuesLocal()` for matrices obtained with `DMCreateMatrix()`.
120720f4b53cSBarry Smith 
120820f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` the offsets can be used with `VecSetValues()`.
120920f4b53cSBarry Smith 
121020f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
121120f4b53cSBarry Smith     the vector values with array[offset].
121220f4b53cSBarry Smith 
121320f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValuesLocal()`.
121420f4b53cSBarry Smith 
121520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
12169988b915SShri Abhyankar @*/
1217d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset)
1218d71ae5a4SJacob Faibussowitsch {
12199988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12209988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12219988b915SShri Abhyankar   DMNetworkComponentHeader header;
12229988b915SShri Abhyankar 
12239988b915SShri Abhyankar   PetscFunctionBegin;
12249566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
12252bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12262bf73ac6SHong Zhang     *offset = offsetp;
12273ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12282bf73ac6SHong Zhang   }
12292bf73ac6SHong Zhang 
12309566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12319988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12329988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
12333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12349988b915SShri Abhyankar }
12359988b915SShri Abhyankar 
12369988b915SShri Abhyankar /*@
12372bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
12389988b915SShri Abhyankar 
12399988b915SShri Abhyankar   Not Collective
12409988b915SShri Abhyankar 
12419988b915SShri Abhyankar   Input Parameters:
124220f4b53cSBarry Smith + dm - the `DMNETWORK` object
1243f2f58720SBarry Smith . p - the edge or vertex point
12442bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12459988b915SShri Abhyankar 
12462fe279fdSBarry Smith   Output Parameter:
12479988b915SShri Abhyankar . offsetg - the global offset
12489988b915SShri Abhyankar 
12499988b915SShri Abhyankar   Level: intermediate
12509988b915SShri Abhyankar 
125120f4b53cSBarry Smith   Notes:
125220f4b53cSBarry Smith     These offsets can be passed to `MatSetValues()` for matrices obtained with `DMCreateMatrix()`.
125320f4b53cSBarry Smith 
125420f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValues()`.
125520f4b53cSBarry Smith 
125620f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
125720f4b53cSBarry Smith     the vector values with array[offset - rstart] where restart is obtained with `VecGetOwnershipRange`(v,&rstart,`NULL`);
125820f4b53cSBarry Smith 
125920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
12609988b915SShri Abhyankar @*/
1261d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg)
1262d71ae5a4SJacob Faibussowitsch {
12639988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12649988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12659988b915SShri Abhyankar   DMNetworkComponentHeader header;
12669988b915SShri Abhyankar 
12679988b915SShri Abhyankar   PetscFunctionBegin;
12689566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
12692bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
12702bf73ac6SHong Zhang 
12712bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12722bf73ac6SHong Zhang     *offsetg = offsetp;
12733ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12742bf73ac6SHong Zhang   }
12759566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12769988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12779988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
12783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12799988b915SShri Abhyankar }
12809988b915SShri Abhyankar 
12819988b915SShri Abhyankar /*@
12822bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
128324121865SAdrian Maldonado 
128424121865SAdrian Maldonado   Not Collective
128524121865SAdrian Maldonado 
128624121865SAdrian Maldonado   Input Parameters:
128720f4b53cSBarry Smith + dm - the `DMNETWORK` object
128824121865SAdrian Maldonado - p - the edge point
128924121865SAdrian Maldonado 
12902fe279fdSBarry Smith   Output Parameter:
129124121865SAdrian Maldonado . offset - the offset
129224121865SAdrian Maldonado 
129324121865SAdrian Maldonado   Level: intermediate
129424121865SAdrian Maldonado 
129520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
129624121865SAdrian Maldonado @*/
1297d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset)
1298d71ae5a4SJacob Faibussowitsch {
129924121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
130024121865SAdrian Maldonado 
130124121865SAdrian Maldonado   PetscFunctionBegin;
13029566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
13033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
130424121865SAdrian Maldonado }
130524121865SAdrian Maldonado 
130624121865SAdrian Maldonado /*@
13072bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
130824121865SAdrian Maldonado 
130924121865SAdrian Maldonado   Not Collective
131024121865SAdrian Maldonado 
131124121865SAdrian Maldonado   Input Parameters:
131220f4b53cSBarry Smith + dm - the `DMNETWORK` object
131324121865SAdrian Maldonado - p - the vertex point
131424121865SAdrian Maldonado 
13152fe279fdSBarry Smith   Output Parameter:
131624121865SAdrian Maldonado . offset - the offset
131724121865SAdrian Maldonado 
131824121865SAdrian Maldonado   Level: intermediate
131924121865SAdrian Maldonado 
132020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
132124121865SAdrian Maldonado @*/
1322d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset)
1323d71ae5a4SJacob Faibussowitsch {
132424121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
132524121865SAdrian Maldonado 
132624121865SAdrian Maldonado   PetscFunctionBegin;
1327daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
13289566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
13293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
133024121865SAdrian Maldonado }
13312bf73ac6SHong Zhang 
13325f2c45f1SShri Abhyankar /*@
13332bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
13345f2c45f1SShri Abhyankar 
133520f4b53cSBarry Smith   Collective
13365f2c45f1SShri Abhyankar 
13375f2c45f1SShri Abhyankar   Input Parameters:
13384dc646bcSBarry Smith + dm - the DMNetwork
133920f4b53cSBarry Smith . p - the vertex/edge point. These points are local indices provided by `DMNetworkGetSubnetwork()`
134020f4b53cSBarry Smith . componentkey - component key returned while registering the component with `DMNetworkRegisterComponent()`
134120f4b53cSBarry Smith . compvalue - pointer to the data structure for the component, or `NULL` if the component does not require data, this data is not copied so you cannot
134220f4b53cSBarry Smith               free this space until after `DMSetUp()` is called.
1343eac198afSGetnet - nvar - number of variables for the component at the vertex/edge point, zero if the component does not introduce any degrees of freedom at the point
13445f2c45f1SShri Abhyankar 
134520f4b53cSBarry Smith   Level: beginner
134620f4b53cSBarry Smith 
1347eac198afSGetnet   Notes:
1348eac198afSGetnet     The owning rank and any other ranks that have this point as a ghost location must call this routine to add a component and number of variables in the same order at the given point.
1349eac198afSGetnet 
135020f4b53cSBarry Smith     `DMNetworkLayoutSetUp()` must be called before this routine.
1351eac198afSGetnet 
135220f4b53cSBarry Smith   Developer Note:
135320f4b53cSBarry Smith      The requirement that all the ranks with access to a vertex (as owner or as ghost) add all the components comes from a limitation of the underlying implementation based on `DMPLEX`.
13545f2c45f1SShri Abhyankar 
135520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
13565f2c45f1SShri Abhyankar @*/
1357d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar)
1358d71ae5a4SJacob Faibussowitsch {
13595f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
13602bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
136154dfd506SHong Zhang   DMNetworkComponentHeader header;
136254dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
136354dfd506SHong Zhang   PetscInt                 compnum;
136454dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
136554dfd506SHong Zhang   void                   **compdata;
13665f2c45f1SShri Abhyankar 
13675f2c45f1SShri Abhyankar   PetscFunctionBegin;
13685c6496baSHong Zhang   PetscCheck(componentkey >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "componentkey %" PetscInt_FMT " cannot be negative. Input a component key returned while registering the component with DMNetworkRegisterComponent()", componentkey);
1369daad07d3SAidan Hamilton   PetscCheck(network->componentsetup == PETSC_FALSE, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "The network has already finalized the components. No new components can be added.");
1370eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
13719566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
13722bf73ac6SHong Zhang 
1373eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
137454dfd506SHong Zhang   header = &network->header[p];
137554dfd506SHong Zhang   cvalue = &network->cvalue[p];
137654dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1377f11a936eSBarry Smith     PetscInt additional_size;
1378f11a936eSBarry Smith 
137954dfd506SHong Zhang     /* Reached limit so resize header component arrays */
138054dfd506SHong Zhang     header->maxcomps += 2;
138154dfd506SHong Zhang 
138254dfd506SHong Zhang     /* Allocate arrays for component information and value */
13839566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
13849566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
138554dfd506SHong Zhang 
138654dfd506SHong Zhang     /* Recalculate header size */
138754dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
138854dfd506SHong Zhang 
138954dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
139054dfd506SHong Zhang 
139154dfd506SHong Zhang     /* Copy over component info */
13929566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
13939566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
13949566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
13959566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
13969566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
139754dfd506SHong Zhang 
139854dfd506SHong Zhang     /* Copy over component data pointers */
13999566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
140054dfd506SHong Zhang 
140154dfd506SHong Zhang     /* Free old arrays */
14029566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
14039566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
140454dfd506SHong Zhang 
140554dfd506SHong Zhang     /* Update pointers */
140654dfd506SHong Zhang     header->size         = compsize;
140754dfd506SHong Zhang     header->key          = compkey;
140854dfd506SHong Zhang     header->offset       = compoffset;
140954dfd506SHong Zhang     header->nvar         = compnvar;
141054dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
141154dfd506SHong Zhang 
141254dfd506SHong Zhang     cvalue->data = compdata;
141354dfd506SHong Zhang 
141454dfd506SHong Zhang     /* Update DataSection Dofs */
141554dfd506SHong Zhang     /* The dofs for datasection point p equals sizeof the header (i.e. header->hsize) + sizes of the components added at point p. With the resizing of the header, we need to update the dofs for point p. Hence, we add the extra size added for the header */
1416f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
14179566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
141854dfd506SHong Zhang   }
141954dfd506SHong Zhang   header = &network->header[p];
142054dfd506SHong Zhang   cvalue = &network->cvalue[p];
142154dfd506SHong Zhang 
142254dfd506SHong Zhang   compnum = header->ndata;
14232bf73ac6SHong Zhang 
14242bf73ac6SHong Zhang   header->size[compnum] = component->size;
14259566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
14262bf73ac6SHong Zhang   header->key[compnum] = componentkey;
14272bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
14282bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
14292bf73ac6SHong Zhang 
14302bf73ac6SHong Zhang   /* variables */
14312bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
14322bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
14332bf73ac6SHong Zhang 
14342bf73ac6SHong Zhang   header->ndata++;
14353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14365f2c45f1SShri Abhyankar }
14375f2c45f1SShri Abhyankar 
143827f51fceSHong Zhang /*@
14392bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
144027f51fceSHong Zhang 
144127f51fceSHong Zhang   Not Collective
144227f51fceSHong Zhang 
144327f51fceSHong Zhang   Input Parameters:
144420f4b53cSBarry Smith + dm - the `DMNETWORK` object
14452bf73ac6SHong Zhang . p - vertex/edge point
144699c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
144727f51fceSHong Zhang 
144827f51fceSHong Zhang   Output Parameters:
144920f4b53cSBarry Smith + compkey - the key obtained when registering the component (use `NULL` if not required)
145020f4b53cSBarry Smith . component - the component data (use `NULL` if not required)
145120f4b53cSBarry Smith - nvar  - number of variables (use `NULL` if not required)
145227f51fceSHong Zhang 
145397bb938eSShri Abhyankar   Level: beginner
145427f51fceSHong Zhang 
145520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
145627f51fceSHong Zhang @*/
1457d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar)
1458d71ae5a4SJacob Faibussowitsch {
145927f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
14602bf73ac6SHong Zhang   PetscInt                 offset  = 0;
14612bf73ac6SHong Zhang   DMNetworkComponentHeader header;
146227f51fceSHong Zhang 
146327f51fceSHong Zhang   PetscFunctionBegin;
14642bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
14659566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
14663ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
146727f51fceSHong Zhang   }
146827f51fceSHong Zhang 
14699566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
147042dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
14715f2c45f1SShri Abhyankar 
14722bf73ac6SHong Zhang   if (compnum >= 0) {
14732bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
14742bf73ac6SHong Zhang     if (component) {
147554dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
14762bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
14772bf73ac6SHong Zhang     }
14782bf73ac6SHong Zhang   }
14795f2c45f1SShri Abhyankar 
14802bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
148154dfd506SHong Zhang 
14823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14835f2c45f1SShri Abhyankar }
14845f2c45f1SShri Abhyankar 
14852bf73ac6SHong Zhang /*
14862bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14872bf73ac6SHong Zhang  It copies the data for all components in a contiguous array called componentdataarray. The component data is stored pointwise with an additional header (metadata) stored for each point. The header has metadata information such as number of components at each point, number of variables for each component, offsets for the components data, etc.
14882bf73ac6SHong Zhang */
1489d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkComponentSetUp(DM dm)
1490d71ae5a4SJacob Faibussowitsch {
14915f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1492f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
14935f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
14945f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1495f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
14965f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
14975f2c45f1SShri Abhyankar 
14985f2c45f1SShri Abhyankar   PetscFunctionBegin;
14999566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
15009566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1501f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
15029566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
15035f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1504daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
15059566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
15065f2c45f1SShri Abhyankar     /* Copy header */
15075f2c45f1SShri Abhyankar     header     = &network->header[p];
1508f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
15099566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1510f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
15119566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1512aeb78aa7SBarry Smith     headerinfo->size = headerarr;
151354dfd506SHong Zhang     headerarr += header->maxcomps;
15149566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1515aeb78aa7SBarry Smith     headerinfo->key = headerarr;
151654dfd506SHong Zhang     headerarr += header->maxcomps;
15179566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1518aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
151954dfd506SHong Zhang     headerarr += header->maxcomps;
15209566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1521aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
152254dfd506SHong Zhang     headerarr += header->maxcomps;
15239566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1524aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
152554dfd506SHong Zhang 
15265f2c45f1SShri Abhyankar     /* Copy data */
15275f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
15285f2c45f1SShri Abhyankar     ncomp  = header->ndata;
15292bf73ac6SHong Zhang 
15305f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
153154dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
15329566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
15335f2c45f1SShri Abhyankar     }
15345f2c45f1SShri Abhyankar   }
1535aeb78aa7SBarry Smith 
1536daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1537aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1538aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1539aeb78aa7SBarry Smith   }
1540aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
15413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15425f2c45f1SShri Abhyankar }
15435f2c45f1SShri Abhyankar 
15445f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1545d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1546d71ae5a4SJacob Faibussowitsch {
15475f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
15485f2c45f1SShri Abhyankar 
15495f2c45f1SShri Abhyankar   PetscFunctionBegin;
15509566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
15513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15525f2c45f1SShri Abhyankar }
15535f2c45f1SShri Abhyankar 
155424121865SAdrian Maldonado /* Get a subsection from a range of points */
1555d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1556d71ae5a4SJacob Faibussowitsch {
155724121865SAdrian Maldonado   PetscInt i, nvar;
155824121865SAdrian Maldonado 
155924121865SAdrian Maldonado   PetscFunctionBegin;
15609566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
15619566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
156224121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
15639566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
15649566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
156524121865SAdrian Maldonado   }
156624121865SAdrian Maldonado 
15679566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
15683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
156924121865SAdrian Maldonado }
157024121865SAdrian Maldonado 
157124121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1572d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkSetSubMap_private(PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1573d71ae5a4SJacob Faibussowitsch {
157424121865SAdrian Maldonado   PetscInt i, *subpoints;
157524121865SAdrian Maldonado 
157624121865SAdrian Maldonado   PetscFunctionBegin;
157724121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15789566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1579ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
15809566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15819566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
15823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
158324121865SAdrian Maldonado }
158424121865SAdrian Maldonado 
158524121865SAdrian Maldonado /*@
158620f4b53cSBarry Smith   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after `DMNetworkDistribute()`
158724121865SAdrian Maldonado 
158820f4b53cSBarry Smith   Collective
158924121865SAdrian Maldonado 
15902fe279fdSBarry Smith   Input Parameter:
159120f4b53cSBarry Smith . dm - the `DMNETWORK` Object
159224121865SAdrian Maldonado 
159320f4b53cSBarry Smith   Level: intermediate
159420f4b53cSBarry Smith 
159520f4b53cSBarry Smith   Note:
159620f4b53cSBarry Smith   the routine will create alternative orderings for the vertices and edges. Assume global network points are:
159724121865SAdrian Maldonado 
159824121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
159924121865SAdrian Maldonado 
1600caf410d2SHong Zhang   where edges = [0,1,2,3] and vertices = [4,5,6]. The new orderings will be specific to the subset (i.e vertices = [0,1,2] <- [4,5,6]).
160124121865SAdrian Maldonado 
160220f4b53cSBarry Smith   With this new ordering a local `PetscSection`, global `PetscSection` and` PetscSF` will be created specific to the subset.
160324121865SAdrian Maldonado 
160424121865SAdrian Maldonado @*/
1605d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1606d71ae5a4SJacob Faibussowitsch {
160724121865SAdrian Maldonado   MPI_Comm    comm;
1608f11a936eSBarry Smith   PetscMPIInt size;
160924121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
161024121865SAdrian Maldonado 
1611eab1376dSHong Zhang   PetscFunctionBegin;
16129566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
16139566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
161424121865SAdrian Maldonado 
161524121865SAdrian Maldonado   /* Create maps for vertices and edges */
1616daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1617daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
161824121865SAdrian Maldonado 
161924121865SAdrian Maldonado   /* Create local sub-sections */
1620daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1621daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
162224121865SAdrian Maldonado 
16239852e123SBarry Smith   if (size > 1) {
16249566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
162522bbedd7SHong Zhang 
16269566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
16279566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
16289566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
162924121865SAdrian Maldonado   } else {
163024121865SAdrian Maldonado     /* create structures for vertex */
16319566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
163224121865SAdrian Maldonado     /* create structures for edge */
16339566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
163424121865SAdrian Maldonado   }
163524121865SAdrian Maldonado 
163624121865SAdrian Maldonado   /* Add viewers */
16379566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
16389566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
16399566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
16409566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
16413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
164224121865SAdrian Maldonado }
16437b6afd5bSHong Zhang 
1644f11a936eSBarry Smith /*
16455c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
16465c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1647f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1648f11a936eSBarry Smith */
1649d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1650d71ae5a4SJacob Faibussowitsch {
1651f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1652f11a936eSBarry Smith   const PetscInt          *edges;
1653f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1654f11a936eSBarry Smith   DMNetworkComponentHeader header;
1655f11a936eSBarry Smith 
1656f11a936eSBarry Smith   PetscFunctionBegin;
16579566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
16589566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1659f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
16609566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1661f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16629566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1663f11a936eSBarry Smith   }
16643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1665f11a936eSBarry Smith }
1666f11a936eSBarry Smith 
16678afb7921SAidan Hamilton /*
16688afb7921SAidan Hamilton   DMNetworkDistributeCoordinates - Internal function to distribute the coordinate network and coordinates.
16698afb7921SAidan Hamilton 
16708afb7921SAidan Hamilton   Collective
16718afb7921SAidan Hamilton 
16728afb7921SAidan Hamilton   Input Parameters:
167320f4b53cSBarry Smith   + dm - The original `DMNETWORK` object
1674*aaa8cc7dSPierre Jolivet   - migrationSF - The `PetscSF` describing the migration from dm to dmnew
16758afb7921SAidan Hamilton   - newDM - The new distributed dmnetwork object.
16768afb7921SAidan Hamilton */
16778afb7921SAidan Hamilton 
16788afb7921SAidan Hamilton static PetscErrorCode DMNetworkDistributeCoordinates(DM dm, PetscSF migrationSF, DM newDM)
16798afb7921SAidan Hamilton {
16808afb7921SAidan Hamilton   DM_Network              *newDMnetwork = (DM_Network *)((newDM)->data), *newCoordnetwork, *oldCoordnetwork;
16818afb7921SAidan Hamilton   DM                       cdm, newcdm;
16828afb7921SAidan Hamilton   PetscInt                 cdim, bs, p, pStart, pEnd, offset;
16838afb7921SAidan Hamilton   Vec                      oldCoord, newCoord;
16848afb7921SAidan Hamilton   DMNetworkComponentHeader header;
16858afb7921SAidan Hamilton   const char              *name;
16868afb7921SAidan Hamilton 
16878afb7921SAidan Hamilton   PetscFunctionBegin;
16888afb7921SAidan Hamilton   /* Distribute the coordinate network and coordinates */
16898afb7921SAidan Hamilton   PetscCall(DMGetCoordinateDim(dm, &cdim));
16908afb7921SAidan Hamilton   PetscCall(DMSetCoordinateDim(newDM, cdim));
16918afb7921SAidan Hamilton 
16928afb7921SAidan Hamilton   /* Migrate only if original network had coordinates */
16938afb7921SAidan Hamilton   PetscCall(DMGetCoordinatesLocal(dm, &oldCoord));
16948afb7921SAidan Hamilton   if (oldCoord) {
16958afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(dm, &cdm));
16968afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(newDM, &newcdm));
16978afb7921SAidan Hamilton     newCoordnetwork = (DM_Network *)newcdm->data;
16988afb7921SAidan Hamilton     oldCoordnetwork = (DM_Network *)cdm->data;
16998afb7921SAidan Hamilton 
17008afb7921SAidan Hamilton     PetscCall(VecCreate(PETSC_COMM_SELF, &newCoord));
17018afb7921SAidan Hamilton     PetscCall(PetscObjectGetName((PetscObject)oldCoord, &name));
17028afb7921SAidan Hamilton     PetscCall(PetscObjectSetName((PetscObject)newCoord, name));
17038afb7921SAidan Hamilton     PetscCall(VecGetBlockSize(oldCoord, &bs));
17048afb7921SAidan Hamilton     PetscCall(VecSetBlockSize(newCoord, bs));
17058afb7921SAidan Hamilton 
17068afb7921SAidan Hamilton     PetscCall(DMPlexDistributeField(newDMnetwork->plex, migrationSF, oldCoordnetwork->DofSection, oldCoord, newCoordnetwork->DofSection, newCoord));
17078afb7921SAidan Hamilton     PetscCall(DMSetCoordinatesLocal(newDM, newCoord));
17088afb7921SAidan Hamilton 
17098afb7921SAidan Hamilton     PetscCall(VecDestroy(&newCoord));
1710*aaa8cc7dSPierre Jolivet     /* Migrate the components from the original coordinate network to the new coordinate network */
17118afb7921SAidan Hamilton     PetscCall(DMPlexDistributeData(newDMnetwork->plex, migrationSF, oldCoordnetwork->DataSection, MPIU_INT, (void *)oldCoordnetwork->componentdataarray, newCoordnetwork->DataSection, (void **)&newCoordnetwork->componentdataarray));
17128afb7921SAidan Hamilton     /* update the header pointers in the new coordinate network components */
17138afb7921SAidan Hamilton     PetscCall(PetscSectionGetChart(newCoordnetwork->DataSection, &pStart, &pEnd));
17148afb7921SAidan Hamilton     for (p = pStart; p < pEnd; p++) {
17158afb7921SAidan Hamilton       PetscCall(PetscSectionGetOffset(newCoordnetwork->DataSection, p, &offset));
17168afb7921SAidan Hamilton       header = (DMNetworkComponentHeader)(newCoordnetwork->componentdataarray + offset);
17178afb7921SAidan Hamilton       /* Update pointers */
17188afb7921SAidan Hamilton       header->size         = (PetscInt *)(header + 1);
17198afb7921SAidan Hamilton       header->key          = header->size + header->maxcomps;
17208afb7921SAidan Hamilton       header->offset       = header->key + header->maxcomps;
17218afb7921SAidan Hamilton       header->nvar         = header->offset + header->maxcomps;
17228afb7921SAidan Hamilton       header->offsetvarrel = header->nvar + header->maxcomps;
17238afb7921SAidan Hamilton     }
17248afb7921SAidan Hamilton 
17258afb7921SAidan Hamilton     PetscCall(DMSetLocalSection(newCoordnetwork->plex, newCoordnetwork->DofSection));
17268afb7921SAidan Hamilton     PetscCall(DMGetGlobalSection(newCoordnetwork->plex, &newCoordnetwork->GlobalDofSection));
17278afb7921SAidan Hamilton     newCoordnetwork->componentsetup = PETSC_TRUE;
17288afb7921SAidan Hamilton   }
17293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17308afb7921SAidan Hamilton }
17318afb7921SAidan Hamilton 
17325f2c45f1SShri Abhyankar /*@
17332bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
17345f2c45f1SShri Abhyankar 
17355f2c45f1SShri Abhyankar   Collective
17365f2c45f1SShri Abhyankar 
1737d8d19677SJose E. Roman   Input Parameters:
173820f4b53cSBarry Smith + DM - the `DMNETWORK` object
17392bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
17405f2c45f1SShri Abhyankar 
174120f4b53cSBarry Smith   Options Database Keys:
17426e4289a0SDuncan Campbell + -dmnetwork_view - Calls `DMView()` at the conclusion of `DMSetUp()`
17436e4289a0SDuncan Campbell . -dmnetwork_view_distributed - Calls `DMView()` at the conclusion of `DMNetworkDistribute()`
17446e4289a0SDuncan Campbell - -dmnetwork_view_tmpdir - Sets the temporary directory to use when viewing with the `draw` option
17455b3f975aSHong Zhang 
17465f2c45f1SShri Abhyankar   Level: intermediate
17475f2c45f1SShri Abhyankar 
174820f4b53cSBarry Smith   Note:
174920f4b53cSBarry Smith   Distributes the network with <overlap>-overlapping partitioning of the edges.
175020f4b53cSBarry Smith 
175120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`
17525f2c45f1SShri Abhyankar @*/
1753d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1754d71ae5a4SJacob Faibussowitsch {
1755d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1756d3464fd4SAdrian Maldonado   PetscMPIInt              size;
17578afb7921SAidan Hamilton   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data), *newDMnetwork;
1758caf410d2SHong Zhang   PetscSF                  pointsf      = NULL;
17595f2c45f1SShri Abhyankar   DM                       newDM;
17608afb7921SAidan Hamilton   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv, net;
17618afb7921SAidan Hamilton   PetscInt                *sv;
1762f11a936eSBarry Smith   PetscBT                  btable;
176351ac5effSHong Zhang   PetscPartitioner         part;
1764b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
17655f2c45f1SShri Abhyankar 
17665f2c45f1SShri Abhyankar   PetscFunctionBegin;
17675c6496baSHong Zhang   PetscValidPointer(dm, 1);
17685c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
17699566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
17709566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1771a9750deaSHong Zhang   if (size == 1) {
1772a9750deaSHong Zhang     oldDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1773a9750deaSHong Zhang     PetscFunctionReturn(PETSC_SUCCESS);
1774a9750deaSHong Zhang   }
1775d3464fd4SAdrian Maldonado 
17765c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
17775b3f975aSHong Zhang 
17782bf73ac6SHong Zhang   /* This routine moves the component data to the appropriate processors. It makes use of the DataSection and the componentdataarray to move the component data to appropriate processors and returns a new DataSection and new componentdataarray. */
1779e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
17809566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
17815f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
178254dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
17839566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
178451ac5effSHong Zhang 
178551ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
17869566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
17879566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
178851ac5effSHong Zhang 
17892bf73ac6SHong Zhang   /* Distribute plex dm */
17909566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
179151ac5effSHong Zhang 
17925f2c45f1SShri Abhyankar   /* Distribute dof section */
17939566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
17949566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
179551ac5effSHong Zhang 
17965f2c45f1SShri Abhyankar   /* Distribute data and associated section */
17979566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
17989566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
179924121865SAdrian Maldonado 
1800daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1801daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1802daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1803daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1804daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1805daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1806daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1807daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1808daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
180924121865SAdrian Maldonado 
18101bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
18119566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
18129566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
18135f2c45f1SShri Abhyankar 
1814b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1815daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1816daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1817daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1818daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1819daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1820daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
18212bf73ac6SHong Zhang 
18222bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
18232bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1824b9c6e19dSShri Abhyankar   */
1825daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1826f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1827daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1828daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1829b9c6e19dSShri Abhyankar   }
1830b9c6e19dSShri Abhyankar 
1831f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1832daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18339566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
183454dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18355c6496baSHong Zhang 
183654dfd506SHong Zhang     /* Update pointers */
183754dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
183854dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
183954dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
184054dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
184154dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
184254dfd506SHong Zhang 
1843daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1844b9c6e19dSShri Abhyankar   }
1845b9c6e19dSShri Abhyankar 
18465c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
184748a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
18485c6496baSHong Zhang 
18495c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1850daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
18519566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
18525f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18535c6496baSHong Zhang 
185454dfd506SHong Zhang     /* Update pointers */
185554dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
185654dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
185754dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
185854dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
185954dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
186054dfd506SHong Zhang 
18612bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
18622bf73ac6SHong Zhang     gidx = header->index;
1863eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, gidx + 1, 0, &svtx_idx));
18642bf73ac6SHong Zhang     svtx_idx--;
18652bf73ac6SHong Zhang 
18662bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1867daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
18682bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
18695c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
18709566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1871f11a936eSBarry Smith 
1872daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1873daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
18745c6496baSHong Zhang         net = sv[0];
187535cb6cd3SPierre Jolivet         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this process */
18762bf73ac6SHong Zhang       }
18772bf73ac6SHong Zhang     }
1878b9c6e19dSShri Abhyankar   }
1879b9c6e19dSShri Abhyankar 
18802bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
18812bf73ac6SHong Zhang   nv = 0;
1882daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1883daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1884caf410d2SHong Zhang 
18852bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1886daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1887daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1888daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1889daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1890daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1891daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
18922bf73ac6SHong Zhang 
1893daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1894daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1895caf410d2SHong Zhang 
18962bf73ac6SHong Zhang     /* Temporarily setting nvtx and nedge to 0 so we can use them as counters in the below for loop. These get updated when the vertices and edges are added. */
1897daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1898b9c6e19dSShri Abhyankar   }
1899daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1900b9c6e19dSShri Abhyankar 
19012bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1902daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
19039566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
19045f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1905daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1906b9c6e19dSShri Abhyankar   }
1907b9c6e19dSShri Abhyankar 
19082bf73ac6SHong Zhang   nv = 0;
1909daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
19109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
19115f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
19122bf73ac6SHong Zhang 
19132bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1914eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, header->index + 1, 0, &svtx_idx));
19152bf73ac6SHong Zhang     svtx_idx--;
19162bf73ac6SHong Zhang     if (svtx_idx < 0) {
1917daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
19182bf73ac6SHong Zhang     } else { /* a shared vertex */
1919daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
19202bf73ac6SHong Zhang 
19215c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
19229566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1923f11a936eSBarry Smith 
1924daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1925daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
19265c6496baSHong Zhang         net = sv[0];
19279371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1928b9c6e19dSShri Abhyankar       }
19292bf73ac6SHong Zhang     }
19302bf73ac6SHong Zhang   }
1931daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1932b9c6e19dSShri Abhyankar 
19338afb7921SAidan Hamilton   PetscCall(DMNetworkDistributeCoordinates(*dm, pointsf, newDM));
1934caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1935daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1936caf410d2SHong Zhang 
19372bf73ac6SHong Zhang   /* Free spaces */
19389566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
19399566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
194048a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
19412bf73ac6SHong Zhang 
19425b3f975aSHong Zhang   /* View distributed dmnetwork */
19439566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
19445b3f975aSHong Zhang 
1945d3464fd4SAdrian Maldonado   *dm = newDM;
1946e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
19473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19485f2c45f1SShri Abhyankar }
19495f2c45f1SShri Abhyankar 
195024121865SAdrian Maldonado /*@C
195120f4b53cSBarry Smith   PetscSFGetSubSF - Returns an `PetscSF` for a specific subset of points. Leaves are re-numbered to reflect the new ordering
19522bf73ac6SHong Zhang 
19532bf73ac6SHong Zhang  Collective
195424121865SAdrian Maldonado 
195524121865SAdrian Maldonado   Input Parameters:
195620f4b53cSBarry Smith + mainSF - `PetscSF` structure
195720f4b53cSBarry Smith - map - a `ISLocalToGlobalMapping` that contains the subset of points
195824121865SAdrian Maldonado 
195997bb3fdcSJose E. Roman   Output Parameter:
196020f4b53cSBarry Smith . subSF - a subset of the `mainSF` for the desired subset.
1961ee300463SSatish Balay 
1962ee300463SSatish Balay   Level: intermediate
196320f4b53cSBarry Smith 
196420f4b53cSBarry Smith .seealso: `PetscSF`
19657d928bffSSatish Balay @*/
1966d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1967d71ae5a4SJacob Faibussowitsch {
196824121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
196924121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
197024121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
197124121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
197224121865SAdrian Maldonado   const PetscInt    *ilocal;
197324121865SAdrian Maldonado   const PetscSFNode *iremote;
197424121865SAdrian Maldonado 
197524121865SAdrian Maldonado   PetscFunctionBegin;
19769566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
197724121865SAdrian Maldonado 
197824121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
19799566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
19809566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
198124121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
198224121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
198324121865SAdrian Maldonado   }
198424121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
19859566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
198624121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
19879566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
19889566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
19899566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
199024121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
19919566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
19929566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
199324121865SAdrian Maldonado   nleaves_sub = 0;
199424121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
199524121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
199624121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
19974b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
199824121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
199924121865SAdrian Maldonado       nleaves_sub += 1;
200024121865SAdrian Maldonado     }
200124121865SAdrian Maldonado   }
20029566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
20039566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
200424121865SAdrian Maldonado 
200524121865SAdrian Maldonado   /* Create new subSF */
20069566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(PETSC_COMM_WORLD, subSF));
20079566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
20089566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
20099566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
20109566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
20113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
201224121865SAdrian Maldonado }
201324121865SAdrian Maldonado 
20145f2c45f1SShri Abhyankar /*@C
20155f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
20165f2c45f1SShri Abhyankar 
20175f2c45f1SShri Abhyankar   Not Collective
20185f2c45f1SShri Abhyankar 
20195f2c45f1SShri Abhyankar   Input Parameters:
202020f4b53cSBarry Smith + dm - the `DMNETWORK` object
20215f2c45f1SShri Abhyankar - p  - the vertex point
20225f2c45f1SShri Abhyankar 
2023fd292e60Sprj-   Output Parameters:
20245f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
20252bf73ac6SHong Zhang - edges  - list of edge points
20265f2c45f1SShri Abhyankar 
202797bb938eSShri Abhyankar   Level: beginner
20285f2c45f1SShri Abhyankar 
202920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
20305f2c45f1SShri Abhyankar @*/
2031d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[])
2032d71ae5a4SJacob Faibussowitsch {
20335f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20345f2c45f1SShri Abhyankar 
20355f2c45f1SShri Abhyankar   PetscFunctionBegin;
20369566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
20379566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
20383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20395f2c45f1SShri Abhyankar }
20405f2c45f1SShri Abhyankar 
20415f2c45f1SShri Abhyankar /*@C
2042d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
20435f2c45f1SShri Abhyankar 
20445f2c45f1SShri Abhyankar   Not Collective
20455f2c45f1SShri Abhyankar 
20465f2c45f1SShri Abhyankar   Input Parameters:
204720f4b53cSBarry Smith + dm - the `DMNETWORK` object
20485f2c45f1SShri Abhyankar - p - the edge point
20495f2c45f1SShri Abhyankar 
20502fe279fdSBarry Smith   Output Parameter:
20515f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
20525f2c45f1SShri Abhyankar 
205397bb938eSShri Abhyankar   Level: beginner
20545f2c45f1SShri Abhyankar 
205520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
20565f2c45f1SShri Abhyankar @*/
2057d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
2058d71ae5a4SJacob Faibussowitsch {
20595f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20605f2c45f1SShri Abhyankar 
20615f2c45f1SShri Abhyankar   PetscFunctionBegin;
20629566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
20633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20645f2c45f1SShri Abhyankar }
20655f2c45f1SShri Abhyankar 
20665f2c45f1SShri Abhyankar /*@
206720f4b53cSBarry Smith   DMNetworkIsSharedVertex - Returns `PETSC_TRUE` if the vertex is shared by subnetworks
20682bf73ac6SHong Zhang 
20692bf73ac6SHong Zhang   Not Collective
20702bf73ac6SHong Zhang 
20712bf73ac6SHong Zhang   Input Parameters:
207220f4b53cSBarry Smith + dm - the `DMNETWORK` object
20732bf73ac6SHong Zhang - p - the vertex point
20742bf73ac6SHong Zhang 
20752bf73ac6SHong Zhang   Output Parameter:
207620f4b53cSBarry Smith . flag - `PETSC_TRUE` if the vertex is shared by subnetworks
20772bf73ac6SHong Zhang 
20782bf73ac6SHong Zhang   Level: beginner
20792bf73ac6SHong Zhang 
208020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
20812bf73ac6SHong Zhang @*/
2082d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
2083d71ae5a4SJacob Faibussowitsch {
20842bf73ac6SHong Zhang   PetscFunctionBegin;
2085eec179cfSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2086eec179cfSJacob Faibussowitsch   PetscValidBoolPointer(flag, 3);
20872bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
20882bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
20892bf73ac6SHong Zhang     PetscInt    gidx;
2090eec179cfSJacob Faibussowitsch 
20919566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
2092eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIHas(network->cloneshared->svtable, gidx + 1, flag));
20932bf73ac6SHong Zhang   } else { /* would be removed? */
20942bf73ac6SHong Zhang     PetscInt        nv;
20952bf73ac6SHong Zhang     const PetscInt *vtx;
2096eec179cfSJacob Faibussowitsch 
20979566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
2098eec179cfSJacob Faibussowitsch     for (PetscInt i = 0; i < nv; i++) {
20992bf73ac6SHong Zhang       if (p == vtx[i]) {
21002bf73ac6SHong Zhang         *flag = PETSC_TRUE;
21013ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
21022bf73ac6SHong Zhang       }
21032bf73ac6SHong Zhang     }
2104eec179cfSJacob Faibussowitsch     *flag = PETSC_FALSE;
21052bf73ac6SHong Zhang   }
21063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21072bf73ac6SHong Zhang }
21082bf73ac6SHong Zhang 
21092bf73ac6SHong Zhang /*@
211020f4b53cSBarry Smith   DMNetworkIsGhostVertex - Returns `PETSC_TRUE` if the vertex is a ghost vertex
21115f2c45f1SShri Abhyankar 
21125f2c45f1SShri Abhyankar   Not Collective
21135f2c45f1SShri Abhyankar 
21145f2c45f1SShri Abhyankar   Input Parameters:
211520f4b53cSBarry Smith + dm - the `DMNETWORK` object
2116a2b725a8SWilliam Gropp - p - the vertex point
21175f2c45f1SShri Abhyankar 
21185f2c45f1SShri Abhyankar   Output Parameter:
211920f4b53cSBarry Smith . isghost - `PETSC_TRUE` if the vertex is a ghost point
21205f2c45f1SShri Abhyankar 
212197bb938eSShri Abhyankar   Level: beginner
21225f2c45f1SShri Abhyankar 
212320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
21245f2c45f1SShri Abhyankar @*/
2125d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
2126d71ae5a4SJacob Faibussowitsch {
21275f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
21285f2c45f1SShri Abhyankar   PetscInt     offsetg;
21295f2c45f1SShri Abhyankar   PetscSection sectiong;
21305f2c45f1SShri Abhyankar 
21315f2c45f1SShri Abhyankar   PetscFunctionBegin;
21325f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
21339566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
21349566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
21355f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
21363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21375f2c45f1SShri Abhyankar }
21385f2c45f1SShri Abhyankar 
2139d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
2140d71ae5a4SJacob Faibussowitsch {
21415f2c45f1SShri Abhyankar   PetscFunctionBegin;
2142e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2143daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
21445b3f975aSHong Zhang   /* View dmnetwork */
21459566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2146e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
21473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21485f2c45f1SShri Abhyankar }
21495f2c45f1SShri Abhyankar 
21501ad426b7SHong Zhang /*@
215117df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
215220f4b53cSBarry Smith       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TRUE)?
21531ad426b7SHong Zhang 
21541ad426b7SHong Zhang   Collective
21551ad426b7SHong Zhang 
21561ad426b7SHong Zhang   Input Parameters:
215720f4b53cSBarry Smith + dm - the `DMNETWORK` object
215820f4b53cSBarry Smith . eflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for edges
215920f4b53cSBarry Smith - vflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for vertices
21601ad426b7SHong Zhang 
21611ad426b7SHong Zhang  Level: intermediate
21621ad426b7SHong Zhang 
21631ad426b7SHong Zhang @*/
2164d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2165d71ae5a4SJacob Faibussowitsch {
21661ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2167daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
21681ad426b7SHong Zhang 
21691ad426b7SHong Zhang   PetscFunctionBegin;
217083b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
217183b2e829SHong Zhang   network->userVertexJacobian = vflg;
21728675203cSHong Zhang 
217348a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
21748675203cSHong Zhang 
217566b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2176daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
217766b4e0ffSHong Zhang     PetscInt        nedges_total;
21788675203cSHong Zhang     const PetscInt *edges;
21798675203cSHong Zhang 
21808675203cSHong Zhang     /* count nvertex_total */
21818675203cSHong Zhang     nedges_total = 0;
21829566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
21838675203cSHong Zhang 
21848675203cSHong Zhang     vptr[0] = 0;
21858675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
21869566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
21878675203cSHong Zhang       nedges_total += nedges;
21888675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
21898675203cSHong Zhang     }
21908675203cSHong Zhang 
21919566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
21928675203cSHong Zhang     network->Jvptr = vptr;
21938675203cSHong Zhang   }
21943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21951ad426b7SHong Zhang }
21961ad426b7SHong Zhang 
21971ad426b7SHong Zhang /*@
219883b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
219983b2e829SHong Zhang 
220083b2e829SHong Zhang   Not Collective
220183b2e829SHong Zhang 
220283b2e829SHong Zhang   Input Parameters:
220320f4b53cSBarry Smith + dm - the `DMNETWORK` object
220483b2e829SHong Zhang . p - the edge point
22053e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
22063e97b6e8SHong Zhang         J[0]: this edge
220720f4b53cSBarry Smith         J[1] and J[2]: connected vertices, obtained by calling `DMNetworkGetConnectedVertices()`
220883b2e829SHong Zhang 
220997bb938eSShri Abhyankar   Level: advanced
221083b2e829SHong Zhang 
221120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkVertexSetMatrix()`
221283b2e829SHong Zhang @*/
2213d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2214d71ae5a4SJacob Faibussowitsch {
221583b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
221683b2e829SHong Zhang 
221783b2e829SHong Zhang   PetscFunctionBegin;
22185c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
22198675203cSHong Zhang 
22208675203cSHong Zhang   if (J) {
2221883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2222883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2223883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
22248675203cSHong Zhang   }
22253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
222683b2e829SHong Zhang }
222783b2e829SHong Zhang 
222883b2e829SHong Zhang /*@
222976ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
22301ad426b7SHong Zhang 
22311ad426b7SHong Zhang   Not Collective
22321ad426b7SHong Zhang 
22331ad426b7SHong Zhang   Input Parameters:
223420f4b53cSBarry Smith + dm - The `DMNETWORK` object
22351ad426b7SHong Zhang . p - the vertex point
22363e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
22373e97b6e8SHong Zhang         J[0]:       this vertex
22383e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
22393e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
22401ad426b7SHong Zhang 
224197bb938eSShri Abhyankar   Level: advanced
22421ad426b7SHong Zhang 
224320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkEdgeSetMatrix()`
22441ad426b7SHong Zhang @*/
2245d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2246d71ae5a4SJacob Faibussowitsch {
22475f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2248daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2249883e35e8SHong Zhang   const PetscInt *edges;
22505f2c45f1SShri Abhyankar 
22515f2c45f1SShri Abhyankar   PetscFunctionBegin;
22525c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2253883e35e8SHong Zhang 
22548675203cSHong Zhang   if (J) {
2255883e35e8SHong Zhang     vptr                          = network->Jvptr;
22563e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
22573e97b6e8SHong Zhang 
22583e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
22599566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2260883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
22618675203cSHong Zhang   }
22623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2263883e35e8SHong Zhang }
2264883e35e8SHong Zhang 
2265d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2266d71ae5a4SJacob Faibussowitsch {
22675cf7da58SHong Zhang   PetscInt    j;
22685cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
22695cf7da58SHong Zhang 
22705cf7da58SHong Zhang   PetscFunctionBegin;
22715cf7da58SHong Zhang   if (!ghost) {
227248a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22735cf7da58SHong Zhang   } else {
227448a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22755cf7da58SHong Zhang   }
22763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22775cf7da58SHong Zhang }
22785cf7da58SHong Zhang 
2279d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2280d71ae5a4SJacob Faibussowitsch {
22815cf7da58SHong Zhang   PetscInt    j, ncols_u;
22825cf7da58SHong Zhang   PetscScalar val;
22835cf7da58SHong Zhang 
22845cf7da58SHong Zhang   PetscFunctionBegin;
22855cf7da58SHong Zhang   if (!ghost) {
22865cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22879566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22885cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22899566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22909566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22915cf7da58SHong Zhang     }
22925cf7da58SHong Zhang   } else {
22935cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22949566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22955cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22969566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22979566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22985cf7da58SHong Zhang     }
22995cf7da58SHong Zhang   }
23003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23015cf7da58SHong Zhang }
23025cf7da58SHong Zhang 
2303d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2304d71ae5a4SJacob Faibussowitsch {
23055cf7da58SHong Zhang   PetscFunctionBegin;
23065cf7da58SHong Zhang   if (Ju) {
23079566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
23085cf7da58SHong Zhang   } else {
23099566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
23105cf7da58SHong Zhang   }
23113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23125cf7da58SHong Zhang }
23135cf7da58SHong Zhang 
2314d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2315d71ae5a4SJacob Faibussowitsch {
2316883e35e8SHong Zhang   PetscInt     j, *cols;
2317883e35e8SHong Zhang   PetscScalar *zeros;
2318883e35e8SHong Zhang 
2319883e35e8SHong Zhang   PetscFunctionBegin;
23209566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2321883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
23229566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
23239566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
23243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23251ad426b7SHong Zhang }
2326a4e85ca8SHong Zhang 
2327d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2328d71ae5a4SJacob Faibussowitsch {
23293e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
23303e97b6e8SHong Zhang   const PetscInt *cols;
23313e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
23323e97b6e8SHong Zhang 
23333e97b6e8SHong Zhang   PetscFunctionBegin;
23349566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
233563a3b9bcSJacob Faibussowitsch   PetscCheck(nrows == M && ncols == N, PetscObjectComm((PetscObject)Ju), PETSC_ERR_USER, "%" PetscInt_FMT " by %" PetscInt_FMT " must equal %" PetscInt_FMT " by %" PetscInt_FMT, nrows, ncols, M, N);
23363e97b6e8SHong Zhang 
23373e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
23389566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
23393e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
23403e97b6e8SHong Zhang       col = cols[j] + cstart;
23419566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
23423e97b6e8SHong Zhang     }
23439566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
23443e97b6e8SHong Zhang   }
23453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23463e97b6e8SHong Zhang }
23471ad426b7SHong Zhang 
2348d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2349d71ae5a4SJacob Faibussowitsch {
2350a4e85ca8SHong Zhang   PetscFunctionBegin;
2351a4e85ca8SHong Zhang   if (Ju) {
23529566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2353a4e85ca8SHong Zhang   } else {
23549566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2355a4e85ca8SHong Zhang   }
23563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2357a4e85ca8SHong Zhang }
2358a4e85ca8SHong Zhang 
235924121865SAdrian Maldonado /* Creates a GlobalToLocal mapping with a Local and Global section. This is akin to the routine DMGetLocalToGlobalMapping but without the need of providing a dm.
236024121865SAdrian Maldonado */
2361d71ae5a4SJacob Faibussowitsch PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2362d71ae5a4SJacob Faibussowitsch {
236324121865SAdrian Maldonado   PetscInt  i, size, dof;
236424121865SAdrian Maldonado   PetscInt *glob2loc;
236524121865SAdrian Maldonado 
236624121865SAdrian Maldonado   PetscFunctionBegin;
23679566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
23689566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
236924121865SAdrian Maldonado 
237024121865SAdrian Maldonado   for (i = 0; i < size; i++) {
23719566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
237224121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
237324121865SAdrian Maldonado     glob2loc[i] = dof;
237424121865SAdrian Maldonado   }
237524121865SAdrian Maldonado 
23769566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
237724121865SAdrian Maldonado #if 0
23789566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
237924121865SAdrian Maldonado #endif
23803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
238124121865SAdrian Maldonado }
238224121865SAdrian Maldonado 
238301ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
23849e1d080bSHong Zhang 
2385d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2386d71ae5a4SJacob Faibussowitsch {
23871ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
238824121865SAdrian Maldonado   PetscInt               eDof, vDof;
238924121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
23909e1d080bSHong Zhang   MPI_Comm               comm;
239124121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
239224121865SAdrian Maldonado 
23939e1d080bSHong Zhang   PetscFunctionBegin;
23949566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
239524121865SAdrian Maldonado 
23969566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
23979566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
239824121865SAdrian Maldonado 
23999566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
24009566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24019566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
240224121865SAdrian Maldonado 
24039566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
24049566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24059566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
240624121865SAdrian Maldonado 
24079566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
24089566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24099566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
241024121865SAdrian Maldonado 
24119566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
24129566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24139566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
241424121865SAdrian Maldonado 
24153f6a6bdaSHong Zhang   bA[0][0] = j11;
24163f6a6bdaSHong Zhang   bA[0][1] = j12;
24173f6a6bdaSHong Zhang   bA[1][0] = j21;
24183f6a6bdaSHong Zhang   bA[1][1] = j22;
241924121865SAdrian Maldonado 
24209566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
24219566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
242224121865SAdrian Maldonado 
24239566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
24249566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
24259566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
24269566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
242724121865SAdrian Maldonado 
24289566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
24299566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
24309566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
24319566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
243224121865SAdrian Maldonado 
24339566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
24349566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
24359566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
24369566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
24379566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
24389566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
24399566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
244024121865SAdrian Maldonado 
24419566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
24429566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
24439566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
244424121865SAdrian Maldonado 
244524121865SAdrian Maldonado   /* Free structures */
24469566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
24479566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
24483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24499e1d080bSHong Zhang }
24509e1d080bSHong Zhang 
2451d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2452d71ae5a4SJacob Faibussowitsch {
24539e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
24549e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
24559e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
24569e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
24579e1d080bSHong Zhang   Mat             Juser;
24589e1d080bSHong Zhang   PetscSection    sectionGlobal;
24599e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
24609e1d080bSHong Zhang   const PetscInt *edges, *cone;
24619e1d080bSHong Zhang   MPI_Comm        comm;
24629e1d080bSHong Zhang   MatType         mtype;
24639e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
24649e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
24659e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
24669e1d080bSHong Zhang 
24679e1d080bSHong Zhang   PetscFunctionBegin;
24689e1d080bSHong Zhang   mtype = dm->mattype;
24699566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
24709e1d080bSHong Zhang   if (isNest) {
24719566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
24729566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24733ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24749e1d080bSHong Zhang   }
24759e1d080bSHong Zhang 
24769e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2477a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
24789566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
24799566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24803ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24811ad426b7SHong Zhang   }
24821ad426b7SHong Zhang 
24839566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
24849566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
24859566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
24869566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
24872a945128SHong Zhang 
24889566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
24899566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
249089898e50SHong Zhang 
249189898e50SHong Zhang   /* (1) Set matrix preallocation */
249289898e50SHong Zhang   /*------------------------------*/
24939566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
24949566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
24959566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
24969566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
24979566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
24989566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2499840c2264SHong Zhang 
250089898e50SHong Zhang   /* Set preallocation for edges */
250189898e50SHong Zhang   /*-----------------------------*/
25029566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2503840c2264SHong Zhang 
25049566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2505840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2506840c2264SHong Zhang     /* Get row indices */
25079566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
25089566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2509840c2264SHong Zhang     if (nrows) {
2510840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2511840c2264SHong Zhang 
2512a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
25139566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2514840c2264SHong Zhang       for (v = 0; v < 2; v++) {
25159566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2516840c2264SHong Zhang 
25178675203cSHong Zhang         if (network->Je) {
2518840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
25198675203cSHong Zhang         } else Juser = NULL;
25209566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
25219566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2522840c2264SHong Zhang       }
2523840c2264SHong Zhang 
252489898e50SHong Zhang       /* Set preallocation for edge self */
2525840c2264SHong Zhang       cstart = rstart;
25268675203cSHong Zhang       if (network->Je) {
2527840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25288675203cSHong Zhang       } else Juser = NULL;
25299566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2530840c2264SHong Zhang     }
2531840c2264SHong Zhang   }
2532840c2264SHong Zhang 
253389898e50SHong Zhang   /* Set preallocation for vertices */
253489898e50SHong Zhang   /*--------------------------------*/
25359566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
25368675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2537840c2264SHong Zhang 
2538840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2539840c2264SHong Zhang     /* Get row indices */
25409566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25419566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2542840c2264SHong Zhang     if (!nrows) continue;
2543840c2264SHong Zhang 
25449566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2545bdcb62a2SHong Zhang     if (ghost) {
25469566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2547bdcb62a2SHong Zhang     } else {
2548bdcb62a2SHong Zhang       rows_v = rows;
2549bdcb62a2SHong Zhang     }
2550bdcb62a2SHong Zhang 
2551bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2552840c2264SHong Zhang 
2553840c2264SHong Zhang     /* Get supporting edges and connected vertices */
25549566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2555840c2264SHong Zhang 
2556840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2557840c2264SHong Zhang       /* Supporting edges */
25589566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25599566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2560840c2264SHong Zhang 
25618675203cSHong Zhang       if (network->Jv) {
2562840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25638675203cSHong Zhang       } else Juser = NULL;
25649566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2565840c2264SHong Zhang 
2566840c2264SHong Zhang       /* Connected vertices */
25679566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2568840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25699566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2570840c2264SHong Zhang 
25719566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2572840c2264SHong Zhang 
25738675203cSHong Zhang       if (network->Jv) {
2574840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25758675203cSHong Zhang       } else Juser = NULL;
2576e102a522SHong Zhang       if (ghost_vc || ghost) {
2577e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2578e102a522SHong Zhang       } else {
2579e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2580e102a522SHong Zhang       }
25819566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2582840c2264SHong Zhang     }
2583840c2264SHong Zhang 
258489898e50SHong Zhang     /* Set preallocation for vertex self */
25859566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2586840c2264SHong Zhang     if (!ghost) {
25879566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
25888675203cSHong Zhang       if (network->Jv) {
2589840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25908675203cSHong Zhang       } else Juser = NULL;
25919566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2592840c2264SHong Zhang     }
25931baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2594840c2264SHong Zhang   }
2595840c2264SHong Zhang 
25969566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
25979566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
25985cf7da58SHong Zhang 
25999566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
26005cf7da58SHong Zhang 
26019566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
26029566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2603840c2264SHong Zhang 
26049566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
26059566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2606840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2607e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2608e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2609840c2264SHong Zhang   }
26109566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
26119566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
26129566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
26139566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2614840c2264SHong Zhang 
26159566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
26169566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
26179566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
26185cf7da58SHong Zhang 
26199566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
26205cf7da58SHong Zhang 
262189898e50SHong Zhang   /* (2) Set matrix entries for edges */
262289898e50SHong Zhang   /*----------------------------------*/
26231ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2624bfbc38dcSHong Zhang     /* Get row indices */
26259566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
26269566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
26274b976069SHong Zhang     if (nrows) {
262817df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
26291ad426b7SHong Zhang 
2630a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
26319566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2632bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
26339566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
26349566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
26353e97b6e8SHong Zhang 
26368675203cSHong Zhang         if (network->Je) {
2637a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
26388675203cSHong Zhang         } else Juser = NULL;
26399566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2640bfbc38dcSHong Zhang       }
264117df6e9eSHong Zhang 
2642bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
26433e97b6e8SHong Zhang       cstart = rstart;
26448675203cSHong Zhang       if (network->Je) {
2645a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
26468675203cSHong Zhang       } else Juser = NULL;
26479566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
26481ad426b7SHong Zhang     }
26494b976069SHong Zhang   }
26501ad426b7SHong Zhang 
2651bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
265283b2e829SHong Zhang   /*---------------------------------*/
26531ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2654bfbc38dcSHong Zhang     /* Get row indices */
26559566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
26569566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
26574b976069SHong Zhang     if (!nrows) continue;
2658596e729fSHong Zhang 
26599566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2660bdcb62a2SHong Zhang     if (ghost) {
26619566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2662bdcb62a2SHong Zhang     } else {
2663bdcb62a2SHong Zhang       rows_v = rows;
2664bdcb62a2SHong Zhang     }
2665bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2666596e729fSHong Zhang 
2667bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
26689566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2669596e729fSHong Zhang 
2670596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2671bfbc38dcSHong Zhang       /* Supporting edges */
26729566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
26739566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2674596e729fSHong Zhang 
26758675203cSHong Zhang       if (network->Jv) {
2676a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
26778675203cSHong Zhang       } else Juser = NULL;
26789566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2679596e729fSHong Zhang 
2680bfbc38dcSHong Zhang       /* Connected vertices */
26819566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
26822a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
26832a945128SHong Zhang 
26849566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
26859566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2686a4e85ca8SHong Zhang 
26878675203cSHong Zhang       if (network->Jv) {
2688a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
26898675203cSHong Zhang       } else Juser = NULL;
26909566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2691596e729fSHong Zhang     }
2692596e729fSHong Zhang 
2693bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
26941ad426b7SHong Zhang     if (!ghost) {
26959566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
26968675203cSHong Zhang       if (network->Jv) {
2697a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
26988675203cSHong Zhang       } else Juser = NULL;
26999566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2700bdcb62a2SHong Zhang     }
27011baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
27021ad426b7SHong Zhang   }
27039566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2704bdcb62a2SHong Zhang 
27059566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
27069566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2707dd6f46cdSHong Zhang 
27089566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
27093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27105f2c45f1SShri Abhyankar }
27115f2c45f1SShri Abhyankar 
2712d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2713d71ae5a4SJacob Faibussowitsch {
2714daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2715daad07d3SAidan Hamilton   PetscInt    j, np;
2716daad07d3SAidan Hamilton 
2717daad07d3SAidan Hamilton   PetscFunctionBegin;
2718daad07d3SAidan Hamilton   if (network->header) {
2719daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2720daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2721daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2722daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2723daad07d3SAidan Hamilton     }
2724daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2725daad07d3SAidan Hamilton   }
27263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2727daad07d3SAidan Hamilton }
2728daad07d3SAidan Hamilton 
2729d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2730d71ae5a4SJacob Faibussowitsch {
27315f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2732aeb78aa7SBarry Smith   PetscInt    j;
27335f2c45f1SShri Abhyankar 
27345f2c45f1SShri Abhyankar   PetscFunctionBegin;
2735daad07d3SAidan Hamilton   /*
2736daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2737daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2738daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2739daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2740daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2741daad07d3SAidan Hamilton   */
2742daad07d3SAidan Hamilton 
2743daad07d3SAidan Hamilton   /* Always destroy data ON the network */
27449566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
274583b2e829SHong Zhang   if (network->Jv) {
27469566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
27479566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
27481ad426b7SHong Zhang   }
2749daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2750daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2751daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2752daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2753daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
275413c2a604SAdrian Maldonado 
2755daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2756daad07d3SAidan Hamilton 
2757daad07d3SAidan Hamilton   /*
2758daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2759daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2760daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2761daad07d3SAidan Hamilton     PetscSF                           sf;
2762daad07d3SAidan Hamilton   and data ON the network
2763daad07d3SAidan Hamilton     PetscSection                      DofSection;
2764daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2765daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2766daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2767daad07d3SAidan Hamilton   for any clone.
2768daad07d3SAidan Hamilton   */
27699566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
27709566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
27719566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
27729566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
277313c2a604SAdrian Maldonado   /* edge */
27749566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
27759566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
27769566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
27779566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2778daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2779daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2780daad07d3SAidan Hamilton     /* Developer Note: I'm not sure if vltog can be reused or not, as I'm not sure what it's purpose is. I
2781daad07d3SAidan Hamilton      naively think it can be reused. */
2782daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2783daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2784daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2785daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2786eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(&network->cloneshared->svtable));
2787daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2788daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2789daad07d3SAidan Hamilton   }
2790daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
27913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27925f2c45f1SShri Abhyankar }
27935f2c45f1SShri Abhyankar 
2794d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2795d71ae5a4SJacob Faibussowitsch {
27965f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27975f2c45f1SShri Abhyankar 
27985f2c45f1SShri Abhyankar   PetscFunctionBegin;
27999566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
28003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28015f2c45f1SShri Abhyankar }
28025f2c45f1SShri Abhyankar 
2803d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2804d71ae5a4SJacob Faibussowitsch {
28055f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28065f2c45f1SShri Abhyankar 
28075f2c45f1SShri Abhyankar   PetscFunctionBegin;
28089566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
28093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28105f2c45f1SShri Abhyankar }
28115f2c45f1SShri Abhyankar 
2812d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2813d71ae5a4SJacob Faibussowitsch {
28145f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28155f2c45f1SShri Abhyankar 
28165f2c45f1SShri Abhyankar   PetscFunctionBegin;
28179566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
28183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28195f2c45f1SShri Abhyankar }
28205f2c45f1SShri Abhyankar 
2821d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2822d71ae5a4SJacob Faibussowitsch {
28235f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28245f2c45f1SShri Abhyankar 
28255f2c45f1SShri Abhyankar   PetscFunctionBegin;
28269566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
28273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28285f2c45f1SShri Abhyankar }
282922bbedd7SHong Zhang 
283022bbedd7SHong Zhang /*@
283164238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
283222bbedd7SHong Zhang 
283320f4b53cSBarry Smith   Not Collective
283422bbedd7SHong Zhang 
28357a7aea1fSJed Brown   Input Parameters:
283620f4b53cSBarry Smith + dm - the `DMNETWORK` object
283722bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
283822bbedd7SHong Zhang 
28392fe279fdSBarry Smith   Output Parameter:
2840f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
284122bbedd7SHong Zhang 
284297bb938eSShri Abhyankar   Level: advanced
284322bbedd7SHong Zhang 
284420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetVertexLocalToGlobalOrdering()`
284522bbedd7SHong Zhang @*/
2846d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2847d71ae5a4SJacob Faibussowitsch {
284822bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2849daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
285022bbedd7SHong Zhang 
285122bbedd7SHong Zhang   PetscFunctionBegin;
28525c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
285322bbedd7SHong Zhang   *vg = vltog[vloc];
28543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
285522bbedd7SHong Zhang }
285622bbedd7SHong Zhang 
285722bbedd7SHong Zhang /*@
285864238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
285922bbedd7SHong Zhang 
286022bbedd7SHong Zhang   Collective
286122bbedd7SHong Zhang 
286222bbedd7SHong Zhang   Input Parameters:
286320f4b53cSBarry Smith . dm - the `DMNETWORK` object
286422bbedd7SHong Zhang 
286597bb938eSShri Abhyankar   Level: advanced
286622bbedd7SHong Zhang 
286720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
286822bbedd7SHong Zhang @*/
2869d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2870d71ae5a4SJacob Faibussowitsch {
287122bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
287222bbedd7SHong Zhang   MPI_Comm           comm;
28732bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
287422bbedd7SHong Zhang   PetscBool          ghost;
287563029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
287622bbedd7SHong Zhang   const PetscSFNode *iremote;
287722bbedd7SHong Zhang   PetscSF            vsf;
287863029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
287963029d29SHong Zhang   VecScatter         ctx;
288063029d29SHong Zhang   PetscScalar       *varr, val;
288163029d29SHong Zhang   const PetscScalar *varr_read;
288222bbedd7SHong Zhang 
288322bbedd7SHong Zhang   PetscFunctionBegin;
28849566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
28859566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
28869566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
288722bbedd7SHong Zhang 
288822bbedd7SHong Zhang   if (size == 1) {
2889daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
28909566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
289122bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2892daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
28933ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
289422bbedd7SHong Zhang   }
289522bbedd7SHong Zhang 
2896daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2897daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
289822bbedd7SHong Zhang 
2899daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
29009566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
290122bbedd7SHong Zhang   vsf = network->vertex.sf;
290222bbedd7SHong Zhang 
29039566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
29049566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
290522bbedd7SHong Zhang 
29069371c9d4SSatish Balay   for (i = 0; i < size; i++) {
29079371c9d4SSatish Balay     displs[i]     = i;
29089371c9d4SSatish Balay     recvcounts[i] = 1;
29099371c9d4SSatish Balay   }
291022bbedd7SHong Zhang 
291122bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
291222bbedd7SHong Zhang   vrange[0] = 0;
29139566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
2914ad540459SPierre Jolivet   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
291522bbedd7SHong Zhang 
29169566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2917daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
291822bbedd7SHong Zhang 
291963029d29SHong Zhang   /* Set vltog for non-ghost vertices */
292063029d29SHong Zhang   k = 0;
292122bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2922daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
292363029d29SHong Zhang     if (ghost) continue;
292463029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
292522bbedd7SHong Zhang   }
29269566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
292763029d29SHong Zhang 
292863029d29SHong Zhang   /* Set vltog for ghost vertices */
292963029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
29309566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
29319566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
29329566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
29339566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
293463029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
293563029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
293663029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
293763029d29SHong Zhang   }
29389566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
293963029d29SHong Zhang 
294063029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
29419566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
29429566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
29439566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
294463029d29SHong Zhang 
294563029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
29469566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
29479566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
294863029d29SHong Zhang   for (i = 0; i < N; i += 2) {
29492e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
295063029d29SHong Zhang     if (remoterank == rank) {
295163029d29SHong Zhang       k    = i + 1; /* row number */
29522e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
295363029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
29549566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
295563029d29SHong Zhang     }
295663029d29SHong Zhang   }
29579566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
29589566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
29599566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
296063029d29SHong Zhang 
296163029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
29629566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
296363029d29SHong Zhang   k = 0;
296463029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2965daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
296663029d29SHong Zhang     if (!ghost) continue;
29679371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
29689371c9d4SSatish Balay     k++;
296963029d29SHong Zhang   }
29709566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
297163029d29SHong Zhang 
29729566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
29739566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
29749566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
29753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297622bbedd7SHong Zhang }
297742dc13f1SHong Zhang 
2978d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2979d71ae5a4SJacob Faibussowitsch {
298042dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
298142dc13f1SHong Zhang   DMNetworkComponentHeader header;
298242dc13f1SHong Zhang 
298342dc13f1SHong Zhang   PetscFunctionBegin;
29849566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
298542dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
298642dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
298742dc13f1SHong Zhang 
298842dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
298942dc13f1SHong Zhang     key  = header->key[i];
299042dc13f1SHong Zhang     nvar = header->nvar[i];
299142dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
299242dc13f1SHong Zhang       if (key == keys[j]) {
299342dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
299442dc13f1SHong Zhang           *nidx += nvar;
299542dc13f1SHong Zhang         } else {
299642dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
299742dc13f1SHong Zhang         }
299842dc13f1SHong Zhang       }
299942dc13f1SHong Zhang     }
300042dc13f1SHong Zhang   }
30013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
300242dc13f1SHong Zhang }
300342dc13f1SHong Zhang 
3004d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3005d71ae5a4SJacob Faibussowitsch {
300642dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
300742dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
300842dc13f1SHong Zhang   DMNetworkComponentHeader header;
300942dc13f1SHong Zhang 
301042dc13f1SHong Zhang   PetscFunctionBegin;
30119566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
301242dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
301342dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
301442dc13f1SHong Zhang 
301542dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
301642dc13f1SHong Zhang     key  = header->key[i];
301742dc13f1SHong Zhang     nvar = header->nvar[i];
301842dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
301942dc13f1SHong Zhang       if (key != keys[j]) continue;
302042dc13f1SHong Zhang 
30219566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
302242dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
302342dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
302442dc13f1SHong Zhang       } else {
302542dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
302642dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
302742dc13f1SHong Zhang         }
302842dc13f1SHong Zhang       }
302942dc13f1SHong Zhang     }
303042dc13f1SHong Zhang   }
30313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
303242dc13f1SHong Zhang }
303342dc13f1SHong Zhang 
303442dc13f1SHong Zhang /*@
303542dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
303642dc13f1SHong Zhang 
303742dc13f1SHong Zhang   Collective
303842dc13f1SHong Zhang 
303942dc13f1SHong Zhang   Input Parameters:
304020f4b53cSBarry Smith + dm - `DMNETWORK` object
304142dc13f1SHong Zhang . numkeys - number of keys
304242dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
304342dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
304442dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
304542dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
304642dc13f1SHong Zhang 
30472fe279fdSBarry Smith   Output Parameter:
304842dc13f1SHong Zhang . is - the index set
304942dc13f1SHong Zhang 
305020f4b53cSBarry Smith   Level: advanced
305142dc13f1SHong Zhang 
305242dc13f1SHong Zhang   Notes:
305320f4b53cSBarry Smith     Use blocksize[i] of -1 to indicate select all the variables of the i-th component, for which nselectvar[i] and selectedvar[i] are ignored. Use` NULL`, `NULL`, `NULL` to indicate for all selected components one wishes to obtain all the values of that component. For example, `DMNetworkCreateIS`(dm,1,&key,NULL,NULL,NULL,&is) will return an is that extracts all the variables for the 0-th component.
305442dc13f1SHong Zhang 
305520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
305642dc13f1SHong Zhang @*/
3057d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3058d71ae5a4SJacob Faibussowitsch {
305942dc13f1SHong Zhang   MPI_Comm    comm;
306042dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
306142dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
306242dc13f1SHong Zhang   PetscBool   ghost;
306342dc13f1SHong Zhang 
306442dc13f1SHong Zhang   PetscFunctionBegin;
30659566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
306642dc13f1SHong Zhang 
306742dc13f1SHong Zhang   /* Check input parameters */
306842dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
306942dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
307063a3b9bcSJacob Faibussowitsch     PetscCheck(nselectedvar[i] <= blocksize[i], PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "number of selectedvariables %" PetscInt_FMT " cannot be larger than blocksize %" PetscInt_FMT, nselectedvar[i], blocksize[i]);
307142dc13f1SHong Zhang   }
307242dc13f1SHong Zhang 
30739566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
30749566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
307542dc13f1SHong Zhang 
307642dc13f1SHong Zhang   /* Get local number of idx */
307742dc13f1SHong Zhang   nidx = 0;
307848a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
307942dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30809566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
308142dc13f1SHong Zhang     if (ghost) continue;
30829566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
308342dc13f1SHong Zhang   }
308442dc13f1SHong Zhang 
308542dc13f1SHong Zhang   /* Compute idx */
30869566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
308742dc13f1SHong Zhang   i = 0;
308848a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
308942dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30909566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
309142dc13f1SHong Zhang     if (ghost) continue;
30929566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
309342dc13f1SHong Zhang   }
309442dc13f1SHong Zhang 
309542dc13f1SHong Zhang   /* Create is */
30969566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
30979566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
30983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
309942dc13f1SHong Zhang }
310042dc13f1SHong Zhang 
3101d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3102d71ae5a4SJacob Faibussowitsch {
310342dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
310442dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
310542dc13f1SHong Zhang   DMNetworkComponentHeader header;
310642dc13f1SHong Zhang 
310742dc13f1SHong Zhang   PetscFunctionBegin;
31089566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
310942dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
311042dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
311142dc13f1SHong Zhang 
311242dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
311342dc13f1SHong Zhang     key  = header->key[i];
311442dc13f1SHong Zhang     nvar = header->nvar[i];
311542dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
311642dc13f1SHong Zhang       if (key != keys[j]) continue;
311742dc13f1SHong Zhang 
31189566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
311942dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
312042dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
312142dc13f1SHong Zhang       } else {
312242dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
312342dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
312442dc13f1SHong Zhang         }
312542dc13f1SHong Zhang       }
312642dc13f1SHong Zhang     }
312742dc13f1SHong Zhang   }
31283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
312942dc13f1SHong Zhang }
313042dc13f1SHong Zhang 
313142dc13f1SHong Zhang /*@
313242dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
313342dc13f1SHong Zhang 
313420f4b53cSBarry Smith   Not Collective
313542dc13f1SHong Zhang 
313642dc13f1SHong Zhang   Input Parameters:
313720f4b53cSBarry Smith + dm - `DMNETWORK` object
313842dc13f1SHong Zhang . numkeys - number of keys
313942dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
314042dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
314142dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
314242dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
314342dc13f1SHong Zhang 
31442fe279fdSBarry Smith   Output Parameter:
314542dc13f1SHong Zhang . is - the index set
314642dc13f1SHong Zhang 
314720f4b53cSBarry Smith   Level: advanced
314842dc13f1SHong Zhang 
314942dc13f1SHong Zhang   Notes:
315020f4b53cSBarry Smith     Use blocksize[i] of -1 to indicate select all the variables of the i-th component, for which nselectvar[i] and selectedvar[i] are ignored. Use `NULL`, `NULL`, `NULL` to indicate for all selected components one wishes to obtain all the values of that component. For example, `DMNetworkCreateLocalIS`(dm,1,&key,`NULL`,`NULL`,`NULL`,&is) will return an is that extracts all the variables for the 0-th component.
315142dc13f1SHong Zhang 
315220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkCreateIS`, `ISCreateGeneral()`
315342dc13f1SHong Zhang @*/
3154d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3155d71ae5a4SJacob Faibussowitsch {
315642dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
315742dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
315842dc13f1SHong Zhang 
315942dc13f1SHong Zhang   PetscFunctionBegin;
316042dc13f1SHong Zhang   /* Check input parameters */
316142dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
316242dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
316363a3b9bcSJacob Faibussowitsch     PetscCheck(nselectedvar[i] <= blocksize[i], PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "number of selectedvariables %" PetscInt_FMT " cannot be larger than blocksize %" PetscInt_FMT, nselectedvar[i], blocksize[i]);
316442dc13f1SHong Zhang   }
316542dc13f1SHong Zhang 
3166daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3167daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
316842dc13f1SHong Zhang 
316942dc13f1SHong Zhang   /* Get local number of idx */
317042dc13f1SHong Zhang   nidx = 0;
317148a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
317242dc13f1SHong Zhang 
317342dc13f1SHong Zhang   /* Compute local idx */
31749566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
317542dc13f1SHong Zhang   i = 0;
317648a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
317742dc13f1SHong Zhang 
317842dc13f1SHong Zhang   /* Create is */
31799566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31809566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
318242dc13f1SHong Zhang }
3183daad07d3SAidan Hamilton /*@
3184d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3185daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3186daad07d3SAidan Hamilton 
3187daad07d3SAidan Hamilton   Collective
3188daad07d3SAidan Hamilton 
31892fe279fdSBarry Smith   Input Parameter:
319020f4b53cSBarry Smith . dm - the `DMNETWORK` object
3191daad07d3SAidan Hamilton 
3192daad07d3SAidan Hamilton   Level: beginner
3193daad07d3SAidan Hamilton 
319420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3195daad07d3SAidan Hamilton @*/
3196d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3197d71ae5a4SJacob Faibussowitsch {
3198daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3199daad07d3SAidan Hamilton 
3200daad07d3SAidan Hamilton   PetscFunctionBegin;
32013ba16761SJacob Faibussowitsch   if (network->componentsetup) PetscFunctionReturn(PETSC_SUCCESS);
3202daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3203daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3204daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3205daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3206daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
32073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3208daad07d3SAidan Hamilton }
3209