xref: /petsc/src/dm/impls/network/network.c (revision b44f4de476a10dd52a698c0f9a8f47d015bd1e19)
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);
21dd5bbc93SStefano Zampini #if defined(__NEC__)
22dd5bbc93SStefano Zampini   /* NEC/LG: quick hack to keep data aligned on 8 bytes. */
23dd5bbc93SStefano Zampini   header->hsize = (header->hsize + (8 - 1)) & ~(8 - 1);
24dd5bbc93SStefano 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     }
403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
41daad07d3SAidan Hamilton }
425f25b224SDuncan Campbell 
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 /*@
6815229ffcSPierre Jolivet   DMNetworkGetNumSubNetworks - Gets 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:
76ce78bad3SBarry Smith + nsubnet - local number of subnetworks, pass `NULL` if not needed
77ce78bad3SBarry Smith - Nsubnet - global number of subnetworks, pass `NULL` if not needed
7872c3e9f7SHong Zhang 
7997bb938eSShri Abhyankar   Level: beginner
8072c3e9f7SHong Zhang 
8120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
8272c3e9f7SHong Zhang @*/
83ce78bad3SBarry Smith PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PeOp PetscInt *nsubnet, PeOp 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);
120462c564dSBarry Smith     PetscCallMPI(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 
1345d83a8b1SBarry Smith /*@
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
144*b44f4de4SBarry Smith               of the vertices) of each edge: [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc.]
1452bf73ac6SHong Zhang 
1462fe279fdSBarry Smith   Output Parameter:
1472bf73ac6SHong Zhang . netnum - global index of the subnetwork
1485f2c45f1SShri Abhyankar 
14920f4b53cSBarry Smith   Level: beginner
15020f4b53cSBarry Smith 
1515f2c45f1SShri Abhyankar   Notes:
152f13dfd9eSBarry Smith   There is no copy involved in this operation, only the pointer is referenced. The `edgelist` should
15320f4b53cSBarry Smith   not be destroyed before the call to `DMNetworkLayoutSetUp()`
1545f2c45f1SShri Abhyankar 
15520f4b53cSBarry 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.
15620f4b53cSBarry Smith   For a multiple subnetworks,
157f13dfd9eSBarry Smith   each subnetwork topology needs to be set on a unique MPI process and the communicator size needs to be at least equal to the number of subnetworks.
158f11a936eSBarry Smith 
159e3e68989SHong Zhang   Example usage:
160a4e35b19SJacob Faibussowitsch   Consider the following networks\:
161a4e35b19SJacob Faibussowitsch   1) A single subnetwork\:
162e3e68989SHong Zhang .vb
163f11a936eSBarry Smith  network 0:
164f11a936eSBarry Smith  rank[0]:
165f11a936eSBarry Smith    v0 --> v2; v1 --> v2
166f11a936eSBarry Smith  rank[1]:
167f11a936eSBarry Smith    v3 --> v5; v4 --> v5
168e3e68989SHong Zhang .ve
169e3e68989SHong Zhang 
17060225df5SJacob Faibussowitsch   The resulting input network 0\:
17160225df5SJacob Faibussowitsch .vb
172f11a936eSBarry Smith   rank[0]:
173f11a936eSBarry Smith   ne = 2
174f11a936eSBarry Smith   edgelist = [0 2 | 1 2]
17560225df5SJacob Faibussowitsch 
176f11a936eSBarry Smith   rank[1]:
177f11a936eSBarry Smith   ne = 2
178f11a936eSBarry Smith   edgelist = [3 5 | 4 5]
17960225df5SJacob Faibussowitsch .ve
18060225df5SJacob Faibussowitsch   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 
19060225df5SJacob Faibussowitsch   The resulting input subnetwork 0\:
19160225df5SJacob Faibussowitsch .vb
192f11a936eSBarry Smith   rank[0]:
193f11a936eSBarry Smith   ne = 3
194f11a936eSBarry Smith   edgelist = [0 2 | 2 1 | 1 3]
19560225df5SJacob Faibussowitsch 
196f11a936eSBarry Smith   rank[1]:
197f11a936eSBarry Smith   ne = 0
198f11a936eSBarry Smith   edgelist = NULL
19960225df5SJacob Faibussowitsch .ve
20060225df5SJacob Faibussowitsch   subnetwork 1\:
20160225df5SJacob Faibussowitsch .vb
202f11a936eSBarry Smith   rank[0]:
203f11a936eSBarry Smith   ne = 0
204f11a936eSBarry Smith   edgelist = NULL
20560225df5SJacob Faibussowitsch 
206f11a936eSBarry Smith   rank[1]:
207f11a936eSBarry Smith   edgelist = [0 3 | 3 2 | 2 1]
20860225df5SJacob Faibussowitsch .ve
209e3e68989SHong Zhang 
21020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
2115f2c45f1SShri Abhyankar @*/
212d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum)
213d71ae5a4SJacob Faibussowitsch {
2145f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2155c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
216f11a936eSBarry Smith   PetscBT     table;
2175f2c45f1SShri Abhyankar 
2185f2c45f1SShri Abhyankar   PetscFunctionBegin;
219ad540459SPierre 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]);
220f11a936eSBarry Smith 
2215c6496baSHong Zhang   i = 0;
2225c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2235c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2245c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2255c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2265c6496baSHong Zhang     i++;
2275c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2285c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2295c6496baSHong Zhang     i++;
2305c6496baSHong Zhang   }
2315c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2325c6496baSHong Zhang 
2335c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2349566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2359566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
236f11a936eSBarry Smith   i = 0;
237f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2389566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2399566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
240f11a936eSBarry Smith   }
241f11a936eSBarry Smith   nvtx = 0;
242f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
243f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
244f11a936eSBarry Smith   }
2455c6496baSHong Zhang 
2465c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
247462c564dSBarry Smith   PetscCallMPI(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2485c6496baSHong Zhang   Nvtx++;
2499566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
250f11a936eSBarry Smith 
251f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
252462c564dSBarry Smith   PetscCallMPI(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
253f11a936eSBarry Smith 
254daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
255c6a7a370SJeremy L Thompson   if (name) PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
256daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
257daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
258daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
259daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
260daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2612bf73ac6SHong Zhang 
2622bf73ac6SHong Zhang   /* ----------------------------------------------------------
2632bf73ac6SHong Zhang    p=v or e;
2642bf73ac6SHong Zhang    subnet[0].pStart   = 0
2652bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2662bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2672bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
268daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
269daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2702bf73ac6SHong Zhang 
271daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
272daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2732bf73ac6SHong Zhang 
2742bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
275daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
276daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
277daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
278daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2792bf73ac6SHong Zhang 
280c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
281daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
282daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2842bf73ac6SHong Zhang }
2852bf73ac6SHong Zhang 
2865c6496baSHong Zhang /*@C
2875c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2882bf73ac6SHong Zhang 
28920f4b53cSBarry Smith   Not Collective
2905c6496baSHong Zhang 
2915c6496baSHong Zhang   Input Parameters:
29220f4b53cSBarry Smith + dm - the `DM` object
2935c6496baSHong Zhang - v  - vertex point
2945c6496baSHong Zhang 
2955c6496baSHong Zhang   Output Parameters:
296ce78bad3SBarry Smith + gidx - global number of this shared vertex in the internal dmplex, pass `NULL` if not needed
297ce78bad3SBarry Smith . n    - number of subnetworks that share this vertex, pass `NULL` if not needed
298ce78bad3SBarry Smith - sv   - array of size `n`: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1, pass `NULL` if not needed
2995c6496baSHong Zhang 
3005c6496baSHong Zhang   Level: intermediate
3015c6496baSHong Zhang 
30220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSharedVertices()`
3035c6496baSHong Zhang @*/
304ce78bad3SBarry Smith PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PeOp PetscInt *gidx, PeOp PetscInt *n, const PeOp PetscInt *sv[])
305d71ae5a4SJacob Faibussowitsch {
3065c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
307daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
3085c6496baSHong Zhang   PetscInt    i, gidx_tmp;
3095c6496baSHong Zhang 
3105c6496baSHong Zhang   PetscFunctionBegin;
3119566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
312eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, gidx_tmp + 1, 0, &i));
3135c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
3145c6496baSHong Zhang 
3155c6496baSHong Zhang   i--;
3165c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3175c6496baSHong Zhang   if (n) *n = svtx[i].n;
3185c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3205c6496baSHong Zhang }
3215c6496baSHong Zhang 
3225c6496baSHong Zhang /*
3235c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3245c6496baSHong Zhang 
3255c6496baSHong Zhang   Input Parameters:
3265c6496baSHong Zhang + Nsvtx - global num of shared vertices
3275c6496baSHong Zhang . svtx - array of shared vertices (global)
3285c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3295c6496baSHong Zhang 
3305c6496baSHong Zhang   Output Parameters:
3315c6496baSHong Zhang + gidx - global index of (net,idx)
3325c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3335c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3345c6496baSHong Zhang */
335d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx)
336d71ae5a4SJacob Faibussowitsch {
3375c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3382bf73ac6SHong Zhang   SVtxType vtype;
3392bf73ac6SHong Zhang 
3402bf73ac6SHong Zhang   PetscFunctionBegin;
3413ba16761SJacob Faibussowitsch   if (!Nsvtx) PetscFunctionReturn(PETSC_SUCCESS);
3422bf73ac6SHong Zhang 
3435c6496baSHong Zhang   g_idx = -1;
3442bf73ac6SHong Zhang   vtype = SVNONE;
3455c6496baSHong Zhang 
3462bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3472bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3485c6496baSHong Zhang       g_idx = svtx[i].gidx;
3492bf73ac6SHong Zhang       vtype = SVFROM;
3502bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3512bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3522bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3532bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3542bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3555c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3562bf73ac6SHong Zhang           vtype = SVTO;
3572bf73ac6SHong Zhang         }
3582bf73ac6SHong Zhang       }
3592bf73ac6SHong Zhang     }
3602bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3612bf73ac6SHong Zhang   }
3625c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3632bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3642bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3662bf73ac6SHong Zhang }
3672bf73ac6SHong Zhang 
3682bf73ac6SHong Zhang /*
3695c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3705c6496baSHong Zhang 
3715c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3725c6496baSHong Zhang   Output: svta, tdata, ta2sv
3732bf73ac6SHong Zhang */
374eec179cfSJacob Faibussowitsch static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscHMapI svta, PetscInt *tdata, PetscInt *ta2sv)
375d71ae5a4SJacob Faibussowitsch {
3765c6496baSHong Zhang   PetscInt net, idx, gidx;
3772bf73ac6SHong Zhang 
3782bf73ac6SHong Zhang   PetscFunctionBegin;
3795c6496baSHong Zhang   net  = sedgelist[k];
3805c6496baSHong Zhang   idx  = sedgelist[k + 1];
381daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
382c76ffc5fSJacob Faibussowitsch   PetscCall(PetscHMapISet(svta, gidx + 1, *tdata + 1));
3835c6496baSHong Zhang 
3845c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3855c6496baSHong Zhang   (*tdata)++;
3863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3872bf73ac6SHong Zhang }
3882bf73ac6SHong Zhang 
3892bf73ac6SHong Zhang /*
3905c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3912bf73ac6SHong Zhang 
3922bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3932bf73ac6SHong Zhang 
3942bf73ac6SHong Zhang   Note: Output svtx is organized as
3952bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3962bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3972bf73ac6SHong Zhang                           ...
3982bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3992bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
4002bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
4012bf73ac6SHong Zhang  */
402d71ae5a4SJacob Faibussowitsch static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist)
403d71ae5a4SJacob Faibussowitsch {
4045c6496baSHong Zhang   SVtx         *svtx = NULL;
4052bf73ac6SHong Zhang   PetscInt     *sv, k, j, nsv, *tdata, **ta2sv;
406eec179cfSJacob Faibussowitsch   PetscHMapI   *svtas;
4077340ca2cSHong Zhang   PetscInt      gidx, net, idx, i, nta, ita, idx_from, idx_to, n, *net_tmp, *idx_tmp, *gidx_tmp;
4082bf73ac6SHong Zhang   DM_Network   *network = (DM_Network *)dm->data;
409eec179cfSJacob Faibussowitsch   PetscHashIter ppos;
4102bf73ac6SHong Zhang 
4112bf73ac6SHong Zhang   PetscFunctionBegin;
4125c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
4139566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
4142bf73ac6SHong Zhang 
4152bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
4167340ca2cSHong Zhang   nta = 0; /* num of svta tables created = num of groups of shared vertices */
4172bf73ac6SHong Zhang 
4182bf73ac6SHong Zhang   /* for j=0 */
419eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4209566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4212bf73ac6SHong Zhang 
4229566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4239566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4249371c9d4SSatish Balay   nta++;
4259371c9d4SSatish Balay   k += 4;
4262bf73ac6SHong Zhang 
4275c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4282bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4292bf73ac6SHong Zhang       /* vfrom */
4309371c9d4SSatish Balay       net  = sedgelist[k];
4319371c9d4SSatish Balay       idx  = sedgelist[k + 1];
432daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
433eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_from));
4342bf73ac6SHong Zhang 
4352bf73ac6SHong Zhang       /* vto */
4369371c9d4SSatish Balay       net  = sedgelist[k + 2];
4379371c9d4SSatish Balay       idx  = sedgelist[k + 3];
438daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
439eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_to));
4402bf73ac6SHong Zhang 
4412bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4429371c9d4SSatish Balay         idx_from--;
4439371c9d4SSatish Balay         idx_to--;
4442bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4459566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4462bf73ac6SHong Zhang           break;
4472bf73ac6SHong Zhang         } else if (idx_to < 0) {
4489566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4492bf73ac6SHong Zhang           break;
4502bf73ac6SHong Zhang         }
4512bf73ac6SHong Zhang       }
4522bf73ac6SHong Zhang     }
4532bf73ac6SHong Zhang 
4542bf73ac6SHong Zhang     if (ita == nta) {
455eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4569566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4572bf73ac6SHong Zhang 
4589566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4599566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4602bf73ac6SHong Zhang       nta++;
4612bf73ac6SHong Zhang     }
4622bf73ac6SHong Zhang     k += 4;
4632bf73ac6SHong Zhang   }
4642bf73ac6SHong Zhang 
4656aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
466eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(nta, &network->cloneshared->svtable));
4675c6496baSHong Zhang 
4685c6496baSHong Zhang   /* (3) Construct svtx from svtas
4697340ca2cSHong Zhang    svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1. */
4709566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4712bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4724f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
473eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetSize(svtas[nsv], &n));
4749566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4757340ca2cSHong Zhang     PetscCall(PetscMalloc3(n, &gidx_tmp, n, &net_tmp, n, &idx_tmp));
4765c6496baSHong Zhang     svtx[nsv].sv   = sv;
4775c6496baSHong Zhang     svtx[nsv].n    = n;
478daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4792bf73ac6SHong Zhang 
480eec179cfSJacob Faibussowitsch     PetscHashIterBegin(svtas[nsv], ppos);
4814f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
482eec179cfSJacob Faibussowitsch       PetscHashIterGetKey(svtas[nsv], ppos, gidx);
483eec179cfSJacob Faibussowitsch       PetscHashIterGetVal(svtas[nsv], ppos, i);
484eec179cfSJacob Faibussowitsch       PetscHashIterNext(svtas[nsv], ppos);
4859371c9d4SSatish Balay       gidx--;
4869371c9d4SSatish Balay       i--;
4875c6496baSHong Zhang       j           = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4887340ca2cSHong Zhang       net_tmp[k]  = sedgelist[j];     /* subnet number */
4897340ca2cSHong Zhang       idx_tmp[k]  = sedgelist[j + 1]; /* index on the subnet */
4907340ca2cSHong Zhang       gidx_tmp[k] = gidx;             /* gidx in un-merged dmnetwork */
4912bf73ac6SHong Zhang     }
4925c6496baSHong Zhang 
4937340ca2cSHong Zhang     /* current implementation requires sv[]=[net,idx] in ascending order of its gidx in un-merged dmnetwork */
4947340ca2cSHong Zhang     PetscCall(PetscSortIntWithArrayPair(n, gidx_tmp, net_tmp, idx_tmp));
4957340ca2cSHong Zhang     svtx[nsv].gidx = gidx_tmp[0]; /* = min(gidx) */
4967340ca2cSHong Zhang     for (k = 0; k < n; k++) {
4977340ca2cSHong Zhang       sv[2 * k]     = net_tmp[k];
4987340ca2cSHong Zhang       sv[2 * k + 1] = idx_tmp[k];
4997340ca2cSHong Zhang     }
5007340ca2cSHong Zhang     PetscCall(PetscFree3(gidx_tmp, net_tmp, idx_tmp));
5017340ca2cSHong Zhang 
5026aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
503c76ffc5fSJacob Faibussowitsch     PetscCall(PetscHMapISet(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1));
5042bf73ac6SHong Zhang   }
5052bf73ac6SHong Zhang 
5062bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
507eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(svtas + j));
5089566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
5092bf73ac6SHong Zhang   }
5109566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
5112bf73ac6SHong Zhang 
512daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
513daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
5143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5152bf73ac6SHong Zhang }
5162bf73ac6SHong Zhang 
5175c6496baSHong Zhang /*
5185c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
5195c6496baSHong Zhang 
5205c6496baSHong Zhang   Input Parameters:
5215c6496baSHong Zhang . dm - the dmnetwork object
5225c6496baSHong Zhang 
5235c6496baSHong Zhang    Output Parameters:
5245c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
5255c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
5265c6496baSHong Zhang */
527d71ae5a4SJacob Faibussowitsch static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr)
528d71ae5a4SJacob Faibussowitsch {
5292bf73ac6SHong Zhang   MPI_Comm    comm;
5305c795782SAidan Hamilton   PetscMPIInt size, rank;
531eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
532eac198afSGetnet   PetscInt    i, j, ctr, np;
533daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
5345c795782SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist, vrange;
5355c795782SAidan Hamilton   PetscInt    net, idx, gidx, nmerged, gidx_from, net_from, sv_idx;
5362bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5375c6496baSHong Zhang   SVtx       *svtx;
5382bf73ac6SHong Zhang 
5392bf73ac6SHong Zhang   PetscFunctionBegin;
5409566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5419566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5429566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5432bf73ac6SHong Zhang 
5445c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5455c6496baSHong Zhang   /* --------------------------------------- */
546daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
547daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
548daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5492bf73ac6SHong Zhang 
550d5b43468SJose E. Roman   /* (2) Merge shared vto vertices to their vfrom vertex with same global vertex index (gidx) */
5515c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5522bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
5535c795782SAidan Hamilton   PetscCall(PetscMalloc1(network->cloneshared->nVertices, &vidxlTog));
5542bf73ac6SHong Zhang 
5555c795782SAidan Hamilton   PetscCallMPI(MPI_Scan(&network->cloneshared->nVertices, &vrange, 1, MPIU_INT, MPI_SUM, comm));
5565c795782SAidan Hamilton   vrange -= network->cloneshared->nVertices;
5572bf73ac6SHong Zhang 
5582bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5599371c9d4SSatish Balay   i                           = 0;
5609371c9d4SSatish Balay   gidx                        = 0;
5612bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
562daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5632bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
564daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5659566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5662bf73ac6SHong Zhang       if (svtype == SVTO) {
567daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5685c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
569daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5705c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
571daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5722bf73ac6SHong Zhang           }
5735c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5745c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5752bf73ac6SHong Zhang         }
5762bf73ac6SHong Zhang       } else {
577daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5785c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
579daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5802bf73ac6SHong Zhang         }
581daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5822bf73ac6SHong Zhang         gidx++;
5832bf73ac6SHong Zhang       }
5842bf73ac6SHong Zhang     }
5852bf73ac6SHong Zhang   }
586b498ca8aSPierre Jolivet   PetscAssert(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5872bf73ac6SHong Zhang 
5885c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
589462c564dSBarry Smith   PetscCallMPI(MPIU_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
590daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5912bf73ac6SHong Zhang 
5922bf73ac6SHong Zhang   ctr = 0;
5932bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
594daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5952bf73ac6SHong Zhang       /* vfrom: */
5965c795782SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange);
5972bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5982bf73ac6SHong Zhang 
5992bf73ac6SHong Zhang       /* vto */
6005c795782SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange);
6012bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
6022bf73ac6SHong Zhang       ctr++;
6032bf73ac6SHong Zhang     }
6042bf73ac6SHong Zhang   }
6055c795782SAidan Hamilton   PetscCall(PetscFree(vidxlTog));
6069566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
6072bf73ac6SHong Zhang 
608eac198afSGetnet   *nmerged_ptr = nmerged;
6093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6105f2c45f1SShri Abhyankar }
6115f2c45f1SShri Abhyankar 
612d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
613d71ae5a4SJacob Faibussowitsch {
614daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
615daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
616daad07d3SAidan Hamilton   MPI_Comm    comm;
617daad07d3SAidan Hamilton 
618daad07d3SAidan Hamilton   PetscFunctionBegin;
619daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
620daad07d3SAidan Hamilton 
621daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
622daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
623daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
624daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
625daad07d3SAidan Hamilton 
626daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
627daad07d3SAidan Hamilton 
628daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
629daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
630daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
631daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
632daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
633daad07d3SAidan Hamilton   }
6343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
635daad07d3SAidan Hamilton }
636daad07d3SAidan Hamilton 
6375f2c45f1SShri Abhyankar /*@
6385f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6395f2c45f1SShri Abhyankar 
640eac198afSGetnet   Not Collective
6415f2c45f1SShri Abhyankar 
6422fe279fdSBarry Smith   Input Parameter:
64320f4b53cSBarry Smith . dm - the `DMNETWORK` object
64420f4b53cSBarry Smith 
64520f4b53cSBarry Smith   Level: beginner
6465f2c45f1SShri Abhyankar 
6475f2c45f1SShri Abhyankar   Notes:
6485f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6495f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6505f2c45f1SShri Abhyankar 
6515f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6525f2c45f1SShri Abhyankar 
65320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6545f2c45f1SShri Abhyankar @*/
655d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
656d71ae5a4SJacob Faibussowitsch {
6575f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
658daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
659caf410d2SHong Zhang   const PetscInt *cone;
660caf410d2SHong Zhang   MPI_Comm        comm;
6615503a911SAidan Hamilton   PetscMPIInt     size;
662eac198afSGetnet   PetscSection    sectiong;
6635c6496baSHong Zhang   PetscInt        nmerged = 0;
6646500d4abSHong Zhang 
6656500d4abSHong Zhang   PetscFunctionBegin;
666e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
667daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6682bf73ac6SHong Zhang 
669eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
670eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6719371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6729371c9d4SSatish 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,
6739371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
674eac198afSGetnet   }
675eac198afSGetnet 
6769566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6773ba16761SJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6786500d4abSHong Zhang 
679f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
680daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
681eac198afSGetnet 
682daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6839566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
684eac198afSGetnet   } else { /* subnetworks are not coupled */
6856aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
686eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapICreate(&network->cloneshared->svtable));
687caf410d2SHong Zhang     ctr = 0;
6882bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
689daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
690daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
691daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6926500d4abSHong Zhang         ctr++;
6936500d4abSHong Zhang       }
6946500d4abSHong Zhang     }
695eac198afSGetnet   }
6967765340cSHong Zhang 
6972bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6989566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
6999566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
7009566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
701eac198afSGetnet 
702daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
703daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
7046500d4abSHong Zhang 
705daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
706daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
707daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
708daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
7099566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
710caf410d2SHong Zhang 
711f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
712f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
713f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
714f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
715f11a936eSBarry Smith   */
716daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
717daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
718daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7195c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
720daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
7218e3a54c0SPierre Jolivet     subnetedge                            = PetscSafePointerPlusOffset(subnetedge, network->cloneshared->subnet[j].nedge);
722f11a936eSBarry Smith 
723daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
7248e3a54c0SPierre Jolivet     subnetvtx                                = PetscSafePointerPlusOffset(subnetvtx, network->cloneshared->subnet[j].nvtx);
7256500d4abSHong Zhang   }
726daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
727caf410d2SHong Zhang 
728caf410d2SHong Zhang   /* Get edge ownership */
729daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7305503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7315503a911SAidan Hamilton   globaledgeoff -= np;
732caf410d2SHong Zhang 
733eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7342bf73ac6SHong Zhang   e = 0;
7352bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
736f11a936eSBarry Smith     ctr = 0;
737daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7382bf73ac6SHong Zhang       /* edge e */
7395503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7402bf73ac6SHong Zhang       network->header[e].subnetid              = i;
741daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7422bf73ac6SHong Zhang 
7432bf73ac6SHong Zhang       /* connected vertices */
7449566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7452bf73ac6SHong Zhang 
7462bf73ac6SHong Zhang       /* vertex cone[0] */
747f11a936eSBarry Smith       v                           = cone[0];
748f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
749f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
750f11a936eSBarry Smith       if (Nsubnet == 1) {
751daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
752f11a936eSBarry Smith       } else {
753daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
754daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
755f11a936eSBarry Smith       }
7562bf73ac6SHong Zhang 
7572bf73ac6SHong Zhang       /* vertex cone[1] */
758f11a936eSBarry Smith       v                           = cone[1];
759f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
760f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
761f11a936eSBarry Smith       if (Nsubnet == 1) {
762daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
763f11a936eSBarry Smith       } else {
764daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
765daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
766f11a936eSBarry Smith       }
7672bf73ac6SHong Zhang 
7689371c9d4SSatish Balay       e++;
7699371c9d4SSatish Balay       ctr++;
7706500d4abSHong Zhang     }
7716500d4abSHong Zhang   }
7725503a911SAidan Hamilton   PetscCall(PetscFree(edges));
773caf410d2SHong Zhang 
774eac198afSGetnet   /* Set local vertex array for the subnetworks */
775eac198afSGetnet   j = 0;
776daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
777eac198afSGetnet     /* local shared vertex */
778eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, network->header[v].index + 1, 0, &i));
779daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7806500d4abSHong Zhang   }
781eac198afSGetnet 
782eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
783eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7849566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
785daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
786daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
787e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7895f2c45f1SShri Abhyankar }
7905f2c45f1SShri Abhyankar 
79194ef8ddeSSatish Balay /*@C
7922bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7932bf73ac6SHong Zhang 
79420f4b53cSBarry Smith   Not Collective
7952727e31bSShri Abhyankar 
7967a7aea1fSJed Brown   Input Parameters:
79720f4b53cSBarry Smith + dm     - the `DMNETWORK` object
7982bf73ac6SHong Zhang - netnum - the global index of the subnetwork
7992727e31bSShri Abhyankar 
8007a7aea1fSJed Brown   Output Parameters:
8012727e31bSShri Abhyankar + nv   - number of vertices (local)
8022727e31bSShri Abhyankar . ne   - number of edges (local)
8032bf73ac6SHong Zhang . vtx  - local vertices of the subnetwork
8042bf73ac6SHong Zhang - edge - local edges of the subnetwork
8052727e31bSShri Abhyankar 
80606dd6b0eSSatish Balay   Level: intermediate
80706dd6b0eSSatish Balay 
80820f4b53cSBarry Smith   Notes:
809ce78bad3SBarry Smith   Pass `NULL` for any output argument that is not needed.
810ce78bad3SBarry Smith 
81120f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
81220f4b53cSBarry Smith 
81320f4b53cSBarry Smith   The local vertices returned on each rank are determined by `DMNETWORK`. The user does not have any control over what vertices are local.
81420f4b53cSBarry Smith 
81520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8162727e31bSShri Abhyankar @*/
817ce78bad3SBarry Smith PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PeOp PetscInt *nv, PeOp PetscInt *ne, PeOp const PetscInt *vtx[], PeOp const PetscInt *edge[])
818d71ae5a4SJacob Faibussowitsch {
819caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8202727e31bSShri Abhyankar 
8212727e31bSShri Abhyankar   PetscFunctionBegin;
822daad07d3SAidan 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);
823daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
824daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
825daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
826daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8282bf73ac6SHong Zhang }
8292bf73ac6SHong Zhang 
8302bf73ac6SHong Zhang /*@
8312bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8322bf73ac6SHong Zhang 
83320f4b53cSBarry Smith   Collective
8342bf73ac6SHong Zhang 
8352bf73ac6SHong Zhang   Input Parameters:
83620f4b53cSBarry Smith + dm      - the `DMNETWORK` object
83720f4b53cSBarry Smith . anetnum - first subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
83820f4b53cSBarry Smith . bnetnum - second subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
8392bf73ac6SHong Zhang . nsvtx   - number of vertices that are shared by the two subnetworks
8402bf73ac6SHong Zhang . asvtx   - vertex index in the first subnetwork
8412bf73ac6SHong Zhang - bsvtx   - vertex index in the second subnetwork
8422bf73ac6SHong Zhang 
8432bf73ac6SHong Zhang   Level: beginner
8442bf73ac6SHong Zhang 
84520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8462bf73ac6SHong Zhang @*/
847d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
848d71ae5a4SJacob Faibussowitsch {
8492bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
850daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8512bf73ac6SHong Zhang 
8522bf73ac6SHong Zhang   PetscFunctionBegin;
8535c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8545c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8552bf73ac6SHong Zhang   if (!Nsvtx) {
8562bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
857daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8582bf73ac6SHong Zhang   }
8592bf73ac6SHong Zhang 
860daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8612bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8629371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8639371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8649371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8659371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8662bf73ac6SHong Zhang     Nsvtx++;
8672bf73ac6SHong Zhang   }
8685c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
869daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8712727e31bSShri Abhyankar }
8722727e31bSShri Abhyankar 
8732727e31bSShri Abhyankar /*@C
8742bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8752bf73ac6SHong Zhang 
87620f4b53cSBarry Smith   Not Collective
877caf410d2SHong Zhang 
878f899ff85SJose E. Roman   Input Parameter:
87920f4b53cSBarry Smith . dm - the `DMNETWORK` object
880caf410d2SHong Zhang 
8817a7aea1fSJed Brown   Output Parameters:
882ce78bad3SBarry Smith + nsv  - number of local shared vertices, pass `NULL` if not needed
883ce78bad3SBarry Smith - svtx - local shared vertices, pass `NULL` if not needed
884caf410d2SHong Zhang 
885caf410d2SHong Zhang   Level: intermediate
886caf410d2SHong Zhang 
887ce78bad3SBarry Smith   Note:
88820f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
88920f4b53cSBarry Smith 
89020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
891caf410d2SHong Zhang @*/
892ce78bad3SBarry Smith PetscErrorCode DMNetworkGetSharedVertices(DM dm, PeOp PetscInt *nsv, PeOp const PetscInt *svtx[])
893d71ae5a4SJacob Faibussowitsch {
894caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
895caf410d2SHong Zhang 
896caf410d2SHong Zhang   PetscFunctionBegin;
8975c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
898daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
899daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
9003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
901caf410d2SHong Zhang }
902caf410d2SHong Zhang 
903caf410d2SHong Zhang /*@C
9045f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
9055f2c45f1SShri Abhyankar 
90620f4b53cSBarry Smith   Logically Collective
9075f2c45f1SShri Abhyankar 
9087a7aea1fSJed Brown   Input Parameters:
90920f4b53cSBarry Smith + dm   - the `DMNETWORK` object
9105f2c45f1SShri Abhyankar . name - the component name
9115f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
9125f2c45f1SShri Abhyankar 
9132fe279fdSBarry Smith   Output Parameter:
9145f2c45f1SShri Abhyankar . key - an integer key that defines the component
9155f2c45f1SShri Abhyankar 
91620f4b53cSBarry Smith   Level: beginner
91720f4b53cSBarry Smith 
91887497f52SBarry Smith   Note:
91987497f52SBarry Smith   This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9205f2c45f1SShri Abhyankar 
92120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9225f2c45f1SShri Abhyankar @*/
923d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
924d71ae5a4SJacob Faibussowitsch {
9255f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
92654dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9275f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9285f2c45f1SShri Abhyankar   PetscInt            i;
9295f2c45f1SShri Abhyankar 
9305f2c45f1SShri Abhyankar   PetscFunctionBegin;
93148a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
93254dfd506SHong Zhang 
9335f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9349566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9355f2c45f1SShri Abhyankar     if (flg) {
9365f2c45f1SShri Abhyankar       *key = i;
9373ba16761SJacob Faibussowitsch       PetscFunctionReturn(PETSC_SUCCESS);
9385f2c45f1SShri Abhyankar     }
9396d64e262SShri Abhyankar   }
94054dfd506SHong Zhang 
94154dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
94254dfd506SHong Zhang     /* Reached max allowed so resize component */
94354dfd506SHong Zhang     network->max_comps_registered += 2;
9449566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
94554dfd506SHong Zhang     /* Copy over the previous component info */
94654dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
947c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(newcomponent[i].name, network->component[i].name, sizeof(newcomponent[i].name)));
94854dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9495f2c45f1SShri Abhyankar     }
95054dfd506SHong Zhang     /* Free old one */
9519566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
95254dfd506SHong Zhang     /* Update pointer */
95354dfd506SHong Zhang     network->component = newcomponent;
95454dfd506SHong Zhang   }
95554dfd506SHong Zhang 
95654dfd506SHong Zhang   component = &network->component[network->ncomponent];
9575f2c45f1SShri Abhyankar 
958c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(component->name, name, sizeof(component->name)));
959dec611a3SBarry Smith   PetscCheck((size % sizeof(DMNetworkComponentGenericDataType)) == 0, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Size of datatype must be divisible by sizeof(DMNetworkComponentGenericDataType)");
9606497c311SBarry Smith   PetscCall(PetscIntCast(size / sizeof(DMNetworkComponentGenericDataType), &component->size));
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:
975ce78bad3SBarry Smith + nVertices - the local number of vertices, pass `NULL` if not needed
976ce78bad3SBarry Smith - NVertices - the global number of vertices, pass `NULL` if not needed
9778afb7921SAidan Hamilton 
9788afb7921SAidan Hamilton   Level: beginner
9798afb7921SAidan Hamilton 
98020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumEdges()`
9818afb7921SAidan Hamilton @*/
982ce78bad3SBarry Smith PetscErrorCode DMNetworkGetNumVertices(DM dm, PeOp PetscInt *nVertices, PeOp 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) {
9894f572ea9SToby Isaac     PetscAssertPointer(nVertices, 2);
9908afb7921SAidan Hamilton     *nVertices = network->cloneshared->nVertices;
9918afb7921SAidan Hamilton   }
9928afb7921SAidan Hamilton   if (NVertices) {
9934f572ea9SToby Isaac     PetscAssertPointer(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:
1008ce78bad3SBarry Smith + nEdges - the local number of edges, pass `NULL` if not needed
1009ce78bad3SBarry Smith - NEdges - the global number of edges, pass `NULL` if not needed
10108afb7921SAidan Hamilton 
10118afb7921SAidan Hamilton   Level: beginner
10128afb7921SAidan Hamilton 
101320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumVertices()`
10148afb7921SAidan Hamilton @*/
1015ce78bad3SBarry Smith PetscErrorCode DMNetworkGetNumEdges(DM dm, PeOp PetscInt *nEdges, PeOp 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) {
10224f572ea9SToby Isaac     PetscAssertPointer(nEdges, 2);
10238afb7921SAidan Hamilton     *nEdges = network->cloneshared->nEdges;
10248afb7921SAidan Hamilton   }
10258afb7921SAidan Hamilton   if (NEdges) {
10264f572ea9SToby Isaac     PetscAssertPointer(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:
1041ce78bad3SBarry Smith + vStart - the first vertex point, pass `NULL` if not needed
1042ce78bad3SBarry Smith - vEnd   - one beyond the last vertex point, pass `NULL` if not needed
10435f2c45f1SShri Abhyankar 
104497bb938eSShri Abhyankar   Level: beginner
10455f2c45f1SShri Abhyankar 
104620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeRange()`
10475f2c45f1SShri Abhyankar @*/
1048ce78bad3SBarry Smith PetscErrorCode DMNetworkGetVertexRange(DM dm, PeOp PetscInt *vStart, PeOp 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:
1067ce78bad3SBarry Smith + eStart - The first edge point, pass `NULL` if not needed
1068ce78bad3SBarry Smith - eEnd   - One beyond the last edge point, pass `NULL` if not needed
10695f2c45f1SShri Abhyankar 
107097bb938eSShri Abhyankar   Level: beginner
10715f2c45f1SShri Abhyankar 
107220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetVertexRange()`
10735f2c45f1SShri Abhyankar @*/
1074ce78bad3SBarry Smith PetscErrorCode DMNetworkGetEdgeRange(DM dm, PeOp PetscInt *eStart, PeOp 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 
135660225df5SJacob Faibussowitsch   Developer Notes:
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);
1393dd5bbc93SStefano Zampini #if defined(__NEC__)
1394dd5bbc93SStefano Zampini     /* NEC/LG: quick hack to keep data aligned on 8 bytes. */
1395dd5bbc93SStefano Zampini     header->hsize = (header->hsize + (8 - 1)) & ~(8 - 1);
1396dd5bbc93SStefano 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];
1435835f2295SStefano Zampini   cvalue->data[compnum] = 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 @*/
1464ce78bad3SBarry Smith PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PeOp PetscInt *compkey, PeCtx component, PeOp 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];
1483ce78bad3SBarry Smith       *(void **)component = network->componentdataarray + offset;
14842bf73ac6SHong Zhang     }
14852bf73ac6SHong Zhang   }
14865f2c45f1SShri Abhyankar 
14872bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
14883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14895f2c45f1SShri Abhyankar }
14905f2c45f1SShri Abhyankar 
14912bf73ac6SHong Zhang /*
14922bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14932bf73ac6SHong 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.
14942bf73ac6SHong Zhang */
1495a4e35b19SJacob Faibussowitsch static PetscErrorCode DMNetworkComponentSetUp(DM dm)
1496d71ae5a4SJacob Faibussowitsch {
14975f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1498f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
14995f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
15005f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1501f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
15025f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
15035f2c45f1SShri Abhyankar 
15045f2c45f1SShri Abhyankar   PetscFunctionBegin;
15059566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
15069566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1507f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
15089566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
15095f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1510daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
15119566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
15125f2c45f1SShri Abhyankar     /* Copy header */
15135f2c45f1SShri Abhyankar     header     = &network->header[p];
1514f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
15159566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1516f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
15179566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1518aeb78aa7SBarry Smith     headerinfo->size = headerarr;
151954dfd506SHong Zhang     headerarr += header->maxcomps;
15209566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1521aeb78aa7SBarry Smith     headerinfo->key = headerarr;
152254dfd506SHong Zhang     headerarr += header->maxcomps;
15239566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1524aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
152554dfd506SHong Zhang     headerarr += header->maxcomps;
15269566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1527aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
152854dfd506SHong Zhang     headerarr += header->maxcomps;
15299566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1530aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
153154dfd506SHong Zhang 
15325f2c45f1SShri Abhyankar     /* Copy data */
15335f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
15345f2c45f1SShri Abhyankar     ncomp  = header->ndata;
15352bf73ac6SHong Zhang 
15365f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
153754dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
15389566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
15395f2c45f1SShri Abhyankar     }
15405f2c45f1SShri Abhyankar   }
1541aeb78aa7SBarry Smith 
1542daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1543aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1544aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1545aeb78aa7SBarry Smith   }
1546aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
15473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15485f2c45f1SShri Abhyankar }
15495f2c45f1SShri Abhyankar 
15505f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1551d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1552d71ae5a4SJacob Faibussowitsch {
15535f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
15545f2c45f1SShri Abhyankar 
15555f2c45f1SShri Abhyankar   PetscFunctionBegin;
15569566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
15573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15585f2c45f1SShri Abhyankar }
15595f2c45f1SShri Abhyankar 
156024121865SAdrian Maldonado /* Get a subsection from a range of points */
1561d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1562d71ae5a4SJacob Faibussowitsch {
156324121865SAdrian Maldonado   PetscInt i, nvar;
156424121865SAdrian Maldonado 
156524121865SAdrian Maldonado   PetscFunctionBegin;
15669566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
15679566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
156824121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
15699566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
15709566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
157124121865SAdrian Maldonado   }
157224121865SAdrian Maldonado 
15739566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
15743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
157524121865SAdrian Maldonado }
157624121865SAdrian Maldonado 
157724121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1578e66d8692SHong Zhang static PetscErrorCode DMNetworkSetSubMap_private(DM dm, PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1579d71ae5a4SJacob Faibussowitsch {
158024121865SAdrian Maldonado   PetscInt i, *subpoints;
158124121865SAdrian Maldonado 
158224121865SAdrian Maldonado   PetscFunctionBegin;
158324121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15849566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1585ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
1586e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15879566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
15883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
158924121865SAdrian Maldonado }
159024121865SAdrian Maldonado 
159124121865SAdrian Maldonado /*@
159220f4b53cSBarry Smith   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after `DMNetworkDistribute()`
159324121865SAdrian Maldonado 
159420f4b53cSBarry Smith   Collective
159524121865SAdrian Maldonado 
15962fe279fdSBarry Smith   Input Parameter:
159720f4b53cSBarry Smith . dm - the `DMNETWORK` Object
159824121865SAdrian Maldonado 
159920f4b53cSBarry Smith   Level: intermediate
160020f4b53cSBarry Smith 
160120f4b53cSBarry Smith   Note:
1602a4e35b19SJacob Faibussowitsch   The routine will create alternative orderings for the vertices and edges. Assume global
1603a4e35b19SJacob Faibussowitsch   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 
1611a4e35b19SJacob Faibussowitsch .seealso: `DMNetworkDistribute()`
161224121865SAdrian Maldonado @*/
1613d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1614d71ae5a4SJacob Faibussowitsch {
161524121865SAdrian Maldonado   MPI_Comm    comm;
1616f11a936eSBarry Smith   PetscMPIInt size;
161724121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
161824121865SAdrian Maldonado 
1619eab1376dSHong Zhang   PetscFunctionBegin;
16209566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
16219566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
162224121865SAdrian Maldonado 
162324121865SAdrian Maldonado   /* Create maps for vertices and edges */
1624e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1625e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
162624121865SAdrian Maldonado 
162724121865SAdrian Maldonado   /* Create local sub-sections */
1628daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1629daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
163024121865SAdrian Maldonado 
16319852e123SBarry Smith   if (size > 1) {
16329566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
163322bbedd7SHong Zhang 
1634eb9d3e4dSMatthew G. Knepley     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_TRUE, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
16359566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
1636eb9d3e4dSMatthew G. Knepley     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_TRUE, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
163724121865SAdrian Maldonado   } else {
163824121865SAdrian Maldonado     /* create structures for vertex */
16399566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
164024121865SAdrian Maldonado     /* create structures for edge */
16419566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
164224121865SAdrian Maldonado   }
164324121865SAdrian Maldonado 
164424121865SAdrian Maldonado   /* Add viewers */
16459566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
16469566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
16479566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
16489566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
16493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
165024121865SAdrian Maldonado }
16517b6afd5bSHong Zhang 
1652f11a936eSBarry Smith /*
16535c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
16545c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1655f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1656f11a936eSBarry Smith */
1657d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1658d71ae5a4SJacob Faibussowitsch {
1659f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1660f11a936eSBarry Smith   const PetscInt          *edges;
1661f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1662f11a936eSBarry Smith   DMNetworkComponentHeader header;
1663f11a936eSBarry Smith 
1664f11a936eSBarry Smith   PetscFunctionBegin;
16659566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
16669566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1667f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
16689566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1669f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16709566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1671f11a936eSBarry Smith   }
16723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1673f11a936eSBarry Smith }
1674f11a936eSBarry Smith 
16758afb7921SAidan Hamilton /*
16768afb7921SAidan Hamilton   DMNetworkDistributeCoordinates - Internal function to distribute the coordinate network and coordinates.
16778afb7921SAidan Hamilton 
16788afb7921SAidan Hamilton   Collective
16798afb7921SAidan Hamilton 
16808afb7921SAidan Hamilton   Input Parameters:
168120f4b53cSBarry Smith   + dm - The original `DMNETWORK` object
1682aaa8cc7dSPierre Jolivet   - migrationSF - The `PetscSF` describing the migration from dm to dmnew
16838afb7921SAidan Hamilton   - newDM - The new distributed dmnetwork object.
16848afb7921SAidan Hamilton */
16858afb7921SAidan Hamilton 
16868afb7921SAidan Hamilton static PetscErrorCode DMNetworkDistributeCoordinates(DM dm, PetscSF migrationSF, DM newDM)
16878afb7921SAidan Hamilton {
16888afb7921SAidan Hamilton   DM_Network              *newDMnetwork = (DM_Network *)((newDM)->data), *newCoordnetwork, *oldCoordnetwork;
16898afb7921SAidan Hamilton   DM                       cdm, newcdm;
16908afb7921SAidan Hamilton   PetscInt                 cdim, bs, p, pStart, pEnd, offset;
16918afb7921SAidan Hamilton   Vec                      oldCoord, newCoord;
16928afb7921SAidan Hamilton   DMNetworkComponentHeader header;
16938afb7921SAidan Hamilton   const char              *name;
16948afb7921SAidan Hamilton 
16958afb7921SAidan Hamilton   PetscFunctionBegin;
16968afb7921SAidan Hamilton   /* Distribute the coordinate network and coordinates */
16978afb7921SAidan Hamilton   PetscCall(DMGetCoordinateDim(dm, &cdim));
16988afb7921SAidan Hamilton   PetscCall(DMSetCoordinateDim(newDM, cdim));
16998afb7921SAidan Hamilton 
17008afb7921SAidan Hamilton   /* Migrate only if original network had coordinates */
17018afb7921SAidan Hamilton   PetscCall(DMGetCoordinatesLocal(dm, &oldCoord));
17028afb7921SAidan Hamilton   if (oldCoord) {
17038afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(dm, &cdm));
17048afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(newDM, &newcdm));
17058afb7921SAidan Hamilton     newCoordnetwork = (DM_Network *)newcdm->data;
17068afb7921SAidan Hamilton     oldCoordnetwork = (DM_Network *)cdm->data;
17078afb7921SAidan Hamilton 
17088afb7921SAidan Hamilton     PetscCall(VecCreate(PETSC_COMM_SELF, &newCoord));
17098afb7921SAidan Hamilton     PetscCall(PetscObjectGetName((PetscObject)oldCoord, &name));
17108afb7921SAidan Hamilton     PetscCall(PetscObjectSetName((PetscObject)newCoord, name));
17118afb7921SAidan Hamilton     PetscCall(VecGetBlockSize(oldCoord, &bs));
17128afb7921SAidan Hamilton     PetscCall(VecSetBlockSize(newCoord, bs));
17138afb7921SAidan Hamilton 
17148afb7921SAidan Hamilton     PetscCall(DMPlexDistributeField(newDMnetwork->plex, migrationSF, oldCoordnetwork->DofSection, oldCoord, newCoordnetwork->DofSection, newCoord));
17158afb7921SAidan Hamilton     PetscCall(DMSetCoordinatesLocal(newDM, newCoord));
17168afb7921SAidan Hamilton 
17178afb7921SAidan Hamilton     PetscCall(VecDestroy(&newCoord));
1718aaa8cc7dSPierre Jolivet     /* Migrate the components from the original coordinate network to the new coordinate network */
17198afb7921SAidan Hamilton     PetscCall(DMPlexDistributeData(newDMnetwork->plex, migrationSF, oldCoordnetwork->DataSection, MPIU_INT, (void *)oldCoordnetwork->componentdataarray, newCoordnetwork->DataSection, (void **)&newCoordnetwork->componentdataarray));
17208afb7921SAidan Hamilton     /* update the header pointers in the new coordinate network components */
17218afb7921SAidan Hamilton     PetscCall(PetscSectionGetChart(newCoordnetwork->DataSection, &pStart, &pEnd));
17228afb7921SAidan Hamilton     for (p = pStart; p < pEnd; p++) {
17238afb7921SAidan Hamilton       PetscCall(PetscSectionGetOffset(newCoordnetwork->DataSection, p, &offset));
17248afb7921SAidan Hamilton       header = (DMNetworkComponentHeader)(newCoordnetwork->componentdataarray + offset);
17258afb7921SAidan Hamilton       /* Update pointers */
17268afb7921SAidan Hamilton       header->size         = (PetscInt *)(header + 1);
17278afb7921SAidan Hamilton       header->key          = header->size + header->maxcomps;
17288afb7921SAidan Hamilton       header->offset       = header->key + header->maxcomps;
17298afb7921SAidan Hamilton       header->nvar         = header->offset + header->maxcomps;
17308afb7921SAidan Hamilton       header->offsetvarrel = header->nvar + header->maxcomps;
17318afb7921SAidan Hamilton     }
17328afb7921SAidan Hamilton 
17338afb7921SAidan Hamilton     PetscCall(DMSetLocalSection(newCoordnetwork->plex, newCoordnetwork->DofSection));
17348afb7921SAidan Hamilton     PetscCall(DMGetGlobalSection(newCoordnetwork->plex, &newCoordnetwork->GlobalDofSection));
17358afb7921SAidan Hamilton     newCoordnetwork->componentsetup = PETSC_TRUE;
17368afb7921SAidan Hamilton   }
17373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17388afb7921SAidan Hamilton }
17398afb7921SAidan Hamilton 
17405f2c45f1SShri Abhyankar /*@
17412bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
17425f2c45f1SShri Abhyankar 
17435f2c45f1SShri Abhyankar   Collective
17445f2c45f1SShri Abhyankar 
1745d8d19677SJose E. Roman   Input Parameters:
174660225df5SJacob Faibussowitsch + dm      - the `DMNETWORK` object
17472bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
17485f2c45f1SShri Abhyankar 
174920f4b53cSBarry Smith   Options Database Keys:
17506e4289a0SDuncan Campbell + -dmnetwork_view              - Calls `DMView()` at the conclusion of `DMSetUp()`
17516e4289a0SDuncan Campbell . -dmnetwork_view_distributed  - Calls `DMView()` at the conclusion of `DMNetworkDistribute()`
17525f25b224SDuncan Campbell . -dmnetwork_view_tmpdir       - Sets the temporary directory to use when viewing with the `draw` option
17535f25b224SDuncan Campbell . -dmnetwork_view_all_ranks    - Displays all of the subnetworks for each MPI rank
17545f25b224SDuncan Campbell . -dmnetwork_view_rank_range   - Displays the subnetworks for the ranks in a comma-separated list
17555f25b224SDuncan Campbell . -dmnetwork_view_no_vertices  - Disables displaying the vertices in the network visualization
17565f25b224SDuncan Campbell - -dmnetwork_view_no_numbering - Disables displaying the numbering of edges and vertices in the network visualization
17575b3f975aSHong Zhang 
17585f2c45f1SShri Abhyankar   Level: intermediate
17595f2c45f1SShri Abhyankar 
176020f4b53cSBarry Smith   Note:
176120f4b53cSBarry Smith   Distributes the network with <overlap>-overlapping partitioning of the edges.
176220f4b53cSBarry Smith 
176320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`
17645f2c45f1SShri Abhyankar @*/
1765d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1766d71ae5a4SJacob Faibussowitsch {
1767d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1768d3464fd4SAdrian Maldonado   PetscMPIInt              size;
17698afb7921SAidan Hamilton   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data), *newDMnetwork;
1770caf410d2SHong Zhang   PetscSF                  pointsf      = NULL;
17715f2c45f1SShri Abhyankar   DM                       newDM;
17728afb7921SAidan Hamilton   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv, net;
17738afb7921SAidan Hamilton   PetscInt                *sv;
1774f11a936eSBarry Smith   PetscBT                  btable;
177551ac5effSHong Zhang   PetscPartitioner         part;
1776b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
17775f2c45f1SShri Abhyankar 
17785f2c45f1SShri Abhyankar   PetscFunctionBegin;
17794f572ea9SToby Isaac   PetscAssertPointer(dm, 1);
17805c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
17819566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
17829566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1783a9750deaSHong Zhang   if (size == 1) {
1784a9750deaSHong Zhang     oldDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1785a9750deaSHong Zhang     PetscFunctionReturn(PETSC_SUCCESS);
1786a9750deaSHong Zhang   }
1787d3464fd4SAdrian Maldonado 
17885c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
17895b3f975aSHong Zhang 
17902bf73ac6SHong 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. */
17919566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
1792448dab84SStefano Zampini   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, newDM, 0, 0, 0));
17935f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
179454dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
17959566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
179651ac5effSHong Zhang 
179751ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
17989566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
17999566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
180051ac5effSHong Zhang 
18012bf73ac6SHong Zhang   /* Distribute plex dm */
18029566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
180351ac5effSHong Zhang 
18045f2c45f1SShri Abhyankar   /* Distribute dof section */
18059566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
18069566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
180751ac5effSHong Zhang 
18085f2c45f1SShri Abhyankar   /* Distribute data and associated section */
18099566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
18109566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
181124121865SAdrian Maldonado 
1812daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1813daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1814daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1815daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1816daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1817daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1818daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1819daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1820daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
182124121865SAdrian Maldonado 
18221bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
18239566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
18249566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
18255f2c45f1SShri Abhyankar 
1826b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1827daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1828daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1829daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1830daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1831daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1832daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
18332bf73ac6SHong Zhang 
18342bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
18352bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1836b9c6e19dSShri Abhyankar   */
1837daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1838f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1839daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1840daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1841b9c6e19dSShri Abhyankar   }
1842b9c6e19dSShri Abhyankar 
1843f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1844daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18459566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
184654dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18475c6496baSHong Zhang 
184854dfd506SHong Zhang     /* Update pointers */
184954dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
185054dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
185154dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
185254dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
185354dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
185454dfd506SHong Zhang 
1855daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1856b9c6e19dSShri Abhyankar   }
1857b9c6e19dSShri Abhyankar 
18585c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
185948a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
18605c6496baSHong Zhang 
18615c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1862daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
18639566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
18645f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18655c6496baSHong Zhang 
186654dfd506SHong Zhang     /* Update pointers */
186754dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
186854dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
186954dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
187054dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
187154dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
187254dfd506SHong Zhang 
18732bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
18742bf73ac6SHong Zhang     gidx = header->index;
1875eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, gidx + 1, 0, &svtx_idx));
18762bf73ac6SHong Zhang     svtx_idx--;
18772bf73ac6SHong Zhang 
18782bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1879daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
18802bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
18815c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
18829566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1883f11a936eSBarry Smith 
1884daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1885daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
18865c6496baSHong Zhang         net = sv[0];
188735cb6cd3SPierre Jolivet         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this process */
18882bf73ac6SHong Zhang       }
18892bf73ac6SHong Zhang     }
1890b9c6e19dSShri Abhyankar   }
1891b9c6e19dSShri Abhyankar 
18922bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
18932bf73ac6SHong Zhang   nv = 0;
1894daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1895daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1896caf410d2SHong Zhang 
18972bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1898daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1899daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1900daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1901daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1902daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1903daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
19042bf73ac6SHong Zhang 
1905daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1906daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1907caf410d2SHong Zhang 
19082bf73ac6SHong 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. */
1909daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1910b9c6e19dSShri Abhyankar   }
1911daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1912b9c6e19dSShri Abhyankar 
19132bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1914daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
19159566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
19165f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1917daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1918b9c6e19dSShri Abhyankar   }
1919b9c6e19dSShri Abhyankar 
19202bf73ac6SHong Zhang   nv = 0;
1921daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
19229566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
19235f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
19242bf73ac6SHong Zhang 
19252bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1926eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, header->index + 1, 0, &svtx_idx));
19272bf73ac6SHong Zhang     svtx_idx--;
19282bf73ac6SHong Zhang     if (svtx_idx < 0) {
1929daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
19302bf73ac6SHong Zhang     } else { /* a shared vertex */
1931daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
19322bf73ac6SHong Zhang 
19335c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
19349566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1935f11a936eSBarry Smith 
1936daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1937daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
19385c6496baSHong Zhang         net = sv[0];
19399371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1940b9c6e19dSShri Abhyankar       }
19412bf73ac6SHong Zhang     }
19422bf73ac6SHong Zhang   }
1943daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1944b9c6e19dSShri Abhyankar 
19458afb7921SAidan Hamilton   PetscCall(DMNetworkDistributeCoordinates(*dm, pointsf, newDM));
1946caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1947daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1948caf410d2SHong Zhang 
19492bf73ac6SHong Zhang   /* Free spaces */
19509566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
19519566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
195248a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
1953448dab84SStefano Zampini   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, newDM, 0, 0, 0));
19542bf73ac6SHong Zhang 
19555b3f975aSHong Zhang   /* View distributed dmnetwork */
19569566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
19575b3f975aSHong Zhang 
1958d3464fd4SAdrian Maldonado   *dm = newDM;
19593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19605f2c45f1SShri Abhyankar }
19615f2c45f1SShri Abhyankar 
1962cc4c1da9SBarry Smith /*@
196320f4b53cSBarry Smith   PetscSFGetSubSF - Returns an `PetscSF` for a specific subset of points. Leaves are re-numbered to reflect the new ordering
19642bf73ac6SHong Zhang 
19652bf73ac6SHong Zhang   Collective
196624121865SAdrian Maldonado 
196724121865SAdrian Maldonado   Input Parameters:
196860225df5SJacob Faibussowitsch + mainsf - `PetscSF` structure
196920f4b53cSBarry Smith - map    - a `ISLocalToGlobalMapping` that contains the subset of points
197024121865SAdrian Maldonado 
197197bb3fdcSJose E. Roman   Output Parameter:
197220f4b53cSBarry Smith . subSF - a subset of the `mainSF` for the desired subset.
1973ee300463SSatish Balay 
1974ee300463SSatish Balay   Level: intermediate
197520f4b53cSBarry Smith 
197620f4b53cSBarry Smith .seealso: `PetscSF`
19777d928bffSSatish Balay @*/
1978d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1979d71ae5a4SJacob Faibussowitsch {
198024121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
198124121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
198224121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
198324121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
198424121865SAdrian Maldonado   const PetscInt    *ilocal;
198524121865SAdrian Maldonado   const PetscSFNode *iremote;
198624121865SAdrian Maldonado 
198724121865SAdrian Maldonado   PetscFunctionBegin;
19889566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
198924121865SAdrian Maldonado 
199024121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
19919566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
19929566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
199324121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
199424121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
199524121865SAdrian Maldonado   }
199624121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
19979566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
199824121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
19999566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
20009566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
20019566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
200224121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
20039566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
20049566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
200524121865SAdrian Maldonado   nleaves_sub = 0;
200624121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
200724121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
200824121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
20094b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
201024121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
201124121865SAdrian Maldonado       nleaves_sub += 1;
201224121865SAdrian Maldonado     }
201324121865SAdrian Maldonado   }
20149566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
20159566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
201624121865SAdrian Maldonado 
201724121865SAdrian Maldonado   /* Create new subSF */
2018e66d8692SHong Zhang   PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)mainsf), subSF));
20199566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
20209566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
20219566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
20229566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
20233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
202424121865SAdrian Maldonado }
202524121865SAdrian Maldonado 
20265f2c45f1SShri Abhyankar /*@C
20275f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
20285f2c45f1SShri Abhyankar 
20295f2c45f1SShri Abhyankar   Not Collective
20305f2c45f1SShri Abhyankar 
20315f2c45f1SShri Abhyankar   Input Parameters:
203220f4b53cSBarry Smith + dm     - the `DMNETWORK` object
203360225df5SJacob Faibussowitsch - vertex - the vertex point
20345f2c45f1SShri Abhyankar 
2035fd292e60Sprj-   Output Parameters:
20365f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
2037ce78bad3SBarry Smith - edges  - list of edge points, pass `NULL` if not needed
20385f2c45f1SShri Abhyankar 
203997bb938eSShri Abhyankar   Level: beginner
20405f2c45f1SShri Abhyankar 
204120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
20425f2c45f1SShri Abhyankar @*/
2043ce78bad3SBarry Smith PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, PeOp const PetscInt *edges[])
2044d71ae5a4SJacob Faibussowitsch {
20455f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20465f2c45f1SShri Abhyankar 
20475f2c45f1SShri Abhyankar   PetscFunctionBegin;
20489566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
20499566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
20503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20515f2c45f1SShri Abhyankar }
20525f2c45f1SShri Abhyankar 
20535f2c45f1SShri Abhyankar /*@C
2054d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
20555f2c45f1SShri Abhyankar 
20565f2c45f1SShri Abhyankar   Not Collective
20575f2c45f1SShri Abhyankar 
20585f2c45f1SShri Abhyankar   Input Parameters:
205920f4b53cSBarry Smith + dm   - the `DMNETWORK` object
206060225df5SJacob Faibussowitsch - edge - the edge point
20615f2c45f1SShri Abhyankar 
20622fe279fdSBarry Smith   Output Parameter:
20635f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
20645f2c45f1SShri Abhyankar 
206597bb938eSShri Abhyankar   Level: beginner
20665f2c45f1SShri Abhyankar 
206720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
20685f2c45f1SShri Abhyankar @*/
2069d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
2070d71ae5a4SJacob Faibussowitsch {
20715f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20725f2c45f1SShri Abhyankar 
20735f2c45f1SShri Abhyankar   PetscFunctionBegin;
20749566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
20753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20765f2c45f1SShri Abhyankar }
20775f2c45f1SShri Abhyankar 
20785f2c45f1SShri Abhyankar /*@
207920f4b53cSBarry Smith   DMNetworkIsSharedVertex - Returns `PETSC_TRUE` if the vertex is shared by subnetworks
20802bf73ac6SHong Zhang 
20812bf73ac6SHong Zhang   Not Collective
20822bf73ac6SHong Zhang 
20832bf73ac6SHong Zhang   Input Parameters:
208420f4b53cSBarry Smith + dm - the `DMNETWORK` object
20852bf73ac6SHong Zhang - p  - the vertex point
20862bf73ac6SHong Zhang 
20872bf73ac6SHong Zhang   Output Parameter:
208820f4b53cSBarry Smith . flag - `PETSC_TRUE` if the vertex is shared by subnetworks
20892bf73ac6SHong Zhang 
20902bf73ac6SHong Zhang   Level: beginner
20912bf73ac6SHong Zhang 
209220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
20932bf73ac6SHong Zhang @*/
2094d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
2095d71ae5a4SJacob Faibussowitsch {
20962bf73ac6SHong Zhang   PetscFunctionBegin;
2097eec179cfSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
20984f572ea9SToby Isaac   PetscAssertPointer(flag, 3);
20992bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
21002bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
21012bf73ac6SHong Zhang     PetscInt    gidx;
2102eec179cfSJacob Faibussowitsch 
21039566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
2104eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIHas(network->cloneshared->svtable, gidx + 1, flag));
21052bf73ac6SHong Zhang   } else { /* would be removed? */
21062bf73ac6SHong Zhang     PetscInt        nv;
21072bf73ac6SHong Zhang     const PetscInt *vtx;
2108eec179cfSJacob Faibussowitsch 
21099566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
2110eec179cfSJacob Faibussowitsch     for (PetscInt i = 0; i < nv; i++) {
21112bf73ac6SHong Zhang       if (p == vtx[i]) {
21122bf73ac6SHong Zhang         *flag = PETSC_TRUE;
21133ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
21142bf73ac6SHong Zhang       }
21152bf73ac6SHong Zhang     }
2116eec179cfSJacob Faibussowitsch     *flag = PETSC_FALSE;
21172bf73ac6SHong Zhang   }
21183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21192bf73ac6SHong Zhang }
21202bf73ac6SHong Zhang 
21212bf73ac6SHong Zhang /*@
212220f4b53cSBarry Smith   DMNetworkIsGhostVertex - Returns `PETSC_TRUE` if the vertex is a ghost vertex
21235f2c45f1SShri Abhyankar 
21245f2c45f1SShri Abhyankar   Not Collective
21255f2c45f1SShri Abhyankar 
21265f2c45f1SShri Abhyankar   Input Parameters:
212720f4b53cSBarry Smith + dm - the `DMNETWORK` object
2128a2b725a8SWilliam Gropp - p  - the vertex point
21295f2c45f1SShri Abhyankar 
21305f2c45f1SShri Abhyankar   Output Parameter:
213120f4b53cSBarry Smith . isghost - `PETSC_TRUE` if the vertex is a ghost point
21325f2c45f1SShri Abhyankar 
213397bb938eSShri Abhyankar   Level: beginner
21345f2c45f1SShri Abhyankar 
213520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
21365f2c45f1SShri Abhyankar @*/
2137d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
2138d71ae5a4SJacob Faibussowitsch {
21395f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
21405f2c45f1SShri Abhyankar   PetscInt     offsetg;
21415f2c45f1SShri Abhyankar   PetscSection sectiong;
21425f2c45f1SShri Abhyankar 
21435f2c45f1SShri Abhyankar   PetscFunctionBegin;
21445f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
21459566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
21469566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
21475f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
21483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21495f2c45f1SShri Abhyankar }
21505f2c45f1SShri Abhyankar 
2151d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
2152d71ae5a4SJacob Faibussowitsch {
21535f2c45f1SShri Abhyankar   PetscFunctionBegin;
2154e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2155daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
21565b3f975aSHong Zhang   /* View dmnetwork */
21579566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2158e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
21593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21605f2c45f1SShri Abhyankar }
21615f2c45f1SShri Abhyankar 
21621ad426b7SHong Zhang /*@
216317df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
216420f4b53cSBarry Smith   -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TRUE)?
21651ad426b7SHong Zhang 
21661ad426b7SHong Zhang   Collective
21671ad426b7SHong Zhang 
21681ad426b7SHong Zhang   Input Parameters:
216920f4b53cSBarry Smith + dm   - the `DMNETWORK` object
217020f4b53cSBarry Smith . eflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for edges
217120f4b53cSBarry Smith - vflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for vertices
21721ad426b7SHong Zhang 
21731ad426b7SHong Zhang   Level: intermediate
21741ad426b7SHong Zhang 
2175a4e35b19SJacob Faibussowitsch .seealso: `DMNetworkSetOption()`
21761ad426b7SHong Zhang @*/
2177d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2178d71ae5a4SJacob Faibussowitsch {
21791ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2180daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
21811ad426b7SHong Zhang 
21821ad426b7SHong Zhang   PetscFunctionBegin;
218383b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
218483b2e829SHong Zhang   network->userVertexJacobian = vflg;
21858675203cSHong Zhang 
218648a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
21878675203cSHong Zhang 
218866b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2189daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
219066b4e0ffSHong Zhang     PetscInt        nedges_total;
21918675203cSHong Zhang     const PetscInt *edges;
21928675203cSHong Zhang 
21938675203cSHong Zhang     /* count nvertex_total */
21948675203cSHong Zhang     nedges_total = 0;
21959566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
21968675203cSHong Zhang 
21978675203cSHong Zhang     vptr[0] = 0;
21988675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
21999566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
22008675203cSHong Zhang       nedges_total += nedges;
22018675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
22028675203cSHong Zhang     }
22038675203cSHong Zhang 
22049566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
22058675203cSHong Zhang     network->Jvptr = vptr;
22068675203cSHong Zhang   }
22073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22081ad426b7SHong Zhang }
22091ad426b7SHong Zhang 
22101ad426b7SHong Zhang /*@
221183b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
221283b2e829SHong Zhang 
221383b2e829SHong Zhang   Not Collective
221483b2e829SHong Zhang 
221583b2e829SHong Zhang   Input Parameters:
221620f4b53cSBarry Smith + dm - the `DMNETWORK` object
221783b2e829SHong Zhang . p  - the edge point
22183e97b6e8SHong Zhang - J  - array (size = 3) of Jacobian submatrices for this edge point:
22193e97b6e8SHong Zhang         J[0]: this edge
222020f4b53cSBarry Smith         J[1] and J[2]: connected vertices, obtained by calling `DMNetworkGetConnectedVertices()`
222183b2e829SHong Zhang 
222297bb938eSShri Abhyankar   Level: advanced
222383b2e829SHong Zhang 
222420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkVertexSetMatrix()`
222583b2e829SHong Zhang @*/
2226d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2227d71ae5a4SJacob Faibussowitsch {
222883b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
222983b2e829SHong Zhang 
223083b2e829SHong Zhang   PetscFunctionBegin;
22315c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
22328675203cSHong Zhang 
22338675203cSHong Zhang   if (J) {
2234883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2235883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2236883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
22378675203cSHong Zhang   }
22383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
223983b2e829SHong Zhang }
224083b2e829SHong Zhang 
224183b2e829SHong Zhang /*@
224276ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
22431ad426b7SHong Zhang 
22441ad426b7SHong Zhang   Not Collective
22451ad426b7SHong Zhang 
22461ad426b7SHong Zhang   Input Parameters:
224720f4b53cSBarry Smith + dm - The `DMNETWORK` object
22481ad426b7SHong Zhang . p  - the vertex point
22493e97b6e8SHong Zhang - J  - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
22503e97b6e8SHong Zhang         J[0]:       this vertex
22513e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
22523e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
22531ad426b7SHong Zhang 
225497bb938eSShri Abhyankar   Level: advanced
22551ad426b7SHong Zhang 
225620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkEdgeSetMatrix()`
22571ad426b7SHong Zhang @*/
2258d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2259d71ae5a4SJacob Faibussowitsch {
22605f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2261daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2262883e35e8SHong Zhang   const PetscInt *edges;
22635f2c45f1SShri Abhyankar 
22645f2c45f1SShri Abhyankar   PetscFunctionBegin;
22655c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2266883e35e8SHong Zhang 
22678675203cSHong Zhang   if (J) {
2268883e35e8SHong Zhang     vptr                          = network->Jvptr;
22693e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
22703e97b6e8SHong Zhang 
22713e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
22729566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2273883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
22748675203cSHong Zhang   }
22753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2276883e35e8SHong Zhang }
2277883e35e8SHong Zhang 
2278d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2279d71ae5a4SJacob Faibussowitsch {
22805cf7da58SHong Zhang   PetscInt    j;
22815cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
22825cf7da58SHong Zhang 
22835cf7da58SHong Zhang   PetscFunctionBegin;
22845cf7da58SHong Zhang   if (!ghost) {
228548a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22865cf7da58SHong Zhang   } else {
228748a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22885cf7da58SHong Zhang   }
22893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22905cf7da58SHong Zhang }
22915cf7da58SHong Zhang 
2292d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2293d71ae5a4SJacob Faibussowitsch {
22945cf7da58SHong Zhang   PetscInt    j, ncols_u;
22955cf7da58SHong Zhang   PetscScalar val;
22965cf7da58SHong Zhang 
22975cf7da58SHong Zhang   PetscFunctionBegin;
22985cf7da58SHong Zhang   if (!ghost) {
22995cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
23009566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
23015cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
23029566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
23039566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
23045cf7da58SHong Zhang     }
23055cf7da58SHong Zhang   } else {
23065cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
23079566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
23085cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
23099566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
23109566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
23115cf7da58SHong Zhang     }
23125cf7da58SHong Zhang   }
23133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23145cf7da58SHong Zhang }
23155cf7da58SHong Zhang 
2316d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2317d71ae5a4SJacob Faibussowitsch {
23185cf7da58SHong Zhang   PetscFunctionBegin;
23195cf7da58SHong Zhang   if (Ju) {
23209566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
23215cf7da58SHong Zhang   } else {
23229566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
23235cf7da58SHong Zhang   }
23243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23255cf7da58SHong Zhang }
23265cf7da58SHong Zhang 
2327d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2328d71ae5a4SJacob Faibussowitsch {
2329883e35e8SHong Zhang   PetscInt     j, *cols;
2330883e35e8SHong Zhang   PetscScalar *zeros;
2331883e35e8SHong Zhang 
2332883e35e8SHong Zhang   PetscFunctionBegin;
23339566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2334883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
23359566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
23369566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
23373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23381ad426b7SHong Zhang }
2339a4e85ca8SHong Zhang 
2340d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2341d71ae5a4SJacob Faibussowitsch {
23423e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
23433e97b6e8SHong Zhang   const PetscInt *cols;
23443e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
23453e97b6e8SHong Zhang 
23463e97b6e8SHong Zhang   PetscFunctionBegin;
23479566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
234863a3b9bcSJacob 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);
23493e97b6e8SHong Zhang 
23503e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
23519566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
23523e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
23533e97b6e8SHong Zhang       col = cols[j] + cstart;
23549566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
23553e97b6e8SHong Zhang     }
23569566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
23573e97b6e8SHong Zhang   }
23583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23593e97b6e8SHong Zhang }
23601ad426b7SHong Zhang 
2361d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2362d71ae5a4SJacob Faibussowitsch {
2363a4e85ca8SHong Zhang   PetscFunctionBegin;
2364a4e85ca8SHong Zhang   if (Ju) {
23659566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2366a4e85ca8SHong Zhang   } else {
23679566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2368a4e85ca8SHong Zhang   }
23693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2370a4e85ca8SHong Zhang }
2371a4e85ca8SHong Zhang 
237224121865SAdrian 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.
237324121865SAdrian Maldonado */
2374a4e35b19SJacob Faibussowitsch static PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2375d71ae5a4SJacob Faibussowitsch {
237624121865SAdrian Maldonado   PetscInt  i, size, dof;
237724121865SAdrian Maldonado   PetscInt *glob2loc;
237824121865SAdrian Maldonado 
237924121865SAdrian Maldonado   PetscFunctionBegin;
23809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
23819566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
238224121865SAdrian Maldonado 
238324121865SAdrian Maldonado   for (i = 0; i < size; i++) {
23849566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
238524121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
238624121865SAdrian Maldonado     glob2loc[i] = dof;
238724121865SAdrian Maldonado   }
238824121865SAdrian Maldonado 
2389e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)globalsec), 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
239024121865SAdrian Maldonado #if 0
23919566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
239224121865SAdrian Maldonado #endif
23933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
239424121865SAdrian Maldonado }
239524121865SAdrian Maldonado 
239601ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
23979e1d080bSHong Zhang 
2398a4e35b19SJacob Faibussowitsch static PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2399d71ae5a4SJacob Faibussowitsch {
24001ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
240124121865SAdrian Maldonado   PetscInt               eDof, vDof;
240224121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
24039e1d080bSHong Zhang   MPI_Comm               comm;
240424121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
240524121865SAdrian Maldonado 
24069e1d080bSHong Zhang   PetscFunctionBegin;
24079566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
240824121865SAdrian Maldonado 
24099566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
24109566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
241124121865SAdrian Maldonado 
24129566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
24139566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24149566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
241524121865SAdrian Maldonado 
24169566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
24179566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24189566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
241924121865SAdrian Maldonado 
24209566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
24219566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24229566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
242324121865SAdrian Maldonado 
24249566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
24259566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24269566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
242724121865SAdrian Maldonado 
24283f6a6bdaSHong Zhang   bA[0][0] = j11;
24293f6a6bdaSHong Zhang   bA[0][1] = j12;
24303f6a6bdaSHong Zhang   bA[1][0] = j21;
24313f6a6bdaSHong Zhang   bA[1][1] = j22;
243224121865SAdrian Maldonado 
24339566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
24349566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
243524121865SAdrian Maldonado 
24369566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
24379566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
24389566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
24399566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
244024121865SAdrian Maldonado 
24419566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
24429566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
24439566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
24449566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
244524121865SAdrian Maldonado 
24469566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
24479566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
24489566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
24499566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
24509566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
24519566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
24529566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
245324121865SAdrian Maldonado 
24549566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
24559566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
24569566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
245724121865SAdrian Maldonado 
245824121865SAdrian Maldonado   /* Free structures */
24599566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
24609566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
24613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24629e1d080bSHong Zhang }
24639e1d080bSHong Zhang 
2464d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2465d71ae5a4SJacob Faibussowitsch {
24669e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
24679e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
24689e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
24699e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
24709e1d080bSHong Zhang   Mat             Juser;
24719e1d080bSHong Zhang   PetscSection    sectionGlobal;
24729e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
24739e1d080bSHong Zhang   const PetscInt *edges, *cone;
24749e1d080bSHong Zhang   MPI_Comm        comm;
24759e1d080bSHong Zhang   MatType         mtype;
24769e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
24779e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
24789e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
24799e1d080bSHong Zhang 
24809e1d080bSHong Zhang   PetscFunctionBegin;
24819e1d080bSHong Zhang   mtype = dm->mattype;
24829566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
24839e1d080bSHong Zhang   if (isNest) {
24849566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
24859566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24863ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24879e1d080bSHong Zhang   }
24889e1d080bSHong Zhang 
24899e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2490a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
24919566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
24929566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24933ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24941ad426b7SHong Zhang   }
24951ad426b7SHong Zhang 
24969566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
24979566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
24989566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
24999566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
25002a945128SHong Zhang 
25019566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
25029566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
250389898e50SHong Zhang 
250489898e50SHong Zhang   /* (1) Set matrix preallocation */
250589898e50SHong Zhang   /*------------------------------*/
25069566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
25079566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
25089566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
25099566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
25109566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
25119566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2512840c2264SHong Zhang 
251389898e50SHong Zhang   /* Set preallocation for edges */
251489898e50SHong Zhang   /*-----------------------------*/
25159566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2516840c2264SHong Zhang 
25179566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2518840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2519840c2264SHong Zhang     /* Get row indices */
25209566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
25219566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2522840c2264SHong Zhang     if (nrows) {
2523840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2524840c2264SHong Zhang 
2525a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
25269566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2527840c2264SHong Zhang       for (v = 0; v < 2; v++) {
25289566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2529840c2264SHong Zhang 
25308675203cSHong Zhang         if (network->Je) {
2531840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
25328675203cSHong Zhang         } else Juser = NULL;
25339566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
25349566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2535840c2264SHong Zhang       }
2536840c2264SHong Zhang 
253789898e50SHong Zhang       /* Set preallocation for edge self */
2538840c2264SHong Zhang       cstart = rstart;
25398675203cSHong Zhang       if (network->Je) {
2540840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25418675203cSHong Zhang       } else Juser = NULL;
25429566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2543840c2264SHong Zhang     }
2544840c2264SHong Zhang   }
2545840c2264SHong Zhang 
254689898e50SHong Zhang   /* Set preallocation for vertices */
254789898e50SHong Zhang   /*--------------------------------*/
25489566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
25498675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2550840c2264SHong Zhang 
2551840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2552840c2264SHong Zhang     /* Get row indices */
25539566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25549566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2555840c2264SHong Zhang     if (!nrows) continue;
2556840c2264SHong Zhang 
25579566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2558bdcb62a2SHong Zhang     if (ghost) {
25599566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2560bdcb62a2SHong Zhang     } else {
2561bdcb62a2SHong Zhang       rows_v = rows;
2562bdcb62a2SHong Zhang     }
2563bdcb62a2SHong Zhang 
2564bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2565840c2264SHong Zhang 
2566840c2264SHong Zhang     /* Get supporting edges and connected vertices */
25679566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2568840c2264SHong Zhang 
2569840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2570840c2264SHong Zhang       /* Supporting edges */
25719566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25729566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2573840c2264SHong Zhang 
25748675203cSHong Zhang       if (network->Jv) {
2575840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25768675203cSHong Zhang       } else Juser = NULL;
25779566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2578840c2264SHong Zhang 
2579840c2264SHong Zhang       /* Connected vertices */
25809566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2581840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25829566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2583840c2264SHong Zhang 
25849566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2585840c2264SHong Zhang 
25868675203cSHong Zhang       if (network->Jv) {
2587840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25888675203cSHong Zhang       } else Juser = NULL;
2589e102a522SHong Zhang       if (ghost_vc || ghost) {
2590e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2591e102a522SHong Zhang       } else {
2592e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2593e102a522SHong Zhang       }
25949566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2595840c2264SHong Zhang     }
2596840c2264SHong Zhang 
259789898e50SHong Zhang     /* Set preallocation for vertex self */
25989566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2599840c2264SHong Zhang     if (!ghost) {
26009566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
26018675203cSHong Zhang       if (network->Jv) {
2602840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
26038675203cSHong Zhang       } else Juser = NULL;
26049566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2605840c2264SHong Zhang     }
26061baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2607840c2264SHong Zhang   }
2608840c2264SHong Zhang 
26099566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
26109566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
26115cf7da58SHong Zhang 
26129566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
26135cf7da58SHong Zhang 
26149566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
26159566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2616840c2264SHong Zhang 
26179566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
26189566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2619840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2620e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2621e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2622840c2264SHong Zhang   }
26239566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
26249566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
26259566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
26269566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2627840c2264SHong Zhang 
26289566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
26299566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
26309566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
26315cf7da58SHong Zhang 
26329566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
26335cf7da58SHong Zhang 
263489898e50SHong Zhang   /* (2) Set matrix entries for edges */
263589898e50SHong Zhang   /*----------------------------------*/
26361ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2637bfbc38dcSHong Zhang     /* Get row indices */
26389566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
26399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
26404b976069SHong Zhang     if (nrows) {
264117df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
26421ad426b7SHong Zhang 
2643a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
26449566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2645bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
26469566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
26479566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
26483e97b6e8SHong Zhang 
26498675203cSHong Zhang         if (network->Je) {
2650a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
26518675203cSHong Zhang         } else Juser = NULL;
26529566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2653bfbc38dcSHong Zhang       }
265417df6e9eSHong Zhang 
2655bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
26563e97b6e8SHong Zhang       cstart = rstart;
26578675203cSHong Zhang       if (network->Je) {
2658a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
26598675203cSHong Zhang       } else Juser = NULL;
26609566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
26611ad426b7SHong Zhang     }
26624b976069SHong Zhang   }
26631ad426b7SHong Zhang 
2664bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
266583b2e829SHong Zhang   /*---------------------------------*/
26661ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2667bfbc38dcSHong Zhang     /* Get row indices */
26689566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
26699566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
26704b976069SHong Zhang     if (!nrows) continue;
2671596e729fSHong Zhang 
26729566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2673bdcb62a2SHong Zhang     if (ghost) {
26749566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2675bdcb62a2SHong Zhang     } else {
2676bdcb62a2SHong Zhang       rows_v = rows;
2677bdcb62a2SHong Zhang     }
2678bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2679596e729fSHong Zhang 
2680bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
26819566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2682596e729fSHong Zhang 
2683596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2684bfbc38dcSHong Zhang       /* Supporting edges */
26859566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
26869566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2687596e729fSHong Zhang 
26888675203cSHong Zhang       if (network->Jv) {
2689a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
26908675203cSHong Zhang       } else Juser = NULL;
26919566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2692596e729fSHong Zhang 
2693bfbc38dcSHong Zhang       /* Connected vertices */
26949566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
26952a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
26962a945128SHong Zhang 
26979566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
26989566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2699a4e85ca8SHong Zhang 
27008675203cSHong Zhang       if (network->Jv) {
2701a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
27028675203cSHong Zhang       } else Juser = NULL;
27039566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2704596e729fSHong Zhang     }
2705596e729fSHong Zhang 
2706bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
27071ad426b7SHong Zhang     if (!ghost) {
27089566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
27098675203cSHong Zhang       if (network->Jv) {
2710a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
27118675203cSHong Zhang       } else Juser = NULL;
27129566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2713bdcb62a2SHong Zhang     }
27141baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
27151ad426b7SHong Zhang   }
27169566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2717bdcb62a2SHong Zhang 
27189566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
27199566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2720dd6f46cdSHong Zhang 
27219566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
27223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27235f2c45f1SShri Abhyankar }
27245f2c45f1SShri Abhyankar 
2725d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2726d71ae5a4SJacob Faibussowitsch {
2727daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2728daad07d3SAidan Hamilton   PetscInt    j, np;
2729daad07d3SAidan Hamilton 
2730daad07d3SAidan Hamilton   PetscFunctionBegin;
2731daad07d3SAidan Hamilton   if (network->header) {
2732daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2733daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2734daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2735daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2736daad07d3SAidan Hamilton     }
2737daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2738daad07d3SAidan Hamilton   }
27393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2740daad07d3SAidan Hamilton }
2741daad07d3SAidan Hamilton 
2742d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2743d71ae5a4SJacob Faibussowitsch {
27445f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2745aeb78aa7SBarry Smith   PetscInt    j;
27465f2c45f1SShri Abhyankar 
27475f2c45f1SShri Abhyankar   PetscFunctionBegin;
2748daad07d3SAidan Hamilton   /*
2749b5e6e808SPierre Jolivet     Developer Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2750daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2751daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2752daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2753daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2754daad07d3SAidan Hamilton   */
2755daad07d3SAidan Hamilton 
2756daad07d3SAidan Hamilton   /* Always destroy data ON the network */
27579566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
275883b2e829SHong Zhang   if (network->Jv) {
27599566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
27609566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
27611ad426b7SHong Zhang   }
2762daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2763daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2764daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2765daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2766daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
276713c2a604SAdrian Maldonado 
2768daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2769daad07d3SAidan Hamilton 
2770daad07d3SAidan Hamilton   /*
2771b5e6e808SPierre Jolivet   Developer Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2772daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2773daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2774daad07d3SAidan Hamilton     PetscSF                           sf;
2775daad07d3SAidan Hamilton   and data ON the network
2776daad07d3SAidan Hamilton     PetscSection                      DofSection;
2777daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2778daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2779daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2780daad07d3SAidan Hamilton   for any clone.
2781daad07d3SAidan Hamilton   */
27829566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
27839566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
27849566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
27859566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
278613c2a604SAdrian Maldonado   /* edge */
27879566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
27889566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
27899566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
27909566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
27915f25b224SDuncan Campbell   /* viewer options */
27925f25b224SDuncan Campbell   PetscCall(ISDestroy(&network->vieweroptions.viewranks));
2793daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2794daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2795daad07d3SAidan 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
2796daad07d3SAidan Hamilton      naively think it can be reused. */
2797daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2798daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2799daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2800daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2801eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(&network->cloneshared->svtable));
2802daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2803daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2804daad07d3SAidan Hamilton   }
2805daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
28063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28075f2c45f1SShri Abhyankar }
28085f2c45f1SShri Abhyankar 
2809d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2810d71ae5a4SJacob Faibussowitsch {
28115f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28125f2c45f1SShri Abhyankar 
28135f2c45f1SShri Abhyankar   PetscFunctionBegin;
28149566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
28153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28165f2c45f1SShri Abhyankar }
28175f2c45f1SShri Abhyankar 
2818d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2819d71ae5a4SJacob Faibussowitsch {
28205f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28215f2c45f1SShri Abhyankar 
28225f2c45f1SShri Abhyankar   PetscFunctionBegin;
28239566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
28243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28255f2c45f1SShri Abhyankar }
28265f2c45f1SShri Abhyankar 
2827d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2828d71ae5a4SJacob Faibussowitsch {
28295f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28305f2c45f1SShri Abhyankar 
28315f2c45f1SShri Abhyankar   PetscFunctionBegin;
28329566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
28333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28345f2c45f1SShri Abhyankar }
28355f2c45f1SShri Abhyankar 
2836d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2837d71ae5a4SJacob Faibussowitsch {
28385f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28395f2c45f1SShri Abhyankar 
28405f2c45f1SShri Abhyankar   PetscFunctionBegin;
28419566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
28423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28435f2c45f1SShri Abhyankar }
284422bbedd7SHong Zhang 
284522bbedd7SHong Zhang /*@
284664238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
284722bbedd7SHong Zhang 
284820f4b53cSBarry Smith   Not Collective
284922bbedd7SHong Zhang 
28507a7aea1fSJed Brown   Input Parameters:
285120f4b53cSBarry Smith + dm   - the `DMNETWORK` object
285222bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
285322bbedd7SHong Zhang 
28542fe279fdSBarry Smith   Output Parameter:
2855f0fc11ceSJed Brown . vg - global vertex ordering, start from 0
285622bbedd7SHong Zhang 
285797bb938eSShri Abhyankar   Level: advanced
285822bbedd7SHong Zhang 
285920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetVertexLocalToGlobalOrdering()`
286022bbedd7SHong Zhang @*/
2861d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2862d71ae5a4SJacob Faibussowitsch {
286322bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2864daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
286522bbedd7SHong Zhang 
286622bbedd7SHong Zhang   PetscFunctionBegin;
28675c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
286822bbedd7SHong Zhang   *vg = vltog[vloc];
28693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
287022bbedd7SHong Zhang }
287122bbedd7SHong Zhang 
287222bbedd7SHong Zhang /*@
287364238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
287422bbedd7SHong Zhang 
287522bbedd7SHong Zhang   Collective
287622bbedd7SHong Zhang 
287722bbedd7SHong Zhang   Input Parameters:
287820f4b53cSBarry Smith . dm - the `DMNETWORK` object
287922bbedd7SHong Zhang 
288097bb938eSShri Abhyankar   Level: advanced
288122bbedd7SHong Zhang 
288220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
288322bbedd7SHong Zhang @*/
2884d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2885d71ae5a4SJacob Faibussowitsch {
288622bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
288722bbedd7SHong Zhang   MPI_Comm           comm;
28882bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
288922bbedd7SHong Zhang   PetscBool          ghost;
28906497c311SBarry Smith   PetscInt          *vltog, nroots, nleaves, *vrange, k, N, lidx, ii;
289122bbedd7SHong Zhang   const PetscSFNode *iremote;
289222bbedd7SHong Zhang   PetscSF            vsf;
289363029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
289463029d29SHong Zhang   VecScatter         ctx;
289563029d29SHong Zhang   PetscScalar       *varr, val;
289663029d29SHong Zhang   const PetscScalar *varr_read;
289722bbedd7SHong Zhang 
289822bbedd7SHong Zhang   PetscFunctionBegin;
28999566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
29009566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
29019566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
290222bbedd7SHong Zhang 
290322bbedd7SHong Zhang   if (size == 1) {
2904daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
29059566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
29066497c311SBarry Smith     for (PetscInt i = 0; i < nroots; i++) vltog[i] = i;
2907daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
29083ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
290922bbedd7SHong Zhang   }
291022bbedd7SHong Zhang 
2911daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2912daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
291322bbedd7SHong Zhang 
2914e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
29159566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
291622bbedd7SHong Zhang   vsf = network->vertex.sf;
291722bbedd7SHong Zhang 
29189566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
29199566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
292022bbedd7SHong Zhang 
29216497c311SBarry Smith   for (PetscMPIInt i = 0; i < size; i++) {
29229371c9d4SSatish Balay     displs[i]     = i;
29239371c9d4SSatish Balay     recvcounts[i] = 1;
29249371c9d4SSatish Balay   }
292522bbedd7SHong Zhang 
29266497c311SBarry Smith   ii        = nroots - nleaves; /* local number of vertices, excluding ghosts */
292722bbedd7SHong Zhang   vrange[0] = 0;
29286497c311SBarry Smith   PetscCallMPI(MPI_Allgatherv(&ii, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
29296497c311SBarry Smith   for (PetscMPIInt i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
293022bbedd7SHong Zhang 
29319566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2932daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
293322bbedd7SHong Zhang 
293463029d29SHong Zhang   /* Set vltog for non-ghost vertices */
293563029d29SHong Zhang   k = 0;
29366497c311SBarry Smith   for (PetscInt i = 0; i < nroots; i++) {
2937daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
293863029d29SHong Zhang     if (ghost) continue;
293963029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
294022bbedd7SHong Zhang   }
29419566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
294263029d29SHong Zhang 
294363029d29SHong Zhang   /* Set vltog for ghost vertices */
294463029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
29459566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
29469566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
29479566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
29489566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
29496497c311SBarry Smith   for (PetscInt i = 0; i < nleaves; i++) {
2950f4f49eeaSPierre Jolivet     varr[2 * i]     = (PetscScalar)iremote[i].rank;  /* rank of remote process */
2951f4f49eeaSPierre Jolivet     varr[2 * i + 1] = (PetscScalar)iremote[i].index; /* local index in remote process */
295263029d29SHong Zhang   }
29539566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
295463029d29SHong Zhang 
295563029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
29569566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
29579566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
29589566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
295963029d29SHong Zhang 
296063029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
29619566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
29629566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
29636497c311SBarry Smith   for (PetscInt i = 0; i < N; i += 2) {
29642e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
296563029d29SHong Zhang     if (remoterank == rank) {
296663029d29SHong Zhang       k    = i + 1; /* row number */
29672e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
296863029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
29699566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
297063029d29SHong Zhang     }
297163029d29SHong Zhang   }
29729566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
29739566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
29749566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
297563029d29SHong Zhang 
297663029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
29779566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
297863029d29SHong Zhang   k = 0;
29796497c311SBarry Smith   for (PetscInt i = 0; i < nroots; i++) {
2980daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
298163029d29SHong Zhang     if (!ghost) continue;
29829371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
29839371c9d4SSatish Balay     k++;
298463029d29SHong Zhang   }
29859566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
298663029d29SHong Zhang 
29879566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
29889566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
29899566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
29903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
299122bbedd7SHong Zhang }
299242dc13f1SHong Zhang 
2993d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2994d71ae5a4SJacob Faibussowitsch {
299542dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
299642dc13f1SHong Zhang   DMNetworkComponentHeader header;
299742dc13f1SHong Zhang 
299842dc13f1SHong Zhang   PetscFunctionBegin;
29999566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
300042dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
300142dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
300242dc13f1SHong Zhang 
300342dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
300442dc13f1SHong Zhang     key  = header->key[i];
300542dc13f1SHong Zhang     nvar = header->nvar[i];
300642dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
300742dc13f1SHong Zhang       if (key == keys[j]) {
300842dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
300942dc13f1SHong Zhang           *nidx += nvar;
301042dc13f1SHong Zhang         } else {
301142dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
301242dc13f1SHong Zhang         }
301342dc13f1SHong Zhang       }
301442dc13f1SHong Zhang     }
301542dc13f1SHong Zhang   }
30163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
301742dc13f1SHong Zhang }
301842dc13f1SHong Zhang 
3019d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3020d71ae5a4SJacob Faibussowitsch {
302142dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
302242dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
302342dc13f1SHong Zhang   DMNetworkComponentHeader header;
302442dc13f1SHong Zhang 
302542dc13f1SHong Zhang   PetscFunctionBegin;
30269566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
302742dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
302842dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
302942dc13f1SHong Zhang 
303042dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
303142dc13f1SHong Zhang     key  = header->key[i];
303242dc13f1SHong Zhang     nvar = header->nvar[i];
303342dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
303442dc13f1SHong Zhang       if (key != keys[j]) continue;
303542dc13f1SHong Zhang 
30369566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
303742dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
303842dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
303942dc13f1SHong Zhang       } else {
304042dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
304142dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
304242dc13f1SHong Zhang         }
304342dc13f1SHong Zhang       }
304442dc13f1SHong Zhang     }
304542dc13f1SHong Zhang   }
30463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
304742dc13f1SHong Zhang }
304842dc13f1SHong Zhang 
304942dc13f1SHong Zhang /*@
305042dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
305142dc13f1SHong Zhang 
305242dc13f1SHong Zhang   Collective
305342dc13f1SHong Zhang 
305442dc13f1SHong Zhang   Input Parameters:
305520f4b53cSBarry Smith + dm           - `DMNETWORK` object
305642dc13f1SHong Zhang . numkeys      - number of keys
305742dc13f1SHong Zhang . keys         - array of keys that define the components of the variables you wish to extract
305842dc13f1SHong Zhang . blocksize    - block size of the variables associated to the component
305942dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
306042dc13f1SHong Zhang - selectedvar  - the offset into the block of each variable in each block to select
306142dc13f1SHong Zhang 
30622fe279fdSBarry Smith   Output Parameter:
306342dc13f1SHong Zhang . is - the index set
306442dc13f1SHong Zhang 
306520f4b53cSBarry Smith   Level: advanced
306642dc13f1SHong Zhang 
306742dc13f1SHong Zhang   Notes:
306820f4b53cSBarry 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.
306942dc13f1SHong Zhang 
307020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
307142dc13f1SHong Zhang @*/
3072d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3073d71ae5a4SJacob Faibussowitsch {
307442dc13f1SHong Zhang   MPI_Comm    comm;
307542dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
307642dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
307742dc13f1SHong Zhang   PetscBool   ghost;
307842dc13f1SHong Zhang 
307942dc13f1SHong Zhang   PetscFunctionBegin;
30809566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
308142dc13f1SHong Zhang 
308242dc13f1SHong Zhang   /* Check input parameters */
308342dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
308442dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
308563a3b9bcSJacob 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]);
308642dc13f1SHong Zhang   }
308742dc13f1SHong Zhang 
30889566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
30899566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
309042dc13f1SHong Zhang 
309142dc13f1SHong Zhang   /* Get local number of idx */
309242dc13f1SHong Zhang   nidx = 0;
309348a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
309442dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30959566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
309642dc13f1SHong Zhang     if (ghost) continue;
30979566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
309842dc13f1SHong Zhang   }
309942dc13f1SHong Zhang 
310042dc13f1SHong Zhang   /* Compute idx */
31019566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
310242dc13f1SHong Zhang   i = 0;
310348a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
310442dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
31059566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
310642dc13f1SHong Zhang     if (ghost) continue;
31079566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
310842dc13f1SHong Zhang   }
310942dc13f1SHong Zhang 
311042dc13f1SHong Zhang   /* Create is */
31119566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
31129566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
311442dc13f1SHong Zhang }
311542dc13f1SHong Zhang 
3116d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3117d71ae5a4SJacob Faibussowitsch {
311842dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
311942dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
312042dc13f1SHong Zhang   DMNetworkComponentHeader header;
312142dc13f1SHong Zhang 
312242dc13f1SHong Zhang   PetscFunctionBegin;
31239566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
312442dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
312542dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
312642dc13f1SHong Zhang 
312742dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
312842dc13f1SHong Zhang     key  = header->key[i];
312942dc13f1SHong Zhang     nvar = header->nvar[i];
313042dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
313142dc13f1SHong Zhang       if (key != keys[j]) continue;
313242dc13f1SHong Zhang 
31339566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
313442dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
313542dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
313642dc13f1SHong Zhang       } else {
313742dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
313842dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
313942dc13f1SHong Zhang         }
314042dc13f1SHong Zhang       }
314142dc13f1SHong Zhang     }
314242dc13f1SHong Zhang   }
31433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
314442dc13f1SHong Zhang }
314542dc13f1SHong Zhang 
314642dc13f1SHong Zhang /*@
314742dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
314842dc13f1SHong Zhang 
314920f4b53cSBarry Smith   Not Collective
315042dc13f1SHong Zhang 
315142dc13f1SHong Zhang   Input Parameters:
315220f4b53cSBarry Smith + dm           - `DMNETWORK` object
315342dc13f1SHong Zhang . numkeys      - number of keys
315442dc13f1SHong Zhang . keys         - array of keys that define the components of the variables you wish to extract
315542dc13f1SHong Zhang . blocksize    - block size of the variables associated to the component
315642dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
315742dc13f1SHong Zhang - selectedvar  - the offset into the block of each variable in each block to select
315842dc13f1SHong Zhang 
31592fe279fdSBarry Smith   Output Parameter:
316042dc13f1SHong Zhang . is - the index set
316142dc13f1SHong Zhang 
316220f4b53cSBarry Smith   Level: advanced
316342dc13f1SHong Zhang 
316442dc13f1SHong Zhang   Notes:
316520f4b53cSBarry 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.
316642dc13f1SHong Zhang 
31675f25b224SDuncan Campbell .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkCreateIS()`, `ISCreateGeneral()`
316842dc13f1SHong Zhang @*/
3169d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3170d71ae5a4SJacob Faibussowitsch {
317142dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
317242dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
317342dc13f1SHong Zhang 
317442dc13f1SHong Zhang   PetscFunctionBegin;
317542dc13f1SHong Zhang   /* Check input parameters */
317642dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
317742dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
317863a3b9bcSJacob 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]);
317942dc13f1SHong Zhang   }
318042dc13f1SHong Zhang 
3181daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3182daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
318342dc13f1SHong Zhang 
318442dc13f1SHong Zhang   /* Get local number of idx */
318542dc13f1SHong Zhang   nidx = 0;
318648a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
318742dc13f1SHong Zhang 
318842dc13f1SHong Zhang   /* Compute local idx */
31899566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
319042dc13f1SHong Zhang   i = 0;
319148a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
319242dc13f1SHong Zhang 
319342dc13f1SHong Zhang   /* Create is */
31949566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31959566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
319742dc13f1SHong Zhang }
3198daad07d3SAidan Hamilton /*@
3199d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3200daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3201daad07d3SAidan Hamilton 
3202daad07d3SAidan Hamilton   Collective
3203daad07d3SAidan Hamilton 
32042fe279fdSBarry Smith   Input Parameter:
320520f4b53cSBarry Smith . dm - the `DMNETWORK` object
3206daad07d3SAidan Hamilton 
3207daad07d3SAidan Hamilton   Level: beginner
3208daad07d3SAidan Hamilton 
320920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3210daad07d3SAidan Hamilton @*/
3211d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3212d71ae5a4SJacob Faibussowitsch {
3213daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3214daad07d3SAidan Hamilton 
3215daad07d3SAidan Hamilton   PetscFunctionBegin;
32163ba16761SJacob Faibussowitsch   if (network->componentsetup) PetscFunctionReturn(PETSC_SUCCESS);
3217daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3218daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3219daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3220daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3221daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
32223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3223daad07d3SAidan Hamilton }
3224