xref: /petsc/src/dm/impls/network/network.c (revision dd5bbc93040c06606aba1545b075ff38bd28e24f)
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);
21*dd5bbc93SStefano Zampini #if defined(__NEC__)
22*dd5bbc93SStefano Zampini   /* NEC/LG: quick hack to keep data aligned on 8 bytes. */
23*dd5bbc93SStefano Zampini   header->hsize = (header->hsize + (8 - 1)) & ~(8 - 1);
24*dd5bbc93SStefano Zampini #endif
253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2654dfd506SHong Zhang }
2754dfd506SHong Zhang 
28d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeHeaderComponentData(DM dm)
29d71ae5a4SJacob Faibussowitsch {
30daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
31daad07d3SAidan Hamilton   PetscInt    np, p, defaultnumcomp = DMNETWORK_MAX_COMP_AT_POINT_DEFAULT;
32daad07d3SAidan Hamilton 
33daad07d3SAidan Hamilton   PetscFunctionBegin;
34daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
35daad07d3SAidan Hamilton   if (network->header)
36daad07d3SAidan Hamilton     for (p = 0; p < np; p++) {
37daad07d3SAidan Hamilton       network->header[p].maxcomps = defaultnumcomp;
38daad07d3SAidan Hamilton       PetscCall(SetUpNetworkHeaderComponentValue(dm, &network->header[p], &network->cvalue[p]));
39daad07d3SAidan Hamilton     }
40daad07d3SAidan Hamilton 
413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
42daad07d3SAidan Hamilton }
435f2c45f1SShri Abhyankar /*@
4420f4b53cSBarry Smith   DMNetworkGetPlex - Gets the `DMPLEX` associated with this `DMNETWORK`
45556ed216SShri Abhyankar 
4620f4b53cSBarry Smith   Not Collective
47556ed216SShri Abhyankar 
482fe279fdSBarry Smith   Input Parameter:
4920f4b53cSBarry Smith . dm - the `DMNETWORK` object
502bf73ac6SHong Zhang 
512fe279fdSBarry Smith   Output Parameter:
5220f4b53cSBarry Smith . plexdm - the `DMPLEX` object
53556ed216SShri Abhyankar 
5420f4b53cSBarry Smith   Level: advanced
55556ed216SShri Abhyankar 
5620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMPLEX`, `DMNetworkCreate()`
57556ed216SShri Abhyankar @*/
58d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetPlex(DM dm, DM *plexdm)
59d71ae5a4SJacob Faibussowitsch {
602bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
61556ed216SShri Abhyankar 
62556ed216SShri Abhyankar   PetscFunctionBegin;
63556ed216SShri Abhyankar   *plexdm = network->plex;
643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
65556ed216SShri Abhyankar }
66556ed216SShri Abhyankar 
67556ed216SShri Abhyankar /*@
682bf73ac6SHong Zhang   DMNetworkGetNumSubNetworks - Gets the the number of subnetworks
6972c3e9f7SHong Zhang 
7020f4b53cSBarry Smith   Not Collective
7172c3e9f7SHong Zhang 
72f899ff85SJose E. Roman   Input Parameter:
7320f4b53cSBarry Smith . dm - the `DMNETWORK` object
742bf73ac6SHong Zhang 
752bf73ac6SHong Zhang   Output Parameters:
762bf73ac6SHong Zhang + nsubnet - local number of subnetworks
772bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
7872c3e9f7SHong Zhang 
7997bb938eSShri Abhyankar   Level: beginner
8072c3e9f7SHong Zhang 
8120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
8272c3e9f7SHong Zhang @*/
83d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PetscInt *nsubnet, PetscInt *Nsubnet)
84d71ae5a4SJacob Faibussowitsch {
852bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8672c3e9f7SHong Zhang 
8772c3e9f7SHong Zhang   PetscFunctionBegin;
88daad07d3SAidan Hamilton   if (nsubnet) *nsubnet = network->cloneshared->nsubnet;
89daad07d3SAidan Hamilton   if (Nsubnet) *Nsubnet = network->cloneshared->Nsubnet;
903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9172c3e9f7SHong Zhang }
9272c3e9f7SHong Zhang 
9372c3e9f7SHong Zhang /*@
942bf73ac6SHong Zhang   DMNetworkSetNumSubNetworks - Sets the number of subnetworks
955f2c45f1SShri Abhyankar 
9620f4b53cSBarry Smith   Collective
975f2c45f1SShri Abhyankar 
985f2c45f1SShri Abhyankar   Input Parameters:
9920f4b53cSBarry Smith + dm - the `DMNETWORK` object
1002bf73ac6SHong Zhang . nsubnet - local number of subnetworks
1012bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
1025f2c45f1SShri Abhyankar 
10397bb938eSShri Abhyankar    Level: beginner
1041b266c99SBarry Smith 
10520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetNumSubNetworks()`
1065f2c45f1SShri Abhyankar @*/
107d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetNumSubNetworks(DM dm, PetscInt nsubnet, PetscInt Nsubnet)
108d71ae5a4SJacob Faibussowitsch {
1095f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1105f2c45f1SShri Abhyankar 
1115f2c45f1SShri Abhyankar   PetscFunctionBegin;
112d5b43468SJose E. Roman   PetscCheck(network->cloneshared->Nsubnet == 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Network sizes already set, cannot resize the network");
1132bf73ac6SHong Zhang 
1145f2c45f1SShri Abhyankar   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1152bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, nsubnet, 2);
1162bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, Nsubnet, 3);
1177765340cSHong Zhang 
1182bf73ac6SHong Zhang   if (Nsubnet == PETSC_DECIDE) {
1195c6496baSHong Zhang     PetscCheck(nsubnet >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Number of local subnetworks %" PetscInt_FMT " cannot be less than 0", nsubnet);
1201c2dc1cbSBarry Smith     PetscCall(MPIU_Allreduce(&nsubnet, &Nsubnet, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
121caf410d2SHong Zhang   }
1225c6496baSHong Zhang   PetscCheck(Nsubnet >= 1, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Number of global subnetworks %" PetscInt_FMT " cannot be less than 1", Nsubnet);
123caf410d2SHong Zhang 
124daad07d3SAidan Hamilton   network->cloneshared->Nsubnet = Nsubnet;
125da81f932SPierre Jolivet   network->cloneshared->nsubnet = 0; /* initial value; will be determined by DMNetworkAddSubnetwork() */
126daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(Nsubnet, &network->cloneshared->subnet));
127caf410d2SHong Zhang 
1282bf73ac6SHong Zhang   /* num of shared vertices */
129daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0;
130daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = 0;
1313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1327765340cSHong Zhang }
1337765340cSHong Zhang 
1345f2c45f1SShri Abhyankar /*@
1352bf73ac6SHong Zhang   DMNetworkAddSubnetwork - Add a subnetwork
1365f2c45f1SShri Abhyankar 
13720f4b53cSBarry Smith   Collective
1385f2c45f1SShri Abhyankar 
1395f2c45f1SShri Abhyankar   Input Parameters:
14020f4b53cSBarry Smith + dm - the `DMNETWORK`  object
1412bf73ac6SHong Zhang . name - name of the subnetwork
1422bf73ac6SHong Zhang . ne - number of local edges of this subnetwork
14320f4b53cSBarry 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
14420f4b53cSBarry Smith               of the vertices) of each edge,
1458d1cd658SBarry Smith $            [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc]
1462bf73ac6SHong Zhang 
1472fe279fdSBarry Smith   Output Parameter:
1482bf73ac6SHong Zhang . netnum - global index of the subnetwork
1495f2c45f1SShri Abhyankar 
15020f4b53cSBarry Smith   Level: beginner
15120f4b53cSBarry Smith 
1525f2c45f1SShri Abhyankar   Notes:
1535f2c45f1SShri Abhyankar   There is no copy involved in this operation, only the pointer is referenced. The edgelist should
15420f4b53cSBarry Smith   not be destroyed before the call to `DMNetworkLayoutSetUp()`
1555f2c45f1SShri Abhyankar 
15620f4b53cSBarry 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.
15720f4b53cSBarry Smith   For a multiple subnetworks,
1588d1cd658SBarry 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.
159f11a936eSBarry Smith 
160e3e68989SHong Zhang   Example usage:
161f11a936eSBarry Smith   Consider the following networks:
162d5b43468SJose E. Roman   1) A single subnetwork:
163e3e68989SHong Zhang .vb
164f11a936eSBarry Smith  network 0:
165f11a936eSBarry Smith  rank[0]:
166f11a936eSBarry Smith    v0 --> v2; v1 --> v2
167f11a936eSBarry Smith  rank[1]:
168f11a936eSBarry Smith    v3 --> v5; v4 --> v5
169e3e68989SHong Zhang .ve
170e3e68989SHong Zhang 
171e3e68989SHong Zhang  The resulting input
172f11a936eSBarry Smith  network 0:
173f11a936eSBarry Smith  rank[0]:
174f11a936eSBarry Smith    ne = 2
175f11a936eSBarry Smith    edgelist = [0 2 | 1 2]
176f11a936eSBarry Smith  rank[1]:
177f11a936eSBarry Smith    ne = 2
178f11a936eSBarry Smith    edgelist = [3 5 | 4 5]
179f11a936eSBarry Smith 
180f11a936eSBarry Smith   2) Two subnetworks:
181f11a936eSBarry Smith .vb
182f11a936eSBarry Smith  subnetwork 0:
183f11a936eSBarry Smith  rank[0]:
184f11a936eSBarry Smith    v0 --> v2; v2 --> v1; v1 --> v3;
185f11a936eSBarry Smith  subnetwork 1:
186f11a936eSBarry Smith  rank[1]:
187f11a936eSBarry Smith    v0 --> v3; v3 --> v2; v2 --> v1;
188f11a936eSBarry Smith .ve
189f11a936eSBarry Smith 
190f11a936eSBarry Smith  The resulting input
191f11a936eSBarry Smith  subnetwork 0:
192f11a936eSBarry Smith  rank[0]:
193f11a936eSBarry Smith    ne = 3
194f11a936eSBarry Smith    edgelist = [0 2 | 2 1 | 1 3]
195f11a936eSBarry Smith  rank[1]:
196f11a936eSBarry Smith    ne = 0
197f11a936eSBarry Smith    edgelist = NULL
198f11a936eSBarry Smith 
199f11a936eSBarry Smith  subnetwork 1:
200f11a936eSBarry Smith  rank[0]:
201f11a936eSBarry Smith    ne = 0
202f11a936eSBarry Smith    edgelist = NULL
203f11a936eSBarry Smith  rank[1]:
204f11a936eSBarry Smith    edgelist = [0 3 | 3 2 | 2 1]
205e3e68989SHong Zhang 
20620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
2075f2c45f1SShri Abhyankar @*/
208d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum)
209d71ae5a4SJacob Faibussowitsch {
2105f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2115c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
212f11a936eSBarry Smith   PetscBT     table;
2135f2c45f1SShri Abhyankar 
2145f2c45f1SShri Abhyankar   PetscFunctionBegin;
215ad540459SPierre 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]);
216f11a936eSBarry Smith 
2175c6496baSHong Zhang   i = 0;
2185c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2195c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2205c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2215c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2225c6496baSHong Zhang     i++;
2235c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2245c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2255c6496baSHong Zhang     i++;
2265c6496baSHong Zhang   }
2275c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2285c6496baSHong Zhang 
2295c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2309566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2319566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
232f11a936eSBarry Smith   i = 0;
233f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2349566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2359566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
236f11a936eSBarry Smith   }
237f11a936eSBarry Smith   nvtx = 0;
238f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
239f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
240f11a936eSBarry Smith   }
2415c6496baSHong Zhang 
2425c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
2431c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2445c6496baSHong Zhang   Nvtx++;
2459566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
246f11a936eSBarry Smith 
247f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
2481c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
249f11a936eSBarry Smith 
250daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
251c6a7a370SJeremy L Thompson   if (name) PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
252daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
253daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
254daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
255daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
256daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2572bf73ac6SHong Zhang 
2582bf73ac6SHong Zhang   /* ----------------------------------------------------------
2592bf73ac6SHong Zhang    p=v or e;
2602bf73ac6SHong Zhang    subnet[0].pStart   = 0
2612bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2622bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2632bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
264daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
265daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2662bf73ac6SHong Zhang 
267daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
268daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2692bf73ac6SHong Zhang 
2702bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
271daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
272daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
273daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
274daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2752bf73ac6SHong Zhang 
276c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
277daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
278daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2802bf73ac6SHong Zhang }
2812bf73ac6SHong Zhang 
2825c6496baSHong Zhang /*@C
2835c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2842bf73ac6SHong Zhang 
28520f4b53cSBarry Smith   Not Collective
2865c6496baSHong Zhang 
2875c6496baSHong Zhang   Input Parameters:
28820f4b53cSBarry Smith + dm - the `DM` object
2895c6496baSHong Zhang - v - vertex point
2905c6496baSHong Zhang 
2915c6496baSHong Zhang   Output Parameters:
2925c6496baSHong Zhang + gidx - global number of this shared vertex in the internal dmplex
2935c6496baSHong Zhang . n - number of subnetworks that share this vertex
2945c6496baSHong Zhang - sv - array of size n: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1
2955c6496baSHong Zhang 
2965c6496baSHong Zhang   Level: intermediate
2975c6496baSHong Zhang 
29820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSharedVertices()`
2995c6496baSHong Zhang @*/
300d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PetscInt *gidx, PetscInt *n, const PetscInt **sv)
301d71ae5a4SJacob Faibussowitsch {
3025c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
303daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
3045c6496baSHong Zhang   PetscInt    i, gidx_tmp;
3055c6496baSHong Zhang 
3065c6496baSHong Zhang   PetscFunctionBegin;
3079566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
308eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, gidx_tmp + 1, 0, &i));
3095c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
3105c6496baSHong Zhang 
3115c6496baSHong Zhang   i--;
3125c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3135c6496baSHong Zhang   if (n) *n = svtx[i].n;
3145c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3165c6496baSHong Zhang }
3175c6496baSHong Zhang 
3185c6496baSHong Zhang /*
3195c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3205c6496baSHong Zhang 
3215c6496baSHong Zhang   Input Parameters:
3225c6496baSHong Zhang + Nsvtx - global num of shared vertices
3235c6496baSHong Zhang . svtx - array of shared vertices (global)
3245c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3255c6496baSHong Zhang 
3265c6496baSHong Zhang   Output Parameters:
3275c6496baSHong Zhang + gidx - global index of (net,idx)
3285c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3295c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3305c6496baSHong Zhang */
331d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx)
332d71ae5a4SJacob Faibussowitsch {
3335c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3342bf73ac6SHong Zhang   SVtxType vtype;
3352bf73ac6SHong Zhang 
3362bf73ac6SHong Zhang   PetscFunctionBegin;
3373ba16761SJacob Faibussowitsch   if (!Nsvtx) PetscFunctionReturn(PETSC_SUCCESS);
3382bf73ac6SHong Zhang 
3395c6496baSHong Zhang   g_idx = -1;
3402bf73ac6SHong Zhang   vtype = SVNONE;
3415c6496baSHong Zhang 
3422bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3432bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3445c6496baSHong Zhang       g_idx = svtx[i].gidx;
3452bf73ac6SHong Zhang       vtype = SVFROM;
3462bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3472bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3482bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3492bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3502bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3515c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3522bf73ac6SHong Zhang           vtype = SVTO;
3532bf73ac6SHong Zhang         }
3542bf73ac6SHong Zhang       }
3552bf73ac6SHong Zhang     }
3562bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3572bf73ac6SHong Zhang   }
3585c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3592bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3602bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3622bf73ac6SHong Zhang }
3632bf73ac6SHong Zhang 
3642bf73ac6SHong Zhang /*
3655c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3665c6496baSHong Zhang 
3675c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3685c6496baSHong Zhang   Output: svta, tdata, ta2sv
3692bf73ac6SHong Zhang */
370eec179cfSJacob Faibussowitsch static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscHMapI svta, PetscInt *tdata, PetscInt *ta2sv)
371d71ae5a4SJacob Faibussowitsch {
3725c6496baSHong Zhang   PetscInt net, idx, gidx;
3732bf73ac6SHong Zhang 
3742bf73ac6SHong Zhang   PetscFunctionBegin;
3755c6496baSHong Zhang   net  = sedgelist[k];
3765c6496baSHong Zhang   idx  = sedgelist[k + 1];
377daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
378c76ffc5fSJacob Faibussowitsch   PetscCall(PetscHMapISet(svta, gidx + 1, *tdata + 1));
3795c6496baSHong Zhang 
3805c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3815c6496baSHong Zhang   (*tdata)++;
3823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3832bf73ac6SHong Zhang }
3842bf73ac6SHong Zhang 
3852bf73ac6SHong Zhang /*
3865c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3872bf73ac6SHong Zhang 
3882bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3892bf73ac6SHong Zhang 
3902bf73ac6SHong Zhang   Note: Output svtx is organized as
3912bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3922bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3932bf73ac6SHong Zhang                           ...
3942bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3952bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
3962bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
3972bf73ac6SHong Zhang  */
398d71ae5a4SJacob Faibussowitsch static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist)
399d71ae5a4SJacob Faibussowitsch {
4005c6496baSHong Zhang   SVtx         *svtx = NULL;
4012bf73ac6SHong Zhang   PetscInt     *sv, k, j, nsv, *tdata, **ta2sv;
402eec179cfSJacob Faibussowitsch   PetscHMapI   *svtas;
4037340ca2cSHong Zhang   PetscInt      gidx, net, idx, i, nta, ita, idx_from, idx_to, n, *net_tmp, *idx_tmp, *gidx_tmp;
4042bf73ac6SHong Zhang   DM_Network   *network = (DM_Network *)dm->data;
405eec179cfSJacob Faibussowitsch   PetscHashIter ppos;
4062bf73ac6SHong Zhang 
4072bf73ac6SHong Zhang   PetscFunctionBegin;
4085c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
4099566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
4102bf73ac6SHong Zhang 
4112bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
4127340ca2cSHong Zhang   nta = 0; /* num of svta tables created = num of groups of shared vertices */
4132bf73ac6SHong Zhang 
4142bf73ac6SHong Zhang   /* for j=0 */
415eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4169566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4172bf73ac6SHong Zhang 
4189566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4199566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4209371c9d4SSatish Balay   nta++;
4219371c9d4SSatish Balay   k += 4;
4222bf73ac6SHong Zhang 
4235c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4242bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4252bf73ac6SHong Zhang       /* vfrom */
4269371c9d4SSatish Balay       net  = sedgelist[k];
4279371c9d4SSatish Balay       idx  = sedgelist[k + 1];
428daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
429eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_from));
4302bf73ac6SHong Zhang 
4312bf73ac6SHong Zhang       /* vto */
4329371c9d4SSatish Balay       net  = sedgelist[k + 2];
4339371c9d4SSatish Balay       idx  = sedgelist[k + 3];
434daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
435eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_to));
4362bf73ac6SHong Zhang 
4372bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4389371c9d4SSatish Balay         idx_from--;
4399371c9d4SSatish Balay         idx_to--;
4402bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4419566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4422bf73ac6SHong Zhang           break;
4432bf73ac6SHong Zhang         } else if (idx_to < 0) {
4449566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4452bf73ac6SHong Zhang           break;
4462bf73ac6SHong Zhang         }
4472bf73ac6SHong Zhang       }
4482bf73ac6SHong Zhang     }
4492bf73ac6SHong Zhang 
4502bf73ac6SHong Zhang     if (ita == nta) {
451eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4529566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4532bf73ac6SHong Zhang 
4549566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4559566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4562bf73ac6SHong Zhang       nta++;
4572bf73ac6SHong Zhang     }
4582bf73ac6SHong Zhang     k += 4;
4592bf73ac6SHong Zhang   }
4602bf73ac6SHong Zhang 
4616aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
462eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(nta, &network->cloneshared->svtable));
4635c6496baSHong Zhang 
4645c6496baSHong Zhang   /* (3) Construct svtx from svtas
4657340ca2cSHong Zhang    svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1. */
4669566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4672bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4684f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
469eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetSize(svtas[nsv], &n));
4709566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4717340ca2cSHong Zhang     PetscCall(PetscMalloc3(n, &gidx_tmp, n, &net_tmp, n, &idx_tmp));
4725c6496baSHong Zhang     svtx[nsv].sv   = sv;
4735c6496baSHong Zhang     svtx[nsv].n    = n;
474daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4752bf73ac6SHong Zhang 
476eec179cfSJacob Faibussowitsch     PetscHashIterBegin(svtas[nsv], ppos);
4774f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
478eec179cfSJacob Faibussowitsch       PetscHashIterGetKey(svtas[nsv], ppos, gidx);
479eec179cfSJacob Faibussowitsch       PetscHashIterGetVal(svtas[nsv], ppos, i);
480eec179cfSJacob Faibussowitsch       PetscHashIterNext(svtas[nsv], ppos);
4819371c9d4SSatish Balay       gidx--;
4829371c9d4SSatish Balay       i--;
4835c6496baSHong Zhang       j           = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4847340ca2cSHong Zhang       net_tmp[k]  = sedgelist[j];     /* subnet number */
4857340ca2cSHong Zhang       idx_tmp[k]  = sedgelist[j + 1]; /* index on the subnet */
4867340ca2cSHong Zhang       gidx_tmp[k] = gidx;             /* gidx in un-merged dmnetwork */
4872bf73ac6SHong Zhang     }
4885c6496baSHong Zhang 
4897340ca2cSHong Zhang     /* current implementation requires sv[]=[net,idx] in ascending order of its gidx in un-merged dmnetwork */
4907340ca2cSHong Zhang     PetscCall(PetscSortIntWithArrayPair(n, gidx_tmp, net_tmp, idx_tmp));
4917340ca2cSHong Zhang     svtx[nsv].gidx = gidx_tmp[0]; /* = min(gidx) */
4927340ca2cSHong Zhang     for (k = 0; k < n; k++) {
4937340ca2cSHong Zhang       sv[2 * k]     = net_tmp[k];
4947340ca2cSHong Zhang       sv[2 * k + 1] = idx_tmp[k];
4957340ca2cSHong Zhang     }
4967340ca2cSHong Zhang     PetscCall(PetscFree3(gidx_tmp, net_tmp, idx_tmp));
4977340ca2cSHong Zhang 
4986aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
499c76ffc5fSJacob Faibussowitsch     PetscCall(PetscHMapISet(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1));
5002bf73ac6SHong Zhang   }
5012bf73ac6SHong Zhang 
5022bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
503eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(svtas + j));
5049566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
5052bf73ac6SHong Zhang   }
5069566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
5072bf73ac6SHong Zhang 
508daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
509daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
5103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5112bf73ac6SHong Zhang }
5122bf73ac6SHong Zhang 
5135c6496baSHong Zhang /*
5145c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
5155c6496baSHong Zhang 
5165c6496baSHong Zhang   Input Parameters:
5175c6496baSHong Zhang . dm - the dmnetwork object
5185c6496baSHong Zhang 
5195c6496baSHong Zhang    Output Parameters:
5205c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
5215c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
5225c6496baSHong Zhang */
523d71ae5a4SJacob Faibussowitsch static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr)
524d71ae5a4SJacob Faibussowitsch {
5252bf73ac6SHong Zhang   MPI_Comm    comm;
5262bf73ac6SHong Zhang   PetscMPIInt size, rank, *recvcounts = NULL, *displs = NULL;
527eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
528eac198afSGetnet   PetscInt    i, j, ctr, np;
529daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
530daad07d3SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist;
5315c6496baSHong Zhang   PetscInt    net, idx, gidx, nmerged, *vrange, gidx_from, net_from, sv_idx;
5322bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5335c6496baSHong Zhang   SVtx       *svtx;
5342bf73ac6SHong Zhang 
5352bf73ac6SHong Zhang   PetscFunctionBegin;
5369566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5379566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5389566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5392bf73ac6SHong Zhang 
5405c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5415c6496baSHong Zhang   /* --------------------------------------- */
542daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
543daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
544daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5452bf73ac6SHong Zhang 
546d5b43468SJose E. Roman   /* (2) Merge shared vto vertices to their vfrom vertex with same global vertex index (gidx) */
5475c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5482bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
549daad07d3SAidan Hamilton   PetscCall(PetscMalloc4(size + 1, &vrange, size, &displs, size, &recvcounts, network->cloneshared->nVertices, &vidxlTog));
5509371c9d4SSatish Balay   for (i = 0; i < size; i++) {
5519371c9d4SSatish Balay     displs[i]     = i;
5529371c9d4SSatish Balay     recvcounts[i] = 1;
5539371c9d4SSatish Balay   }
5542bf73ac6SHong Zhang 
5552bf73ac6SHong Zhang   vrange[0] = 0;
556daad07d3SAidan Hamilton   PetscCallMPI(MPI_Allgatherv(&network->cloneshared->nVertices, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
5575c6496baSHong Zhang   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
5582bf73ac6SHong Zhang 
5592bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5609371c9d4SSatish Balay   i                           = 0;
5619371c9d4SSatish Balay   gidx                        = 0;
5622bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
563daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5642bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
565daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5669566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5672bf73ac6SHong Zhang       if (svtype == SVTO) {
568daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5695c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
570daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5715c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
572daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5732bf73ac6SHong Zhang           }
5745c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5755c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5762bf73ac6SHong Zhang         }
5772bf73ac6SHong Zhang       } else {
578daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5795c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
580daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5812bf73ac6SHong Zhang         }
582daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5832bf73ac6SHong Zhang         gidx++;
5842bf73ac6SHong Zhang       }
5852bf73ac6SHong Zhang     }
5862bf73ac6SHong Zhang   }
5872bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
588daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5892bf73ac6SHong Zhang #endif
5902bf73ac6SHong Zhang 
5915c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
592712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
593daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5942bf73ac6SHong Zhang 
5952bf73ac6SHong Zhang   ctr = 0;
5962bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
597daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5982bf73ac6SHong Zhang       /* vfrom: */
599daad07d3SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
6002bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
6012bf73ac6SHong Zhang 
6022bf73ac6SHong Zhang       /* vto */
603daad07d3SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
6042bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
6052bf73ac6SHong Zhang       ctr++;
6062bf73ac6SHong Zhang     }
6072bf73ac6SHong Zhang   }
6089566063dSJacob Faibussowitsch   PetscCall(PetscFree4(vrange, displs, recvcounts, vidxlTog));
6099566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
6102bf73ac6SHong Zhang 
611eac198afSGetnet   *nmerged_ptr = nmerged;
6123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6135f2c45f1SShri Abhyankar }
6145f2c45f1SShri Abhyankar 
615d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
616d71ae5a4SJacob Faibussowitsch {
617daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
618daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
619daad07d3SAidan Hamilton   MPI_Comm    comm;
620daad07d3SAidan Hamilton 
621daad07d3SAidan Hamilton   PetscFunctionBegin;
622daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
623daad07d3SAidan Hamilton 
624daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
625daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
626daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
627daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
628daad07d3SAidan Hamilton 
629daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
630daad07d3SAidan Hamilton 
631daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
632daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
633daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
634daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
635daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
636daad07d3SAidan Hamilton   }
6373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
638daad07d3SAidan Hamilton }
639daad07d3SAidan Hamilton 
6405f2c45f1SShri Abhyankar /*@
6415f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6425f2c45f1SShri Abhyankar 
643eac198afSGetnet   Not Collective
6445f2c45f1SShri Abhyankar 
6452fe279fdSBarry Smith   Input Parameter:
64620f4b53cSBarry Smith . dm - the `DMNETWORK` object
64720f4b53cSBarry Smith 
64820f4b53cSBarry Smith   Level: beginner
6495f2c45f1SShri Abhyankar 
6505f2c45f1SShri Abhyankar   Notes:
6515f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6525f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6535f2c45f1SShri Abhyankar 
6545f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6555f2c45f1SShri Abhyankar 
65620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6575f2c45f1SShri Abhyankar @*/
658d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
659d71ae5a4SJacob Faibussowitsch {
6605f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
661daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
662caf410d2SHong Zhang   const PetscInt *cone;
663caf410d2SHong Zhang   MPI_Comm        comm;
6645503a911SAidan Hamilton   PetscMPIInt     size;
665eac198afSGetnet   PetscSection    sectiong;
6665c6496baSHong Zhang   PetscInt        nmerged = 0;
6676500d4abSHong Zhang 
6686500d4abSHong Zhang   PetscFunctionBegin;
669e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
670daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6712bf73ac6SHong Zhang 
672eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
673eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6749371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6759371c9d4SSatish 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,
6769371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
677eac198afSGetnet   }
678eac198afSGetnet 
6799566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6803ba16761SJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6816500d4abSHong Zhang 
682f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
683daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
684eac198afSGetnet 
685daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6869566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
687eac198afSGetnet   } else { /* subnetworks are not coupled */
6886aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
689eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapICreate(&network->cloneshared->svtable));
690caf410d2SHong Zhang     ctr = 0;
6912bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
692daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
693daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
694daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6956500d4abSHong Zhang         ctr++;
6966500d4abSHong Zhang       }
6976500d4abSHong Zhang     }
698eac198afSGetnet   }
6997765340cSHong Zhang 
7002bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
7019566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
7029566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
7039566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
704eac198afSGetnet 
705daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
706daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
7076500d4abSHong Zhang 
708daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
709daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
710daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
711daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
7129566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
713caf410d2SHong Zhang 
714f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
715f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
716f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
717f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
718f11a936eSBarry Smith   */
719daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
720daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
721daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7225c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
723daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
724daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
725f11a936eSBarry Smith 
726daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
727daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7286500d4abSHong Zhang   }
729daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
730caf410d2SHong Zhang 
731caf410d2SHong Zhang   /* Get edge ownership */
732daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7335503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7345503a911SAidan Hamilton   globaledgeoff -= np;
735caf410d2SHong Zhang 
736eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7372bf73ac6SHong Zhang   e = 0;
7382bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
739f11a936eSBarry Smith     ctr = 0;
740daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7412bf73ac6SHong Zhang       /* edge e */
7425503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7432bf73ac6SHong Zhang       network->header[e].subnetid              = i;
744daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7452bf73ac6SHong Zhang 
7462bf73ac6SHong Zhang       /* connected vertices */
7479566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7482bf73ac6SHong Zhang 
7492bf73ac6SHong Zhang       /* vertex cone[0] */
750f11a936eSBarry Smith       v                           = cone[0];
751f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
752f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
753f11a936eSBarry Smith       if (Nsubnet == 1) {
754daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
755f11a936eSBarry Smith       } else {
756daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
757daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
758f11a936eSBarry Smith       }
7592bf73ac6SHong Zhang 
7602bf73ac6SHong Zhang       /* vertex cone[1] */
761f11a936eSBarry Smith       v                           = cone[1];
762f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
763f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
764f11a936eSBarry Smith       if (Nsubnet == 1) {
765daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
766f11a936eSBarry Smith       } else {
767daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
768daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
769f11a936eSBarry Smith       }
7702bf73ac6SHong Zhang 
7719371c9d4SSatish Balay       e++;
7729371c9d4SSatish Balay       ctr++;
7736500d4abSHong Zhang     }
7746500d4abSHong Zhang   }
7755503a911SAidan Hamilton   PetscCall(PetscFree(edges));
776caf410d2SHong Zhang 
777eac198afSGetnet   /* Set local vertex array for the subnetworks */
778eac198afSGetnet   j = 0;
779daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
780eac198afSGetnet     /* local shared vertex */
781eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, network->header[v].index + 1, 0, &i));
782daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7836500d4abSHong Zhang   }
784eac198afSGetnet 
785eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
786eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7879566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
788daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
789daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
790e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7925f2c45f1SShri Abhyankar }
7935f2c45f1SShri Abhyankar 
79494ef8ddeSSatish Balay /*@C
7952bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7962bf73ac6SHong Zhang 
79720f4b53cSBarry Smith   Not Collective
7982727e31bSShri Abhyankar 
7997a7aea1fSJed Brown   Input Parameters:
80020f4b53cSBarry Smith + dm - the `DMNETWORK` object
8012bf73ac6SHong Zhang - netnum - the global index of the subnetwork
8022727e31bSShri Abhyankar 
8037a7aea1fSJed Brown   Output Parameters:
8042727e31bSShri Abhyankar + nv - number of vertices (local)
8052727e31bSShri Abhyankar . ne - number of edges (local)
8062bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
8072bf73ac6SHong Zhang - edge - local edges of the subnetwork
8082727e31bSShri Abhyankar 
80906dd6b0eSSatish Balay   Level: intermediate
81006dd6b0eSSatish Balay 
81120f4b53cSBarry Smith   Notes:
81220f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
81320f4b53cSBarry Smith 
81420f4b53cSBarry Smith   The local vertices returned on each rank are determined by `DMNETWORK`. The user does not have any control over what vertices are local.
81520f4b53cSBarry Smith 
81620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8172727e31bSShri Abhyankar @*/
818d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge)
819d71ae5a4SJacob Faibussowitsch {
820caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8212727e31bSShri Abhyankar 
8222727e31bSShri Abhyankar   PetscFunctionBegin;
823daad07d3SAidan 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);
824daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
825daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
826daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
827daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8292bf73ac6SHong Zhang }
8302bf73ac6SHong Zhang 
8312bf73ac6SHong Zhang /*@
8322bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8332bf73ac6SHong Zhang 
83420f4b53cSBarry Smith   Collective
8352bf73ac6SHong Zhang 
8362bf73ac6SHong Zhang   Input Parameters:
83720f4b53cSBarry Smith + dm - the `DMNETWORK` object
83820f4b53cSBarry Smith . anetnum - first subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
83920f4b53cSBarry Smith . bnetnum - second subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
8402bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8412bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8422bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8432bf73ac6SHong Zhang 
8442bf73ac6SHong Zhang   Level: beginner
8452bf73ac6SHong Zhang 
84620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8472bf73ac6SHong Zhang @*/
848d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
849d71ae5a4SJacob Faibussowitsch {
8502bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
851daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8522bf73ac6SHong Zhang 
8532bf73ac6SHong Zhang   PetscFunctionBegin;
8545c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8555c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8562bf73ac6SHong Zhang   if (!Nsvtx) {
8572bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
858daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8592bf73ac6SHong Zhang   }
8602bf73ac6SHong Zhang 
861daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8622bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8639371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8649371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8659371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8669371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8672bf73ac6SHong Zhang     Nsvtx++;
8682bf73ac6SHong Zhang   }
8695c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
870daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8722727e31bSShri Abhyankar }
8732727e31bSShri Abhyankar 
8742727e31bSShri Abhyankar /*@C
8752bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8762bf73ac6SHong Zhang 
87720f4b53cSBarry Smith   Not Collective
878caf410d2SHong Zhang 
879f899ff85SJose E. Roman   Input Parameter:
88020f4b53cSBarry Smith . dm - the `DMNETWORK` object
881caf410d2SHong Zhang 
8827a7aea1fSJed Brown   Output Parameters:
8832bf73ac6SHong Zhang + nsv - number of local shared vertices
8842bf73ac6SHong Zhang - svtx - local shared vertices
885caf410d2SHong Zhang 
886caf410d2SHong Zhang   Level: intermediate
887caf410d2SHong Zhang 
88820f4b53cSBarry Smith   Notes:
88920f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
89020f4b53cSBarry Smith 
89120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
892caf410d2SHong Zhang @*/
893d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx)
894d71ae5a4SJacob Faibussowitsch {
895caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
896caf410d2SHong Zhang 
897caf410d2SHong Zhang   PetscFunctionBegin;
8985c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
899daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
900daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
9013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
902caf410d2SHong Zhang }
903caf410d2SHong Zhang 
904caf410d2SHong Zhang /*@C
9055f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
9065f2c45f1SShri Abhyankar 
90720f4b53cSBarry Smith   Logically Collective
9085f2c45f1SShri Abhyankar 
9097a7aea1fSJed Brown   Input Parameters:
91020f4b53cSBarry Smith + dm - the `DMNETWORK` object
9115f2c45f1SShri Abhyankar . name - the component name
9125f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
9135f2c45f1SShri Abhyankar 
9142fe279fdSBarry Smith    Output Parameter:
9155f2c45f1SShri Abhyankar .  key - an integer key that defines the component
9165f2c45f1SShri Abhyankar 
91720f4b53cSBarry Smith    Level: beginner
91820f4b53cSBarry Smith 
91987497f52SBarry Smith    Note:
92087497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9215f2c45f1SShri Abhyankar 
92220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9235f2c45f1SShri Abhyankar @*/
924d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
925d71ae5a4SJacob Faibussowitsch {
9265f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
92754dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9285f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9295f2c45f1SShri Abhyankar   PetscInt            i;
9305f2c45f1SShri Abhyankar 
9315f2c45f1SShri Abhyankar   PetscFunctionBegin;
93248a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
93354dfd506SHong Zhang 
9345f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9359566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9365f2c45f1SShri Abhyankar     if (flg) {
9375f2c45f1SShri Abhyankar       *key = i;
9383ba16761SJacob Faibussowitsch       PetscFunctionReturn(PETSC_SUCCESS);
9395f2c45f1SShri Abhyankar     }
9406d64e262SShri Abhyankar   }
94154dfd506SHong Zhang 
94254dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
94354dfd506SHong Zhang     /* Reached max allowed so resize component */
94454dfd506SHong Zhang     network->max_comps_registered += 2;
9459566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
94654dfd506SHong Zhang     /* Copy over the previous component info */
94754dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
948c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(newcomponent[i].name, network->component[i].name, sizeof(newcomponent[i].name)));
94954dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9505f2c45f1SShri Abhyankar     }
95154dfd506SHong Zhang     /* Free old one */
9529566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
95354dfd506SHong Zhang     /* Update pointer */
95454dfd506SHong Zhang     network->component = newcomponent;
95554dfd506SHong Zhang   }
95654dfd506SHong Zhang 
95754dfd506SHong Zhang   component = &network->component[network->ncomponent];
9585f2c45f1SShri Abhyankar 
959c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(component->name, name, sizeof(component->name)));
9605f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9615f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9625f2c45f1SShri Abhyankar   network->ncomponent++;
9633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9645f2c45f1SShri Abhyankar }
9655f2c45f1SShri Abhyankar 
9665f2c45f1SShri Abhyankar /*@
9678afb7921SAidan Hamilton   DMNetworkGetNumVertices - Get the local and global number of vertices for the entire network.
9688afb7921SAidan Hamilton 
9698afb7921SAidan Hamilton   Not Collective
9708afb7921SAidan Hamilton 
9718afb7921SAidan Hamilton   Input Parameter:
97220f4b53cSBarry Smith . dm - the `DMNETWORK` object
9738afb7921SAidan Hamilton 
9748afb7921SAidan Hamilton   Output Parameters:
9758afb7921SAidan Hamilton + nVertices - the local number of vertices
9768afb7921SAidan Hamilton - NVertices - the global number of vertices
9778afb7921SAidan Hamilton 
9788afb7921SAidan Hamilton   Level: beginner
9798afb7921SAidan Hamilton 
98020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumEdges()`
9818afb7921SAidan Hamilton @*/
9828afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumVertices(DM dm, PetscInt *nVertices, PetscInt *NVertices)
9838afb7921SAidan Hamilton {
9848afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
9858afb7921SAidan Hamilton 
9868afb7921SAidan Hamilton   PetscFunctionBegin;
9878afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
9888afb7921SAidan Hamilton   if (nVertices) {
9898afb7921SAidan Hamilton     PetscValidIntPointer(nVertices, 2);
9908afb7921SAidan Hamilton     *nVertices = network->cloneshared->nVertices;
9918afb7921SAidan Hamilton   }
9928afb7921SAidan Hamilton   if (NVertices) {
9938afb7921SAidan Hamilton     PetscValidIntPointer(NVertices, 3);
9948afb7921SAidan Hamilton     *NVertices = network->cloneshared->NVertices;
9958afb7921SAidan Hamilton   }
9963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9978afb7921SAidan Hamilton }
9988afb7921SAidan Hamilton 
9998afb7921SAidan Hamilton /*@
10008afb7921SAidan Hamilton   DMNetworkGetNumEdges - Get the local and global number of edges for the entire network.
10018afb7921SAidan Hamilton 
10028afb7921SAidan Hamilton   Not Collective
10038afb7921SAidan Hamilton 
10048afb7921SAidan Hamilton   Input Parameter:
100520f4b53cSBarry Smith . dm - the `DMNETWORK` object
10068afb7921SAidan Hamilton 
10078afb7921SAidan Hamilton   Output Parameters:
10088afb7921SAidan Hamilton + nEdges - the local number of edges
10098afb7921SAidan Hamilton -  NEdges - the global number of edges
10108afb7921SAidan Hamilton 
10118afb7921SAidan Hamilton   Level: beginner
10128afb7921SAidan Hamilton 
101320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumVertices()`
10148afb7921SAidan Hamilton @*/
10158afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumEdges(DM dm, PetscInt *nEdges, PetscInt *NEdges)
10168afb7921SAidan Hamilton {
10178afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
10188afb7921SAidan Hamilton 
10198afb7921SAidan Hamilton   PetscFunctionBegin;
10208afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
10218afb7921SAidan Hamilton   if (nEdges) {
10228afb7921SAidan Hamilton     PetscValidIntPointer(nEdges, 2);
10238afb7921SAidan Hamilton     *nEdges = network->cloneshared->nEdges;
10248afb7921SAidan Hamilton   }
10258afb7921SAidan Hamilton   if (NEdges) {
10268afb7921SAidan Hamilton     PetscValidIntPointer(NEdges, 3);
10278afb7921SAidan Hamilton     *NEdges = network->cloneshared->NEdges;
10288afb7921SAidan Hamilton   }
10293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10308afb7921SAidan Hamilton }
10318afb7921SAidan Hamilton 
10328afb7921SAidan Hamilton /*@
10332bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
10345f2c45f1SShri Abhyankar 
10355f2c45f1SShri Abhyankar   Not Collective
10365f2c45f1SShri Abhyankar 
1037f899ff85SJose E. Roman   Input Parameter:
103820f4b53cSBarry Smith . dm - the `DMNETWORK` object
10395f2c45f1SShri Abhyankar 
1040fd292e60Sprj-   Output Parameters:
10412bf73ac6SHong Zhang + vStart - the first vertex point
10422bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
10435f2c45f1SShri Abhyankar 
104497bb938eSShri Abhyankar   Level: beginner
10455f2c45f1SShri Abhyankar 
104620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeRange()`
10475f2c45f1SShri Abhyankar @*/
1048d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd)
1049d71ae5a4SJacob Faibussowitsch {
10505f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10515f2c45f1SShri Abhyankar 
10525f2c45f1SShri Abhyankar   PetscFunctionBegin;
1053daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
1054daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
10553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10565f2c45f1SShri Abhyankar }
10575f2c45f1SShri Abhyankar 
10585f2c45f1SShri Abhyankar /*@
10592bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
10605f2c45f1SShri Abhyankar 
10615f2c45f1SShri Abhyankar   Not Collective
10625f2c45f1SShri Abhyankar 
1063f899ff85SJose E. Roman   Input Parameter:
106420f4b53cSBarry Smith . dm - the `DMNETWORK` object
10655f2c45f1SShri Abhyankar 
1066fd292e60Sprj-   Output Parameters:
10675f2c45f1SShri Abhyankar + eStart - The first edge point
10685f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
10695f2c45f1SShri Abhyankar 
107097bb938eSShri Abhyankar   Level: beginner
10715f2c45f1SShri Abhyankar 
107220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetVertexRange()`
10735f2c45f1SShri Abhyankar @*/
1074d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd)
1075d71ae5a4SJacob Faibussowitsch {
10765f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10775f2c45f1SShri Abhyankar 
10785f2c45f1SShri Abhyankar   PetscFunctionBegin;
10795c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1080daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
1081daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
10823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10835f2c45f1SShri Abhyankar }
10845f2c45f1SShri Abhyankar 
1085d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index)
1086d71ae5a4SJacob Faibussowitsch {
10872bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
10885c6496baSHong Zhang 
10895c6496baSHong Zhang   PetscFunctionBegin;
10905c6496baSHong Zhang   if (network->header) {
10915c6496baSHong Zhang     *index = network->header[p].index;
10925c6496baSHong Zhang   } else {
10932bf73ac6SHong Zhang     PetscInt                 offsetp;
10942bf73ac6SHong Zhang     DMNetworkComponentHeader header;
10952bf73ac6SHong Zhang 
10969566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
10972bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
10982bf73ac6SHong Zhang     *index = header->index;
10995c6496baSHong Zhang   }
11003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11012bf73ac6SHong Zhang }
11022bf73ac6SHong Zhang 
1103d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid)
1104d71ae5a4SJacob Faibussowitsch {
1105daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1106daad07d3SAidan Hamilton 
1107daad07d3SAidan Hamilton   PetscFunctionBegin;
1108daad07d3SAidan Hamilton   if (network->header) {
1109daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1110daad07d3SAidan Hamilton   } else {
1111daad07d3SAidan Hamilton     PetscInt                 offsetp;
1112daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1113daad07d3SAidan Hamilton 
1114daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1115daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1116daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1117daad07d3SAidan Hamilton   }
11183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1119daad07d3SAidan Hamilton }
1120daad07d3SAidan Hamilton 
11217b6afd5bSHong Zhang /*@
11222bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
11237b6afd5bSHong Zhang 
11247b6afd5bSHong Zhang   Not Collective
11257b6afd5bSHong Zhang 
11267b6afd5bSHong Zhang   Input Parameters:
112720f4b53cSBarry Smith + dm - `DMNETWORK` object
1128e85e6aecSHong Zhang - p - edge point
11297b6afd5bSHong Zhang 
11302fe279fdSBarry Smith   Output Parameter:
11312bf73ac6SHong Zhang . index - the global numbering for the edge
11327b6afd5bSHong Zhang 
11337b6afd5bSHong Zhang   Level: intermediate
11347b6afd5bSHong Zhang 
113520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
11367b6afd5bSHong Zhang @*/
1137d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index)
1138d71ae5a4SJacob Faibussowitsch {
11397b6afd5bSHong Zhang   PetscFunctionBegin;
11409566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11427b6afd5bSHong Zhang }
11437b6afd5bSHong Zhang 
11445f2c45f1SShri Abhyankar /*@
11452bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1146e85e6aecSHong Zhang 
1147e85e6aecSHong Zhang   Not Collective
1148e85e6aecSHong Zhang 
1149e85e6aecSHong Zhang   Input Parameters:
115020f4b53cSBarry Smith + dm - `DMNETWORK` object
1151e85e6aecSHong Zhang - p  - vertex point
1152e85e6aecSHong Zhang 
11532fe279fdSBarry Smith   Output Parameter:
11542bf73ac6SHong Zhang . index - the global numbering for the vertex
1155e85e6aecSHong Zhang 
1156e85e6aecSHong Zhang   Level: intermediate
1157e85e6aecSHong Zhang 
115820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1159e85e6aecSHong Zhang @*/
1160d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index)
1161d71ae5a4SJacob Faibussowitsch {
1162e85e6aecSHong Zhang   PetscFunctionBegin;
11639566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11659988b915SShri Abhyankar }
11669988b915SShri Abhyankar 
11679988b915SShri Abhyankar /*@
11685f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
11695f2c45f1SShri Abhyankar 
11705f2c45f1SShri Abhyankar   Not Collective
11715f2c45f1SShri Abhyankar 
11725f2c45f1SShri Abhyankar   Input Parameters:
117320f4b53cSBarry Smith + dm - the `DMNETWORK` object
1174a2b725a8SWilliam Gropp - p - vertex/edge point
11755f2c45f1SShri Abhyankar 
11762fe279fdSBarry Smith   Output Parameter:
11775f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
11785f2c45f1SShri Abhyankar 
117997bb938eSShri Abhyankar   Level: beginner
11805f2c45f1SShri Abhyankar 
118120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
11825f2c45f1SShri Abhyankar @*/
1183d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents)
1184d71ae5a4SJacob Faibussowitsch {
11855f2c45f1SShri Abhyankar   PetscInt    offset;
11865f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
11875f2c45f1SShri Abhyankar 
11885f2c45f1SShri Abhyankar   PetscFunctionBegin;
11899566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
11905f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
11913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11925f2c45f1SShri Abhyankar }
11935f2c45f1SShri Abhyankar 
11945f2c45f1SShri Abhyankar /*@
11952bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
11965f2c45f1SShri Abhyankar 
11975f2c45f1SShri Abhyankar   Not Collective
11985f2c45f1SShri Abhyankar 
11995f2c45f1SShri Abhyankar   Input Parameters:
120020f4b53cSBarry Smith + dm - the `DMNETWORK` object
1201f2f58720SBarry Smith . p - the edge or vertex point
12022bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12039988b915SShri Abhyankar 
12042fe279fdSBarry Smith   Output Parameter:
12052bf73ac6SHong Zhang . offset - the local offset
12069988b915SShri Abhyankar 
12079988b915SShri Abhyankar   Level: intermediate
12089988b915SShri Abhyankar 
120920f4b53cSBarry Smith   Notes:
121020f4b53cSBarry Smith     These offsets can be passed to `MatSetValuesLocal()` for matrices obtained with `DMCreateMatrix()`.
121120f4b53cSBarry Smith 
121220f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` the offsets can be used with `VecSetValues()`.
121320f4b53cSBarry Smith 
121420f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
121520f4b53cSBarry Smith     the vector values with array[offset].
121620f4b53cSBarry Smith 
121720f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValuesLocal()`.
121820f4b53cSBarry Smith 
121920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
12209988b915SShri Abhyankar @*/
1221d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset)
1222d71ae5a4SJacob Faibussowitsch {
12239988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12249988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12259988b915SShri Abhyankar   DMNetworkComponentHeader header;
12269988b915SShri Abhyankar 
12279988b915SShri Abhyankar   PetscFunctionBegin;
12289566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
12292bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12302bf73ac6SHong Zhang     *offset = offsetp;
12313ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12322bf73ac6SHong Zhang   }
12332bf73ac6SHong Zhang 
12349566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12359988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12369988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
12373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12389988b915SShri Abhyankar }
12399988b915SShri Abhyankar 
12409988b915SShri Abhyankar /*@
12412bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
12429988b915SShri Abhyankar 
12439988b915SShri Abhyankar   Not Collective
12449988b915SShri Abhyankar 
12459988b915SShri Abhyankar   Input Parameters:
124620f4b53cSBarry Smith + dm - the `DMNETWORK` object
1247f2f58720SBarry Smith . p - the edge or vertex point
12482bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12499988b915SShri Abhyankar 
12502fe279fdSBarry Smith   Output Parameter:
12519988b915SShri Abhyankar . offsetg - the global offset
12529988b915SShri Abhyankar 
12539988b915SShri Abhyankar   Level: intermediate
12549988b915SShri Abhyankar 
125520f4b53cSBarry Smith   Notes:
125620f4b53cSBarry Smith     These offsets can be passed to `MatSetValues()` for matrices obtained with `DMCreateMatrix()`.
125720f4b53cSBarry Smith 
125820f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValues()`.
125920f4b53cSBarry Smith 
126020f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
126120f4b53cSBarry Smith     the vector values with array[offset - rstart] where restart is obtained with `VecGetOwnershipRange`(v,&rstart,`NULL`);
126220f4b53cSBarry Smith 
126320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
12649988b915SShri Abhyankar @*/
1265d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg)
1266d71ae5a4SJacob Faibussowitsch {
12679988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12689988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12699988b915SShri Abhyankar   DMNetworkComponentHeader header;
12709988b915SShri Abhyankar 
12719988b915SShri Abhyankar   PetscFunctionBegin;
12729566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
12732bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
12742bf73ac6SHong Zhang 
12752bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12762bf73ac6SHong Zhang     *offsetg = offsetp;
12773ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12782bf73ac6SHong Zhang   }
12799566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12809988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12819988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
12823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12839988b915SShri Abhyankar }
12849988b915SShri Abhyankar 
12859988b915SShri Abhyankar /*@
12862bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
128724121865SAdrian Maldonado 
128824121865SAdrian Maldonado   Not Collective
128924121865SAdrian Maldonado 
129024121865SAdrian Maldonado   Input Parameters:
129120f4b53cSBarry Smith + dm - the `DMNETWORK` object
129224121865SAdrian Maldonado - p - the edge point
129324121865SAdrian Maldonado 
12942fe279fdSBarry Smith   Output Parameter:
129524121865SAdrian Maldonado . offset - the offset
129624121865SAdrian Maldonado 
129724121865SAdrian Maldonado   Level: intermediate
129824121865SAdrian Maldonado 
129920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
130024121865SAdrian Maldonado @*/
1301d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset)
1302d71ae5a4SJacob Faibussowitsch {
130324121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
130424121865SAdrian Maldonado 
130524121865SAdrian Maldonado   PetscFunctionBegin;
13069566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
13073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
130824121865SAdrian Maldonado }
130924121865SAdrian Maldonado 
131024121865SAdrian Maldonado /*@
13112bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
131224121865SAdrian Maldonado 
131324121865SAdrian Maldonado   Not Collective
131424121865SAdrian Maldonado 
131524121865SAdrian Maldonado   Input Parameters:
131620f4b53cSBarry Smith + dm - the `DMNETWORK` object
131724121865SAdrian Maldonado - p - the vertex point
131824121865SAdrian Maldonado 
13192fe279fdSBarry Smith   Output Parameter:
132024121865SAdrian Maldonado . offset - the offset
132124121865SAdrian Maldonado 
132224121865SAdrian Maldonado   Level: intermediate
132324121865SAdrian Maldonado 
132420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
132524121865SAdrian Maldonado @*/
1326d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset)
1327d71ae5a4SJacob Faibussowitsch {
132824121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
132924121865SAdrian Maldonado 
133024121865SAdrian Maldonado   PetscFunctionBegin;
1331daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
13329566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
13333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
133424121865SAdrian Maldonado }
13352bf73ac6SHong Zhang 
13365f2c45f1SShri Abhyankar /*@
13372bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
13385f2c45f1SShri Abhyankar 
133920f4b53cSBarry Smith   Collective
13405f2c45f1SShri Abhyankar 
13415f2c45f1SShri Abhyankar   Input Parameters:
13424dc646bcSBarry Smith + dm - the DMNetwork
134320f4b53cSBarry Smith . p - the vertex/edge point. These points are local indices provided by `DMNetworkGetSubnetwork()`
134420f4b53cSBarry Smith . componentkey - component key returned while registering the component with `DMNetworkRegisterComponent()`
134520f4b53cSBarry 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
134620f4b53cSBarry Smith               free this space until after `DMSetUp()` is called.
1347eac198afSGetnet - 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
13485f2c45f1SShri Abhyankar 
134920f4b53cSBarry Smith   Level: beginner
135020f4b53cSBarry Smith 
1351eac198afSGetnet   Notes:
1352eac198afSGetnet     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.
1353eac198afSGetnet 
135420f4b53cSBarry Smith     `DMNetworkLayoutSetUp()` must be called before this routine.
1355eac198afSGetnet 
135620f4b53cSBarry Smith   Developer Note:
135720f4b53cSBarry 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`.
13585f2c45f1SShri Abhyankar 
135920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
13605f2c45f1SShri Abhyankar @*/
1361d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar)
1362d71ae5a4SJacob Faibussowitsch {
13635f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
13642bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
136554dfd506SHong Zhang   DMNetworkComponentHeader header;
136654dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
136754dfd506SHong Zhang   PetscInt                 compnum;
136854dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
136954dfd506SHong Zhang   void                   **compdata;
13705f2c45f1SShri Abhyankar 
13715f2c45f1SShri Abhyankar   PetscFunctionBegin;
13725c6496baSHong 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);
1373daad07d3SAidan 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.");
1374eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
13759566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
13762bf73ac6SHong Zhang 
1377eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
137854dfd506SHong Zhang   header = &network->header[p];
137954dfd506SHong Zhang   cvalue = &network->cvalue[p];
138054dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1381f11a936eSBarry Smith     PetscInt additional_size;
1382f11a936eSBarry Smith 
138354dfd506SHong Zhang     /* Reached limit so resize header component arrays */
138454dfd506SHong Zhang     header->maxcomps += 2;
138554dfd506SHong Zhang 
138654dfd506SHong Zhang     /* Allocate arrays for component information and value */
13879566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
13889566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
138954dfd506SHong Zhang 
139054dfd506SHong Zhang     /* Recalculate header size */
139154dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
139254dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
1393*dd5bbc93SStefano Zampini #if defined(__NEC__)
1394*dd5bbc93SStefano Zampini     /* NEC/LG: quick hack to keep data aligned on 8 bytes. */
1395*dd5bbc93SStefano Zampini     header->hsize = (header->hsize + (8 - 1)) & ~(8 - 1);
1396*dd5bbc93SStefano Zampini #endif
139754dfd506SHong Zhang 
139854dfd506SHong Zhang     /* Copy over component info */
13999566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
14009566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
14019566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
14029566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
14039566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
140454dfd506SHong Zhang 
140554dfd506SHong Zhang     /* Copy over component data pointers */
14069566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
140754dfd506SHong Zhang 
140854dfd506SHong Zhang     /* Free old arrays */
14099566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
14109566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
141154dfd506SHong Zhang 
141254dfd506SHong Zhang     /* Update pointers */
141354dfd506SHong Zhang     header->size         = compsize;
141454dfd506SHong Zhang     header->key          = compkey;
141554dfd506SHong Zhang     header->offset       = compoffset;
141654dfd506SHong Zhang     header->nvar         = compnvar;
141754dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
141854dfd506SHong Zhang 
141954dfd506SHong Zhang     cvalue->data = compdata;
142054dfd506SHong Zhang 
142154dfd506SHong Zhang     /* Update DataSection Dofs */
142254dfd506SHong 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 */
1423f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
14249566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
142554dfd506SHong Zhang   }
142654dfd506SHong Zhang   header = &network->header[p];
142754dfd506SHong Zhang   cvalue = &network->cvalue[p];
142854dfd506SHong Zhang 
142954dfd506SHong Zhang   compnum = header->ndata;
14302bf73ac6SHong Zhang 
14312bf73ac6SHong Zhang   header->size[compnum] = component->size;
14329566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
14332bf73ac6SHong Zhang   header->key[compnum] = componentkey;
14342bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
14352bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
14362bf73ac6SHong Zhang 
14372bf73ac6SHong Zhang   /* variables */
14382bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
14392bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
14402bf73ac6SHong Zhang 
14412bf73ac6SHong Zhang   header->ndata++;
14423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14435f2c45f1SShri Abhyankar }
14445f2c45f1SShri Abhyankar 
144527f51fceSHong Zhang /*@
14462bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
144727f51fceSHong Zhang 
144827f51fceSHong Zhang   Not Collective
144927f51fceSHong Zhang 
145027f51fceSHong Zhang   Input Parameters:
145120f4b53cSBarry Smith + dm - the `DMNETWORK` object
14522bf73ac6SHong Zhang . p - vertex/edge point
145399c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
145427f51fceSHong Zhang 
145527f51fceSHong Zhang   Output Parameters:
145620f4b53cSBarry Smith + compkey - the key obtained when registering the component (use `NULL` if not required)
145720f4b53cSBarry Smith . component - the component data (use `NULL` if not required)
145820f4b53cSBarry Smith - nvar  - number of variables (use `NULL` if not required)
145927f51fceSHong Zhang 
146097bb938eSShri Abhyankar   Level: beginner
146127f51fceSHong Zhang 
146220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
146327f51fceSHong Zhang @*/
1464d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar)
1465d71ae5a4SJacob Faibussowitsch {
146627f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
14672bf73ac6SHong Zhang   PetscInt                 offset  = 0;
14682bf73ac6SHong Zhang   DMNetworkComponentHeader header;
146927f51fceSHong Zhang 
147027f51fceSHong Zhang   PetscFunctionBegin;
14712bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
14729566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
14733ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
147427f51fceSHong Zhang   }
147527f51fceSHong Zhang 
14769566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
147742dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
14785f2c45f1SShri Abhyankar 
14792bf73ac6SHong Zhang   if (compnum >= 0) {
14802bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
14812bf73ac6SHong Zhang     if (component) {
148254dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
14832bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
14842bf73ac6SHong Zhang     }
14852bf73ac6SHong Zhang   }
14865f2c45f1SShri Abhyankar 
14872bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
148854dfd506SHong Zhang 
14893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14905f2c45f1SShri Abhyankar }
14915f2c45f1SShri Abhyankar 
14922bf73ac6SHong Zhang /*
14932bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14942bf73ac6SHong 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.
14952bf73ac6SHong Zhang */
1496d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkComponentSetUp(DM dm)
1497d71ae5a4SJacob Faibussowitsch {
14985f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1499f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
15005f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
15015f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1502f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
15035f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
15045f2c45f1SShri Abhyankar 
15055f2c45f1SShri Abhyankar   PetscFunctionBegin;
15069566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
15079566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1508f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
15099566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
15105f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1511daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
15129566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
15135f2c45f1SShri Abhyankar     /* Copy header */
15145f2c45f1SShri Abhyankar     header     = &network->header[p];
1515f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
15169566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1517f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
15189566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1519aeb78aa7SBarry Smith     headerinfo->size = headerarr;
152054dfd506SHong Zhang     headerarr += header->maxcomps;
15219566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1522aeb78aa7SBarry Smith     headerinfo->key = headerarr;
152354dfd506SHong Zhang     headerarr += header->maxcomps;
15249566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1525aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
152654dfd506SHong Zhang     headerarr += header->maxcomps;
15279566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1528aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
152954dfd506SHong Zhang     headerarr += header->maxcomps;
15309566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1531aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
153254dfd506SHong Zhang 
15335f2c45f1SShri Abhyankar     /* Copy data */
15345f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
15355f2c45f1SShri Abhyankar     ncomp  = header->ndata;
15362bf73ac6SHong Zhang 
15375f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
153854dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
15399566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
15405f2c45f1SShri Abhyankar     }
15415f2c45f1SShri Abhyankar   }
1542aeb78aa7SBarry Smith 
1543daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1544aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1545aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1546aeb78aa7SBarry Smith   }
1547aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
15483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15495f2c45f1SShri Abhyankar }
15505f2c45f1SShri Abhyankar 
15515f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1552d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1553d71ae5a4SJacob Faibussowitsch {
15545f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
15555f2c45f1SShri Abhyankar 
15565f2c45f1SShri Abhyankar   PetscFunctionBegin;
15579566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
15583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15595f2c45f1SShri Abhyankar }
15605f2c45f1SShri Abhyankar 
156124121865SAdrian Maldonado /* Get a subsection from a range of points */
1562d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1563d71ae5a4SJacob Faibussowitsch {
156424121865SAdrian Maldonado   PetscInt i, nvar;
156524121865SAdrian Maldonado 
156624121865SAdrian Maldonado   PetscFunctionBegin;
15679566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
15689566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
156924121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
15709566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
15719566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
157224121865SAdrian Maldonado   }
157324121865SAdrian Maldonado 
15749566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
15753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
157624121865SAdrian Maldonado }
157724121865SAdrian Maldonado 
157824121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1579e66d8692SHong Zhang static PetscErrorCode DMNetworkSetSubMap_private(DM dm, PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1580d71ae5a4SJacob Faibussowitsch {
158124121865SAdrian Maldonado   PetscInt i, *subpoints;
158224121865SAdrian Maldonado 
158324121865SAdrian Maldonado   PetscFunctionBegin;
158424121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15859566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1586ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
1587e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15889566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
15893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
159024121865SAdrian Maldonado }
159124121865SAdrian Maldonado 
159224121865SAdrian Maldonado /*@
159320f4b53cSBarry Smith   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after `DMNetworkDistribute()`
159424121865SAdrian Maldonado 
159520f4b53cSBarry Smith   Collective
159624121865SAdrian Maldonado 
15972fe279fdSBarry Smith   Input Parameter:
159820f4b53cSBarry Smith . dm - the `DMNETWORK` Object
159924121865SAdrian Maldonado 
160020f4b53cSBarry Smith   Level: intermediate
160120f4b53cSBarry Smith 
160220f4b53cSBarry Smith   Note:
160320f4b53cSBarry Smith   the routine will create alternative orderings for the vertices and edges. Assume global network points are:
160424121865SAdrian Maldonado 
160524121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
160624121865SAdrian Maldonado 
1607caf410d2SHong 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]).
160824121865SAdrian Maldonado 
160920f4b53cSBarry Smith   With this new ordering a local `PetscSection`, global `PetscSection` and` PetscSF` will be created specific to the subset.
161024121865SAdrian Maldonado 
161124121865SAdrian Maldonado @*/
1612d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1613d71ae5a4SJacob Faibussowitsch {
161424121865SAdrian Maldonado   MPI_Comm    comm;
1615f11a936eSBarry Smith   PetscMPIInt size;
161624121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
161724121865SAdrian Maldonado 
1618eab1376dSHong Zhang   PetscFunctionBegin;
16199566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
16209566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
162124121865SAdrian Maldonado 
162224121865SAdrian Maldonado   /* Create maps for vertices and edges */
1623e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1624e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
162524121865SAdrian Maldonado 
162624121865SAdrian Maldonado   /* Create local sub-sections */
1627daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1628daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
162924121865SAdrian Maldonado 
16309852e123SBarry Smith   if (size > 1) {
16319566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
163222bbedd7SHong Zhang 
16339566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
16349566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
16359566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
163624121865SAdrian Maldonado   } else {
163724121865SAdrian Maldonado     /* create structures for vertex */
16389566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
163924121865SAdrian Maldonado     /* create structures for edge */
16409566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
164124121865SAdrian Maldonado   }
164224121865SAdrian Maldonado 
164324121865SAdrian Maldonado   /* Add viewers */
16449566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
16459566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
16469566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
16479566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
16483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
164924121865SAdrian Maldonado }
16507b6afd5bSHong Zhang 
1651f11a936eSBarry Smith /*
16525c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
16535c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1654f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1655f11a936eSBarry Smith */
1656d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1657d71ae5a4SJacob Faibussowitsch {
1658f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1659f11a936eSBarry Smith   const PetscInt          *edges;
1660f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1661f11a936eSBarry Smith   DMNetworkComponentHeader header;
1662f11a936eSBarry Smith 
1663f11a936eSBarry Smith   PetscFunctionBegin;
16649566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
16659566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1666f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
16679566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1668f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16699566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1670f11a936eSBarry Smith   }
16713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1672f11a936eSBarry Smith }
1673f11a936eSBarry Smith 
16748afb7921SAidan Hamilton /*
16758afb7921SAidan Hamilton   DMNetworkDistributeCoordinates - Internal function to distribute the coordinate network and coordinates.
16768afb7921SAidan Hamilton 
16778afb7921SAidan Hamilton   Collective
16788afb7921SAidan Hamilton 
16798afb7921SAidan Hamilton   Input Parameters:
168020f4b53cSBarry Smith   + dm - The original `DMNETWORK` object
1681aaa8cc7dSPierre Jolivet   - migrationSF - The `PetscSF` describing the migration from dm to dmnew
16828afb7921SAidan Hamilton   - newDM - The new distributed dmnetwork object.
16838afb7921SAidan Hamilton */
16848afb7921SAidan Hamilton 
16858afb7921SAidan Hamilton static PetscErrorCode DMNetworkDistributeCoordinates(DM dm, PetscSF migrationSF, DM newDM)
16868afb7921SAidan Hamilton {
16878afb7921SAidan Hamilton   DM_Network              *newDMnetwork = (DM_Network *)((newDM)->data), *newCoordnetwork, *oldCoordnetwork;
16888afb7921SAidan Hamilton   DM                       cdm, newcdm;
16898afb7921SAidan Hamilton   PetscInt                 cdim, bs, p, pStart, pEnd, offset;
16908afb7921SAidan Hamilton   Vec                      oldCoord, newCoord;
16918afb7921SAidan Hamilton   DMNetworkComponentHeader header;
16928afb7921SAidan Hamilton   const char              *name;
16938afb7921SAidan Hamilton 
16948afb7921SAidan Hamilton   PetscFunctionBegin;
16958afb7921SAidan Hamilton   /* Distribute the coordinate network and coordinates */
16968afb7921SAidan Hamilton   PetscCall(DMGetCoordinateDim(dm, &cdim));
16978afb7921SAidan Hamilton   PetscCall(DMSetCoordinateDim(newDM, cdim));
16988afb7921SAidan Hamilton 
16998afb7921SAidan Hamilton   /* Migrate only if original network had coordinates */
17008afb7921SAidan Hamilton   PetscCall(DMGetCoordinatesLocal(dm, &oldCoord));
17018afb7921SAidan Hamilton   if (oldCoord) {
17028afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(dm, &cdm));
17038afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(newDM, &newcdm));
17048afb7921SAidan Hamilton     newCoordnetwork = (DM_Network *)newcdm->data;
17058afb7921SAidan Hamilton     oldCoordnetwork = (DM_Network *)cdm->data;
17068afb7921SAidan Hamilton 
17078afb7921SAidan Hamilton     PetscCall(VecCreate(PETSC_COMM_SELF, &newCoord));
17088afb7921SAidan Hamilton     PetscCall(PetscObjectGetName((PetscObject)oldCoord, &name));
17098afb7921SAidan Hamilton     PetscCall(PetscObjectSetName((PetscObject)newCoord, name));
17108afb7921SAidan Hamilton     PetscCall(VecGetBlockSize(oldCoord, &bs));
17118afb7921SAidan Hamilton     PetscCall(VecSetBlockSize(newCoord, bs));
17128afb7921SAidan Hamilton 
17138afb7921SAidan Hamilton     PetscCall(DMPlexDistributeField(newDMnetwork->plex, migrationSF, oldCoordnetwork->DofSection, oldCoord, newCoordnetwork->DofSection, newCoord));
17148afb7921SAidan Hamilton     PetscCall(DMSetCoordinatesLocal(newDM, newCoord));
17158afb7921SAidan Hamilton 
17168afb7921SAidan Hamilton     PetscCall(VecDestroy(&newCoord));
1717aaa8cc7dSPierre Jolivet     /* Migrate the components from the original coordinate network to the new coordinate network */
17188afb7921SAidan Hamilton     PetscCall(DMPlexDistributeData(newDMnetwork->plex, migrationSF, oldCoordnetwork->DataSection, MPIU_INT, (void *)oldCoordnetwork->componentdataarray, newCoordnetwork->DataSection, (void **)&newCoordnetwork->componentdataarray));
17198afb7921SAidan Hamilton     /* update the header pointers in the new coordinate network components */
17208afb7921SAidan Hamilton     PetscCall(PetscSectionGetChart(newCoordnetwork->DataSection, &pStart, &pEnd));
17218afb7921SAidan Hamilton     for (p = pStart; p < pEnd; p++) {
17228afb7921SAidan Hamilton       PetscCall(PetscSectionGetOffset(newCoordnetwork->DataSection, p, &offset));
17238afb7921SAidan Hamilton       header = (DMNetworkComponentHeader)(newCoordnetwork->componentdataarray + offset);
17248afb7921SAidan Hamilton       /* Update pointers */
17258afb7921SAidan Hamilton       header->size         = (PetscInt *)(header + 1);
17268afb7921SAidan Hamilton       header->key          = header->size + header->maxcomps;
17278afb7921SAidan Hamilton       header->offset       = header->key + header->maxcomps;
17288afb7921SAidan Hamilton       header->nvar         = header->offset + header->maxcomps;
17298afb7921SAidan Hamilton       header->offsetvarrel = header->nvar + header->maxcomps;
17308afb7921SAidan Hamilton     }
17318afb7921SAidan Hamilton 
17328afb7921SAidan Hamilton     PetscCall(DMSetLocalSection(newCoordnetwork->plex, newCoordnetwork->DofSection));
17338afb7921SAidan Hamilton     PetscCall(DMGetGlobalSection(newCoordnetwork->plex, &newCoordnetwork->GlobalDofSection));
17348afb7921SAidan Hamilton     newCoordnetwork->componentsetup = PETSC_TRUE;
17358afb7921SAidan Hamilton   }
17363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17378afb7921SAidan Hamilton }
17388afb7921SAidan Hamilton 
17395f2c45f1SShri Abhyankar /*@
17402bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
17415f2c45f1SShri Abhyankar 
17425f2c45f1SShri Abhyankar   Collective
17435f2c45f1SShri Abhyankar 
1744d8d19677SJose E. Roman   Input Parameters:
174520f4b53cSBarry Smith + DM - the `DMNETWORK` object
17462bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
17475f2c45f1SShri Abhyankar 
174820f4b53cSBarry Smith   Options Database Keys:
17496e4289a0SDuncan Campbell + -dmnetwork_view - Calls `DMView()` at the conclusion of `DMSetUp()`
17506e4289a0SDuncan Campbell . -dmnetwork_view_distributed - Calls `DMView()` at the conclusion of `DMNetworkDistribute()`
17516e4289a0SDuncan Campbell - -dmnetwork_view_tmpdir - Sets the temporary directory to use when viewing with the `draw` option
17525b3f975aSHong Zhang 
17535f2c45f1SShri Abhyankar   Level: intermediate
17545f2c45f1SShri Abhyankar 
175520f4b53cSBarry Smith   Note:
175620f4b53cSBarry Smith   Distributes the network with <overlap>-overlapping partitioning of the edges.
175720f4b53cSBarry Smith 
175820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`
17595f2c45f1SShri Abhyankar @*/
1760d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1761d71ae5a4SJacob Faibussowitsch {
1762d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1763d3464fd4SAdrian Maldonado   PetscMPIInt              size;
17648afb7921SAidan Hamilton   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data), *newDMnetwork;
1765caf410d2SHong Zhang   PetscSF                  pointsf      = NULL;
17665f2c45f1SShri Abhyankar   DM                       newDM;
17678afb7921SAidan Hamilton   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv, net;
17688afb7921SAidan Hamilton   PetscInt                *sv;
1769f11a936eSBarry Smith   PetscBT                  btable;
177051ac5effSHong Zhang   PetscPartitioner         part;
1771b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
17725f2c45f1SShri Abhyankar 
17735f2c45f1SShri Abhyankar   PetscFunctionBegin;
17745c6496baSHong Zhang   PetscValidPointer(dm, 1);
17755c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
17769566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
17779566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1778a9750deaSHong Zhang   if (size == 1) {
1779a9750deaSHong Zhang     oldDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1780a9750deaSHong Zhang     PetscFunctionReturn(PETSC_SUCCESS);
1781a9750deaSHong Zhang   }
1782d3464fd4SAdrian Maldonado 
17835c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
17845b3f975aSHong Zhang 
17852bf73ac6SHong 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. */
1786e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
17879566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
17885f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
178954dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
17909566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
179151ac5effSHong Zhang 
179251ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
17939566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
17949566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
179551ac5effSHong Zhang 
17962bf73ac6SHong Zhang   /* Distribute plex dm */
17979566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
179851ac5effSHong Zhang 
17995f2c45f1SShri Abhyankar   /* Distribute dof section */
18009566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
18019566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
180251ac5effSHong Zhang 
18035f2c45f1SShri Abhyankar   /* Distribute data and associated section */
18049566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
18059566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
180624121865SAdrian Maldonado 
1807daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1808daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1809daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1810daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1811daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1812daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1813daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1814daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1815daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
181624121865SAdrian Maldonado 
18171bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
18189566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
18199566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
18205f2c45f1SShri Abhyankar 
1821b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1822daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1823daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1824daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1825daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1826daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1827daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
18282bf73ac6SHong Zhang 
18292bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
18302bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1831b9c6e19dSShri Abhyankar   */
1832daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1833f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1834daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1835daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1836b9c6e19dSShri Abhyankar   }
1837b9c6e19dSShri Abhyankar 
1838f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1839daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18409566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
184154dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18425c6496baSHong Zhang 
184354dfd506SHong Zhang     /* Update pointers */
184454dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
184554dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
184654dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
184754dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
184854dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
184954dfd506SHong Zhang 
1850daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1851b9c6e19dSShri Abhyankar   }
1852b9c6e19dSShri Abhyankar 
18535c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
185448a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
18555c6496baSHong Zhang 
18565c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1857daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
18589566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
18595f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18605c6496baSHong Zhang 
186154dfd506SHong Zhang     /* Update pointers */
186254dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
186354dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
186454dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
186554dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
186654dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
186754dfd506SHong Zhang 
18682bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
18692bf73ac6SHong Zhang     gidx = header->index;
1870eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, gidx + 1, 0, &svtx_idx));
18712bf73ac6SHong Zhang     svtx_idx--;
18722bf73ac6SHong Zhang 
18732bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1874daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
18752bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
18765c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
18779566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1878f11a936eSBarry Smith 
1879daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1880daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
18815c6496baSHong Zhang         net = sv[0];
188235cb6cd3SPierre Jolivet         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this process */
18832bf73ac6SHong Zhang       }
18842bf73ac6SHong Zhang     }
1885b9c6e19dSShri Abhyankar   }
1886b9c6e19dSShri Abhyankar 
18872bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
18882bf73ac6SHong Zhang   nv = 0;
1889daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1890daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1891caf410d2SHong Zhang 
18922bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1893daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1894daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1895daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1896daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1897daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1898daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
18992bf73ac6SHong Zhang 
1900daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1901daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1902caf410d2SHong Zhang 
19032bf73ac6SHong 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. */
1904daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1905b9c6e19dSShri Abhyankar   }
1906daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1907b9c6e19dSShri Abhyankar 
19082bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1909daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
19109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
19115f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1912daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1913b9c6e19dSShri Abhyankar   }
1914b9c6e19dSShri Abhyankar 
19152bf73ac6SHong Zhang   nv = 0;
1916daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
19179566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
19185f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
19192bf73ac6SHong Zhang 
19202bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1921eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, header->index + 1, 0, &svtx_idx));
19222bf73ac6SHong Zhang     svtx_idx--;
19232bf73ac6SHong Zhang     if (svtx_idx < 0) {
1924daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
19252bf73ac6SHong Zhang     } else { /* a shared vertex */
1926daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
19272bf73ac6SHong Zhang 
19285c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
19299566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1930f11a936eSBarry Smith 
1931daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1932daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
19335c6496baSHong Zhang         net = sv[0];
19349371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1935b9c6e19dSShri Abhyankar       }
19362bf73ac6SHong Zhang     }
19372bf73ac6SHong Zhang   }
1938daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1939b9c6e19dSShri Abhyankar 
19408afb7921SAidan Hamilton   PetscCall(DMNetworkDistributeCoordinates(*dm, pointsf, newDM));
1941caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1942daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1943caf410d2SHong Zhang 
19442bf73ac6SHong Zhang   /* Free spaces */
19459566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
19469566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
194748a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
19482bf73ac6SHong Zhang 
19495b3f975aSHong Zhang   /* View distributed dmnetwork */
19509566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
19515b3f975aSHong Zhang 
1952d3464fd4SAdrian Maldonado   *dm = newDM;
1953e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
19543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19555f2c45f1SShri Abhyankar }
19565f2c45f1SShri Abhyankar 
195724121865SAdrian Maldonado /*@C
195820f4b53cSBarry Smith   PetscSFGetSubSF - Returns an `PetscSF` for a specific subset of points. Leaves are re-numbered to reflect the new ordering
19592bf73ac6SHong Zhang 
19602bf73ac6SHong Zhang  Collective
196124121865SAdrian Maldonado 
196224121865SAdrian Maldonado   Input Parameters:
196320f4b53cSBarry Smith + mainSF - `PetscSF` structure
196420f4b53cSBarry Smith - map - a `ISLocalToGlobalMapping` that contains the subset of points
196524121865SAdrian Maldonado 
196697bb3fdcSJose E. Roman   Output Parameter:
196720f4b53cSBarry Smith . subSF - a subset of the `mainSF` for the desired subset.
1968ee300463SSatish Balay 
1969ee300463SSatish Balay   Level: intermediate
197020f4b53cSBarry Smith 
197120f4b53cSBarry Smith .seealso: `PetscSF`
19727d928bffSSatish Balay @*/
1973d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1974d71ae5a4SJacob Faibussowitsch {
197524121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
197624121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
197724121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
197824121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
197924121865SAdrian Maldonado   const PetscInt    *ilocal;
198024121865SAdrian Maldonado   const PetscSFNode *iremote;
198124121865SAdrian Maldonado 
198224121865SAdrian Maldonado   PetscFunctionBegin;
19839566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
198424121865SAdrian Maldonado 
198524121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
19869566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
19879566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
198824121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
198924121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
199024121865SAdrian Maldonado   }
199124121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
19929566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
199324121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
19949566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
19959566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
19969566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
199724121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
19989566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
19999566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
200024121865SAdrian Maldonado   nleaves_sub = 0;
200124121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
200224121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
200324121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
20044b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
200524121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
200624121865SAdrian Maldonado       nleaves_sub += 1;
200724121865SAdrian Maldonado     }
200824121865SAdrian Maldonado   }
20099566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
20109566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
201124121865SAdrian Maldonado 
201224121865SAdrian Maldonado   /* Create new subSF */
2013e66d8692SHong Zhang   PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)mainsf), subSF));
20149566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
20159566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
20169566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
20179566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
20183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
201924121865SAdrian Maldonado }
202024121865SAdrian Maldonado 
20215f2c45f1SShri Abhyankar /*@C
20225f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
20235f2c45f1SShri Abhyankar 
20245f2c45f1SShri Abhyankar   Not Collective
20255f2c45f1SShri Abhyankar 
20265f2c45f1SShri Abhyankar   Input Parameters:
202720f4b53cSBarry Smith + dm - the `DMNETWORK` object
20285f2c45f1SShri Abhyankar - p  - the vertex point
20295f2c45f1SShri Abhyankar 
2030fd292e60Sprj-   Output Parameters:
20315f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
20322bf73ac6SHong Zhang - edges  - list of edge points
20335f2c45f1SShri Abhyankar 
203497bb938eSShri Abhyankar   Level: beginner
20355f2c45f1SShri Abhyankar 
203620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
20375f2c45f1SShri Abhyankar @*/
2038d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[])
2039d71ae5a4SJacob Faibussowitsch {
20405f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20415f2c45f1SShri Abhyankar 
20425f2c45f1SShri Abhyankar   PetscFunctionBegin;
20439566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
20449566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
20453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20465f2c45f1SShri Abhyankar }
20475f2c45f1SShri Abhyankar 
20485f2c45f1SShri Abhyankar /*@C
2049d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
20505f2c45f1SShri Abhyankar 
20515f2c45f1SShri Abhyankar   Not Collective
20525f2c45f1SShri Abhyankar 
20535f2c45f1SShri Abhyankar   Input Parameters:
205420f4b53cSBarry Smith + dm - the `DMNETWORK` object
20555f2c45f1SShri Abhyankar - p - the edge point
20565f2c45f1SShri Abhyankar 
20572fe279fdSBarry Smith   Output Parameter:
20585f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
20595f2c45f1SShri Abhyankar 
206097bb938eSShri Abhyankar   Level: beginner
20615f2c45f1SShri Abhyankar 
206220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
20635f2c45f1SShri Abhyankar @*/
2064d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
2065d71ae5a4SJacob Faibussowitsch {
20665f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20675f2c45f1SShri Abhyankar 
20685f2c45f1SShri Abhyankar   PetscFunctionBegin;
20699566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
20703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20715f2c45f1SShri Abhyankar }
20725f2c45f1SShri Abhyankar 
20735f2c45f1SShri Abhyankar /*@
207420f4b53cSBarry Smith   DMNetworkIsSharedVertex - Returns `PETSC_TRUE` if the vertex is shared by subnetworks
20752bf73ac6SHong Zhang 
20762bf73ac6SHong Zhang   Not Collective
20772bf73ac6SHong Zhang 
20782bf73ac6SHong Zhang   Input Parameters:
207920f4b53cSBarry Smith + dm - the `DMNETWORK` object
20802bf73ac6SHong Zhang - p - the vertex point
20812bf73ac6SHong Zhang 
20822bf73ac6SHong Zhang   Output Parameter:
208320f4b53cSBarry Smith . flag - `PETSC_TRUE` if the vertex is shared by subnetworks
20842bf73ac6SHong Zhang 
20852bf73ac6SHong Zhang   Level: beginner
20862bf73ac6SHong Zhang 
208720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
20882bf73ac6SHong Zhang @*/
2089d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
2090d71ae5a4SJacob Faibussowitsch {
20912bf73ac6SHong Zhang   PetscFunctionBegin;
2092eec179cfSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2093eec179cfSJacob Faibussowitsch   PetscValidBoolPointer(flag, 3);
20942bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
20952bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
20962bf73ac6SHong Zhang     PetscInt    gidx;
2097eec179cfSJacob Faibussowitsch 
20989566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
2099eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIHas(network->cloneshared->svtable, gidx + 1, flag));
21002bf73ac6SHong Zhang   } else { /* would be removed? */
21012bf73ac6SHong Zhang     PetscInt        nv;
21022bf73ac6SHong Zhang     const PetscInt *vtx;
2103eec179cfSJacob Faibussowitsch 
21049566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
2105eec179cfSJacob Faibussowitsch     for (PetscInt i = 0; i < nv; i++) {
21062bf73ac6SHong Zhang       if (p == vtx[i]) {
21072bf73ac6SHong Zhang         *flag = PETSC_TRUE;
21083ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
21092bf73ac6SHong Zhang       }
21102bf73ac6SHong Zhang     }
2111eec179cfSJacob Faibussowitsch     *flag = PETSC_FALSE;
21122bf73ac6SHong Zhang   }
21133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21142bf73ac6SHong Zhang }
21152bf73ac6SHong Zhang 
21162bf73ac6SHong Zhang /*@
211720f4b53cSBarry Smith   DMNetworkIsGhostVertex - Returns `PETSC_TRUE` if the vertex is a ghost vertex
21185f2c45f1SShri Abhyankar 
21195f2c45f1SShri Abhyankar   Not Collective
21205f2c45f1SShri Abhyankar 
21215f2c45f1SShri Abhyankar   Input Parameters:
212220f4b53cSBarry Smith + dm - the `DMNETWORK` object
2123a2b725a8SWilliam Gropp - p - the vertex point
21245f2c45f1SShri Abhyankar 
21255f2c45f1SShri Abhyankar   Output Parameter:
212620f4b53cSBarry Smith . isghost - `PETSC_TRUE` if the vertex is a ghost point
21275f2c45f1SShri Abhyankar 
212897bb938eSShri Abhyankar   Level: beginner
21295f2c45f1SShri Abhyankar 
213020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
21315f2c45f1SShri Abhyankar @*/
2132d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
2133d71ae5a4SJacob Faibussowitsch {
21345f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
21355f2c45f1SShri Abhyankar   PetscInt     offsetg;
21365f2c45f1SShri Abhyankar   PetscSection sectiong;
21375f2c45f1SShri Abhyankar 
21385f2c45f1SShri Abhyankar   PetscFunctionBegin;
21395f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
21409566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
21419566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
21425f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
21433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21445f2c45f1SShri Abhyankar }
21455f2c45f1SShri Abhyankar 
2146d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
2147d71ae5a4SJacob Faibussowitsch {
21485f2c45f1SShri Abhyankar   PetscFunctionBegin;
2149e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2150daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
21515b3f975aSHong Zhang   /* View dmnetwork */
21529566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2153e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
21543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21555f2c45f1SShri Abhyankar }
21565f2c45f1SShri Abhyankar 
21571ad426b7SHong Zhang /*@
215817df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
215920f4b53cSBarry Smith       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TRUE)?
21601ad426b7SHong Zhang 
21611ad426b7SHong Zhang   Collective
21621ad426b7SHong Zhang 
21631ad426b7SHong Zhang   Input Parameters:
216420f4b53cSBarry Smith + dm - the `DMNETWORK` object
216520f4b53cSBarry Smith . eflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for edges
216620f4b53cSBarry Smith - vflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for vertices
21671ad426b7SHong Zhang 
21681ad426b7SHong Zhang  Level: intermediate
21691ad426b7SHong Zhang 
21701ad426b7SHong Zhang @*/
2171d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2172d71ae5a4SJacob Faibussowitsch {
21731ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2174daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
21751ad426b7SHong Zhang 
21761ad426b7SHong Zhang   PetscFunctionBegin;
217783b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
217883b2e829SHong Zhang   network->userVertexJacobian = vflg;
21798675203cSHong Zhang 
218048a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
21818675203cSHong Zhang 
218266b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2183daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
218466b4e0ffSHong Zhang     PetscInt        nedges_total;
21858675203cSHong Zhang     const PetscInt *edges;
21868675203cSHong Zhang 
21878675203cSHong Zhang     /* count nvertex_total */
21888675203cSHong Zhang     nedges_total = 0;
21899566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
21908675203cSHong Zhang 
21918675203cSHong Zhang     vptr[0] = 0;
21928675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
21939566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
21948675203cSHong Zhang       nedges_total += nedges;
21958675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
21968675203cSHong Zhang     }
21978675203cSHong Zhang 
21989566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
21998675203cSHong Zhang     network->Jvptr = vptr;
22008675203cSHong Zhang   }
22013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22021ad426b7SHong Zhang }
22031ad426b7SHong Zhang 
22041ad426b7SHong Zhang /*@
220583b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
220683b2e829SHong Zhang 
220783b2e829SHong Zhang   Not Collective
220883b2e829SHong Zhang 
220983b2e829SHong Zhang   Input Parameters:
221020f4b53cSBarry Smith + dm - the `DMNETWORK` object
221183b2e829SHong Zhang . p - the edge point
22123e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
22133e97b6e8SHong Zhang         J[0]: this edge
221420f4b53cSBarry Smith         J[1] and J[2]: connected vertices, obtained by calling `DMNetworkGetConnectedVertices()`
221583b2e829SHong Zhang 
221697bb938eSShri Abhyankar   Level: advanced
221783b2e829SHong Zhang 
221820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkVertexSetMatrix()`
221983b2e829SHong Zhang @*/
2220d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2221d71ae5a4SJacob Faibussowitsch {
222283b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
222383b2e829SHong Zhang 
222483b2e829SHong Zhang   PetscFunctionBegin;
22255c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
22268675203cSHong Zhang 
22278675203cSHong Zhang   if (J) {
2228883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2229883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2230883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
22318675203cSHong Zhang   }
22323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
223383b2e829SHong Zhang }
223483b2e829SHong Zhang 
223583b2e829SHong Zhang /*@
223676ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
22371ad426b7SHong Zhang 
22381ad426b7SHong Zhang   Not Collective
22391ad426b7SHong Zhang 
22401ad426b7SHong Zhang   Input Parameters:
224120f4b53cSBarry Smith + dm - The `DMNETWORK` object
22421ad426b7SHong Zhang . p - the vertex point
22433e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
22443e97b6e8SHong Zhang         J[0]:       this vertex
22453e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
22463e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
22471ad426b7SHong Zhang 
224897bb938eSShri Abhyankar   Level: advanced
22491ad426b7SHong Zhang 
225020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkEdgeSetMatrix()`
22511ad426b7SHong Zhang @*/
2252d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2253d71ae5a4SJacob Faibussowitsch {
22545f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2255daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2256883e35e8SHong Zhang   const PetscInt *edges;
22575f2c45f1SShri Abhyankar 
22585f2c45f1SShri Abhyankar   PetscFunctionBegin;
22595c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2260883e35e8SHong Zhang 
22618675203cSHong Zhang   if (J) {
2262883e35e8SHong Zhang     vptr                          = network->Jvptr;
22633e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
22643e97b6e8SHong Zhang 
22653e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
22669566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2267883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
22688675203cSHong Zhang   }
22693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2270883e35e8SHong Zhang }
2271883e35e8SHong Zhang 
2272d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2273d71ae5a4SJacob Faibussowitsch {
22745cf7da58SHong Zhang   PetscInt    j;
22755cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
22765cf7da58SHong Zhang 
22775cf7da58SHong Zhang   PetscFunctionBegin;
22785cf7da58SHong Zhang   if (!ghost) {
227948a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22805cf7da58SHong Zhang   } else {
228148a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22825cf7da58SHong Zhang   }
22833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22845cf7da58SHong Zhang }
22855cf7da58SHong Zhang 
2286d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2287d71ae5a4SJacob Faibussowitsch {
22885cf7da58SHong Zhang   PetscInt    j, ncols_u;
22895cf7da58SHong Zhang   PetscScalar val;
22905cf7da58SHong Zhang 
22915cf7da58SHong Zhang   PetscFunctionBegin;
22925cf7da58SHong Zhang   if (!ghost) {
22935cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22949566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22955cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22969566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22979566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22985cf7da58SHong Zhang     }
22995cf7da58SHong Zhang   } else {
23005cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
23019566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
23025cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
23039566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
23049566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
23055cf7da58SHong Zhang     }
23065cf7da58SHong Zhang   }
23073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23085cf7da58SHong Zhang }
23095cf7da58SHong Zhang 
2310d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2311d71ae5a4SJacob Faibussowitsch {
23125cf7da58SHong Zhang   PetscFunctionBegin;
23135cf7da58SHong Zhang   if (Ju) {
23149566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
23155cf7da58SHong Zhang   } else {
23169566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
23175cf7da58SHong Zhang   }
23183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23195cf7da58SHong Zhang }
23205cf7da58SHong Zhang 
2321d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2322d71ae5a4SJacob Faibussowitsch {
2323883e35e8SHong Zhang   PetscInt     j, *cols;
2324883e35e8SHong Zhang   PetscScalar *zeros;
2325883e35e8SHong Zhang 
2326883e35e8SHong Zhang   PetscFunctionBegin;
23279566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2328883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
23299566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
23309566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
23313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23321ad426b7SHong Zhang }
2333a4e85ca8SHong Zhang 
2334d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2335d71ae5a4SJacob Faibussowitsch {
23363e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
23373e97b6e8SHong Zhang   const PetscInt *cols;
23383e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
23393e97b6e8SHong Zhang 
23403e97b6e8SHong Zhang   PetscFunctionBegin;
23419566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
234263a3b9bcSJacob 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);
23433e97b6e8SHong Zhang 
23443e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
23459566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
23463e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
23473e97b6e8SHong Zhang       col = cols[j] + cstart;
23489566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
23493e97b6e8SHong Zhang     }
23509566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
23513e97b6e8SHong Zhang   }
23523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23533e97b6e8SHong Zhang }
23541ad426b7SHong Zhang 
2355d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2356d71ae5a4SJacob Faibussowitsch {
2357a4e85ca8SHong Zhang   PetscFunctionBegin;
2358a4e85ca8SHong Zhang   if (Ju) {
23599566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2360a4e85ca8SHong Zhang   } else {
23619566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2362a4e85ca8SHong Zhang   }
23633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2364a4e85ca8SHong Zhang }
2365a4e85ca8SHong Zhang 
236624121865SAdrian 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.
236724121865SAdrian Maldonado */
2368d71ae5a4SJacob Faibussowitsch PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2369d71ae5a4SJacob Faibussowitsch {
237024121865SAdrian Maldonado   PetscInt  i, size, dof;
237124121865SAdrian Maldonado   PetscInt *glob2loc;
237224121865SAdrian Maldonado 
237324121865SAdrian Maldonado   PetscFunctionBegin;
23749566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
23759566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
237624121865SAdrian Maldonado 
237724121865SAdrian Maldonado   for (i = 0; i < size; i++) {
23789566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
237924121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
238024121865SAdrian Maldonado     glob2loc[i] = dof;
238124121865SAdrian Maldonado   }
238224121865SAdrian Maldonado 
2383e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)globalsec), 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
238424121865SAdrian Maldonado #if 0
23859566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
238624121865SAdrian Maldonado #endif
23873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
238824121865SAdrian Maldonado }
238924121865SAdrian Maldonado 
239001ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
23919e1d080bSHong Zhang 
2392d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2393d71ae5a4SJacob Faibussowitsch {
23941ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
239524121865SAdrian Maldonado   PetscInt               eDof, vDof;
239624121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
23979e1d080bSHong Zhang   MPI_Comm               comm;
239824121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
239924121865SAdrian Maldonado 
24009e1d080bSHong Zhang   PetscFunctionBegin;
24019566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
240224121865SAdrian Maldonado 
24039566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
24049566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
240524121865SAdrian Maldonado 
24069566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
24079566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24089566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
240924121865SAdrian Maldonado 
24109566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
24119566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24129566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
241324121865SAdrian Maldonado 
24149566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
24159566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24169566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
241724121865SAdrian Maldonado 
24189566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
24199566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24209566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
242124121865SAdrian Maldonado 
24223f6a6bdaSHong Zhang   bA[0][0] = j11;
24233f6a6bdaSHong Zhang   bA[0][1] = j12;
24243f6a6bdaSHong Zhang   bA[1][0] = j21;
24253f6a6bdaSHong Zhang   bA[1][1] = j22;
242624121865SAdrian Maldonado 
24279566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
24289566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
242924121865SAdrian Maldonado 
24309566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
24319566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
24329566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
24339566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
243424121865SAdrian Maldonado 
24359566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
24369566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
24379566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
24389566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
243924121865SAdrian Maldonado 
24409566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
24419566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
24429566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
24439566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
24449566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
24459566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
24469566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
244724121865SAdrian Maldonado 
24489566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
24499566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
24509566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
245124121865SAdrian Maldonado 
245224121865SAdrian Maldonado   /* Free structures */
24539566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
24549566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
24553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24569e1d080bSHong Zhang }
24579e1d080bSHong Zhang 
2458d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2459d71ae5a4SJacob Faibussowitsch {
24609e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
24619e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
24629e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
24639e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
24649e1d080bSHong Zhang   Mat             Juser;
24659e1d080bSHong Zhang   PetscSection    sectionGlobal;
24669e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
24679e1d080bSHong Zhang   const PetscInt *edges, *cone;
24689e1d080bSHong Zhang   MPI_Comm        comm;
24699e1d080bSHong Zhang   MatType         mtype;
24709e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
24719e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
24729e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
24739e1d080bSHong Zhang 
24749e1d080bSHong Zhang   PetscFunctionBegin;
24759e1d080bSHong Zhang   mtype = dm->mattype;
24769566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
24779e1d080bSHong Zhang   if (isNest) {
24789566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
24799566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24803ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24819e1d080bSHong Zhang   }
24829e1d080bSHong Zhang 
24839e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2484a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
24859566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
24869566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24873ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24881ad426b7SHong Zhang   }
24891ad426b7SHong Zhang 
24909566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
24919566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
24929566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
24939566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
24942a945128SHong Zhang 
24959566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
24969566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
249789898e50SHong Zhang 
249889898e50SHong Zhang   /* (1) Set matrix preallocation */
249989898e50SHong Zhang   /*------------------------------*/
25009566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
25019566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
25029566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
25039566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
25049566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
25059566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2506840c2264SHong Zhang 
250789898e50SHong Zhang   /* Set preallocation for edges */
250889898e50SHong Zhang   /*-----------------------------*/
25099566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2510840c2264SHong Zhang 
25119566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2512840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2513840c2264SHong Zhang     /* Get row indices */
25149566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
25159566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2516840c2264SHong Zhang     if (nrows) {
2517840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2518840c2264SHong Zhang 
2519a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
25209566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2521840c2264SHong Zhang       for (v = 0; v < 2; v++) {
25229566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2523840c2264SHong Zhang 
25248675203cSHong Zhang         if (network->Je) {
2525840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
25268675203cSHong Zhang         } else Juser = NULL;
25279566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
25289566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2529840c2264SHong Zhang       }
2530840c2264SHong Zhang 
253189898e50SHong Zhang       /* Set preallocation for edge self */
2532840c2264SHong Zhang       cstart = rstart;
25338675203cSHong Zhang       if (network->Je) {
2534840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25358675203cSHong Zhang       } else Juser = NULL;
25369566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2537840c2264SHong Zhang     }
2538840c2264SHong Zhang   }
2539840c2264SHong Zhang 
254089898e50SHong Zhang   /* Set preallocation for vertices */
254189898e50SHong Zhang   /*--------------------------------*/
25429566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
25438675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2544840c2264SHong Zhang 
2545840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2546840c2264SHong Zhang     /* Get row indices */
25479566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25489566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2549840c2264SHong Zhang     if (!nrows) continue;
2550840c2264SHong Zhang 
25519566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2552bdcb62a2SHong Zhang     if (ghost) {
25539566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2554bdcb62a2SHong Zhang     } else {
2555bdcb62a2SHong Zhang       rows_v = rows;
2556bdcb62a2SHong Zhang     }
2557bdcb62a2SHong Zhang 
2558bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2559840c2264SHong Zhang 
2560840c2264SHong Zhang     /* Get supporting edges and connected vertices */
25619566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2562840c2264SHong Zhang 
2563840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2564840c2264SHong Zhang       /* Supporting edges */
25659566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2567840c2264SHong Zhang 
25688675203cSHong Zhang       if (network->Jv) {
2569840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25708675203cSHong Zhang       } else Juser = NULL;
25719566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2572840c2264SHong Zhang 
2573840c2264SHong Zhang       /* Connected vertices */
25749566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2575840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25769566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2577840c2264SHong Zhang 
25789566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2579840c2264SHong Zhang 
25808675203cSHong Zhang       if (network->Jv) {
2581840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25828675203cSHong Zhang       } else Juser = NULL;
2583e102a522SHong Zhang       if (ghost_vc || ghost) {
2584e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2585e102a522SHong Zhang       } else {
2586e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2587e102a522SHong Zhang       }
25889566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2589840c2264SHong Zhang     }
2590840c2264SHong Zhang 
259189898e50SHong Zhang     /* Set preallocation for vertex self */
25929566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2593840c2264SHong Zhang     if (!ghost) {
25949566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
25958675203cSHong Zhang       if (network->Jv) {
2596840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25978675203cSHong Zhang       } else Juser = NULL;
25989566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2599840c2264SHong Zhang     }
26001baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2601840c2264SHong Zhang   }
2602840c2264SHong Zhang 
26039566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
26049566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
26055cf7da58SHong Zhang 
26069566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
26075cf7da58SHong Zhang 
26089566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
26099566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2610840c2264SHong Zhang 
26119566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
26129566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2613840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2614e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2615e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2616840c2264SHong Zhang   }
26179566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
26189566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
26199566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
26209566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2621840c2264SHong Zhang 
26229566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
26239566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
26249566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
26255cf7da58SHong Zhang 
26269566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
26275cf7da58SHong Zhang 
262889898e50SHong Zhang   /* (2) Set matrix entries for edges */
262989898e50SHong Zhang   /*----------------------------------*/
26301ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2631bfbc38dcSHong Zhang     /* Get row indices */
26329566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
26339566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
26344b976069SHong Zhang     if (nrows) {
263517df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
26361ad426b7SHong Zhang 
2637a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
26389566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2639bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
26409566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
26419566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
26423e97b6e8SHong Zhang 
26438675203cSHong Zhang         if (network->Je) {
2644a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
26458675203cSHong Zhang         } else Juser = NULL;
26469566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2647bfbc38dcSHong Zhang       }
264817df6e9eSHong Zhang 
2649bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
26503e97b6e8SHong Zhang       cstart = rstart;
26518675203cSHong Zhang       if (network->Je) {
2652a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
26538675203cSHong Zhang       } else Juser = NULL;
26549566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
26551ad426b7SHong Zhang     }
26564b976069SHong Zhang   }
26571ad426b7SHong Zhang 
2658bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
265983b2e829SHong Zhang   /*---------------------------------*/
26601ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2661bfbc38dcSHong Zhang     /* Get row indices */
26629566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
26639566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
26644b976069SHong Zhang     if (!nrows) continue;
2665596e729fSHong Zhang 
26669566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2667bdcb62a2SHong Zhang     if (ghost) {
26689566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2669bdcb62a2SHong Zhang     } else {
2670bdcb62a2SHong Zhang       rows_v = rows;
2671bdcb62a2SHong Zhang     }
2672bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2673596e729fSHong Zhang 
2674bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
26759566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2676596e729fSHong Zhang 
2677596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2678bfbc38dcSHong Zhang       /* Supporting edges */
26799566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
26809566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2681596e729fSHong Zhang 
26828675203cSHong Zhang       if (network->Jv) {
2683a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
26848675203cSHong Zhang       } else Juser = NULL;
26859566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2686596e729fSHong Zhang 
2687bfbc38dcSHong Zhang       /* Connected vertices */
26889566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
26892a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
26902a945128SHong Zhang 
26919566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
26929566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2693a4e85ca8SHong Zhang 
26948675203cSHong Zhang       if (network->Jv) {
2695a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
26968675203cSHong Zhang       } else Juser = NULL;
26979566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2698596e729fSHong Zhang     }
2699596e729fSHong Zhang 
2700bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
27011ad426b7SHong Zhang     if (!ghost) {
27029566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
27038675203cSHong Zhang       if (network->Jv) {
2704a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
27058675203cSHong Zhang       } else Juser = NULL;
27069566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2707bdcb62a2SHong Zhang     }
27081baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
27091ad426b7SHong Zhang   }
27109566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2711bdcb62a2SHong Zhang 
27129566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
27139566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2714dd6f46cdSHong Zhang 
27159566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
27163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27175f2c45f1SShri Abhyankar }
27185f2c45f1SShri Abhyankar 
2719d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2720d71ae5a4SJacob Faibussowitsch {
2721daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2722daad07d3SAidan Hamilton   PetscInt    j, np;
2723daad07d3SAidan Hamilton 
2724daad07d3SAidan Hamilton   PetscFunctionBegin;
2725daad07d3SAidan Hamilton   if (network->header) {
2726daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2727daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2728daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2729daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2730daad07d3SAidan Hamilton     }
2731daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2732daad07d3SAidan Hamilton   }
27333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2734daad07d3SAidan Hamilton }
2735daad07d3SAidan Hamilton 
2736d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2737d71ae5a4SJacob Faibussowitsch {
27385f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2739aeb78aa7SBarry Smith   PetscInt    j;
27405f2c45f1SShri Abhyankar 
27415f2c45f1SShri Abhyankar   PetscFunctionBegin;
2742daad07d3SAidan Hamilton   /*
2743daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2744daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2745daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2746daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2747daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2748daad07d3SAidan Hamilton   */
2749daad07d3SAidan Hamilton 
2750daad07d3SAidan Hamilton   /* Always destroy data ON the network */
27519566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
275283b2e829SHong Zhang   if (network->Jv) {
27539566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
27549566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
27551ad426b7SHong Zhang   }
2756daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2757daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2758daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2759daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2760daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
276113c2a604SAdrian Maldonado 
2762daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2763daad07d3SAidan Hamilton 
2764daad07d3SAidan Hamilton   /*
2765daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2766daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2767daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2768daad07d3SAidan Hamilton     PetscSF                           sf;
2769daad07d3SAidan Hamilton   and data ON the network
2770daad07d3SAidan Hamilton     PetscSection                      DofSection;
2771daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2772daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2773daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2774daad07d3SAidan Hamilton   for any clone.
2775daad07d3SAidan Hamilton   */
27769566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
27779566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
27789566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
27799566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
278013c2a604SAdrian Maldonado   /* edge */
27819566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
27829566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
27839566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
27849566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2785daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2786daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2787daad07d3SAidan 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
2788daad07d3SAidan Hamilton      naively think it can be reused. */
2789daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2790daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2791daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2792daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2793eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(&network->cloneshared->svtable));
2794daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2795daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2796daad07d3SAidan Hamilton   }
2797daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
27983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27995f2c45f1SShri Abhyankar }
28005f2c45f1SShri Abhyankar 
2801d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2802d71ae5a4SJacob Faibussowitsch {
28035f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28045f2c45f1SShri Abhyankar 
28055f2c45f1SShri Abhyankar   PetscFunctionBegin;
28069566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
28073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28085f2c45f1SShri Abhyankar }
28095f2c45f1SShri Abhyankar 
2810d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2811d71ae5a4SJacob Faibussowitsch {
28125f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28135f2c45f1SShri Abhyankar 
28145f2c45f1SShri Abhyankar   PetscFunctionBegin;
28159566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
28163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28175f2c45f1SShri Abhyankar }
28185f2c45f1SShri Abhyankar 
2819d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2820d71ae5a4SJacob Faibussowitsch {
28215f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28225f2c45f1SShri Abhyankar 
28235f2c45f1SShri Abhyankar   PetscFunctionBegin;
28249566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
28253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28265f2c45f1SShri Abhyankar }
28275f2c45f1SShri Abhyankar 
2828d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2829d71ae5a4SJacob Faibussowitsch {
28305f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28315f2c45f1SShri Abhyankar 
28325f2c45f1SShri Abhyankar   PetscFunctionBegin;
28339566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
28343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28355f2c45f1SShri Abhyankar }
283622bbedd7SHong Zhang 
283722bbedd7SHong Zhang /*@
283864238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
283922bbedd7SHong Zhang 
284020f4b53cSBarry Smith   Not Collective
284122bbedd7SHong Zhang 
28427a7aea1fSJed Brown   Input Parameters:
284320f4b53cSBarry Smith + dm - the `DMNETWORK` object
284422bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
284522bbedd7SHong Zhang 
28462fe279fdSBarry Smith   Output Parameter:
2847f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
284822bbedd7SHong Zhang 
284997bb938eSShri Abhyankar   Level: advanced
285022bbedd7SHong Zhang 
285120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetVertexLocalToGlobalOrdering()`
285222bbedd7SHong Zhang @*/
2853d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2854d71ae5a4SJacob Faibussowitsch {
285522bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2856daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
285722bbedd7SHong Zhang 
285822bbedd7SHong Zhang   PetscFunctionBegin;
28595c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
286022bbedd7SHong Zhang   *vg = vltog[vloc];
28613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
286222bbedd7SHong Zhang }
286322bbedd7SHong Zhang 
286422bbedd7SHong Zhang /*@
286564238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
286622bbedd7SHong Zhang 
286722bbedd7SHong Zhang   Collective
286822bbedd7SHong Zhang 
286922bbedd7SHong Zhang   Input Parameters:
287020f4b53cSBarry Smith . dm - the `DMNETWORK` object
287122bbedd7SHong Zhang 
287297bb938eSShri Abhyankar   Level: advanced
287322bbedd7SHong Zhang 
287420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
287522bbedd7SHong Zhang @*/
2876d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2877d71ae5a4SJacob Faibussowitsch {
287822bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
287922bbedd7SHong Zhang   MPI_Comm           comm;
28802bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
288122bbedd7SHong Zhang   PetscBool          ghost;
288263029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
288322bbedd7SHong Zhang   const PetscSFNode *iremote;
288422bbedd7SHong Zhang   PetscSF            vsf;
288563029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
288663029d29SHong Zhang   VecScatter         ctx;
288763029d29SHong Zhang   PetscScalar       *varr, val;
288863029d29SHong Zhang   const PetscScalar *varr_read;
288922bbedd7SHong Zhang 
289022bbedd7SHong Zhang   PetscFunctionBegin;
28919566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
28929566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
28939566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
289422bbedd7SHong Zhang 
289522bbedd7SHong Zhang   if (size == 1) {
2896daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
28979566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
289822bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2899daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
29003ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
290122bbedd7SHong Zhang   }
290222bbedd7SHong Zhang 
2903daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2904daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
290522bbedd7SHong Zhang 
2906e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
29079566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
290822bbedd7SHong Zhang   vsf = network->vertex.sf;
290922bbedd7SHong Zhang 
29109566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
29119566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
291222bbedd7SHong Zhang 
29139371c9d4SSatish Balay   for (i = 0; i < size; i++) {
29149371c9d4SSatish Balay     displs[i]     = i;
29159371c9d4SSatish Balay     recvcounts[i] = 1;
29169371c9d4SSatish Balay   }
291722bbedd7SHong Zhang 
291822bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
291922bbedd7SHong Zhang   vrange[0] = 0;
29209566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
2921ad540459SPierre Jolivet   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
292222bbedd7SHong Zhang 
29239566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2924daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
292522bbedd7SHong Zhang 
292663029d29SHong Zhang   /* Set vltog for non-ghost vertices */
292763029d29SHong Zhang   k = 0;
292822bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2929daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
293063029d29SHong Zhang     if (ghost) continue;
293163029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
293222bbedd7SHong Zhang   }
29339566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
293463029d29SHong Zhang 
293563029d29SHong Zhang   /* Set vltog for ghost vertices */
293663029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
29379566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
29389566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
29399566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
29409566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
294163029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
294263029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
294363029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
294463029d29SHong Zhang   }
29459566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
294663029d29SHong Zhang 
294763029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
29489566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
29499566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
29509566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
295163029d29SHong Zhang 
295263029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
29539566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
29549566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
295563029d29SHong Zhang   for (i = 0; i < N; i += 2) {
29562e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
295763029d29SHong Zhang     if (remoterank == rank) {
295863029d29SHong Zhang       k    = i + 1; /* row number */
29592e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
296063029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
29619566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
296263029d29SHong Zhang     }
296363029d29SHong Zhang   }
29649566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
29659566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
29669566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
296763029d29SHong Zhang 
296863029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
29699566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
297063029d29SHong Zhang   k = 0;
297163029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2972daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
297363029d29SHong Zhang     if (!ghost) continue;
29749371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
29759371c9d4SSatish Balay     k++;
297663029d29SHong Zhang   }
29779566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
297863029d29SHong Zhang 
29799566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
29809566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
29819566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
29823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
298322bbedd7SHong Zhang }
298442dc13f1SHong Zhang 
2985d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2986d71ae5a4SJacob Faibussowitsch {
298742dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
298842dc13f1SHong Zhang   DMNetworkComponentHeader header;
298942dc13f1SHong Zhang 
299042dc13f1SHong Zhang   PetscFunctionBegin;
29919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
299242dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
299342dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
299442dc13f1SHong Zhang 
299542dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
299642dc13f1SHong Zhang     key  = header->key[i];
299742dc13f1SHong Zhang     nvar = header->nvar[i];
299842dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
299942dc13f1SHong Zhang       if (key == keys[j]) {
300042dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
300142dc13f1SHong Zhang           *nidx += nvar;
300242dc13f1SHong Zhang         } else {
300342dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
300442dc13f1SHong Zhang         }
300542dc13f1SHong Zhang       }
300642dc13f1SHong Zhang     }
300742dc13f1SHong Zhang   }
30083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
300942dc13f1SHong Zhang }
301042dc13f1SHong Zhang 
3011d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3012d71ae5a4SJacob Faibussowitsch {
301342dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
301442dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
301542dc13f1SHong Zhang   DMNetworkComponentHeader header;
301642dc13f1SHong Zhang 
301742dc13f1SHong Zhang   PetscFunctionBegin;
30189566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
301942dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
302042dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
302142dc13f1SHong Zhang 
302242dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
302342dc13f1SHong Zhang     key  = header->key[i];
302442dc13f1SHong Zhang     nvar = header->nvar[i];
302542dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
302642dc13f1SHong Zhang       if (key != keys[j]) continue;
302742dc13f1SHong Zhang 
30289566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
302942dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
303042dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
303142dc13f1SHong Zhang       } else {
303242dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
303342dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
303442dc13f1SHong Zhang         }
303542dc13f1SHong Zhang       }
303642dc13f1SHong Zhang     }
303742dc13f1SHong Zhang   }
30383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
303942dc13f1SHong Zhang }
304042dc13f1SHong Zhang 
304142dc13f1SHong Zhang /*@
304242dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
304342dc13f1SHong Zhang 
304442dc13f1SHong Zhang   Collective
304542dc13f1SHong Zhang 
304642dc13f1SHong Zhang   Input Parameters:
304720f4b53cSBarry Smith + dm - `DMNETWORK` object
304842dc13f1SHong Zhang . numkeys - number of keys
304942dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
305042dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
305142dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
305242dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
305342dc13f1SHong Zhang 
30542fe279fdSBarry Smith   Output Parameter:
305542dc13f1SHong Zhang . is - the index set
305642dc13f1SHong Zhang 
305720f4b53cSBarry Smith   Level: advanced
305842dc13f1SHong Zhang 
305942dc13f1SHong Zhang   Notes:
306020f4b53cSBarry 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.
306142dc13f1SHong Zhang 
306220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
306342dc13f1SHong Zhang @*/
3064d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3065d71ae5a4SJacob Faibussowitsch {
306642dc13f1SHong Zhang   MPI_Comm    comm;
306742dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
306842dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
306942dc13f1SHong Zhang   PetscBool   ghost;
307042dc13f1SHong Zhang 
307142dc13f1SHong Zhang   PetscFunctionBegin;
30729566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
307342dc13f1SHong Zhang 
307442dc13f1SHong Zhang   /* Check input parameters */
307542dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
307642dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
307763a3b9bcSJacob 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]);
307842dc13f1SHong Zhang   }
307942dc13f1SHong Zhang 
30809566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
30819566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
308242dc13f1SHong Zhang 
308342dc13f1SHong Zhang   /* Get local number of idx */
308442dc13f1SHong Zhang   nidx = 0;
308548a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
308642dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30879566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
308842dc13f1SHong Zhang     if (ghost) continue;
30899566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
309042dc13f1SHong Zhang   }
309142dc13f1SHong Zhang 
309242dc13f1SHong Zhang   /* Compute idx */
30939566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
309442dc13f1SHong Zhang   i = 0;
309548a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
309642dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30979566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
309842dc13f1SHong Zhang     if (ghost) continue;
30999566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
310042dc13f1SHong Zhang   }
310142dc13f1SHong Zhang 
310242dc13f1SHong Zhang   /* Create is */
31039566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
31049566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
310642dc13f1SHong Zhang }
310742dc13f1SHong Zhang 
3108d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3109d71ae5a4SJacob Faibussowitsch {
311042dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
311142dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
311242dc13f1SHong Zhang   DMNetworkComponentHeader header;
311342dc13f1SHong Zhang 
311442dc13f1SHong Zhang   PetscFunctionBegin;
31159566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
311642dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
311742dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
311842dc13f1SHong Zhang 
311942dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
312042dc13f1SHong Zhang     key  = header->key[i];
312142dc13f1SHong Zhang     nvar = header->nvar[i];
312242dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
312342dc13f1SHong Zhang       if (key != keys[j]) continue;
312442dc13f1SHong Zhang 
31259566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
312642dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
312742dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
312842dc13f1SHong Zhang       } else {
312942dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
313042dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
313142dc13f1SHong Zhang         }
313242dc13f1SHong Zhang       }
313342dc13f1SHong Zhang     }
313442dc13f1SHong Zhang   }
31353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
313642dc13f1SHong Zhang }
313742dc13f1SHong Zhang 
313842dc13f1SHong Zhang /*@
313942dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
314042dc13f1SHong Zhang 
314120f4b53cSBarry Smith   Not Collective
314242dc13f1SHong Zhang 
314342dc13f1SHong Zhang   Input Parameters:
314420f4b53cSBarry Smith + dm - `DMNETWORK` object
314542dc13f1SHong Zhang . numkeys - number of keys
314642dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
314742dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
314842dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
314942dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
315042dc13f1SHong Zhang 
31512fe279fdSBarry Smith   Output Parameter:
315242dc13f1SHong Zhang . is - the index set
315342dc13f1SHong Zhang 
315420f4b53cSBarry Smith   Level: advanced
315542dc13f1SHong Zhang 
315642dc13f1SHong Zhang   Notes:
315720f4b53cSBarry 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.
315842dc13f1SHong Zhang 
315920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkCreateIS`, `ISCreateGeneral()`
316042dc13f1SHong Zhang @*/
3161d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3162d71ae5a4SJacob Faibussowitsch {
316342dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
316442dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
316542dc13f1SHong Zhang 
316642dc13f1SHong Zhang   PetscFunctionBegin;
316742dc13f1SHong Zhang   /* Check input parameters */
316842dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
316942dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
317063a3b9bcSJacob 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]);
317142dc13f1SHong Zhang   }
317242dc13f1SHong Zhang 
3173daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3174daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
317542dc13f1SHong Zhang 
317642dc13f1SHong Zhang   /* Get local number of idx */
317742dc13f1SHong Zhang   nidx = 0;
317848a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
317942dc13f1SHong Zhang 
318042dc13f1SHong Zhang   /* Compute local idx */
31819566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
318242dc13f1SHong Zhang   i = 0;
318348a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
318442dc13f1SHong Zhang 
318542dc13f1SHong Zhang   /* Create is */
31869566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31879566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
318942dc13f1SHong Zhang }
3190daad07d3SAidan Hamilton /*@
3191d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3192daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3193daad07d3SAidan Hamilton 
3194daad07d3SAidan Hamilton   Collective
3195daad07d3SAidan Hamilton 
31962fe279fdSBarry Smith   Input Parameter:
319720f4b53cSBarry Smith . dm - the `DMNETWORK` object
3198daad07d3SAidan Hamilton 
3199daad07d3SAidan Hamilton   Level: beginner
3200daad07d3SAidan Hamilton 
320120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3202daad07d3SAidan Hamilton @*/
3203d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3204d71ae5a4SJacob Faibussowitsch {
3205daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3206daad07d3SAidan Hamilton 
3207daad07d3SAidan Hamilton   PetscFunctionBegin;
32083ba16761SJacob Faibussowitsch   if (network->componentsetup) PetscFunctionReturn(PETSC_SUCCESS);
3209daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3210daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3211daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3212daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3213daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
32143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3215daad07d3SAidan Hamilton }
3216