xref: /petsc/src/dm/impls/network/network.c (revision 5c79578233e60b002d31d9b43ccb6a4974f3e90b)
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;
522*5c795782SAidan Hamilton   PetscMPIInt size, rank;
523eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
524eac198afSGetnet   PetscInt    i, j, ctr, np;
525daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
526*5c795782SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist, vrange;
527*5c795782SAidan Hamilton   PetscInt    net, idx, gidx, nmerged, 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] */
545*5c795782SAidan Hamilton   PetscCall(PetscMalloc1(network->cloneshared->nVertices, &vidxlTog));
5462bf73ac6SHong Zhang 
547*5c795782SAidan Hamilton   PetscCallMPI(MPI_Scan(&network->cloneshared->nVertices, &vrange, 1, MPIU_INT, MPI_SUM, comm));
548*5c795782SAidan Hamilton   vrange -= network->cloneshared->nVertices;
5492bf73ac6SHong Zhang 
5502bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5519371c9d4SSatish Balay   i                           = 0;
5529371c9d4SSatish Balay   gidx                        = 0;
5532bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
554daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5552bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
556daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5579566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5582bf73ac6SHong Zhang       if (svtype == SVTO) {
559daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5605c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
561daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5625c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
563daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5642bf73ac6SHong Zhang           }
5655c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5665c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5672bf73ac6SHong Zhang         }
5682bf73ac6SHong Zhang       } else {
569daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5705c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
571daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5722bf73ac6SHong Zhang         }
573daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5742bf73ac6SHong Zhang         gidx++;
5752bf73ac6SHong Zhang       }
5762bf73ac6SHong Zhang     }
5772bf73ac6SHong Zhang   }
5782bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
579daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5802bf73ac6SHong Zhang #endif
5812bf73ac6SHong Zhang 
5825c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
583712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
584daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5852bf73ac6SHong Zhang 
5862bf73ac6SHong Zhang   ctr = 0;
5872bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
588daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5892bf73ac6SHong Zhang       /* vfrom: */
590*5c795782SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange);
5912bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5922bf73ac6SHong Zhang 
5932bf73ac6SHong Zhang       /* vto */
594*5c795782SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange);
5952bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
5962bf73ac6SHong Zhang       ctr++;
5972bf73ac6SHong Zhang     }
5982bf73ac6SHong Zhang   }
599*5c795782SAidan Hamilton   PetscCall(PetscFree(vidxlTog));
6009566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
6012bf73ac6SHong Zhang 
602eac198afSGetnet   *nmerged_ptr = nmerged;
6033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6045f2c45f1SShri Abhyankar }
6055f2c45f1SShri Abhyankar 
606d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
607d71ae5a4SJacob Faibussowitsch {
608daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
609daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
610daad07d3SAidan Hamilton   MPI_Comm    comm;
611daad07d3SAidan Hamilton 
612daad07d3SAidan Hamilton   PetscFunctionBegin;
613daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
614daad07d3SAidan Hamilton 
615daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
616daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
617daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
618daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
619daad07d3SAidan Hamilton 
620daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
621daad07d3SAidan Hamilton 
622daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
623daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
624daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
625daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
626daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
627daad07d3SAidan Hamilton   }
6283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
629daad07d3SAidan Hamilton }
630daad07d3SAidan Hamilton 
6315f2c45f1SShri Abhyankar /*@
6325f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6335f2c45f1SShri Abhyankar 
634eac198afSGetnet   Not Collective
6355f2c45f1SShri Abhyankar 
6362fe279fdSBarry Smith   Input Parameter:
63720f4b53cSBarry Smith . dm - the `DMNETWORK` object
63820f4b53cSBarry Smith 
63920f4b53cSBarry Smith   Level: beginner
6405f2c45f1SShri Abhyankar 
6415f2c45f1SShri Abhyankar   Notes:
6425f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6435f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6445f2c45f1SShri Abhyankar 
6455f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6465f2c45f1SShri Abhyankar 
64720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6485f2c45f1SShri Abhyankar @*/
649d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
650d71ae5a4SJacob Faibussowitsch {
6515f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
652daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
653caf410d2SHong Zhang   const PetscInt *cone;
654caf410d2SHong Zhang   MPI_Comm        comm;
6555503a911SAidan Hamilton   PetscMPIInt     size;
656eac198afSGetnet   PetscSection    sectiong;
6575c6496baSHong Zhang   PetscInt        nmerged = 0;
6586500d4abSHong Zhang 
6596500d4abSHong Zhang   PetscFunctionBegin;
660e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
661daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6622bf73ac6SHong Zhang 
663eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
664eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6659371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6669371c9d4SSatish 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,
6679371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
668eac198afSGetnet   }
669eac198afSGetnet 
6709566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6713ba16761SJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6726500d4abSHong Zhang 
673f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
674daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
675eac198afSGetnet 
676daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6779566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
678eac198afSGetnet   } else { /* subnetworks are not coupled */
6796aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
680eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapICreate(&network->cloneshared->svtable));
681caf410d2SHong Zhang     ctr = 0;
6822bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
683daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
684daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
685daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6866500d4abSHong Zhang         ctr++;
6876500d4abSHong Zhang       }
6886500d4abSHong Zhang     }
689eac198afSGetnet   }
6907765340cSHong Zhang 
6912bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6929566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
6939566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
6949566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
695eac198afSGetnet 
696daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
697daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
6986500d4abSHong Zhang 
699daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
700daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
701daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
702daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
7039566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
704caf410d2SHong Zhang 
705f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
706f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
707f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
708f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
709f11a936eSBarry Smith   */
710daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
711daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
712daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7135c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
714daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
715daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
716f11a936eSBarry Smith 
717daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
718daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7196500d4abSHong Zhang   }
720daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
721caf410d2SHong Zhang 
722caf410d2SHong Zhang   /* Get edge ownership */
723daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7245503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7255503a911SAidan Hamilton   globaledgeoff -= np;
726caf410d2SHong Zhang 
727eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7282bf73ac6SHong Zhang   e = 0;
7292bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
730f11a936eSBarry Smith     ctr = 0;
731daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7322bf73ac6SHong Zhang       /* edge e */
7335503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7342bf73ac6SHong Zhang       network->header[e].subnetid              = i;
735daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7362bf73ac6SHong Zhang 
7372bf73ac6SHong Zhang       /* connected vertices */
7389566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7392bf73ac6SHong Zhang 
7402bf73ac6SHong Zhang       /* vertex cone[0] */
741f11a936eSBarry Smith       v                           = cone[0];
742f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
743f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
744f11a936eSBarry Smith       if (Nsubnet == 1) {
745daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
746f11a936eSBarry Smith       } else {
747daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
748daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
749f11a936eSBarry Smith       }
7502bf73ac6SHong Zhang 
7512bf73ac6SHong Zhang       /* vertex cone[1] */
752f11a936eSBarry Smith       v                           = cone[1];
753f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
754f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
755f11a936eSBarry Smith       if (Nsubnet == 1) {
756daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
757f11a936eSBarry Smith       } else {
758daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
759daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
760f11a936eSBarry Smith       }
7612bf73ac6SHong Zhang 
7629371c9d4SSatish Balay       e++;
7639371c9d4SSatish Balay       ctr++;
7646500d4abSHong Zhang     }
7656500d4abSHong Zhang   }
7665503a911SAidan Hamilton   PetscCall(PetscFree(edges));
767caf410d2SHong Zhang 
768eac198afSGetnet   /* Set local vertex array for the subnetworks */
769eac198afSGetnet   j = 0;
770daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
771eac198afSGetnet     /* local shared vertex */
772eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, network->header[v].index + 1, 0, &i));
773daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7746500d4abSHong Zhang   }
775eac198afSGetnet 
776eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
777eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7789566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
779daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
780daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
781e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7835f2c45f1SShri Abhyankar }
7845f2c45f1SShri Abhyankar 
78594ef8ddeSSatish Balay /*@C
7862bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7872bf73ac6SHong Zhang 
78820f4b53cSBarry Smith   Not Collective
7892727e31bSShri Abhyankar 
7907a7aea1fSJed Brown   Input Parameters:
79120f4b53cSBarry Smith + dm - the `DMNETWORK` object
7922bf73ac6SHong Zhang - netnum - the global index of the subnetwork
7932727e31bSShri Abhyankar 
7947a7aea1fSJed Brown   Output Parameters:
7952727e31bSShri Abhyankar + nv - number of vertices (local)
7962727e31bSShri Abhyankar . ne - number of edges (local)
7972bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
7982bf73ac6SHong Zhang - edge - local edges of the subnetwork
7992727e31bSShri Abhyankar 
80006dd6b0eSSatish Balay   Level: intermediate
80106dd6b0eSSatish Balay 
80220f4b53cSBarry Smith   Notes:
80320f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
80420f4b53cSBarry Smith 
80520f4b53cSBarry Smith   The local vertices returned on each rank are determined by `DMNETWORK`. The user does not have any control over what vertices are local.
80620f4b53cSBarry Smith 
80720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8082727e31bSShri Abhyankar @*/
809d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge)
810d71ae5a4SJacob Faibussowitsch {
811caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8122727e31bSShri Abhyankar 
8132727e31bSShri Abhyankar   PetscFunctionBegin;
814daad07d3SAidan 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);
815daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
816daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
817daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
818daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8202bf73ac6SHong Zhang }
8212bf73ac6SHong Zhang 
8222bf73ac6SHong Zhang /*@
8232bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8242bf73ac6SHong Zhang 
82520f4b53cSBarry Smith   Collective
8262bf73ac6SHong Zhang 
8272bf73ac6SHong Zhang   Input Parameters:
82820f4b53cSBarry Smith + dm - the `DMNETWORK` object
82920f4b53cSBarry Smith . anetnum - first subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
83020f4b53cSBarry Smith . bnetnum - second subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
8312bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8322bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8332bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8342bf73ac6SHong Zhang 
8352bf73ac6SHong Zhang   Level: beginner
8362bf73ac6SHong Zhang 
83720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8382bf73ac6SHong Zhang @*/
839d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
840d71ae5a4SJacob Faibussowitsch {
8412bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
842daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8432bf73ac6SHong Zhang 
8442bf73ac6SHong Zhang   PetscFunctionBegin;
8455c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8465c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8472bf73ac6SHong Zhang   if (!Nsvtx) {
8482bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
849daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8502bf73ac6SHong Zhang   }
8512bf73ac6SHong Zhang 
852daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8532bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8549371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8559371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8569371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8579371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8582bf73ac6SHong Zhang     Nsvtx++;
8592bf73ac6SHong Zhang   }
8605c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
861daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8632727e31bSShri Abhyankar }
8642727e31bSShri Abhyankar 
8652727e31bSShri Abhyankar /*@C
8662bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8672bf73ac6SHong Zhang 
86820f4b53cSBarry Smith   Not Collective
869caf410d2SHong Zhang 
870f899ff85SJose E. Roman   Input Parameter:
87120f4b53cSBarry Smith . dm - the `DMNETWORK` object
872caf410d2SHong Zhang 
8737a7aea1fSJed Brown   Output Parameters:
8742bf73ac6SHong Zhang + nsv - number of local shared vertices
8752bf73ac6SHong Zhang - svtx - local shared vertices
876caf410d2SHong Zhang 
877caf410d2SHong Zhang   Level: intermediate
878caf410d2SHong Zhang 
87920f4b53cSBarry Smith   Notes:
88020f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
88120f4b53cSBarry Smith 
88220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
883caf410d2SHong Zhang @*/
884d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx)
885d71ae5a4SJacob Faibussowitsch {
886caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
887caf410d2SHong Zhang 
888caf410d2SHong Zhang   PetscFunctionBegin;
8895c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
890daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
891daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
8923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
893caf410d2SHong Zhang }
894caf410d2SHong Zhang 
895caf410d2SHong Zhang /*@C
8965f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
8975f2c45f1SShri Abhyankar 
89820f4b53cSBarry Smith   Logically Collective
8995f2c45f1SShri Abhyankar 
9007a7aea1fSJed Brown   Input Parameters:
90120f4b53cSBarry Smith + dm - the `DMNETWORK` object
9025f2c45f1SShri Abhyankar . name - the component name
9035f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
9045f2c45f1SShri Abhyankar 
9052fe279fdSBarry Smith    Output Parameter:
9065f2c45f1SShri Abhyankar .  key - an integer key that defines the component
9075f2c45f1SShri Abhyankar 
90820f4b53cSBarry Smith    Level: beginner
90920f4b53cSBarry Smith 
91087497f52SBarry Smith    Note:
91187497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9125f2c45f1SShri Abhyankar 
91320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9145f2c45f1SShri Abhyankar @*/
915d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
916d71ae5a4SJacob Faibussowitsch {
9175f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
91854dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9195f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9205f2c45f1SShri Abhyankar   PetscInt            i;
9215f2c45f1SShri Abhyankar 
9225f2c45f1SShri Abhyankar   PetscFunctionBegin;
92348a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
92454dfd506SHong Zhang 
9255f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9269566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9275f2c45f1SShri Abhyankar     if (flg) {
9285f2c45f1SShri Abhyankar       *key = i;
9293ba16761SJacob Faibussowitsch       PetscFunctionReturn(PETSC_SUCCESS);
9305f2c45f1SShri Abhyankar     }
9316d64e262SShri Abhyankar   }
93254dfd506SHong Zhang 
93354dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
93454dfd506SHong Zhang     /* Reached max allowed so resize component */
93554dfd506SHong Zhang     network->max_comps_registered += 2;
9369566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
93754dfd506SHong Zhang     /* Copy over the previous component info */
93854dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
939c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(newcomponent[i].name, network->component[i].name, sizeof(newcomponent[i].name)));
94054dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9415f2c45f1SShri Abhyankar     }
94254dfd506SHong Zhang     /* Free old one */
9439566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
94454dfd506SHong Zhang     /* Update pointer */
94554dfd506SHong Zhang     network->component = newcomponent;
94654dfd506SHong Zhang   }
94754dfd506SHong Zhang 
94854dfd506SHong Zhang   component = &network->component[network->ncomponent];
9495f2c45f1SShri Abhyankar 
950c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(component->name, name, sizeof(component->name)));
9515f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9525f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9535f2c45f1SShri Abhyankar   network->ncomponent++;
9543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9555f2c45f1SShri Abhyankar }
9565f2c45f1SShri Abhyankar 
9575f2c45f1SShri Abhyankar /*@
9588afb7921SAidan Hamilton   DMNetworkGetNumVertices - Get the local and global number of vertices for the entire network.
9598afb7921SAidan Hamilton 
9608afb7921SAidan Hamilton   Not Collective
9618afb7921SAidan Hamilton 
9628afb7921SAidan Hamilton   Input Parameter:
96320f4b53cSBarry Smith . dm - the `DMNETWORK` object
9648afb7921SAidan Hamilton 
9658afb7921SAidan Hamilton   Output Parameters:
9668afb7921SAidan Hamilton + nVertices - the local number of vertices
9678afb7921SAidan Hamilton - NVertices - the global number of vertices
9688afb7921SAidan Hamilton 
9698afb7921SAidan Hamilton   Level: beginner
9708afb7921SAidan Hamilton 
97120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumEdges()`
9728afb7921SAidan Hamilton @*/
9738afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumVertices(DM dm, PetscInt *nVertices, PetscInt *NVertices)
9748afb7921SAidan Hamilton {
9758afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
9768afb7921SAidan Hamilton 
9778afb7921SAidan Hamilton   PetscFunctionBegin;
9788afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
9798afb7921SAidan Hamilton   if (nVertices) {
9808afb7921SAidan Hamilton     PetscValidIntPointer(nVertices, 2);
9818afb7921SAidan Hamilton     *nVertices = network->cloneshared->nVertices;
9828afb7921SAidan Hamilton   }
9838afb7921SAidan Hamilton   if (NVertices) {
9848afb7921SAidan Hamilton     PetscValidIntPointer(NVertices, 3);
9858afb7921SAidan Hamilton     *NVertices = network->cloneshared->NVertices;
9868afb7921SAidan Hamilton   }
9873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9888afb7921SAidan Hamilton }
9898afb7921SAidan Hamilton 
9908afb7921SAidan Hamilton /*@
9918afb7921SAidan Hamilton   DMNetworkGetNumEdges - Get the local and global number of edges for the entire network.
9928afb7921SAidan Hamilton 
9938afb7921SAidan Hamilton   Not Collective
9948afb7921SAidan Hamilton 
9958afb7921SAidan Hamilton   Input Parameter:
99620f4b53cSBarry Smith . dm - the `DMNETWORK` object
9978afb7921SAidan Hamilton 
9988afb7921SAidan Hamilton   Output Parameters:
9998afb7921SAidan Hamilton + nEdges - the local number of edges
10008afb7921SAidan Hamilton -  NEdges - the global number of edges
10018afb7921SAidan Hamilton 
10028afb7921SAidan Hamilton   Level: beginner
10038afb7921SAidan Hamilton 
100420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumVertices()`
10058afb7921SAidan Hamilton @*/
10068afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumEdges(DM dm, PetscInt *nEdges, PetscInt *NEdges)
10078afb7921SAidan Hamilton {
10088afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
10098afb7921SAidan Hamilton 
10108afb7921SAidan Hamilton   PetscFunctionBegin;
10118afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
10128afb7921SAidan Hamilton   if (nEdges) {
10138afb7921SAidan Hamilton     PetscValidIntPointer(nEdges, 2);
10148afb7921SAidan Hamilton     *nEdges = network->cloneshared->nEdges;
10158afb7921SAidan Hamilton   }
10168afb7921SAidan Hamilton   if (NEdges) {
10178afb7921SAidan Hamilton     PetscValidIntPointer(NEdges, 3);
10188afb7921SAidan Hamilton     *NEdges = network->cloneshared->NEdges;
10198afb7921SAidan Hamilton   }
10203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10218afb7921SAidan Hamilton }
10228afb7921SAidan Hamilton 
10238afb7921SAidan Hamilton /*@
10242bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
10255f2c45f1SShri Abhyankar 
10265f2c45f1SShri Abhyankar   Not Collective
10275f2c45f1SShri Abhyankar 
1028f899ff85SJose E. Roman   Input Parameter:
102920f4b53cSBarry Smith . dm - the `DMNETWORK` object
10305f2c45f1SShri Abhyankar 
1031fd292e60Sprj-   Output Parameters:
10322bf73ac6SHong Zhang + vStart - the first vertex point
10332bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
10345f2c45f1SShri Abhyankar 
103597bb938eSShri Abhyankar   Level: beginner
10365f2c45f1SShri Abhyankar 
103720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeRange()`
10385f2c45f1SShri Abhyankar @*/
1039d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd)
1040d71ae5a4SJacob Faibussowitsch {
10415f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10425f2c45f1SShri Abhyankar 
10435f2c45f1SShri Abhyankar   PetscFunctionBegin;
1044daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
1045daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
10463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10475f2c45f1SShri Abhyankar }
10485f2c45f1SShri Abhyankar 
10495f2c45f1SShri Abhyankar /*@
10502bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
10515f2c45f1SShri Abhyankar 
10525f2c45f1SShri Abhyankar   Not Collective
10535f2c45f1SShri Abhyankar 
1054f899ff85SJose E. Roman   Input Parameter:
105520f4b53cSBarry Smith . dm - the `DMNETWORK` object
10565f2c45f1SShri Abhyankar 
1057fd292e60Sprj-   Output Parameters:
10585f2c45f1SShri Abhyankar + eStart - The first edge point
10595f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
10605f2c45f1SShri Abhyankar 
106197bb938eSShri Abhyankar   Level: beginner
10625f2c45f1SShri Abhyankar 
106320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetVertexRange()`
10645f2c45f1SShri Abhyankar @*/
1065d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd)
1066d71ae5a4SJacob Faibussowitsch {
10675f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10685f2c45f1SShri Abhyankar 
10695f2c45f1SShri Abhyankar   PetscFunctionBegin;
10705c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1071daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
1072daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
10733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10745f2c45f1SShri Abhyankar }
10755f2c45f1SShri Abhyankar 
1076d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index)
1077d71ae5a4SJacob Faibussowitsch {
10782bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
10795c6496baSHong Zhang 
10805c6496baSHong Zhang   PetscFunctionBegin;
10815c6496baSHong Zhang   if (network->header) {
10825c6496baSHong Zhang     *index = network->header[p].index;
10835c6496baSHong Zhang   } else {
10842bf73ac6SHong Zhang     PetscInt                 offsetp;
10852bf73ac6SHong Zhang     DMNetworkComponentHeader header;
10862bf73ac6SHong Zhang 
10879566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
10882bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
10892bf73ac6SHong Zhang     *index = header->index;
10905c6496baSHong Zhang   }
10913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10922bf73ac6SHong Zhang }
10932bf73ac6SHong Zhang 
1094d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid)
1095d71ae5a4SJacob Faibussowitsch {
1096daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1097daad07d3SAidan Hamilton 
1098daad07d3SAidan Hamilton   PetscFunctionBegin;
1099daad07d3SAidan Hamilton   if (network->header) {
1100daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1101daad07d3SAidan Hamilton   } else {
1102daad07d3SAidan Hamilton     PetscInt                 offsetp;
1103daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1104daad07d3SAidan Hamilton 
1105daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1106daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1107daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1108daad07d3SAidan Hamilton   }
11093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1110daad07d3SAidan Hamilton }
1111daad07d3SAidan Hamilton 
11127b6afd5bSHong Zhang /*@
11132bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
11147b6afd5bSHong Zhang 
11157b6afd5bSHong Zhang   Not Collective
11167b6afd5bSHong Zhang 
11177b6afd5bSHong Zhang   Input Parameters:
111820f4b53cSBarry Smith + dm - `DMNETWORK` object
1119e85e6aecSHong Zhang - p - edge point
11207b6afd5bSHong Zhang 
11212fe279fdSBarry Smith   Output Parameter:
11222bf73ac6SHong Zhang . index - the global numbering for the edge
11237b6afd5bSHong Zhang 
11247b6afd5bSHong Zhang   Level: intermediate
11257b6afd5bSHong Zhang 
112620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
11277b6afd5bSHong Zhang @*/
1128d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index)
1129d71ae5a4SJacob Faibussowitsch {
11307b6afd5bSHong Zhang   PetscFunctionBegin;
11319566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11337b6afd5bSHong Zhang }
11347b6afd5bSHong Zhang 
11355f2c45f1SShri Abhyankar /*@
11362bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1137e85e6aecSHong Zhang 
1138e85e6aecSHong Zhang   Not Collective
1139e85e6aecSHong Zhang 
1140e85e6aecSHong Zhang   Input Parameters:
114120f4b53cSBarry Smith + dm - `DMNETWORK` object
1142e85e6aecSHong Zhang - p  - vertex point
1143e85e6aecSHong Zhang 
11442fe279fdSBarry Smith   Output Parameter:
11452bf73ac6SHong Zhang . index - the global numbering for the vertex
1146e85e6aecSHong Zhang 
1147e85e6aecSHong Zhang   Level: intermediate
1148e85e6aecSHong Zhang 
114920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1150e85e6aecSHong Zhang @*/
1151d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index)
1152d71ae5a4SJacob Faibussowitsch {
1153e85e6aecSHong Zhang   PetscFunctionBegin;
11549566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11569988b915SShri Abhyankar }
11579988b915SShri Abhyankar 
11589988b915SShri Abhyankar /*@
11595f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
11605f2c45f1SShri Abhyankar 
11615f2c45f1SShri Abhyankar   Not Collective
11625f2c45f1SShri Abhyankar 
11635f2c45f1SShri Abhyankar   Input Parameters:
116420f4b53cSBarry Smith + dm - the `DMNETWORK` object
1165a2b725a8SWilliam Gropp - p - vertex/edge point
11665f2c45f1SShri Abhyankar 
11672fe279fdSBarry Smith   Output Parameter:
11685f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
11695f2c45f1SShri Abhyankar 
117097bb938eSShri Abhyankar   Level: beginner
11715f2c45f1SShri Abhyankar 
117220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
11735f2c45f1SShri Abhyankar @*/
1174d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents)
1175d71ae5a4SJacob Faibussowitsch {
11765f2c45f1SShri Abhyankar   PetscInt    offset;
11775f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
11785f2c45f1SShri Abhyankar 
11795f2c45f1SShri Abhyankar   PetscFunctionBegin;
11809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
11815f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
11823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11835f2c45f1SShri Abhyankar }
11845f2c45f1SShri Abhyankar 
11855f2c45f1SShri Abhyankar /*@
11862bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
11875f2c45f1SShri Abhyankar 
11885f2c45f1SShri Abhyankar   Not Collective
11895f2c45f1SShri Abhyankar 
11905f2c45f1SShri Abhyankar   Input Parameters:
119120f4b53cSBarry Smith + dm - the `DMNETWORK` object
1192f2f58720SBarry Smith . p - the edge or vertex point
11932bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
11949988b915SShri Abhyankar 
11952fe279fdSBarry Smith   Output Parameter:
11962bf73ac6SHong Zhang . offset - the local offset
11979988b915SShri Abhyankar 
11989988b915SShri Abhyankar   Level: intermediate
11999988b915SShri Abhyankar 
120020f4b53cSBarry Smith   Notes:
120120f4b53cSBarry Smith     These offsets can be passed to `MatSetValuesLocal()` for matrices obtained with `DMCreateMatrix()`.
120220f4b53cSBarry Smith 
120320f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` the offsets can be used with `VecSetValues()`.
120420f4b53cSBarry Smith 
120520f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
120620f4b53cSBarry Smith     the vector values with array[offset].
120720f4b53cSBarry Smith 
120820f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValuesLocal()`.
120920f4b53cSBarry Smith 
121020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
12119988b915SShri Abhyankar @*/
1212d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset)
1213d71ae5a4SJacob Faibussowitsch {
12149988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12159988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12169988b915SShri Abhyankar   DMNetworkComponentHeader header;
12179988b915SShri Abhyankar 
12189988b915SShri Abhyankar   PetscFunctionBegin;
12199566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
12202bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12212bf73ac6SHong Zhang     *offset = offsetp;
12223ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12232bf73ac6SHong Zhang   }
12242bf73ac6SHong Zhang 
12259566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12269988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12279988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
12283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12299988b915SShri Abhyankar }
12309988b915SShri Abhyankar 
12319988b915SShri Abhyankar /*@
12322bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
12339988b915SShri Abhyankar 
12349988b915SShri Abhyankar   Not Collective
12359988b915SShri Abhyankar 
12369988b915SShri Abhyankar   Input Parameters:
123720f4b53cSBarry Smith + dm - the `DMNETWORK` object
1238f2f58720SBarry Smith . p - the edge or vertex point
12392bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12409988b915SShri Abhyankar 
12412fe279fdSBarry Smith   Output Parameter:
12429988b915SShri Abhyankar . offsetg - the global offset
12439988b915SShri Abhyankar 
12449988b915SShri Abhyankar   Level: intermediate
12459988b915SShri Abhyankar 
124620f4b53cSBarry Smith   Notes:
124720f4b53cSBarry Smith     These offsets can be passed to `MatSetValues()` for matrices obtained with `DMCreateMatrix()`.
124820f4b53cSBarry Smith 
124920f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValues()`.
125020f4b53cSBarry Smith 
125120f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
125220f4b53cSBarry Smith     the vector values with array[offset - rstart] where restart is obtained with `VecGetOwnershipRange`(v,&rstart,`NULL`);
125320f4b53cSBarry Smith 
125420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
12559988b915SShri Abhyankar @*/
1256d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg)
1257d71ae5a4SJacob Faibussowitsch {
12589988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12599988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12609988b915SShri Abhyankar   DMNetworkComponentHeader header;
12619988b915SShri Abhyankar 
12629988b915SShri Abhyankar   PetscFunctionBegin;
12639566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
12642bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
12652bf73ac6SHong Zhang 
12662bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12672bf73ac6SHong Zhang     *offsetg = offsetp;
12683ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12692bf73ac6SHong Zhang   }
12709566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12719988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12729988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
12733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12749988b915SShri Abhyankar }
12759988b915SShri Abhyankar 
12769988b915SShri Abhyankar /*@
12772bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
127824121865SAdrian Maldonado 
127924121865SAdrian Maldonado   Not Collective
128024121865SAdrian Maldonado 
128124121865SAdrian Maldonado   Input Parameters:
128220f4b53cSBarry Smith + dm - the `DMNETWORK` object
128324121865SAdrian Maldonado - p - the edge point
128424121865SAdrian Maldonado 
12852fe279fdSBarry Smith   Output Parameter:
128624121865SAdrian Maldonado . offset - the offset
128724121865SAdrian Maldonado 
128824121865SAdrian Maldonado   Level: intermediate
128924121865SAdrian Maldonado 
129020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
129124121865SAdrian Maldonado @*/
1292d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset)
1293d71ae5a4SJacob Faibussowitsch {
129424121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
129524121865SAdrian Maldonado 
129624121865SAdrian Maldonado   PetscFunctionBegin;
12979566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
12983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
129924121865SAdrian Maldonado }
130024121865SAdrian Maldonado 
130124121865SAdrian Maldonado /*@
13022bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
130324121865SAdrian Maldonado 
130424121865SAdrian Maldonado   Not Collective
130524121865SAdrian Maldonado 
130624121865SAdrian Maldonado   Input Parameters:
130720f4b53cSBarry Smith + dm - the `DMNETWORK` object
130824121865SAdrian Maldonado - p - the vertex point
130924121865SAdrian Maldonado 
13102fe279fdSBarry Smith   Output Parameter:
131124121865SAdrian Maldonado . offset - the offset
131224121865SAdrian Maldonado 
131324121865SAdrian Maldonado   Level: intermediate
131424121865SAdrian Maldonado 
131520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
131624121865SAdrian Maldonado @*/
1317d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset)
1318d71ae5a4SJacob Faibussowitsch {
131924121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
132024121865SAdrian Maldonado 
132124121865SAdrian Maldonado   PetscFunctionBegin;
1322daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
13239566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
13243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
132524121865SAdrian Maldonado }
13262bf73ac6SHong Zhang 
13275f2c45f1SShri Abhyankar /*@
13282bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
13295f2c45f1SShri Abhyankar 
133020f4b53cSBarry Smith   Collective
13315f2c45f1SShri Abhyankar 
13325f2c45f1SShri Abhyankar   Input Parameters:
13334dc646bcSBarry Smith + dm - the DMNetwork
133420f4b53cSBarry Smith . p - the vertex/edge point. These points are local indices provided by `DMNetworkGetSubnetwork()`
133520f4b53cSBarry Smith . componentkey - component key returned while registering the component with `DMNetworkRegisterComponent()`
133620f4b53cSBarry 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
133720f4b53cSBarry Smith               free this space until after `DMSetUp()` is called.
1338eac198afSGetnet - 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
13395f2c45f1SShri Abhyankar 
134020f4b53cSBarry Smith   Level: beginner
134120f4b53cSBarry Smith 
1342eac198afSGetnet   Notes:
1343eac198afSGetnet     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.
1344eac198afSGetnet 
134520f4b53cSBarry Smith     `DMNetworkLayoutSetUp()` must be called before this routine.
1346eac198afSGetnet 
134720f4b53cSBarry Smith   Developer Note:
134820f4b53cSBarry 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`.
13495f2c45f1SShri Abhyankar 
135020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
13515f2c45f1SShri Abhyankar @*/
1352d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar)
1353d71ae5a4SJacob Faibussowitsch {
13545f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
13552bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
135654dfd506SHong Zhang   DMNetworkComponentHeader header;
135754dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
135854dfd506SHong Zhang   PetscInt                 compnum;
135954dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
136054dfd506SHong Zhang   void                   **compdata;
13615f2c45f1SShri Abhyankar 
13625f2c45f1SShri Abhyankar   PetscFunctionBegin;
13635c6496baSHong 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);
1364daad07d3SAidan 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.");
1365eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
13669566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
13672bf73ac6SHong Zhang 
1368eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
136954dfd506SHong Zhang   header = &network->header[p];
137054dfd506SHong Zhang   cvalue = &network->cvalue[p];
137154dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1372f11a936eSBarry Smith     PetscInt additional_size;
1373f11a936eSBarry Smith 
137454dfd506SHong Zhang     /* Reached limit so resize header component arrays */
137554dfd506SHong Zhang     header->maxcomps += 2;
137654dfd506SHong Zhang 
137754dfd506SHong Zhang     /* Allocate arrays for component information and value */
13789566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
13799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
138054dfd506SHong Zhang 
138154dfd506SHong Zhang     /* Recalculate header size */
138254dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
138354dfd506SHong Zhang 
138454dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
138554dfd506SHong Zhang 
138654dfd506SHong Zhang     /* Copy over component info */
13879566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
13889566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
13899566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
13909566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
13919566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
139254dfd506SHong Zhang 
139354dfd506SHong Zhang     /* Copy over component data pointers */
13949566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
139554dfd506SHong Zhang 
139654dfd506SHong Zhang     /* Free old arrays */
13979566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
13989566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
139954dfd506SHong Zhang 
140054dfd506SHong Zhang     /* Update pointers */
140154dfd506SHong Zhang     header->size         = compsize;
140254dfd506SHong Zhang     header->key          = compkey;
140354dfd506SHong Zhang     header->offset       = compoffset;
140454dfd506SHong Zhang     header->nvar         = compnvar;
140554dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
140654dfd506SHong Zhang 
140754dfd506SHong Zhang     cvalue->data = compdata;
140854dfd506SHong Zhang 
140954dfd506SHong Zhang     /* Update DataSection Dofs */
141054dfd506SHong 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 */
1411f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
14129566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
141354dfd506SHong Zhang   }
141454dfd506SHong Zhang   header = &network->header[p];
141554dfd506SHong Zhang   cvalue = &network->cvalue[p];
141654dfd506SHong Zhang 
141754dfd506SHong Zhang   compnum = header->ndata;
14182bf73ac6SHong Zhang 
14192bf73ac6SHong Zhang   header->size[compnum] = component->size;
14209566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
14212bf73ac6SHong Zhang   header->key[compnum] = componentkey;
14222bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
14232bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
14242bf73ac6SHong Zhang 
14252bf73ac6SHong Zhang   /* variables */
14262bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
14272bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
14282bf73ac6SHong Zhang 
14292bf73ac6SHong Zhang   header->ndata++;
14303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14315f2c45f1SShri Abhyankar }
14325f2c45f1SShri Abhyankar 
143327f51fceSHong Zhang /*@
14342bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
143527f51fceSHong Zhang 
143627f51fceSHong Zhang   Not Collective
143727f51fceSHong Zhang 
143827f51fceSHong Zhang   Input Parameters:
143920f4b53cSBarry Smith + dm - the `DMNETWORK` object
14402bf73ac6SHong Zhang . p - vertex/edge point
144199c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
144227f51fceSHong Zhang 
144327f51fceSHong Zhang   Output Parameters:
144420f4b53cSBarry Smith + compkey - the key obtained when registering the component (use `NULL` if not required)
144520f4b53cSBarry Smith . component - the component data (use `NULL` if not required)
144620f4b53cSBarry Smith - nvar  - number of variables (use `NULL` if not required)
144727f51fceSHong Zhang 
144897bb938eSShri Abhyankar   Level: beginner
144927f51fceSHong Zhang 
145020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
145127f51fceSHong Zhang @*/
1452d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar)
1453d71ae5a4SJacob Faibussowitsch {
145427f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
14552bf73ac6SHong Zhang   PetscInt                 offset  = 0;
14562bf73ac6SHong Zhang   DMNetworkComponentHeader header;
145727f51fceSHong Zhang 
145827f51fceSHong Zhang   PetscFunctionBegin;
14592bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
14609566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
14613ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
146227f51fceSHong Zhang   }
146327f51fceSHong Zhang 
14649566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
146542dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
14665f2c45f1SShri Abhyankar 
14672bf73ac6SHong Zhang   if (compnum >= 0) {
14682bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
14692bf73ac6SHong Zhang     if (component) {
147054dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
14712bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
14722bf73ac6SHong Zhang     }
14732bf73ac6SHong Zhang   }
14745f2c45f1SShri Abhyankar 
14752bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
147654dfd506SHong Zhang 
14773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14785f2c45f1SShri Abhyankar }
14795f2c45f1SShri Abhyankar 
14802bf73ac6SHong Zhang /*
14812bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14822bf73ac6SHong 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.
14832bf73ac6SHong Zhang */
1484d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkComponentSetUp(DM dm)
1485d71ae5a4SJacob Faibussowitsch {
14865f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1487f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
14885f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
14895f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1490f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
14915f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
14925f2c45f1SShri Abhyankar 
14935f2c45f1SShri Abhyankar   PetscFunctionBegin;
14949566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
14959566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1496f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
14979566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
14985f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1499daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
15009566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
15015f2c45f1SShri Abhyankar     /* Copy header */
15025f2c45f1SShri Abhyankar     header     = &network->header[p];
1503f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
15049566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1505f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
15069566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1507aeb78aa7SBarry Smith     headerinfo->size = headerarr;
150854dfd506SHong Zhang     headerarr += header->maxcomps;
15099566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1510aeb78aa7SBarry Smith     headerinfo->key = headerarr;
151154dfd506SHong Zhang     headerarr += header->maxcomps;
15129566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1513aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
151454dfd506SHong Zhang     headerarr += header->maxcomps;
15159566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1516aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
151754dfd506SHong Zhang     headerarr += header->maxcomps;
15189566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1519aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
152054dfd506SHong Zhang 
15215f2c45f1SShri Abhyankar     /* Copy data */
15225f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
15235f2c45f1SShri Abhyankar     ncomp  = header->ndata;
15242bf73ac6SHong Zhang 
15255f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
152654dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
15279566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
15285f2c45f1SShri Abhyankar     }
15295f2c45f1SShri Abhyankar   }
1530aeb78aa7SBarry Smith 
1531daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1532aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1533aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1534aeb78aa7SBarry Smith   }
1535aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
15363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15375f2c45f1SShri Abhyankar }
15385f2c45f1SShri Abhyankar 
15395f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1540d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1541d71ae5a4SJacob Faibussowitsch {
15425f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
15435f2c45f1SShri Abhyankar 
15445f2c45f1SShri Abhyankar   PetscFunctionBegin;
15459566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
15463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15475f2c45f1SShri Abhyankar }
15485f2c45f1SShri Abhyankar 
154924121865SAdrian Maldonado /* Get a subsection from a range of points */
1550d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1551d71ae5a4SJacob Faibussowitsch {
155224121865SAdrian Maldonado   PetscInt i, nvar;
155324121865SAdrian Maldonado 
155424121865SAdrian Maldonado   PetscFunctionBegin;
15559566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
15569566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
155724121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
15589566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
15599566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
156024121865SAdrian Maldonado   }
156124121865SAdrian Maldonado 
15629566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
15633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
156424121865SAdrian Maldonado }
156524121865SAdrian Maldonado 
156624121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1567e66d8692SHong Zhang static PetscErrorCode DMNetworkSetSubMap_private(DM dm, PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1568d71ae5a4SJacob Faibussowitsch {
156924121865SAdrian Maldonado   PetscInt i, *subpoints;
157024121865SAdrian Maldonado 
157124121865SAdrian Maldonado   PetscFunctionBegin;
157224121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15739566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1574ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
1575e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15769566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
15773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
157824121865SAdrian Maldonado }
157924121865SAdrian Maldonado 
158024121865SAdrian Maldonado /*@
158120f4b53cSBarry Smith   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after `DMNetworkDistribute()`
158224121865SAdrian Maldonado 
158320f4b53cSBarry Smith   Collective
158424121865SAdrian Maldonado 
15852fe279fdSBarry Smith   Input Parameter:
158620f4b53cSBarry Smith . dm - the `DMNETWORK` Object
158724121865SAdrian Maldonado 
158820f4b53cSBarry Smith   Level: intermediate
158920f4b53cSBarry Smith 
159020f4b53cSBarry Smith   Note:
159120f4b53cSBarry Smith   the routine will create alternative orderings for the vertices and edges. Assume global network points are:
159224121865SAdrian Maldonado 
159324121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
159424121865SAdrian Maldonado 
1595caf410d2SHong 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]).
159624121865SAdrian Maldonado 
159720f4b53cSBarry Smith   With this new ordering a local `PetscSection`, global `PetscSection` and` PetscSF` will be created specific to the subset.
159824121865SAdrian Maldonado 
159924121865SAdrian Maldonado @*/
1600d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1601d71ae5a4SJacob Faibussowitsch {
160224121865SAdrian Maldonado   MPI_Comm    comm;
1603f11a936eSBarry Smith   PetscMPIInt size;
160424121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
160524121865SAdrian Maldonado 
1606eab1376dSHong Zhang   PetscFunctionBegin;
16079566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
16089566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
160924121865SAdrian Maldonado 
161024121865SAdrian Maldonado   /* Create maps for vertices and edges */
1611e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1612e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
161324121865SAdrian Maldonado 
161424121865SAdrian Maldonado   /* Create local sub-sections */
1615daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1616daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
161724121865SAdrian Maldonado 
16189852e123SBarry Smith   if (size > 1) {
16199566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
162022bbedd7SHong Zhang 
16219566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
16229566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
16239566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
162424121865SAdrian Maldonado   } else {
162524121865SAdrian Maldonado     /* create structures for vertex */
16269566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
162724121865SAdrian Maldonado     /* create structures for edge */
16289566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
162924121865SAdrian Maldonado   }
163024121865SAdrian Maldonado 
163124121865SAdrian Maldonado   /* Add viewers */
16329566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
16339566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
16349566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
16359566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
16363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
163724121865SAdrian Maldonado }
16387b6afd5bSHong Zhang 
1639f11a936eSBarry Smith /*
16405c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
16415c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1642f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1643f11a936eSBarry Smith */
1644d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1645d71ae5a4SJacob Faibussowitsch {
1646f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1647f11a936eSBarry Smith   const PetscInt          *edges;
1648f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1649f11a936eSBarry Smith   DMNetworkComponentHeader header;
1650f11a936eSBarry Smith 
1651f11a936eSBarry Smith   PetscFunctionBegin;
16529566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
16539566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1654f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
16559566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1656f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16579566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1658f11a936eSBarry Smith   }
16593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1660f11a936eSBarry Smith }
1661f11a936eSBarry Smith 
16628afb7921SAidan Hamilton /*
16638afb7921SAidan Hamilton   DMNetworkDistributeCoordinates - Internal function to distribute the coordinate network and coordinates.
16648afb7921SAidan Hamilton 
16658afb7921SAidan Hamilton   Collective
16668afb7921SAidan Hamilton 
16678afb7921SAidan Hamilton   Input Parameters:
166820f4b53cSBarry Smith   + dm - The original `DMNETWORK` object
1669aaa8cc7dSPierre Jolivet   - migrationSF - The `PetscSF` describing the migration from dm to dmnew
16708afb7921SAidan Hamilton   - newDM - The new distributed dmnetwork object.
16718afb7921SAidan Hamilton */
16728afb7921SAidan Hamilton 
16738afb7921SAidan Hamilton static PetscErrorCode DMNetworkDistributeCoordinates(DM dm, PetscSF migrationSF, DM newDM)
16748afb7921SAidan Hamilton {
16758afb7921SAidan Hamilton   DM_Network              *newDMnetwork = (DM_Network *)((newDM)->data), *newCoordnetwork, *oldCoordnetwork;
16768afb7921SAidan Hamilton   DM                       cdm, newcdm;
16778afb7921SAidan Hamilton   PetscInt                 cdim, bs, p, pStart, pEnd, offset;
16788afb7921SAidan Hamilton   Vec                      oldCoord, newCoord;
16798afb7921SAidan Hamilton   DMNetworkComponentHeader header;
16808afb7921SAidan Hamilton   const char              *name;
16818afb7921SAidan Hamilton 
16828afb7921SAidan Hamilton   PetscFunctionBegin;
16838afb7921SAidan Hamilton   /* Distribute the coordinate network and coordinates */
16848afb7921SAidan Hamilton   PetscCall(DMGetCoordinateDim(dm, &cdim));
16858afb7921SAidan Hamilton   PetscCall(DMSetCoordinateDim(newDM, cdim));
16868afb7921SAidan Hamilton 
16878afb7921SAidan Hamilton   /* Migrate only if original network had coordinates */
16888afb7921SAidan Hamilton   PetscCall(DMGetCoordinatesLocal(dm, &oldCoord));
16898afb7921SAidan Hamilton   if (oldCoord) {
16908afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(dm, &cdm));
16918afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(newDM, &newcdm));
16928afb7921SAidan Hamilton     newCoordnetwork = (DM_Network *)newcdm->data;
16938afb7921SAidan Hamilton     oldCoordnetwork = (DM_Network *)cdm->data;
16948afb7921SAidan Hamilton 
16958afb7921SAidan Hamilton     PetscCall(VecCreate(PETSC_COMM_SELF, &newCoord));
16968afb7921SAidan Hamilton     PetscCall(PetscObjectGetName((PetscObject)oldCoord, &name));
16978afb7921SAidan Hamilton     PetscCall(PetscObjectSetName((PetscObject)newCoord, name));
16988afb7921SAidan Hamilton     PetscCall(VecGetBlockSize(oldCoord, &bs));
16998afb7921SAidan Hamilton     PetscCall(VecSetBlockSize(newCoord, bs));
17008afb7921SAidan Hamilton 
17018afb7921SAidan Hamilton     PetscCall(DMPlexDistributeField(newDMnetwork->plex, migrationSF, oldCoordnetwork->DofSection, oldCoord, newCoordnetwork->DofSection, newCoord));
17028afb7921SAidan Hamilton     PetscCall(DMSetCoordinatesLocal(newDM, newCoord));
17038afb7921SAidan Hamilton 
17048afb7921SAidan Hamilton     PetscCall(VecDestroy(&newCoord));
1705aaa8cc7dSPierre Jolivet     /* Migrate the components from the original coordinate network to the new coordinate network */
17068afb7921SAidan Hamilton     PetscCall(DMPlexDistributeData(newDMnetwork->plex, migrationSF, oldCoordnetwork->DataSection, MPIU_INT, (void *)oldCoordnetwork->componentdataarray, newCoordnetwork->DataSection, (void **)&newCoordnetwork->componentdataarray));
17078afb7921SAidan Hamilton     /* update the header pointers in the new coordinate network components */
17088afb7921SAidan Hamilton     PetscCall(PetscSectionGetChart(newCoordnetwork->DataSection, &pStart, &pEnd));
17098afb7921SAidan Hamilton     for (p = pStart; p < pEnd; p++) {
17108afb7921SAidan Hamilton       PetscCall(PetscSectionGetOffset(newCoordnetwork->DataSection, p, &offset));
17118afb7921SAidan Hamilton       header = (DMNetworkComponentHeader)(newCoordnetwork->componentdataarray + offset);
17128afb7921SAidan Hamilton       /* Update pointers */
17138afb7921SAidan Hamilton       header->size         = (PetscInt *)(header + 1);
17148afb7921SAidan Hamilton       header->key          = header->size + header->maxcomps;
17158afb7921SAidan Hamilton       header->offset       = header->key + header->maxcomps;
17168afb7921SAidan Hamilton       header->nvar         = header->offset + header->maxcomps;
17178afb7921SAidan Hamilton       header->offsetvarrel = header->nvar + header->maxcomps;
17188afb7921SAidan Hamilton     }
17198afb7921SAidan Hamilton 
17208afb7921SAidan Hamilton     PetscCall(DMSetLocalSection(newCoordnetwork->plex, newCoordnetwork->DofSection));
17218afb7921SAidan Hamilton     PetscCall(DMGetGlobalSection(newCoordnetwork->plex, &newCoordnetwork->GlobalDofSection));
17228afb7921SAidan Hamilton     newCoordnetwork->componentsetup = PETSC_TRUE;
17238afb7921SAidan Hamilton   }
17243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17258afb7921SAidan Hamilton }
17268afb7921SAidan Hamilton 
17275f2c45f1SShri Abhyankar /*@
17282bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
17295f2c45f1SShri Abhyankar 
17305f2c45f1SShri Abhyankar   Collective
17315f2c45f1SShri Abhyankar 
1732d8d19677SJose E. Roman   Input Parameters:
173320f4b53cSBarry Smith + DM - the `DMNETWORK` object
17342bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
17355f2c45f1SShri Abhyankar 
173620f4b53cSBarry Smith   Options Database Keys:
17376e4289a0SDuncan Campbell + -dmnetwork_view - Calls `DMView()` at the conclusion of `DMSetUp()`
17386e4289a0SDuncan Campbell . -dmnetwork_view_distributed - Calls `DMView()` at the conclusion of `DMNetworkDistribute()`
17396e4289a0SDuncan Campbell - -dmnetwork_view_tmpdir - Sets the temporary directory to use when viewing with the `draw` option
17405b3f975aSHong Zhang 
17415f2c45f1SShri Abhyankar   Level: intermediate
17425f2c45f1SShri Abhyankar 
174320f4b53cSBarry Smith   Note:
174420f4b53cSBarry Smith   Distributes the network with <overlap>-overlapping partitioning of the edges.
174520f4b53cSBarry Smith 
174620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`
17475f2c45f1SShri Abhyankar @*/
1748d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1749d71ae5a4SJacob Faibussowitsch {
1750d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1751d3464fd4SAdrian Maldonado   PetscMPIInt              size;
17528afb7921SAidan Hamilton   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data), *newDMnetwork;
1753caf410d2SHong Zhang   PetscSF                  pointsf      = NULL;
17545f2c45f1SShri Abhyankar   DM                       newDM;
17558afb7921SAidan Hamilton   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv, net;
17568afb7921SAidan Hamilton   PetscInt                *sv;
1757f11a936eSBarry Smith   PetscBT                  btable;
175851ac5effSHong Zhang   PetscPartitioner         part;
1759b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
17605f2c45f1SShri Abhyankar 
17615f2c45f1SShri Abhyankar   PetscFunctionBegin;
17625c6496baSHong Zhang   PetscValidPointer(dm, 1);
17635c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
17649566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
17659566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1766a9750deaSHong Zhang   if (size == 1) {
1767a9750deaSHong Zhang     oldDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1768a9750deaSHong Zhang     PetscFunctionReturn(PETSC_SUCCESS);
1769a9750deaSHong Zhang   }
1770d3464fd4SAdrian Maldonado 
17715c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
17725b3f975aSHong Zhang 
17732bf73ac6SHong 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. */
1774e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
17759566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
17765f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
177754dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
17789566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
177951ac5effSHong Zhang 
178051ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
17819566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
17829566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
178351ac5effSHong Zhang 
17842bf73ac6SHong Zhang   /* Distribute plex dm */
17859566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
178651ac5effSHong Zhang 
17875f2c45f1SShri Abhyankar   /* Distribute dof section */
17889566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
17899566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
179051ac5effSHong Zhang 
17915f2c45f1SShri Abhyankar   /* Distribute data and associated section */
17929566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
17939566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
179424121865SAdrian Maldonado 
1795daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1796daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1797daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1798daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1799daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1800daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1801daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1802daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1803daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
180424121865SAdrian Maldonado 
18051bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
18069566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
18079566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
18085f2c45f1SShri Abhyankar 
1809b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1810daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1811daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1812daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1813daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1814daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1815daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
18162bf73ac6SHong Zhang 
18172bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
18182bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1819b9c6e19dSShri Abhyankar   */
1820daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1821f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1822daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1823daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1824b9c6e19dSShri Abhyankar   }
1825b9c6e19dSShri Abhyankar 
1826f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1827daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18289566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
182954dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18305c6496baSHong Zhang 
183154dfd506SHong Zhang     /* Update pointers */
183254dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
183354dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
183454dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
183554dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
183654dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
183754dfd506SHong Zhang 
1838daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1839b9c6e19dSShri Abhyankar   }
1840b9c6e19dSShri Abhyankar 
18415c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
184248a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
18435c6496baSHong Zhang 
18445c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1845daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
18469566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
18475f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18485c6496baSHong Zhang 
184954dfd506SHong Zhang     /* Update pointers */
185054dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
185154dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
185254dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
185354dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
185454dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
185554dfd506SHong Zhang 
18562bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
18572bf73ac6SHong Zhang     gidx = header->index;
1858eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, gidx + 1, 0, &svtx_idx));
18592bf73ac6SHong Zhang     svtx_idx--;
18602bf73ac6SHong Zhang 
18612bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1862daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
18632bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
18645c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
18659566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1866f11a936eSBarry Smith 
1867daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1868daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
18695c6496baSHong Zhang         net = sv[0];
187035cb6cd3SPierre Jolivet         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this process */
18712bf73ac6SHong Zhang       }
18722bf73ac6SHong Zhang     }
1873b9c6e19dSShri Abhyankar   }
1874b9c6e19dSShri Abhyankar 
18752bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
18762bf73ac6SHong Zhang   nv = 0;
1877daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1878daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1879caf410d2SHong Zhang 
18802bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1881daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1882daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1883daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1884daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1885daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1886daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
18872bf73ac6SHong Zhang 
1888daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1889daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1890caf410d2SHong Zhang 
18912bf73ac6SHong 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. */
1892daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1893b9c6e19dSShri Abhyankar   }
1894daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1895b9c6e19dSShri Abhyankar 
18962bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1897daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18989566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
18995f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1900daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1901b9c6e19dSShri Abhyankar   }
1902b9c6e19dSShri Abhyankar 
19032bf73ac6SHong Zhang   nv = 0;
1904daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
19059566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
19065f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
19072bf73ac6SHong Zhang 
19082bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1909eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, header->index + 1, 0, &svtx_idx));
19102bf73ac6SHong Zhang     svtx_idx--;
19112bf73ac6SHong Zhang     if (svtx_idx < 0) {
1912daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
19132bf73ac6SHong Zhang     } else { /* a shared vertex */
1914daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
19152bf73ac6SHong Zhang 
19165c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
19179566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1918f11a936eSBarry Smith 
1919daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1920daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
19215c6496baSHong Zhang         net = sv[0];
19229371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1923b9c6e19dSShri Abhyankar       }
19242bf73ac6SHong Zhang     }
19252bf73ac6SHong Zhang   }
1926daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1927b9c6e19dSShri Abhyankar 
19288afb7921SAidan Hamilton   PetscCall(DMNetworkDistributeCoordinates(*dm, pointsf, newDM));
1929caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1930daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1931caf410d2SHong Zhang 
19322bf73ac6SHong Zhang   /* Free spaces */
19339566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
19349566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
193548a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
19362bf73ac6SHong Zhang 
19375b3f975aSHong Zhang   /* View distributed dmnetwork */
19389566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
19395b3f975aSHong Zhang 
1940d3464fd4SAdrian Maldonado   *dm = newDM;
1941e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
19423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19435f2c45f1SShri Abhyankar }
19445f2c45f1SShri Abhyankar 
194524121865SAdrian Maldonado /*@C
194620f4b53cSBarry Smith   PetscSFGetSubSF - Returns an `PetscSF` for a specific subset of points. Leaves are re-numbered to reflect the new ordering
19472bf73ac6SHong Zhang 
19482bf73ac6SHong Zhang  Collective
194924121865SAdrian Maldonado 
195024121865SAdrian Maldonado   Input Parameters:
195120f4b53cSBarry Smith + mainSF - `PetscSF` structure
195220f4b53cSBarry Smith - map - a `ISLocalToGlobalMapping` that contains the subset of points
195324121865SAdrian Maldonado 
195497bb3fdcSJose E. Roman   Output Parameter:
195520f4b53cSBarry Smith . subSF - a subset of the `mainSF` for the desired subset.
1956ee300463SSatish Balay 
1957ee300463SSatish Balay   Level: intermediate
195820f4b53cSBarry Smith 
195920f4b53cSBarry Smith .seealso: `PetscSF`
19607d928bffSSatish Balay @*/
1961d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1962d71ae5a4SJacob Faibussowitsch {
196324121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
196424121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
196524121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
196624121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
196724121865SAdrian Maldonado   const PetscInt    *ilocal;
196824121865SAdrian Maldonado   const PetscSFNode *iremote;
196924121865SAdrian Maldonado 
197024121865SAdrian Maldonado   PetscFunctionBegin;
19719566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
197224121865SAdrian Maldonado 
197324121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
19749566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
19759566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
197624121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
197724121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
197824121865SAdrian Maldonado   }
197924121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
19809566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
198124121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
19829566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
19839566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
19849566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
198524121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
19869566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
19879566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
198824121865SAdrian Maldonado   nleaves_sub = 0;
198924121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
199024121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
199124121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
19924b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
199324121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
199424121865SAdrian Maldonado       nleaves_sub += 1;
199524121865SAdrian Maldonado     }
199624121865SAdrian Maldonado   }
19979566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
19989566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
199924121865SAdrian Maldonado 
200024121865SAdrian Maldonado   /* Create new subSF */
2001e66d8692SHong Zhang   PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)mainsf), subSF));
20029566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
20039566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
20049566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
20059566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
20063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
200724121865SAdrian Maldonado }
200824121865SAdrian Maldonado 
20095f2c45f1SShri Abhyankar /*@C
20105f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
20115f2c45f1SShri Abhyankar 
20125f2c45f1SShri Abhyankar   Not Collective
20135f2c45f1SShri Abhyankar 
20145f2c45f1SShri Abhyankar   Input Parameters:
201520f4b53cSBarry Smith + dm - the `DMNETWORK` object
20165f2c45f1SShri Abhyankar - p  - the vertex point
20175f2c45f1SShri Abhyankar 
2018fd292e60Sprj-   Output Parameters:
20195f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
20202bf73ac6SHong Zhang - edges  - list of edge points
20215f2c45f1SShri Abhyankar 
202297bb938eSShri Abhyankar   Level: beginner
20235f2c45f1SShri Abhyankar 
202420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
20255f2c45f1SShri Abhyankar @*/
2026d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[])
2027d71ae5a4SJacob Faibussowitsch {
20285f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20295f2c45f1SShri Abhyankar 
20305f2c45f1SShri Abhyankar   PetscFunctionBegin;
20319566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
20329566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
20333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20345f2c45f1SShri Abhyankar }
20355f2c45f1SShri Abhyankar 
20365f2c45f1SShri Abhyankar /*@C
2037d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
20385f2c45f1SShri Abhyankar 
20395f2c45f1SShri Abhyankar   Not Collective
20405f2c45f1SShri Abhyankar 
20415f2c45f1SShri Abhyankar   Input Parameters:
204220f4b53cSBarry Smith + dm - the `DMNETWORK` object
20435f2c45f1SShri Abhyankar - p - the edge point
20445f2c45f1SShri Abhyankar 
20452fe279fdSBarry Smith   Output Parameter:
20465f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
20475f2c45f1SShri Abhyankar 
204897bb938eSShri Abhyankar   Level: beginner
20495f2c45f1SShri Abhyankar 
205020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
20515f2c45f1SShri Abhyankar @*/
2052d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
2053d71ae5a4SJacob Faibussowitsch {
20545f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20555f2c45f1SShri Abhyankar 
20565f2c45f1SShri Abhyankar   PetscFunctionBegin;
20579566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
20583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20595f2c45f1SShri Abhyankar }
20605f2c45f1SShri Abhyankar 
20615f2c45f1SShri Abhyankar /*@
206220f4b53cSBarry Smith   DMNetworkIsSharedVertex - Returns `PETSC_TRUE` if the vertex is shared by subnetworks
20632bf73ac6SHong Zhang 
20642bf73ac6SHong Zhang   Not Collective
20652bf73ac6SHong Zhang 
20662bf73ac6SHong Zhang   Input Parameters:
206720f4b53cSBarry Smith + dm - the `DMNETWORK` object
20682bf73ac6SHong Zhang - p - the vertex point
20692bf73ac6SHong Zhang 
20702bf73ac6SHong Zhang   Output Parameter:
207120f4b53cSBarry Smith . flag - `PETSC_TRUE` if the vertex is shared by subnetworks
20722bf73ac6SHong Zhang 
20732bf73ac6SHong Zhang   Level: beginner
20742bf73ac6SHong Zhang 
207520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
20762bf73ac6SHong Zhang @*/
2077d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
2078d71ae5a4SJacob Faibussowitsch {
20792bf73ac6SHong Zhang   PetscFunctionBegin;
2080eec179cfSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2081eec179cfSJacob Faibussowitsch   PetscValidBoolPointer(flag, 3);
20822bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
20832bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
20842bf73ac6SHong Zhang     PetscInt    gidx;
2085eec179cfSJacob Faibussowitsch 
20869566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
2087eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIHas(network->cloneshared->svtable, gidx + 1, flag));
20882bf73ac6SHong Zhang   } else { /* would be removed? */
20892bf73ac6SHong Zhang     PetscInt        nv;
20902bf73ac6SHong Zhang     const PetscInt *vtx;
2091eec179cfSJacob Faibussowitsch 
20929566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
2093eec179cfSJacob Faibussowitsch     for (PetscInt i = 0; i < nv; i++) {
20942bf73ac6SHong Zhang       if (p == vtx[i]) {
20952bf73ac6SHong Zhang         *flag = PETSC_TRUE;
20963ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
20972bf73ac6SHong Zhang       }
20982bf73ac6SHong Zhang     }
2099eec179cfSJacob Faibussowitsch     *flag = PETSC_FALSE;
21002bf73ac6SHong Zhang   }
21013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21022bf73ac6SHong Zhang }
21032bf73ac6SHong Zhang 
21042bf73ac6SHong Zhang /*@
210520f4b53cSBarry Smith   DMNetworkIsGhostVertex - Returns `PETSC_TRUE` if the vertex is a ghost vertex
21065f2c45f1SShri Abhyankar 
21075f2c45f1SShri Abhyankar   Not Collective
21085f2c45f1SShri Abhyankar 
21095f2c45f1SShri Abhyankar   Input Parameters:
211020f4b53cSBarry Smith + dm - the `DMNETWORK` object
2111a2b725a8SWilliam Gropp - p - the vertex point
21125f2c45f1SShri Abhyankar 
21135f2c45f1SShri Abhyankar   Output Parameter:
211420f4b53cSBarry Smith . isghost - `PETSC_TRUE` if the vertex is a ghost point
21155f2c45f1SShri Abhyankar 
211697bb938eSShri Abhyankar   Level: beginner
21175f2c45f1SShri Abhyankar 
211820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
21195f2c45f1SShri Abhyankar @*/
2120d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
2121d71ae5a4SJacob Faibussowitsch {
21225f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
21235f2c45f1SShri Abhyankar   PetscInt     offsetg;
21245f2c45f1SShri Abhyankar   PetscSection sectiong;
21255f2c45f1SShri Abhyankar 
21265f2c45f1SShri Abhyankar   PetscFunctionBegin;
21275f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
21289566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
21299566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
21305f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
21313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21325f2c45f1SShri Abhyankar }
21335f2c45f1SShri Abhyankar 
2134d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
2135d71ae5a4SJacob Faibussowitsch {
21365f2c45f1SShri Abhyankar   PetscFunctionBegin;
2137e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2138daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
21395b3f975aSHong Zhang   /* View dmnetwork */
21409566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2141e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
21423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21435f2c45f1SShri Abhyankar }
21445f2c45f1SShri Abhyankar 
21451ad426b7SHong Zhang /*@
214617df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
214720f4b53cSBarry Smith       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TRUE)?
21481ad426b7SHong Zhang 
21491ad426b7SHong Zhang   Collective
21501ad426b7SHong Zhang 
21511ad426b7SHong Zhang   Input Parameters:
215220f4b53cSBarry Smith + dm - the `DMNETWORK` object
215320f4b53cSBarry Smith . eflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for edges
215420f4b53cSBarry Smith - vflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for vertices
21551ad426b7SHong Zhang 
21561ad426b7SHong Zhang  Level: intermediate
21571ad426b7SHong Zhang 
21581ad426b7SHong Zhang @*/
2159d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2160d71ae5a4SJacob Faibussowitsch {
21611ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2162daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
21631ad426b7SHong Zhang 
21641ad426b7SHong Zhang   PetscFunctionBegin;
216583b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
216683b2e829SHong Zhang   network->userVertexJacobian = vflg;
21678675203cSHong Zhang 
216848a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
21698675203cSHong Zhang 
217066b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2171daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
217266b4e0ffSHong Zhang     PetscInt        nedges_total;
21738675203cSHong Zhang     const PetscInt *edges;
21748675203cSHong Zhang 
21758675203cSHong Zhang     /* count nvertex_total */
21768675203cSHong Zhang     nedges_total = 0;
21779566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
21788675203cSHong Zhang 
21798675203cSHong Zhang     vptr[0] = 0;
21808675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
21819566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
21828675203cSHong Zhang       nedges_total += nedges;
21838675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
21848675203cSHong Zhang     }
21858675203cSHong Zhang 
21869566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
21878675203cSHong Zhang     network->Jvptr = vptr;
21888675203cSHong Zhang   }
21893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21901ad426b7SHong Zhang }
21911ad426b7SHong Zhang 
21921ad426b7SHong Zhang /*@
219383b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
219483b2e829SHong Zhang 
219583b2e829SHong Zhang   Not Collective
219683b2e829SHong Zhang 
219783b2e829SHong Zhang   Input Parameters:
219820f4b53cSBarry Smith + dm - the `DMNETWORK` object
219983b2e829SHong Zhang . p - the edge point
22003e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
22013e97b6e8SHong Zhang         J[0]: this edge
220220f4b53cSBarry Smith         J[1] and J[2]: connected vertices, obtained by calling `DMNetworkGetConnectedVertices()`
220383b2e829SHong Zhang 
220497bb938eSShri Abhyankar   Level: advanced
220583b2e829SHong Zhang 
220620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkVertexSetMatrix()`
220783b2e829SHong Zhang @*/
2208d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2209d71ae5a4SJacob Faibussowitsch {
221083b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
221183b2e829SHong Zhang 
221283b2e829SHong Zhang   PetscFunctionBegin;
22135c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
22148675203cSHong Zhang 
22158675203cSHong Zhang   if (J) {
2216883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2217883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2218883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
22198675203cSHong Zhang   }
22203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
222183b2e829SHong Zhang }
222283b2e829SHong Zhang 
222383b2e829SHong Zhang /*@
222476ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
22251ad426b7SHong Zhang 
22261ad426b7SHong Zhang   Not Collective
22271ad426b7SHong Zhang 
22281ad426b7SHong Zhang   Input Parameters:
222920f4b53cSBarry Smith + dm - The `DMNETWORK` object
22301ad426b7SHong Zhang . p - the vertex point
22313e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
22323e97b6e8SHong Zhang         J[0]:       this vertex
22333e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
22343e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
22351ad426b7SHong Zhang 
223697bb938eSShri Abhyankar   Level: advanced
22371ad426b7SHong Zhang 
223820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkEdgeSetMatrix()`
22391ad426b7SHong Zhang @*/
2240d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2241d71ae5a4SJacob Faibussowitsch {
22425f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2243daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2244883e35e8SHong Zhang   const PetscInt *edges;
22455f2c45f1SShri Abhyankar 
22465f2c45f1SShri Abhyankar   PetscFunctionBegin;
22475c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2248883e35e8SHong Zhang 
22498675203cSHong Zhang   if (J) {
2250883e35e8SHong Zhang     vptr                          = network->Jvptr;
22513e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
22523e97b6e8SHong Zhang 
22533e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
22549566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2255883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
22568675203cSHong Zhang   }
22573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2258883e35e8SHong Zhang }
2259883e35e8SHong Zhang 
2260d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2261d71ae5a4SJacob Faibussowitsch {
22625cf7da58SHong Zhang   PetscInt    j;
22635cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
22645cf7da58SHong Zhang 
22655cf7da58SHong Zhang   PetscFunctionBegin;
22665cf7da58SHong Zhang   if (!ghost) {
226748a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22685cf7da58SHong Zhang   } else {
226948a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22705cf7da58SHong Zhang   }
22713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22725cf7da58SHong Zhang }
22735cf7da58SHong Zhang 
2274d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2275d71ae5a4SJacob Faibussowitsch {
22765cf7da58SHong Zhang   PetscInt    j, ncols_u;
22775cf7da58SHong Zhang   PetscScalar val;
22785cf7da58SHong Zhang 
22795cf7da58SHong Zhang   PetscFunctionBegin;
22805cf7da58SHong Zhang   if (!ghost) {
22815cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22829566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22835cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22849566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22859566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22865cf7da58SHong Zhang     }
22875cf7da58SHong Zhang   } else {
22885cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22899566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22905cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22919566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22929566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22935cf7da58SHong Zhang     }
22945cf7da58SHong Zhang   }
22953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22965cf7da58SHong Zhang }
22975cf7da58SHong Zhang 
2298d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2299d71ae5a4SJacob Faibussowitsch {
23005cf7da58SHong Zhang   PetscFunctionBegin;
23015cf7da58SHong Zhang   if (Ju) {
23029566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
23035cf7da58SHong Zhang   } else {
23049566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
23055cf7da58SHong Zhang   }
23063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23075cf7da58SHong Zhang }
23085cf7da58SHong Zhang 
2309d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2310d71ae5a4SJacob Faibussowitsch {
2311883e35e8SHong Zhang   PetscInt     j, *cols;
2312883e35e8SHong Zhang   PetscScalar *zeros;
2313883e35e8SHong Zhang 
2314883e35e8SHong Zhang   PetscFunctionBegin;
23159566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2316883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
23179566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
23189566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
23193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23201ad426b7SHong Zhang }
2321a4e85ca8SHong Zhang 
2322d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2323d71ae5a4SJacob Faibussowitsch {
23243e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
23253e97b6e8SHong Zhang   const PetscInt *cols;
23263e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
23273e97b6e8SHong Zhang 
23283e97b6e8SHong Zhang   PetscFunctionBegin;
23299566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
233063a3b9bcSJacob 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);
23313e97b6e8SHong Zhang 
23323e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
23339566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
23343e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
23353e97b6e8SHong Zhang       col = cols[j] + cstart;
23369566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
23373e97b6e8SHong Zhang     }
23389566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
23393e97b6e8SHong Zhang   }
23403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23413e97b6e8SHong Zhang }
23421ad426b7SHong Zhang 
2343d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2344d71ae5a4SJacob Faibussowitsch {
2345a4e85ca8SHong Zhang   PetscFunctionBegin;
2346a4e85ca8SHong Zhang   if (Ju) {
23479566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2348a4e85ca8SHong Zhang   } else {
23499566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2350a4e85ca8SHong Zhang   }
23513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2352a4e85ca8SHong Zhang }
2353a4e85ca8SHong Zhang 
235424121865SAdrian 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.
235524121865SAdrian Maldonado */
2356d71ae5a4SJacob Faibussowitsch PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2357d71ae5a4SJacob Faibussowitsch {
235824121865SAdrian Maldonado   PetscInt  i, size, dof;
235924121865SAdrian Maldonado   PetscInt *glob2loc;
236024121865SAdrian Maldonado 
236124121865SAdrian Maldonado   PetscFunctionBegin;
23629566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
23639566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
236424121865SAdrian Maldonado 
236524121865SAdrian Maldonado   for (i = 0; i < size; i++) {
23669566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
236724121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
236824121865SAdrian Maldonado     glob2loc[i] = dof;
236924121865SAdrian Maldonado   }
237024121865SAdrian Maldonado 
2371e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)globalsec), 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
237224121865SAdrian Maldonado #if 0
23739566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
237424121865SAdrian Maldonado #endif
23753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
237624121865SAdrian Maldonado }
237724121865SAdrian Maldonado 
237801ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
23799e1d080bSHong Zhang 
2380d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2381d71ae5a4SJacob Faibussowitsch {
23821ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
238324121865SAdrian Maldonado   PetscInt               eDof, vDof;
238424121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
23859e1d080bSHong Zhang   MPI_Comm               comm;
238624121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
238724121865SAdrian Maldonado 
23889e1d080bSHong Zhang   PetscFunctionBegin;
23899566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
239024121865SAdrian Maldonado 
23919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
23929566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
239324121865SAdrian Maldonado 
23949566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
23959566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
23969566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
239724121865SAdrian Maldonado 
23989566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
23999566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24009566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
240124121865SAdrian Maldonado 
24029566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
24039566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24049566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
240524121865SAdrian Maldonado 
24069566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
24079566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24089566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
240924121865SAdrian Maldonado 
24103f6a6bdaSHong Zhang   bA[0][0] = j11;
24113f6a6bdaSHong Zhang   bA[0][1] = j12;
24123f6a6bdaSHong Zhang   bA[1][0] = j21;
24133f6a6bdaSHong Zhang   bA[1][1] = j22;
241424121865SAdrian Maldonado 
24159566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
24169566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
241724121865SAdrian Maldonado 
24189566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
24199566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
24209566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
24219566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
242224121865SAdrian Maldonado 
24239566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
24249566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
24259566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
24269566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
242724121865SAdrian Maldonado 
24289566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
24299566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
24309566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
24319566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
24329566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
24339566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
24349566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
243524121865SAdrian Maldonado 
24369566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
24379566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
24389566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
243924121865SAdrian Maldonado 
244024121865SAdrian Maldonado   /* Free structures */
24419566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
24429566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
24433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24449e1d080bSHong Zhang }
24459e1d080bSHong Zhang 
2446d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2447d71ae5a4SJacob Faibussowitsch {
24489e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
24499e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
24509e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
24519e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
24529e1d080bSHong Zhang   Mat             Juser;
24539e1d080bSHong Zhang   PetscSection    sectionGlobal;
24549e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
24559e1d080bSHong Zhang   const PetscInt *edges, *cone;
24569e1d080bSHong Zhang   MPI_Comm        comm;
24579e1d080bSHong Zhang   MatType         mtype;
24589e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
24599e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
24609e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
24619e1d080bSHong Zhang 
24629e1d080bSHong Zhang   PetscFunctionBegin;
24639e1d080bSHong Zhang   mtype = dm->mattype;
24649566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
24659e1d080bSHong Zhang   if (isNest) {
24669566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
24679566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24683ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24699e1d080bSHong Zhang   }
24709e1d080bSHong Zhang 
24719e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2472a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
24739566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
24749566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24753ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24761ad426b7SHong Zhang   }
24771ad426b7SHong Zhang 
24789566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
24799566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
24809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
24819566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
24822a945128SHong Zhang 
24839566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
24849566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
248589898e50SHong Zhang 
248689898e50SHong Zhang   /* (1) Set matrix preallocation */
248789898e50SHong Zhang   /*------------------------------*/
24889566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
24899566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
24909566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
24919566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
24929566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
24939566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2494840c2264SHong Zhang 
249589898e50SHong Zhang   /* Set preallocation for edges */
249689898e50SHong Zhang   /*-----------------------------*/
24979566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2498840c2264SHong Zhang 
24999566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2500840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2501840c2264SHong Zhang     /* Get row indices */
25029566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
25039566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2504840c2264SHong Zhang     if (nrows) {
2505840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2506840c2264SHong Zhang 
2507a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
25089566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2509840c2264SHong Zhang       for (v = 0; v < 2; v++) {
25109566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2511840c2264SHong Zhang 
25128675203cSHong Zhang         if (network->Je) {
2513840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
25148675203cSHong Zhang         } else Juser = NULL;
25159566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
25169566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2517840c2264SHong Zhang       }
2518840c2264SHong Zhang 
251989898e50SHong Zhang       /* Set preallocation for edge self */
2520840c2264SHong Zhang       cstart = rstart;
25218675203cSHong Zhang       if (network->Je) {
2522840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25238675203cSHong Zhang       } else Juser = NULL;
25249566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2525840c2264SHong Zhang     }
2526840c2264SHong Zhang   }
2527840c2264SHong Zhang 
252889898e50SHong Zhang   /* Set preallocation for vertices */
252989898e50SHong Zhang   /*--------------------------------*/
25309566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
25318675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2532840c2264SHong Zhang 
2533840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2534840c2264SHong Zhang     /* Get row indices */
25359566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25369566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2537840c2264SHong Zhang     if (!nrows) continue;
2538840c2264SHong Zhang 
25399566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2540bdcb62a2SHong Zhang     if (ghost) {
25419566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2542bdcb62a2SHong Zhang     } else {
2543bdcb62a2SHong Zhang       rows_v = rows;
2544bdcb62a2SHong Zhang     }
2545bdcb62a2SHong Zhang 
2546bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2547840c2264SHong Zhang 
2548840c2264SHong Zhang     /* Get supporting edges and connected vertices */
25499566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2550840c2264SHong Zhang 
2551840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2552840c2264SHong Zhang       /* Supporting edges */
25539566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25549566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2555840c2264SHong Zhang 
25568675203cSHong Zhang       if (network->Jv) {
2557840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25588675203cSHong Zhang       } else Juser = NULL;
25599566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2560840c2264SHong Zhang 
2561840c2264SHong Zhang       /* Connected vertices */
25629566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2563840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25649566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2565840c2264SHong Zhang 
25669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2567840c2264SHong Zhang 
25688675203cSHong Zhang       if (network->Jv) {
2569840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25708675203cSHong Zhang       } else Juser = NULL;
2571e102a522SHong Zhang       if (ghost_vc || ghost) {
2572e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2573e102a522SHong Zhang       } else {
2574e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2575e102a522SHong Zhang       }
25769566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2577840c2264SHong Zhang     }
2578840c2264SHong Zhang 
257989898e50SHong Zhang     /* Set preallocation for vertex self */
25809566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2581840c2264SHong Zhang     if (!ghost) {
25829566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
25838675203cSHong Zhang       if (network->Jv) {
2584840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25858675203cSHong Zhang       } else Juser = NULL;
25869566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2587840c2264SHong Zhang     }
25881baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2589840c2264SHong Zhang   }
2590840c2264SHong Zhang 
25919566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
25929566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
25935cf7da58SHong Zhang 
25949566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
25955cf7da58SHong Zhang 
25969566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
25979566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2598840c2264SHong Zhang 
25999566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
26009566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2601840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2602e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2603e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2604840c2264SHong Zhang   }
26059566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
26069566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
26079566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
26089566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2609840c2264SHong Zhang 
26109566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
26119566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
26129566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
26135cf7da58SHong Zhang 
26149566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
26155cf7da58SHong Zhang 
261689898e50SHong Zhang   /* (2) Set matrix entries for edges */
261789898e50SHong Zhang   /*----------------------------------*/
26181ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2619bfbc38dcSHong Zhang     /* Get row indices */
26209566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
26219566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
26224b976069SHong Zhang     if (nrows) {
262317df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
26241ad426b7SHong Zhang 
2625a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
26269566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2627bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
26289566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
26299566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
26303e97b6e8SHong Zhang 
26318675203cSHong Zhang         if (network->Je) {
2632a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
26338675203cSHong Zhang         } else Juser = NULL;
26349566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2635bfbc38dcSHong Zhang       }
263617df6e9eSHong Zhang 
2637bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
26383e97b6e8SHong Zhang       cstart = rstart;
26398675203cSHong Zhang       if (network->Je) {
2640a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
26418675203cSHong Zhang       } else Juser = NULL;
26429566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
26431ad426b7SHong Zhang     }
26444b976069SHong Zhang   }
26451ad426b7SHong Zhang 
2646bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
264783b2e829SHong Zhang   /*---------------------------------*/
26481ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2649bfbc38dcSHong Zhang     /* Get row indices */
26509566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
26519566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
26524b976069SHong Zhang     if (!nrows) continue;
2653596e729fSHong Zhang 
26549566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2655bdcb62a2SHong Zhang     if (ghost) {
26569566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2657bdcb62a2SHong Zhang     } else {
2658bdcb62a2SHong Zhang       rows_v = rows;
2659bdcb62a2SHong Zhang     }
2660bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2661596e729fSHong Zhang 
2662bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
26639566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2664596e729fSHong Zhang 
2665596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2666bfbc38dcSHong Zhang       /* Supporting edges */
26679566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
26689566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2669596e729fSHong Zhang 
26708675203cSHong Zhang       if (network->Jv) {
2671a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
26728675203cSHong Zhang       } else Juser = NULL;
26739566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2674596e729fSHong Zhang 
2675bfbc38dcSHong Zhang       /* Connected vertices */
26769566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
26772a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
26782a945128SHong Zhang 
26799566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
26809566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2681a4e85ca8SHong Zhang 
26828675203cSHong Zhang       if (network->Jv) {
2683a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
26848675203cSHong Zhang       } else Juser = NULL;
26859566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2686596e729fSHong Zhang     }
2687596e729fSHong Zhang 
2688bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
26891ad426b7SHong Zhang     if (!ghost) {
26909566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
26918675203cSHong Zhang       if (network->Jv) {
2692a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
26938675203cSHong Zhang       } else Juser = NULL;
26949566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2695bdcb62a2SHong Zhang     }
26961baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
26971ad426b7SHong Zhang   }
26989566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2699bdcb62a2SHong Zhang 
27009566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
27019566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2702dd6f46cdSHong Zhang 
27039566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
27043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27055f2c45f1SShri Abhyankar }
27065f2c45f1SShri Abhyankar 
2707d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2708d71ae5a4SJacob Faibussowitsch {
2709daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2710daad07d3SAidan Hamilton   PetscInt    j, np;
2711daad07d3SAidan Hamilton 
2712daad07d3SAidan Hamilton   PetscFunctionBegin;
2713daad07d3SAidan Hamilton   if (network->header) {
2714daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2715daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2716daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2717daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2718daad07d3SAidan Hamilton     }
2719daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2720daad07d3SAidan Hamilton   }
27213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2722daad07d3SAidan Hamilton }
2723daad07d3SAidan Hamilton 
2724d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2725d71ae5a4SJacob Faibussowitsch {
27265f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2727aeb78aa7SBarry Smith   PetscInt    j;
27285f2c45f1SShri Abhyankar 
27295f2c45f1SShri Abhyankar   PetscFunctionBegin;
2730daad07d3SAidan Hamilton   /*
2731daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2732daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2733daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2734daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2735daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2736daad07d3SAidan Hamilton   */
2737daad07d3SAidan Hamilton 
2738daad07d3SAidan Hamilton   /* Always destroy data ON the network */
27399566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
274083b2e829SHong Zhang   if (network->Jv) {
27419566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
27429566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
27431ad426b7SHong Zhang   }
2744daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2745daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2746daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2747daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2748daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
274913c2a604SAdrian Maldonado 
2750daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2751daad07d3SAidan Hamilton 
2752daad07d3SAidan Hamilton   /*
2753daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2754daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2755daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2756daad07d3SAidan Hamilton     PetscSF                           sf;
2757daad07d3SAidan Hamilton   and data ON the network
2758daad07d3SAidan Hamilton     PetscSection                      DofSection;
2759daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2760daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2761daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2762daad07d3SAidan Hamilton   for any clone.
2763daad07d3SAidan Hamilton   */
27649566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
27659566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
27669566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
27679566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
276813c2a604SAdrian Maldonado   /* edge */
27699566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
27709566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
27719566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
27729566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2773daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2774daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2775daad07d3SAidan 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
2776daad07d3SAidan Hamilton      naively think it can be reused. */
2777daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2778daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2779daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2780daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2781eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(&network->cloneshared->svtable));
2782daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2783daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2784daad07d3SAidan Hamilton   }
2785daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
27863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27875f2c45f1SShri Abhyankar }
27885f2c45f1SShri Abhyankar 
2789d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2790d71ae5a4SJacob Faibussowitsch {
27915f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27925f2c45f1SShri Abhyankar 
27935f2c45f1SShri Abhyankar   PetscFunctionBegin;
27949566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
27953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27965f2c45f1SShri Abhyankar }
27975f2c45f1SShri Abhyankar 
2798d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2799d71ae5a4SJacob Faibussowitsch {
28005f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28015f2c45f1SShri Abhyankar 
28025f2c45f1SShri Abhyankar   PetscFunctionBegin;
28039566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
28043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28055f2c45f1SShri Abhyankar }
28065f2c45f1SShri Abhyankar 
2807d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2808d71ae5a4SJacob Faibussowitsch {
28095f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28105f2c45f1SShri Abhyankar 
28115f2c45f1SShri Abhyankar   PetscFunctionBegin;
28129566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
28133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28145f2c45f1SShri Abhyankar }
28155f2c45f1SShri Abhyankar 
2816d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2817d71ae5a4SJacob Faibussowitsch {
28185f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28195f2c45f1SShri Abhyankar 
28205f2c45f1SShri Abhyankar   PetscFunctionBegin;
28219566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
28223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28235f2c45f1SShri Abhyankar }
282422bbedd7SHong Zhang 
282522bbedd7SHong Zhang /*@
282664238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
282722bbedd7SHong Zhang 
282820f4b53cSBarry Smith   Not Collective
282922bbedd7SHong Zhang 
28307a7aea1fSJed Brown   Input Parameters:
283120f4b53cSBarry Smith + dm - the `DMNETWORK` object
283222bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
283322bbedd7SHong Zhang 
28342fe279fdSBarry Smith   Output Parameter:
2835f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
283622bbedd7SHong Zhang 
283797bb938eSShri Abhyankar   Level: advanced
283822bbedd7SHong Zhang 
283920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetVertexLocalToGlobalOrdering()`
284022bbedd7SHong Zhang @*/
2841d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2842d71ae5a4SJacob Faibussowitsch {
284322bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2844daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
284522bbedd7SHong Zhang 
284622bbedd7SHong Zhang   PetscFunctionBegin;
28475c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
284822bbedd7SHong Zhang   *vg = vltog[vloc];
28493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
285022bbedd7SHong Zhang }
285122bbedd7SHong Zhang 
285222bbedd7SHong Zhang /*@
285364238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
285422bbedd7SHong Zhang 
285522bbedd7SHong Zhang   Collective
285622bbedd7SHong Zhang 
285722bbedd7SHong Zhang   Input Parameters:
285820f4b53cSBarry Smith . dm - the `DMNETWORK` object
285922bbedd7SHong Zhang 
286097bb938eSShri Abhyankar   Level: advanced
286122bbedd7SHong Zhang 
286220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
286322bbedd7SHong Zhang @*/
2864d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2865d71ae5a4SJacob Faibussowitsch {
286622bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
286722bbedd7SHong Zhang   MPI_Comm           comm;
28682bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
286922bbedd7SHong Zhang   PetscBool          ghost;
287063029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
287122bbedd7SHong Zhang   const PetscSFNode *iremote;
287222bbedd7SHong Zhang   PetscSF            vsf;
287363029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
287463029d29SHong Zhang   VecScatter         ctx;
287563029d29SHong Zhang   PetscScalar       *varr, val;
287663029d29SHong Zhang   const PetscScalar *varr_read;
287722bbedd7SHong Zhang 
287822bbedd7SHong Zhang   PetscFunctionBegin;
28799566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
28809566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
28819566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
288222bbedd7SHong Zhang 
288322bbedd7SHong Zhang   if (size == 1) {
2884daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
28859566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
288622bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2887daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
28883ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
288922bbedd7SHong Zhang   }
289022bbedd7SHong Zhang 
2891daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2892daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
289322bbedd7SHong Zhang 
2894e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
28959566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
289622bbedd7SHong Zhang   vsf = network->vertex.sf;
289722bbedd7SHong Zhang 
28989566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
28999566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
290022bbedd7SHong Zhang 
29019371c9d4SSatish Balay   for (i = 0; i < size; i++) {
29029371c9d4SSatish Balay     displs[i]     = i;
29039371c9d4SSatish Balay     recvcounts[i] = 1;
29049371c9d4SSatish Balay   }
290522bbedd7SHong Zhang 
290622bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
290722bbedd7SHong Zhang   vrange[0] = 0;
29089566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
2909ad540459SPierre Jolivet   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
291022bbedd7SHong Zhang 
29119566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2912daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
291322bbedd7SHong Zhang 
291463029d29SHong Zhang   /* Set vltog for non-ghost vertices */
291563029d29SHong Zhang   k = 0;
291622bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2917daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
291863029d29SHong Zhang     if (ghost) continue;
291963029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
292022bbedd7SHong Zhang   }
29219566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
292263029d29SHong Zhang 
292363029d29SHong Zhang   /* Set vltog for ghost vertices */
292463029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
29259566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
29269566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
29279566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
29289566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
292963029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
293063029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
293163029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
293263029d29SHong Zhang   }
29339566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
293463029d29SHong Zhang 
293563029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
29369566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
29379566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
29389566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
293963029d29SHong Zhang 
294063029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
29419566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
29429566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
294363029d29SHong Zhang   for (i = 0; i < N; i += 2) {
29442e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
294563029d29SHong Zhang     if (remoterank == rank) {
294663029d29SHong Zhang       k    = i + 1; /* row number */
29472e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
294863029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
29499566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
295063029d29SHong Zhang     }
295163029d29SHong Zhang   }
29529566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
29539566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
29549566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
295563029d29SHong Zhang 
295663029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
29579566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
295863029d29SHong Zhang   k = 0;
295963029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2960daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
296163029d29SHong Zhang     if (!ghost) continue;
29629371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
29639371c9d4SSatish Balay     k++;
296463029d29SHong Zhang   }
29659566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
296663029d29SHong Zhang 
29679566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
29689566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
29699566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
29703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297122bbedd7SHong Zhang }
297242dc13f1SHong Zhang 
2973d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2974d71ae5a4SJacob Faibussowitsch {
297542dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
297642dc13f1SHong Zhang   DMNetworkComponentHeader header;
297742dc13f1SHong Zhang 
297842dc13f1SHong Zhang   PetscFunctionBegin;
29799566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
298042dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
298142dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
298242dc13f1SHong Zhang 
298342dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
298442dc13f1SHong Zhang     key  = header->key[i];
298542dc13f1SHong Zhang     nvar = header->nvar[i];
298642dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
298742dc13f1SHong Zhang       if (key == keys[j]) {
298842dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
298942dc13f1SHong Zhang           *nidx += nvar;
299042dc13f1SHong Zhang         } else {
299142dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
299242dc13f1SHong Zhang         }
299342dc13f1SHong Zhang       }
299442dc13f1SHong Zhang     }
299542dc13f1SHong Zhang   }
29963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
299742dc13f1SHong Zhang }
299842dc13f1SHong Zhang 
2999d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3000d71ae5a4SJacob Faibussowitsch {
300142dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
300242dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
300342dc13f1SHong Zhang   DMNetworkComponentHeader header;
300442dc13f1SHong Zhang 
300542dc13f1SHong Zhang   PetscFunctionBegin;
30069566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
300742dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
300842dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
300942dc13f1SHong Zhang 
301042dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
301142dc13f1SHong Zhang     key  = header->key[i];
301242dc13f1SHong Zhang     nvar = header->nvar[i];
301342dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
301442dc13f1SHong Zhang       if (key != keys[j]) continue;
301542dc13f1SHong Zhang 
30169566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
301742dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
301842dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
301942dc13f1SHong Zhang       } else {
302042dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
302142dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
302242dc13f1SHong Zhang         }
302342dc13f1SHong Zhang       }
302442dc13f1SHong Zhang     }
302542dc13f1SHong Zhang   }
30263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
302742dc13f1SHong Zhang }
302842dc13f1SHong Zhang 
302942dc13f1SHong Zhang /*@
303042dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
303142dc13f1SHong Zhang 
303242dc13f1SHong Zhang   Collective
303342dc13f1SHong Zhang 
303442dc13f1SHong Zhang   Input Parameters:
303520f4b53cSBarry Smith + dm - `DMNETWORK` object
303642dc13f1SHong Zhang . numkeys - number of keys
303742dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
303842dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
303942dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
304042dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
304142dc13f1SHong Zhang 
30422fe279fdSBarry Smith   Output Parameter:
304342dc13f1SHong Zhang . is - the index set
304442dc13f1SHong Zhang 
304520f4b53cSBarry Smith   Level: advanced
304642dc13f1SHong Zhang 
304742dc13f1SHong Zhang   Notes:
304820f4b53cSBarry 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.
304942dc13f1SHong Zhang 
305020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
305142dc13f1SHong Zhang @*/
3052d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3053d71ae5a4SJacob Faibussowitsch {
305442dc13f1SHong Zhang   MPI_Comm    comm;
305542dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
305642dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
305742dc13f1SHong Zhang   PetscBool   ghost;
305842dc13f1SHong Zhang 
305942dc13f1SHong Zhang   PetscFunctionBegin;
30609566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
306142dc13f1SHong Zhang 
306242dc13f1SHong Zhang   /* Check input parameters */
306342dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
306442dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
306563a3b9bcSJacob 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]);
306642dc13f1SHong Zhang   }
306742dc13f1SHong Zhang 
30689566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
30699566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
307042dc13f1SHong Zhang 
307142dc13f1SHong Zhang   /* Get local number of idx */
307242dc13f1SHong Zhang   nidx = 0;
307348a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
307442dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30759566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
307642dc13f1SHong Zhang     if (ghost) continue;
30779566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
307842dc13f1SHong Zhang   }
307942dc13f1SHong Zhang 
308042dc13f1SHong Zhang   /* Compute idx */
30819566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
308242dc13f1SHong Zhang   i = 0;
308348a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
308442dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30859566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
308642dc13f1SHong Zhang     if (ghost) continue;
30879566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
308842dc13f1SHong Zhang   }
308942dc13f1SHong Zhang 
309042dc13f1SHong Zhang   /* Create is */
30919566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
30929566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
30933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
309442dc13f1SHong Zhang }
309542dc13f1SHong Zhang 
3096d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3097d71ae5a4SJacob Faibussowitsch {
309842dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
309942dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
310042dc13f1SHong Zhang   DMNetworkComponentHeader header;
310142dc13f1SHong Zhang 
310242dc13f1SHong Zhang   PetscFunctionBegin;
31039566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
310442dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
310542dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
310642dc13f1SHong Zhang 
310742dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
310842dc13f1SHong Zhang     key  = header->key[i];
310942dc13f1SHong Zhang     nvar = header->nvar[i];
311042dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
311142dc13f1SHong Zhang       if (key != keys[j]) continue;
311242dc13f1SHong Zhang 
31139566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
311442dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
311542dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
311642dc13f1SHong Zhang       } else {
311742dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
311842dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
311942dc13f1SHong Zhang         }
312042dc13f1SHong Zhang       }
312142dc13f1SHong Zhang     }
312242dc13f1SHong Zhang   }
31233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
312442dc13f1SHong Zhang }
312542dc13f1SHong Zhang 
312642dc13f1SHong Zhang /*@
312742dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
312842dc13f1SHong Zhang 
312920f4b53cSBarry Smith   Not Collective
313042dc13f1SHong Zhang 
313142dc13f1SHong Zhang   Input Parameters:
313220f4b53cSBarry Smith + dm - `DMNETWORK` object
313342dc13f1SHong Zhang . numkeys - number of keys
313442dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
313542dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
313642dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
313742dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
313842dc13f1SHong Zhang 
31392fe279fdSBarry Smith   Output Parameter:
314042dc13f1SHong Zhang . is - the index set
314142dc13f1SHong Zhang 
314220f4b53cSBarry Smith   Level: advanced
314342dc13f1SHong Zhang 
314442dc13f1SHong Zhang   Notes:
314520f4b53cSBarry 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.
314642dc13f1SHong Zhang 
314720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkCreateIS`, `ISCreateGeneral()`
314842dc13f1SHong Zhang @*/
3149d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3150d71ae5a4SJacob Faibussowitsch {
315142dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
315242dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
315342dc13f1SHong Zhang 
315442dc13f1SHong Zhang   PetscFunctionBegin;
315542dc13f1SHong Zhang   /* Check input parameters */
315642dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
315742dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
315863a3b9bcSJacob 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]);
315942dc13f1SHong Zhang   }
316042dc13f1SHong Zhang 
3161daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3162daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
316342dc13f1SHong Zhang 
316442dc13f1SHong Zhang   /* Get local number of idx */
316542dc13f1SHong Zhang   nidx = 0;
316648a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
316742dc13f1SHong Zhang 
316842dc13f1SHong Zhang   /* Compute local idx */
31699566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
317042dc13f1SHong Zhang   i = 0;
317148a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
317242dc13f1SHong Zhang 
317342dc13f1SHong Zhang   /* Create is */
31749566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31759566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
317742dc13f1SHong Zhang }
3178daad07d3SAidan Hamilton /*@
3179d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3180daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3181daad07d3SAidan Hamilton 
3182daad07d3SAidan Hamilton   Collective
3183daad07d3SAidan Hamilton 
31842fe279fdSBarry Smith   Input Parameter:
318520f4b53cSBarry Smith . dm - the `DMNETWORK` object
3186daad07d3SAidan Hamilton 
3187daad07d3SAidan Hamilton   Level: beginner
3188daad07d3SAidan Hamilton 
318920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3190daad07d3SAidan Hamilton @*/
3191d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3192d71ae5a4SJacob Faibussowitsch {
3193daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3194daad07d3SAidan Hamilton 
3195daad07d3SAidan Hamilton   PetscFunctionBegin;
31963ba16761SJacob Faibussowitsch   if (network->componentsetup) PetscFunctionReturn(PETSC_SUCCESS);
3197daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3198daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3199daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3200daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3201daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
32023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3203daad07d3SAidan Hamilton }
3204