xref: /petsc/src/dm/impls/network/network.c (revision 48a46eb9bd028bec07ec0f396b1a3abb43f14558)
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 */
109371c9d4SSatish Balay static PetscErrorCode SetUpNetworkHeaderComponentValue(DM dm, DMNetworkComponentHeader header, DMNetworkComponentValue cvalue) {
1154dfd506SHong Zhang   PetscFunctionBegin;
1254dfd506SHong Zhang   /* Allocate arrays for component information */
139566063dSJacob Faibussowitsch   PetscCall(PetscCalloc5(header->maxcomps, &header->size, header->maxcomps, &header->key, header->maxcomps, &header->offset, header->maxcomps, &header->nvar, header->maxcomps, &header->offsetvarrel));
149566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(header->maxcomps, &cvalue->data));
1554dfd506SHong Zhang 
1654dfd506SHong 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.
1754dfd506SHong Zhang    If the data header struct changes then this header size calculation needs to be updated. */
1854dfd506SHong Zhang   header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
1954dfd506SHong Zhang   header->hsize /= sizeof(DMNetworkComponentGenericDataType);
2054dfd506SHong Zhang   PetscFunctionReturn(0);
2154dfd506SHong Zhang }
2254dfd506SHong Zhang 
239371c9d4SSatish Balay PetscErrorCode DMNetworkInitializeHeaderComponentData(DM dm) {
24daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
25daad07d3SAidan Hamilton   PetscInt    np, p, defaultnumcomp = DMNETWORK_MAX_COMP_AT_POINT_DEFAULT;
26daad07d3SAidan Hamilton 
27daad07d3SAidan Hamilton   PetscFunctionBegin;
28daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
29daad07d3SAidan Hamilton   if (network->header)
30daad07d3SAidan Hamilton     for (p = 0; p < np; p++) {
31daad07d3SAidan Hamilton       network->header[p].maxcomps = defaultnumcomp;
32daad07d3SAidan Hamilton       PetscCall(SetUpNetworkHeaderComponentValue(dm, &network->header[p], &network->cvalue[p]));
33daad07d3SAidan Hamilton     }
34daad07d3SAidan Hamilton 
35daad07d3SAidan Hamilton   PetscFunctionReturn(0);
36daad07d3SAidan Hamilton }
375f2c45f1SShri Abhyankar /*@
38556ed216SShri Abhyankar   DMNetworkGetPlex - Gets the Plex DM associated with this network DM
39556ed216SShri Abhyankar 
40556ed216SShri Abhyankar   Not collective
41556ed216SShri Abhyankar 
42556ed216SShri Abhyankar   Input Parameters:
432bf73ac6SHong Zhang . dm - the dm object
442bf73ac6SHong Zhang 
452bf73ac6SHong Zhang   Output Parameters:
462bf73ac6SHong Zhang . plexdm - the plex dm object
47556ed216SShri Abhyankar 
48556ed216SShri Abhyankar   Level: Advanced
49556ed216SShri Abhyankar 
50db781477SPatrick Sanan .seealso: `DMNetworkCreate()`
51556ed216SShri Abhyankar @*/
529371c9d4SSatish Balay PetscErrorCode DMNetworkGetPlex(DM dm, DM *plexdm) {
532bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
54556ed216SShri Abhyankar 
55556ed216SShri Abhyankar   PetscFunctionBegin;
56556ed216SShri Abhyankar   *plexdm = network->plex;
57556ed216SShri Abhyankar   PetscFunctionReturn(0);
58556ed216SShri Abhyankar }
59556ed216SShri Abhyankar 
60556ed216SShri Abhyankar /*@
612bf73ac6SHong Zhang   DMNetworkGetNumSubNetworks - Gets the the number of subnetworks
6272c3e9f7SHong Zhang 
632bf73ac6SHong Zhang   Not collective
6472c3e9f7SHong Zhang 
65f899ff85SJose E. Roman   Input Parameter:
662bf73ac6SHong Zhang . dm - the dm object
672bf73ac6SHong Zhang 
682bf73ac6SHong Zhang   Output Parameters:
692bf73ac6SHong Zhang + nsubnet - local number of subnetworks
702bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
7172c3e9f7SHong Zhang 
7297bb938eSShri Abhyankar   Level: beginner
7372c3e9f7SHong Zhang 
74db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
7572c3e9f7SHong Zhang @*/
769371c9d4SSatish Balay PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PetscInt *nsubnet, PetscInt *Nsubnet) {
772bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
7872c3e9f7SHong Zhang 
7972c3e9f7SHong Zhang   PetscFunctionBegin;
80daad07d3SAidan Hamilton   if (nsubnet) *nsubnet = network->cloneshared->nsubnet;
81daad07d3SAidan Hamilton   if (Nsubnet) *Nsubnet = network->cloneshared->Nsubnet;
8272c3e9f7SHong Zhang   PetscFunctionReturn(0);
8372c3e9f7SHong Zhang }
8472c3e9f7SHong Zhang 
8572c3e9f7SHong Zhang /*@
862bf73ac6SHong Zhang   DMNetworkSetNumSubNetworks - Sets the number of subnetworks
875f2c45f1SShri Abhyankar 
88d083f849SBarry Smith   Collective on dm
895f2c45f1SShri Abhyankar 
905f2c45f1SShri Abhyankar   Input Parameters:
915f2c45f1SShri Abhyankar + dm - the dm object
922bf73ac6SHong Zhang . nsubnet - local number of subnetworks
932bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
945f2c45f1SShri Abhyankar 
9597bb938eSShri Abhyankar    Level: beginner
961b266c99SBarry Smith 
97db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetNumSubNetworks()`
985f2c45f1SShri Abhyankar @*/
999371c9d4SSatish Balay PetscErrorCode DMNetworkSetNumSubNetworks(DM dm, PetscInt nsubnet, PetscInt Nsubnet) {
1005f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1015f2c45f1SShri Abhyankar 
1025f2c45f1SShri Abhyankar   PetscFunctionBegin;
103daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->Nsubnet == 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Network sizes alread set, cannot resize the network");
1042bf73ac6SHong Zhang 
1055f2c45f1SShri Abhyankar   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1062bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, nsubnet, 2);
1072bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, Nsubnet, 3);
1087765340cSHong Zhang 
1092bf73ac6SHong Zhang   if (Nsubnet == PETSC_DECIDE) {
1105c6496baSHong Zhang     PetscCheck(nsubnet >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Number of local subnetworks %" PetscInt_FMT " cannot be less than 0", nsubnet);
1111c2dc1cbSBarry Smith     PetscCall(MPIU_Allreduce(&nsubnet, &Nsubnet, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
112caf410d2SHong Zhang   }
1135c6496baSHong Zhang   PetscCheck(Nsubnet >= 1, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Number of global subnetworks %" PetscInt_FMT " cannot be less than 1", Nsubnet);
114caf410d2SHong Zhang 
115daad07d3SAidan Hamilton   network->cloneshared->Nsubnet = Nsubnet;
116daad07d3SAidan Hamilton   network->cloneshared->nsubnet = 0; /* initial value; will be determind by DMNetworkAddSubnetwork() */
117daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(Nsubnet, &network->cloneshared->subnet));
118caf410d2SHong Zhang 
1192bf73ac6SHong Zhang   /* num of shared vertices */
120daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0;
121daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = 0;
1227765340cSHong Zhang   PetscFunctionReturn(0);
1237765340cSHong Zhang }
1247765340cSHong Zhang 
1255f2c45f1SShri Abhyankar /*@
1262bf73ac6SHong Zhang   DMNetworkAddSubnetwork - Add a subnetwork
1275f2c45f1SShri Abhyankar 
1282bf73ac6SHong Zhang   Collective on dm
1295f2c45f1SShri Abhyankar 
1305f2c45f1SShri Abhyankar   Input Parameters:
131e3e68989SHong Zhang + dm - the dm object
1322bf73ac6SHong Zhang . name - name of the subnetwork
1332bf73ac6SHong Zhang . ne - number of local edges of this subnetwork
1348d1cd658SBarry 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 of the vertices) of each edge,
1358d1cd658SBarry Smith $            [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc]
1362bf73ac6SHong Zhang 
1372bf73ac6SHong Zhang   Output Parameters:
1382bf73ac6SHong Zhang . netnum - global index of the subnetwork
1395f2c45f1SShri Abhyankar 
1405f2c45f1SShri Abhyankar   Notes:
1415f2c45f1SShri Abhyankar   There is no copy involved in this operation, only the pointer is referenced. The edgelist should
1422bf73ac6SHong Zhang   not be destroyed before the call to DMNetworkLayoutSetUp()
1435f2c45f1SShri Abhyankar 
1448d1cd658SBarry 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. For a multiple subnetworks,
1458d1cd658SBarry Smith   each subnetwork topology needs to be set on a unique rank and the communicator size needs to be at least equal to the number of subnetworks.
146f11a936eSBarry Smith 
14797bb938eSShri Abhyankar   Level: beginner
1485f2c45f1SShri Abhyankar 
149e3e68989SHong Zhang   Example usage:
150f11a936eSBarry Smith   Consider the following networks:
151f11a936eSBarry Smith   1) A sigle subnetwork:
152e3e68989SHong Zhang .vb
153f11a936eSBarry Smith  network 0:
154f11a936eSBarry Smith  rank[0]:
155f11a936eSBarry Smith    v0 --> v2; v1 --> v2
156f11a936eSBarry Smith  rank[1]:
157f11a936eSBarry Smith    v3 --> v5; v4 --> v5
158e3e68989SHong Zhang .ve
159e3e68989SHong Zhang 
160e3e68989SHong Zhang  The resulting input
161f11a936eSBarry Smith  network 0:
162f11a936eSBarry Smith  rank[0]:
163f11a936eSBarry Smith    ne = 2
164f11a936eSBarry Smith    edgelist = [0 2 | 1 2]
165f11a936eSBarry Smith  rank[1]:
166f11a936eSBarry Smith    ne = 2
167f11a936eSBarry Smith    edgelist = [3 5 | 4 5]
168f11a936eSBarry Smith 
169f11a936eSBarry Smith   2) Two subnetworks:
170f11a936eSBarry Smith .vb
171f11a936eSBarry Smith  subnetwork 0:
172f11a936eSBarry Smith  rank[0]:
173f11a936eSBarry Smith    v0 --> v2; v2 --> v1; v1 --> v3;
174f11a936eSBarry Smith  subnetwork 1:
175f11a936eSBarry Smith  rank[1]:
176f11a936eSBarry Smith    v0 --> v3; v3 --> v2; v2 --> v1;
177f11a936eSBarry Smith .ve
178f11a936eSBarry Smith 
179f11a936eSBarry Smith  The resulting input
180f11a936eSBarry Smith  subnetwork 0:
181f11a936eSBarry Smith  rank[0]:
182f11a936eSBarry Smith    ne = 3
183f11a936eSBarry Smith    edgelist = [0 2 | 2 1 | 1 3]
184f11a936eSBarry Smith  rank[1]:
185f11a936eSBarry Smith    ne = 0
186f11a936eSBarry Smith    edgelist = NULL
187f11a936eSBarry Smith 
188f11a936eSBarry Smith  subnetwork 1:
189f11a936eSBarry Smith  rank[0]:
190f11a936eSBarry Smith    ne = 0
191f11a936eSBarry Smith    edgelist = NULL
192f11a936eSBarry Smith  rank[1]:
193f11a936eSBarry Smith    edgelist = [0 3 | 3 2 | 2 1]
194e3e68989SHong Zhang 
195db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
1965f2c45f1SShri Abhyankar @*/
1979371c9d4SSatish Balay PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum) {
1985f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1995c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
200f11a936eSBarry Smith   PetscBT     table;
2015f2c45f1SShri Abhyankar 
2025f2c45f1SShri Abhyankar   PetscFunctionBegin;
2039371c9d4SSatish Balay   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]); }
204f11a936eSBarry Smith 
2055c6496baSHong Zhang   i = 0;
2065c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2075c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2085c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2095c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2105c6496baSHong Zhang     i++;
2115c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2125c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2135c6496baSHong Zhang     i++;
2145c6496baSHong Zhang   }
2155c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2165c6496baSHong Zhang 
2175c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2189566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2199566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
220f11a936eSBarry Smith   i = 0;
221f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2229566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2239566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
224f11a936eSBarry Smith   }
225f11a936eSBarry Smith   nvtx = 0;
226f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
227f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
228f11a936eSBarry Smith   }
2295c6496baSHong Zhang 
2305c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
2311c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2325c6496baSHong Zhang   Nvtx++;
2339566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
234f11a936eSBarry Smith 
235f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
2361c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
237f11a936eSBarry Smith 
238daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
239*48a46eb9SPierre Jolivet   if (name) PetscCall(PetscStrcpy(network->cloneshared->subnet[i].name, name));
240daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
241daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
242daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
243daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
244daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2452bf73ac6SHong Zhang 
2462bf73ac6SHong Zhang   /* ----------------------------------------------------------
2472bf73ac6SHong Zhang    p=v or e;
2482bf73ac6SHong Zhang    subnet[0].pStart   = 0
2492bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2502bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2512bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
252daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
253daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2542bf73ac6SHong Zhang 
255daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
256daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2572bf73ac6SHong Zhang 
2582bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
259daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
260daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
261daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
262daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2632bf73ac6SHong Zhang 
264daad07d3SAidan Hamilton   PetscCall(PetscStrcpy(network->cloneshared->subnet[i].name, name));
265daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
266daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2672bf73ac6SHong Zhang   PetscFunctionReturn(0);
2682bf73ac6SHong Zhang }
2692bf73ac6SHong Zhang 
2705c6496baSHong Zhang /*@C
2715c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2722bf73ac6SHong Zhang 
2735c6496baSHong Zhang   Not collective
2745c6496baSHong Zhang 
2755c6496baSHong Zhang   Input Parameters:
2765c6496baSHong Zhang + dm - the DM object
2775c6496baSHong Zhang - v - vertex point
2785c6496baSHong Zhang 
2795c6496baSHong Zhang   Output Parameters:
2805c6496baSHong Zhang + gidx - global number of this shared vertex in the internal dmplex
2815c6496baSHong Zhang . n - number of subnetworks that share this vertex
2825c6496baSHong Zhang - sv - array of size n: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1
2835c6496baSHong Zhang 
2845c6496baSHong Zhang   Level: intermediate
2855c6496baSHong Zhang 
286db781477SPatrick Sanan .seealso: `DMNetworkGetSharedVertices()`
2875c6496baSHong Zhang @*/
2889371c9d4SSatish Balay PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PetscInt *gidx, PetscInt *n, const PetscInt **sv) {
2895c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
290daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
2915c6496baSHong Zhang   PetscInt    i, gidx_tmp;
2925c6496baSHong Zhang 
2935c6496baSHong Zhang   PetscFunctionBegin;
2949566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
295daad07d3SAidan Hamilton   PetscCall(PetscTableFind(network->cloneshared->svtable, gidx_tmp + 1, &i));
2965c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
2975c6496baSHong Zhang 
2985c6496baSHong Zhang   i--;
2995c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3005c6496baSHong Zhang   if (n) *n = svtx[i].n;
3015c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3025c6496baSHong Zhang   PetscFunctionReturn(0);
3035c6496baSHong Zhang }
3045c6496baSHong Zhang 
3055c6496baSHong Zhang /*
3065c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3075c6496baSHong Zhang 
3085c6496baSHong Zhang   Input Parameters:
3095c6496baSHong Zhang + Nsvtx - global num of shared vertices
3105c6496baSHong Zhang . svtx - array of shared vertices (global)
3115c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3125c6496baSHong Zhang 
3135c6496baSHong Zhang   Output Parameters:
3145c6496baSHong Zhang + gidx - global index of (net,idx)
3155c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3165c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3175c6496baSHong Zhang */
3189371c9d4SSatish Balay static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx) {
3195c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3202bf73ac6SHong Zhang   SVtxType vtype;
3212bf73ac6SHong Zhang 
3222bf73ac6SHong Zhang   PetscFunctionBegin;
3232bf73ac6SHong Zhang   if (!Nsvtx) PetscFunctionReturn(0);
3242bf73ac6SHong Zhang 
3255c6496baSHong Zhang   g_idx = -1;
3262bf73ac6SHong Zhang   vtype = SVNONE;
3275c6496baSHong Zhang 
3282bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3292bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3305c6496baSHong Zhang       g_idx = svtx[i].gidx;
3312bf73ac6SHong Zhang       vtype = SVFROM;
3322bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3332bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3342bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3352bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3362bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3375c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3382bf73ac6SHong Zhang           vtype = SVTO;
3392bf73ac6SHong Zhang         }
3402bf73ac6SHong Zhang       }
3412bf73ac6SHong Zhang     }
3422bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3432bf73ac6SHong Zhang   }
3445c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3452bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3462bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3472bf73ac6SHong Zhang   PetscFunctionReturn(0);
3482bf73ac6SHong Zhang }
3492bf73ac6SHong Zhang 
3502bf73ac6SHong Zhang /*
3515c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3525c6496baSHong Zhang 
3535c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3545c6496baSHong Zhang   Output: svta, tdata, ta2sv
3552bf73ac6SHong Zhang */
3569371c9d4SSatish Balay static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscTable svta, PetscInt *tdata, PetscInt *ta2sv) {
3575c6496baSHong Zhang   PetscInt net, idx, gidx;
3582bf73ac6SHong Zhang 
3592bf73ac6SHong Zhang   PetscFunctionBegin;
3605c6496baSHong Zhang   net  = sedgelist[k];
3615c6496baSHong Zhang   idx  = sedgelist[k + 1];
362daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
3639566063dSJacob Faibussowitsch   PetscCall(PetscTableAdd(svta, gidx + 1, *tdata + 1, INSERT_VALUES));
3645c6496baSHong Zhang 
3655c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3665c6496baSHong Zhang   (*tdata)++;
3672bf73ac6SHong Zhang   PetscFunctionReturn(0);
3682bf73ac6SHong Zhang }
3692bf73ac6SHong Zhang 
3702bf73ac6SHong Zhang /*
3715c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3722bf73ac6SHong Zhang 
3732bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3742bf73ac6SHong Zhang 
3752bf73ac6SHong Zhang   Note: Output svtx is organized as
3762bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3772bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3782bf73ac6SHong Zhang                           ...
3792bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3802bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
3812bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
3822bf73ac6SHong Zhang  */
3839371c9d4SSatish Balay static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist) {
3845c6496baSHong Zhang   SVtx              *svtx = NULL;
3852bf73ac6SHong Zhang   PetscInt          *sv, k, j, nsv, *tdata, **ta2sv;
3862bf73ac6SHong Zhang   PetscTable        *svtas;
3875c6496baSHong Zhang   PetscInt           gidx, net, idx, i, nta, ita, idx_from, idx_to, n;
3882bf73ac6SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
3892bf73ac6SHong Zhang   PetscTablePosition ppos;
3902bf73ac6SHong Zhang 
3912bf73ac6SHong Zhang   PetscFunctionBegin;
3925c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
3939566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
3942bf73ac6SHong Zhang 
3952bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
3965c6496baSHong Zhang   nta = 0; /* num of svta tables created */
3972bf73ac6SHong Zhang 
3982bf73ac6SHong Zhang   /* for j=0 */
399daad07d3SAidan Hamilton   PetscCall(PetscTableCreate(2 * Nsedgelist, network->cloneshared->NVertices + 1, &svtas[nta]));
4009566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4012bf73ac6SHong Zhang 
4029566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4039566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4049371c9d4SSatish Balay   nta++;
4059371c9d4SSatish Balay   k += 4;
4062bf73ac6SHong Zhang 
4075c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4082bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4092bf73ac6SHong Zhang       /* vfrom */
4109371c9d4SSatish Balay       net  = sedgelist[k];
4119371c9d4SSatish Balay       idx  = sedgelist[k + 1];
412daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
4139566063dSJacob Faibussowitsch       PetscCall(PetscTableFind(svtas[ita], gidx + 1, &idx_from));
4142bf73ac6SHong Zhang 
4152bf73ac6SHong Zhang       /* vto */
4169371c9d4SSatish Balay       net  = sedgelist[k + 2];
4179371c9d4SSatish Balay       idx  = sedgelist[k + 3];
418daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
4199566063dSJacob Faibussowitsch       PetscCall(PetscTableFind(svtas[ita], gidx + 1, &idx_to));
4202bf73ac6SHong Zhang 
4212bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4229371c9d4SSatish Balay         idx_from--;
4239371c9d4SSatish Balay         idx_to--;
4242bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4259566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4262bf73ac6SHong Zhang           break;
4272bf73ac6SHong Zhang         } else if (idx_to < 0) {
4289566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4292bf73ac6SHong Zhang           break;
4302bf73ac6SHong Zhang         }
4312bf73ac6SHong Zhang       }
4322bf73ac6SHong Zhang     }
4332bf73ac6SHong Zhang 
4342bf73ac6SHong Zhang     if (ita == nta) {
435daad07d3SAidan Hamilton       PetscCall(PetscTableCreate(2 * Nsedgelist, network->cloneshared->NVertices + 1, &svtas[nta]));
4369566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4372bf73ac6SHong Zhang 
4389566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4399566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4402bf73ac6SHong Zhang       nta++;
4412bf73ac6SHong Zhang     }
4422bf73ac6SHong Zhang     k += 4;
4432bf73ac6SHong Zhang   }
4442bf73ac6SHong Zhang 
4456aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
446daad07d3SAidan Hamilton   PetscCall(PetscTableCreate(nta, network->cloneshared->NVertices + 1, &network->cloneshared->svtable));
4475c6496baSHong Zhang 
4485c6496baSHong Zhang   /* (3) Construct svtx from svtas
4495c6496baSHong Zhang      svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1;
4504f5c2772SJose E. Roman      net[k], k=0, ...,n-1, are in ascending order */
4519566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4522bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4534f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
4549566063dSJacob Faibussowitsch     PetscCall(PetscTableGetCount(svtas[nsv], &n));
4559566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4565c6496baSHong Zhang     svtx[nsv].sv   = sv;
4575c6496baSHong Zhang     svtx[nsv].n    = n;
458daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4592bf73ac6SHong Zhang 
4609566063dSJacob Faibussowitsch     PetscCall(PetscTableGetHeadPosition(svtas[nsv], &ppos));
4614f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
4629566063dSJacob Faibussowitsch       PetscCall(PetscTableGetNext(svtas[nsv], &ppos, &gidx, &i));
4639371c9d4SSatish Balay       gidx--;
4649371c9d4SSatish Balay       i--;
4652bf73ac6SHong Zhang 
4665c6496baSHong Zhang       if (svtx[nsv].gidx > gidx) svtx[nsv].gidx = gidx; /*svtx[nsv].gidx = min(gidx) */
4675c6496baSHong Zhang 
4685c6496baSHong Zhang       j             = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4695c6496baSHong Zhang       sv[2 * k]     = sedgelist[j];     /* subnet number */
4705c6496baSHong Zhang       sv[2 * k + 1] = sedgelist[j + 1]; /* index on the subnet */
4712bf73ac6SHong Zhang     }
4725c6496baSHong Zhang 
4736aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
474daad07d3SAidan Hamilton     PetscCall(PetscTableAdd(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1, INSERT_VALUES));
4752bf73ac6SHong Zhang   }
4762bf73ac6SHong Zhang 
4772bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
4789566063dSJacob Faibussowitsch     PetscCall(PetscTableDestroy(&svtas[j]));
4799566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
4802bf73ac6SHong Zhang   }
4819566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
4822bf73ac6SHong Zhang 
483daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
484daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
4852bf73ac6SHong Zhang   PetscFunctionReturn(0);
4862bf73ac6SHong Zhang }
4872bf73ac6SHong Zhang 
4885c6496baSHong Zhang /*
4895c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
4905c6496baSHong Zhang 
4915c6496baSHong Zhang   Input Parameters:
4925c6496baSHong Zhang . dm - the dmnetwork object
4935c6496baSHong Zhang 
4945c6496baSHong Zhang    Output Parameters:
4955c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
4965c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
4975c6496baSHong Zhang */
4989371c9d4SSatish Balay static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr) {
4992bf73ac6SHong Zhang   MPI_Comm    comm;
5002bf73ac6SHong Zhang   PetscMPIInt size, rank, *recvcounts = NULL, *displs = NULL;
501eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
502eac198afSGetnet   PetscInt    i, j, ctr, np;
503daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
504daad07d3SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist;
5055c6496baSHong Zhang   PetscInt    net, idx, gidx, nmerged, *vrange, gidx_from, net_from, sv_idx;
5062bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5075c6496baSHong Zhang   SVtx       *svtx;
5082bf73ac6SHong Zhang 
5092bf73ac6SHong Zhang   PetscFunctionBegin;
5109566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5119566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5129566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5132bf73ac6SHong Zhang 
5145c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5155c6496baSHong Zhang   /* --------------------------------------- */
516daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
517daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
518daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5192bf73ac6SHong Zhang 
5205c6496baSHong Zhang   /* (2) Merge shared vto vertices to their vfrom vertex with same global vetex index (gidx) */
5215c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5222bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
523daad07d3SAidan Hamilton   PetscCall(PetscMalloc4(size + 1, &vrange, size, &displs, size, &recvcounts, network->cloneshared->nVertices, &vidxlTog));
5249371c9d4SSatish Balay   for (i = 0; i < size; i++) {
5259371c9d4SSatish Balay     displs[i]     = i;
5269371c9d4SSatish Balay     recvcounts[i] = 1;
5279371c9d4SSatish Balay   }
5282bf73ac6SHong Zhang 
5292bf73ac6SHong Zhang   vrange[0] = 0;
530daad07d3SAidan Hamilton   PetscCallMPI(MPI_Allgatherv(&network->cloneshared->nVertices, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
5315c6496baSHong Zhang   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
5322bf73ac6SHong Zhang 
5332bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5349371c9d4SSatish Balay   i                           = 0;
5359371c9d4SSatish Balay   gidx                        = 0;
5362bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
537daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5382bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
539daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5409566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5412bf73ac6SHong Zhang       if (svtype == SVTO) {
542daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5435c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
544daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5455c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
546daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5472bf73ac6SHong Zhang           }
5485c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5495c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5502bf73ac6SHong Zhang         }
5512bf73ac6SHong Zhang       } else {
552daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5535c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
554daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5552bf73ac6SHong Zhang         }
556daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5572bf73ac6SHong Zhang         gidx++;
5582bf73ac6SHong Zhang       }
5592bf73ac6SHong Zhang     }
5602bf73ac6SHong Zhang   }
5612bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
562daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5632bf73ac6SHong Zhang #endif
5642bf73ac6SHong Zhang 
5655c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
5669566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
567daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5682bf73ac6SHong Zhang 
5692bf73ac6SHong Zhang   ctr = 0;
5702bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
571daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5722bf73ac6SHong Zhang       /* vfrom: */
573daad07d3SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5742bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5752bf73ac6SHong Zhang 
5762bf73ac6SHong Zhang       /* vto */
577daad07d3SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5782bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
5792bf73ac6SHong Zhang       ctr++;
5802bf73ac6SHong Zhang     }
5812bf73ac6SHong Zhang   }
5829566063dSJacob Faibussowitsch   PetscCall(PetscFree4(vrange, displs, recvcounts, vidxlTog));
5839566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
5842bf73ac6SHong Zhang 
585eac198afSGetnet   *nmerged_ptr = nmerged;
5865f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
5875f2c45f1SShri Abhyankar }
5885f2c45f1SShri Abhyankar 
5899371c9d4SSatish Balay PetscErrorCode DMNetworkInitializeNonTopological(DM dm) {
590daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
591daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
592daad07d3SAidan Hamilton   MPI_Comm    comm;
593daad07d3SAidan Hamilton 
594daad07d3SAidan Hamilton   PetscFunctionBegin;
595daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
596daad07d3SAidan Hamilton 
597daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
598daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
599daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
600daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
601daad07d3SAidan Hamilton 
602daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
603daad07d3SAidan Hamilton 
604daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
605daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
606daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
607daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
608daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
609daad07d3SAidan Hamilton   }
610daad07d3SAidan Hamilton   PetscFunctionReturn(0);
611daad07d3SAidan Hamilton }
612daad07d3SAidan Hamilton 
6135f2c45f1SShri Abhyankar /*@
6145f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6155f2c45f1SShri Abhyankar 
616eac198afSGetnet   Not Collective
6175f2c45f1SShri Abhyankar 
6187a7aea1fSJed Brown   Input Parameters:
619f11a936eSBarry Smith . dm - the dmnetwork object
6205f2c45f1SShri Abhyankar 
6215f2c45f1SShri Abhyankar   Notes:
6225f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6235f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6245f2c45f1SShri Abhyankar 
6255f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6265f2c45f1SShri Abhyankar 
62797bb938eSShri Abhyankar   Level: beginner
6285f2c45f1SShri Abhyankar 
629db781477SPatrick Sanan .seealso: `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6305f2c45f1SShri Abhyankar @*/
6319371c9d4SSatish Balay PetscErrorCode DMNetworkLayoutSetUp(DM dm) {
6325f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
633daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
634caf410d2SHong Zhang   const PetscInt *cone;
635caf410d2SHong Zhang   MPI_Comm        comm;
6365503a911SAidan Hamilton   PetscMPIInt     size;
637eac198afSGetnet   PetscSection    sectiong;
6385c6496baSHong Zhang   PetscInt        nmerged = 0;
6396500d4abSHong Zhang 
6406500d4abSHong Zhang   PetscFunctionBegin;
641e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
642daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6432bf73ac6SHong Zhang 
644eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
645eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6469371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6479371c9d4SSatish 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,
6489371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
649eac198afSGetnet   }
650eac198afSGetnet 
6519566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6525503a911SAidan Hamilton   PetscCall(MPI_Comm_size(comm, &size));
6536500d4abSHong Zhang 
654f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
655daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
656eac198afSGetnet 
657daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6589566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
659eac198afSGetnet   } else { /* subnetworks are not coupled */
6606aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
661daad07d3SAidan Hamilton     PetscCall(PetscTableCreate(0, network->cloneshared->NVertices + 1, &network->cloneshared->svtable));
662caf410d2SHong Zhang     ctr = 0;
6632bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
664daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
665daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
666daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6676500d4abSHong Zhang         ctr++;
6686500d4abSHong Zhang       }
6696500d4abSHong Zhang     }
670eac198afSGetnet   }
6717765340cSHong Zhang 
6722bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6739566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
6749566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
6759566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
676eac198afSGetnet 
677daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
678daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
6796500d4abSHong Zhang 
680daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
681daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
682daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
683daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
6849566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
685caf410d2SHong Zhang 
686f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
687f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
688f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
689f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
690f11a936eSBarry Smith   */
691daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
692daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
693daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
6945c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
695daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
696daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
697f11a936eSBarry Smith 
698daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
699daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7006500d4abSHong Zhang   }
701daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
702caf410d2SHong Zhang 
703caf410d2SHong Zhang   /* Get edge ownership */
704daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7055503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7065503a911SAidan Hamilton   globaledgeoff -= np;
707caf410d2SHong Zhang 
708eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7092bf73ac6SHong Zhang   e = 0;
7102bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
711f11a936eSBarry Smith     ctr = 0;
712daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7132bf73ac6SHong Zhang       /* edge e */
7145503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7152bf73ac6SHong Zhang       network->header[e].subnetid              = i;
716daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7172bf73ac6SHong Zhang 
7182bf73ac6SHong Zhang       /* connected vertices */
7199566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7202bf73ac6SHong Zhang 
7212bf73ac6SHong Zhang       /* vertex cone[0] */
722f11a936eSBarry Smith       v                           = cone[0];
723f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
724f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
725f11a936eSBarry Smith       if (Nsubnet == 1) {
726daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
727f11a936eSBarry Smith       } else {
728daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
729daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
730f11a936eSBarry Smith       }
7312bf73ac6SHong Zhang 
7322bf73ac6SHong Zhang       /* vertex cone[1] */
733f11a936eSBarry Smith       v                           = cone[1];
734f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
735f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
736f11a936eSBarry Smith       if (Nsubnet == 1) {
737daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
738f11a936eSBarry Smith       } else {
739daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
740daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
741f11a936eSBarry Smith       }
7422bf73ac6SHong Zhang 
7439371c9d4SSatish Balay       e++;
7449371c9d4SSatish Balay       ctr++;
7456500d4abSHong Zhang     }
7466500d4abSHong Zhang   }
7475503a911SAidan Hamilton   PetscCall(PetscFree(edges));
748caf410d2SHong Zhang 
749eac198afSGetnet   /* Set local vertex array for the subnetworks */
750eac198afSGetnet   j = 0;
751daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
752eac198afSGetnet     /* local shared vertex */
753daad07d3SAidan Hamilton     PetscCall(PetscTableFind(network->cloneshared->svtable, network->header[v].index + 1, &i));
754daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7556500d4abSHong Zhang   }
756eac198afSGetnet 
757eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
758eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7599566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
760daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
761daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
762e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7635f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
7645f2c45f1SShri Abhyankar }
7655f2c45f1SShri Abhyankar 
76694ef8ddeSSatish Balay /*@C
7672bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7682bf73ac6SHong Zhang 
7692bf73ac6SHong Zhang   Not collective
7702727e31bSShri Abhyankar 
7717a7aea1fSJed Brown   Input Parameters:
772caf410d2SHong Zhang + dm - the DM object
7732bf73ac6SHong Zhang - netnum - the global index of the subnetwork
7742727e31bSShri Abhyankar 
7757a7aea1fSJed Brown   Output Parameters:
7762727e31bSShri Abhyankar + nv - number of vertices (local)
7772727e31bSShri Abhyankar . ne - number of edges (local)
7782bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
7792bf73ac6SHong Zhang - edge - local edges of the subnetwork
7802727e31bSShri Abhyankar 
7812727e31bSShri Abhyankar   Notes:
7822727e31bSShri Abhyankar     Cannot call this routine before DMNetworkLayoutSetup()
7832727e31bSShri Abhyankar 
784eac198afSGetnet     The local vertices returned on each rank are determined by DMNetwork. The user does not have any control over what vertices are local.
785eac198afSGetnet 
78606dd6b0eSSatish Balay   Level: intermediate
78706dd6b0eSSatish Balay 
788db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
7892727e31bSShri Abhyankar @*/
7909371c9d4SSatish Balay PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge) {
791caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
7922727e31bSShri Abhyankar 
7932727e31bSShri Abhyankar   PetscFunctionBegin;
794daad07d3SAidan 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);
795daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
796daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
797daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
798daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
7992bf73ac6SHong Zhang   PetscFunctionReturn(0);
8002bf73ac6SHong Zhang }
8012bf73ac6SHong Zhang 
8022bf73ac6SHong Zhang /*@
8032bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8042bf73ac6SHong Zhang 
8052bf73ac6SHong Zhang   Collective on dm
8062bf73ac6SHong Zhang 
8072bf73ac6SHong Zhang   Input Parameters:
8082bf73ac6SHong Zhang + dm - the dm object
8092bf73ac6SHong Zhang . anetnum - first subnetwork global numbering returned by DMNetworkAddSubnetwork()
8102bf73ac6SHong Zhang . bnetnum - second subnetwork global numbering returned by DMNetworkAddSubnetwork()
8112bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8122bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8132bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8142bf73ac6SHong Zhang 
8152bf73ac6SHong Zhang   Level: beginner
8162bf73ac6SHong Zhang 
817db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8182bf73ac6SHong Zhang @*/
8199371c9d4SSatish Balay PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[]) {
8202bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
821daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8222bf73ac6SHong Zhang 
8232bf73ac6SHong Zhang   PetscFunctionBegin;
8245c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8255c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8262bf73ac6SHong Zhang   if (!Nsvtx) {
8272bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
828daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8292bf73ac6SHong Zhang   }
8302bf73ac6SHong Zhang 
831daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8322bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8339371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8349371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8359371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8369371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8372bf73ac6SHong Zhang     Nsvtx++;
8382bf73ac6SHong Zhang   }
8395c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
840daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8412727e31bSShri Abhyankar   PetscFunctionReturn(0);
8422727e31bSShri Abhyankar }
8432727e31bSShri Abhyankar 
8442727e31bSShri Abhyankar /*@C
8452bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8462bf73ac6SHong Zhang 
8472bf73ac6SHong Zhang   Not collective
848caf410d2SHong Zhang 
849f899ff85SJose E. Roman   Input Parameter:
8502bf73ac6SHong Zhang . dm - the DM object
851caf410d2SHong Zhang 
8527a7aea1fSJed Brown   Output Parameters:
8532bf73ac6SHong Zhang + nsv - number of local shared vertices
8542bf73ac6SHong Zhang - svtx - local shared vertices
855caf410d2SHong Zhang 
856caf410d2SHong Zhang   Notes:
857caf410d2SHong Zhang   Cannot call this routine before DMNetworkLayoutSetup()
858caf410d2SHong Zhang 
859caf410d2SHong Zhang   Level: intermediate
860caf410d2SHong Zhang 
861db781477SPatrick Sanan .seealso: `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
862caf410d2SHong Zhang @*/
8639371c9d4SSatish Balay PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx) {
864caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
865caf410d2SHong Zhang 
866caf410d2SHong Zhang   PetscFunctionBegin;
8675c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
868daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
869daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
870caf410d2SHong Zhang   PetscFunctionReturn(0);
871caf410d2SHong Zhang }
872caf410d2SHong Zhang 
873caf410d2SHong Zhang /*@C
8745f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
8755f2c45f1SShri Abhyankar 
876d083f849SBarry Smith   Logically collective on dm
8775f2c45f1SShri Abhyankar 
8787a7aea1fSJed Brown   Input Parameters:
8795f2c45f1SShri Abhyankar + dm - the network object
8805f2c45f1SShri Abhyankar . name - the component name
8815f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
8825f2c45f1SShri Abhyankar 
8837a7aea1fSJed Brown    Output Parameters:
8845f2c45f1SShri Abhyankar .  key - an integer key that defines the component
8855f2c45f1SShri Abhyankar 
88687497f52SBarry Smith    Note:
88787497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
8885f2c45f1SShri Abhyankar 
88997bb938eSShri Abhyankar    Level: beginner
8905f2c45f1SShri Abhyankar 
891db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
8925f2c45f1SShri Abhyankar @*/
8939371c9d4SSatish Balay PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key) {
8945f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
89554dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
8965f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
8975f2c45f1SShri Abhyankar   PetscInt            i;
8985f2c45f1SShri Abhyankar 
8995f2c45f1SShri Abhyankar   PetscFunctionBegin;
900*48a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
90154dfd506SHong Zhang 
9025f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9039566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9045f2c45f1SShri Abhyankar     if (flg) {
9055f2c45f1SShri Abhyankar       *key = i;
9065f2c45f1SShri Abhyankar       PetscFunctionReturn(0);
9075f2c45f1SShri Abhyankar     }
9086d64e262SShri Abhyankar   }
90954dfd506SHong Zhang 
91054dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
91154dfd506SHong Zhang     /* Reached max allowed so resize component */
91254dfd506SHong Zhang     network->max_comps_registered += 2;
9139566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
91454dfd506SHong Zhang     /* Copy over the previous component info */
91554dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
9169566063dSJacob Faibussowitsch       PetscCall(PetscStrcpy(newcomponent[i].name, network->component[i].name));
91754dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9185f2c45f1SShri Abhyankar     }
91954dfd506SHong Zhang     /* Free old one */
9209566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
92154dfd506SHong Zhang     /* Update pointer */
92254dfd506SHong Zhang     network->component = newcomponent;
92354dfd506SHong Zhang   }
92454dfd506SHong Zhang 
92554dfd506SHong Zhang   component = &network->component[network->ncomponent];
9265f2c45f1SShri Abhyankar 
9279566063dSJacob Faibussowitsch   PetscCall(PetscStrcpy(component->name, name));
9285f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9295f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9305f2c45f1SShri Abhyankar   network->ncomponent++;
9315f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
9325f2c45f1SShri Abhyankar }
9335f2c45f1SShri Abhyankar 
9345f2c45f1SShri Abhyankar /*@
9352bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
9365f2c45f1SShri Abhyankar 
9375f2c45f1SShri Abhyankar   Not Collective
9385f2c45f1SShri Abhyankar 
939f899ff85SJose E. Roman   Input Parameter:
9402bf73ac6SHong Zhang . dm - the DMNetwork object
9415f2c45f1SShri Abhyankar 
942fd292e60Sprj-   Output Parameters:
9432bf73ac6SHong Zhang + vStart - the first vertex point
9442bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
9455f2c45f1SShri Abhyankar 
94697bb938eSShri Abhyankar   Level: beginner
9475f2c45f1SShri Abhyankar 
948db781477SPatrick Sanan .seealso: `DMNetworkGetEdgeRange()`
9495f2c45f1SShri Abhyankar @*/
9509371c9d4SSatish Balay PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd) {
9515f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
9525f2c45f1SShri Abhyankar 
9535f2c45f1SShri Abhyankar   PetscFunctionBegin;
954daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
955daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
9565f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
9575f2c45f1SShri Abhyankar }
9585f2c45f1SShri Abhyankar 
9595f2c45f1SShri Abhyankar /*@
9602bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
9615f2c45f1SShri Abhyankar 
9625f2c45f1SShri Abhyankar   Not Collective
9635f2c45f1SShri Abhyankar 
964f899ff85SJose E. Roman   Input Parameter:
9652bf73ac6SHong Zhang . dm - the DMNetwork object
9665f2c45f1SShri Abhyankar 
967fd292e60Sprj-   Output Parameters:
9685f2c45f1SShri Abhyankar + eStart - The first edge point
9695f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
9705f2c45f1SShri Abhyankar 
97197bb938eSShri Abhyankar   Level: beginner
9725f2c45f1SShri Abhyankar 
973db781477SPatrick Sanan .seealso: `DMNetworkGetVertexRange()`
9745f2c45f1SShri Abhyankar @*/
9759371c9d4SSatish Balay PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd) {
9765f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
9775f2c45f1SShri Abhyankar 
9785f2c45f1SShri Abhyankar   PetscFunctionBegin;
9795c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
980daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
981daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
9825f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
9835f2c45f1SShri Abhyankar }
9845f2c45f1SShri Abhyankar 
9859371c9d4SSatish Balay PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index) {
9862bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
9875c6496baSHong Zhang 
9885c6496baSHong Zhang   PetscFunctionBegin;
9895c6496baSHong Zhang   if (network->header) {
9905c6496baSHong Zhang     *index = network->header[p].index;
9915c6496baSHong Zhang   } else {
9922bf73ac6SHong Zhang     PetscInt                 offsetp;
9932bf73ac6SHong Zhang     DMNetworkComponentHeader header;
9942bf73ac6SHong Zhang 
9959566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
9962bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
9972bf73ac6SHong Zhang     *index = header->index;
9985c6496baSHong Zhang   }
9992bf73ac6SHong Zhang   PetscFunctionReturn(0);
10002bf73ac6SHong Zhang }
10012bf73ac6SHong Zhang 
10029371c9d4SSatish Balay PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid) {
1003daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1004daad07d3SAidan Hamilton 
1005daad07d3SAidan Hamilton   PetscFunctionBegin;
1006daad07d3SAidan Hamilton   if (network->header) {
1007daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1008daad07d3SAidan Hamilton   } else {
1009daad07d3SAidan Hamilton     PetscInt                 offsetp;
1010daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1011daad07d3SAidan Hamilton 
1012daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1013daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1014daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1015daad07d3SAidan Hamilton   }
1016daad07d3SAidan Hamilton   PetscFunctionReturn(0);
1017daad07d3SAidan Hamilton }
1018daad07d3SAidan Hamilton 
10197b6afd5bSHong Zhang /*@
10202bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
10217b6afd5bSHong Zhang 
10227b6afd5bSHong Zhang   Not Collective
10237b6afd5bSHong Zhang 
10247b6afd5bSHong Zhang   Input Parameters:
10257b6afd5bSHong Zhang + dm - DMNetwork object
1026e85e6aecSHong Zhang - p - edge point
10277b6afd5bSHong Zhang 
1028fd292e60Sprj-   Output Parameters:
10292bf73ac6SHong Zhang . index - the global numbering for the edge
10307b6afd5bSHong Zhang 
10317b6afd5bSHong Zhang   Level: intermediate
10327b6afd5bSHong Zhang 
1033db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalVertexIndex()`
10347b6afd5bSHong Zhang @*/
10359371c9d4SSatish Balay PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index) {
10367b6afd5bSHong Zhang   PetscFunctionBegin;
10379566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
10387b6afd5bSHong Zhang   PetscFunctionReturn(0);
10397b6afd5bSHong Zhang }
10407b6afd5bSHong Zhang 
10415f2c45f1SShri Abhyankar /*@
10422bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1043e85e6aecSHong Zhang 
1044e85e6aecSHong Zhang   Not Collective
1045e85e6aecSHong Zhang 
1046e85e6aecSHong Zhang   Input Parameters:
1047e85e6aecSHong Zhang + dm - DMNetwork object
1048e85e6aecSHong Zhang - p  - vertex point
1049e85e6aecSHong Zhang 
1050fd292e60Sprj-   Output Parameters:
10512bf73ac6SHong Zhang . index - the global numbering for the vertex
1052e85e6aecSHong Zhang 
1053e85e6aecSHong Zhang   Level: intermediate
1054e85e6aecSHong Zhang 
1055db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1056e85e6aecSHong Zhang @*/
10579371c9d4SSatish Balay PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index) {
1058e85e6aecSHong Zhang   PetscFunctionBegin;
10599566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
10609988b915SShri Abhyankar   PetscFunctionReturn(0);
10619988b915SShri Abhyankar }
10629988b915SShri Abhyankar 
10639988b915SShri Abhyankar /*@
10645f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
10655f2c45f1SShri Abhyankar 
10665f2c45f1SShri Abhyankar   Not Collective
10675f2c45f1SShri Abhyankar 
10685f2c45f1SShri Abhyankar   Input Parameters:
10692bf73ac6SHong Zhang + dm - the DMNetwork object
1070a2b725a8SWilliam Gropp - p - vertex/edge point
10715f2c45f1SShri Abhyankar 
10725f2c45f1SShri Abhyankar   Output Parameters:
10735f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
10745f2c45f1SShri Abhyankar 
107597bb938eSShri Abhyankar   Level: beginner
10765f2c45f1SShri Abhyankar 
1077db781477SPatrick Sanan .seealso: `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
10785f2c45f1SShri Abhyankar @*/
10799371c9d4SSatish Balay PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents) {
10805f2c45f1SShri Abhyankar   PetscInt    offset;
10815f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10825f2c45f1SShri Abhyankar 
10835f2c45f1SShri Abhyankar   PetscFunctionBegin;
10849566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
10855f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
10865f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
10875f2c45f1SShri Abhyankar }
10885f2c45f1SShri Abhyankar 
10895f2c45f1SShri Abhyankar /*@
10902bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
10915f2c45f1SShri Abhyankar 
10925f2c45f1SShri Abhyankar   Not Collective
10935f2c45f1SShri Abhyankar 
10945f2c45f1SShri Abhyankar   Input Parameters:
10952bf73ac6SHong Zhang + dm - the DMNetwork object
1096f2f58720SBarry Smith . p - the edge or vertex point
10972bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
10989988b915SShri Abhyankar 
10999988b915SShri Abhyankar   Output Parameters:
11002bf73ac6SHong Zhang . offset - the local offset
11019988b915SShri Abhyankar 
1102f2f58720SBarry Smith   Notes:
1103f2f58720SBarry Smith     These offsets can be passed to MatSetValuesLocal() for matrices obtained with DMCreateMatrix().
1104f2f58720SBarry Smith 
1105f2f58720SBarry Smith     For vectors obtained with DMCreateLocalVector() the offsets can be used with VecSetValues().
1106f2f58720SBarry Smith 
1107f2f58720SBarry Smith     For vectors obtained with DMCreateLocalVector() and the array obtained with VecGetArray(vec,&array) you can access or set
1108f2f58720SBarry Smith     the vector values with array[offset].
1109f2f58720SBarry Smith 
1110f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() the offsets can be used with VecSetValuesLocal().
1111f2f58720SBarry Smith 
11129988b915SShri Abhyankar   Level: intermediate
11139988b915SShri Abhyankar 
1114db781477SPatrick Sanan .seealso: `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
11159988b915SShri Abhyankar @*/
11169371c9d4SSatish Balay PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset) {
11179988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
11189988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
11199988b915SShri Abhyankar   DMNetworkComponentHeader header;
11209988b915SShri Abhyankar 
11219988b915SShri Abhyankar   PetscFunctionBegin;
11229566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
11232bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
11242bf73ac6SHong Zhang     *offset = offsetp;
11252bf73ac6SHong Zhang     PetscFunctionReturn(0);
11262bf73ac6SHong Zhang   }
11272bf73ac6SHong Zhang 
11289566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
11299988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
11309988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
11319988b915SShri Abhyankar   PetscFunctionReturn(0);
11329988b915SShri Abhyankar }
11339988b915SShri Abhyankar 
11349988b915SShri Abhyankar /*@
11352bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
11369988b915SShri Abhyankar 
11379988b915SShri Abhyankar   Not Collective
11389988b915SShri Abhyankar 
11399988b915SShri Abhyankar   Input Parameters:
11402bf73ac6SHong Zhang + dm - the DMNetwork object
1141f2f58720SBarry Smith . p - the edge or vertex point
11422bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
11439988b915SShri Abhyankar 
11449988b915SShri Abhyankar   Output Parameters:
11459988b915SShri Abhyankar . offsetg - the global offset
11469988b915SShri Abhyankar 
1147f2f58720SBarry Smith   Notes:
1148f2f58720SBarry Smith     These offsets can be passed to MatSetValues() for matrices obtained with DMCreateMatrix().
1149f2f58720SBarry Smith 
1150f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() the offsets can be used with VecSetValues().
1151f2f58720SBarry Smith 
1152f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() and the array obtained with VecGetArray(vec,&array) you can access or set
1153f2f58720SBarry Smith     the vector values with array[offset - rstart] where restart is obtained with VecGetOwnershipRange(v,&rstart,NULL);
1154f2f58720SBarry Smith 
11559988b915SShri Abhyankar   Level: intermediate
11569988b915SShri Abhyankar 
1157db781477SPatrick Sanan .seealso: `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
11589988b915SShri Abhyankar @*/
11599371c9d4SSatish Balay PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg) {
11609988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
11619988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
11629988b915SShri Abhyankar   DMNetworkComponentHeader header;
11639988b915SShri Abhyankar 
11649988b915SShri Abhyankar   PetscFunctionBegin;
11659566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
11662bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
11672bf73ac6SHong Zhang 
11682bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
11692bf73ac6SHong Zhang     *offsetg = offsetp;
11702bf73ac6SHong Zhang     PetscFunctionReturn(0);
11712bf73ac6SHong Zhang   }
11729566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
11739988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
11749988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
11759988b915SShri Abhyankar   PetscFunctionReturn(0);
11769988b915SShri Abhyankar }
11779988b915SShri Abhyankar 
11789988b915SShri Abhyankar /*@
11792bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
118024121865SAdrian Maldonado 
118124121865SAdrian Maldonado   Not Collective
118224121865SAdrian Maldonado 
118324121865SAdrian Maldonado   Input Parameters:
11842bf73ac6SHong Zhang + dm - the DMNetwork object
118524121865SAdrian Maldonado - p - the edge point
118624121865SAdrian Maldonado 
118724121865SAdrian Maldonado   Output Parameters:
118824121865SAdrian Maldonado . offset - the offset
118924121865SAdrian Maldonado 
119024121865SAdrian Maldonado   Level: intermediate
119124121865SAdrian Maldonado 
1192db781477SPatrick Sanan .seealso: `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
119324121865SAdrian Maldonado @*/
11949371c9d4SSatish Balay PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset) {
119524121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
119624121865SAdrian Maldonado 
119724121865SAdrian Maldonado   PetscFunctionBegin;
11989566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
119924121865SAdrian Maldonado   PetscFunctionReturn(0);
120024121865SAdrian Maldonado }
120124121865SAdrian Maldonado 
120224121865SAdrian Maldonado /*@
12032bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
120424121865SAdrian Maldonado 
120524121865SAdrian Maldonado   Not Collective
120624121865SAdrian Maldonado 
120724121865SAdrian Maldonado   Input Parameters:
12082bf73ac6SHong Zhang + dm - the DMNetwork object
120924121865SAdrian Maldonado - p - the vertex point
121024121865SAdrian Maldonado 
121124121865SAdrian Maldonado   Output Parameters:
121224121865SAdrian Maldonado . offset - the offset
121324121865SAdrian Maldonado 
121424121865SAdrian Maldonado   Level: intermediate
121524121865SAdrian Maldonado 
1216db781477SPatrick Sanan .seealso: `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
121724121865SAdrian Maldonado @*/
12189371c9d4SSatish Balay PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset) {
121924121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
122024121865SAdrian Maldonado 
122124121865SAdrian Maldonado   PetscFunctionBegin;
1222daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
12239566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
122424121865SAdrian Maldonado   PetscFunctionReturn(0);
122524121865SAdrian Maldonado }
12262bf73ac6SHong Zhang 
12275f2c45f1SShri Abhyankar /*@
12282bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
12295f2c45f1SShri Abhyankar 
1230eac198afSGetnet   Collective on dm
12315f2c45f1SShri Abhyankar 
12325f2c45f1SShri Abhyankar   Input Parameters:
12334dc646bcSBarry Smith + dm - the DMNetwork
1234eac198afSGetnet . p - the vertex/edge point. These points are local indices provided by DMNetworkGetSubnetwork()
1235eac198afSGetnet . componentkey - component key returned while registering the component with DMNetworkRegisterComponent()
123624359064SBarry 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
123724359064SBarry Smith               free this space until after DMSetUp() is called.
1238eac198afSGetnet - 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
12395f2c45f1SShri Abhyankar 
1240eac198afSGetnet   Notes:
1241eac198afSGetnet     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.
1242eac198afSGetnet 
1243eac198afSGetnet     DMNetworkLayoutSetUp() must be called before this routine.
1244eac198afSGetnet 
1245eac198afSGetnet   Developer Notes:
1246eac198afSGetnet      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.
124797bb938eSShri Abhyankar   Level: beginner
12485f2c45f1SShri Abhyankar 
1249db781477SPatrick Sanan .seealso: `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
12505f2c45f1SShri Abhyankar @*/
12519371c9d4SSatish Balay PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar) {
12525f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
12532bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
125454dfd506SHong Zhang   DMNetworkComponentHeader header;
125554dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
125654dfd506SHong Zhang   PetscInt                 compnum;
125754dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
125854dfd506SHong Zhang   void                   **compdata;
12595f2c45f1SShri Abhyankar 
12605f2c45f1SShri Abhyankar   PetscFunctionBegin;
12615c6496baSHong 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);
1262daad07d3SAidan 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.");
1263eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
12649566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
12652bf73ac6SHong Zhang 
1266eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
126754dfd506SHong Zhang   header = &network->header[p];
126854dfd506SHong Zhang   cvalue = &network->cvalue[p];
126954dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1270f11a936eSBarry Smith     PetscInt additional_size;
1271f11a936eSBarry Smith 
127254dfd506SHong Zhang     /* Reached limit so resize header component arrays */
127354dfd506SHong Zhang     header->maxcomps += 2;
127454dfd506SHong Zhang 
127554dfd506SHong Zhang     /* Allocate arrays for component information and value */
12769566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
12779566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
127854dfd506SHong Zhang 
127954dfd506SHong Zhang     /* Recalculate header size */
128054dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
128154dfd506SHong Zhang 
128254dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
128354dfd506SHong Zhang 
128454dfd506SHong Zhang     /* Copy over component info */
12859566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
12869566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
12879566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
12889566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
12899566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
129054dfd506SHong Zhang 
129154dfd506SHong Zhang     /* Copy over component data pointers */
12929566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
129354dfd506SHong Zhang 
129454dfd506SHong Zhang     /* Free old arrays */
12959566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
12969566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
129754dfd506SHong Zhang 
129854dfd506SHong Zhang     /* Update pointers */
129954dfd506SHong Zhang     header->size         = compsize;
130054dfd506SHong Zhang     header->key          = compkey;
130154dfd506SHong Zhang     header->offset       = compoffset;
130254dfd506SHong Zhang     header->nvar         = compnvar;
130354dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
130454dfd506SHong Zhang 
130554dfd506SHong Zhang     cvalue->data = compdata;
130654dfd506SHong Zhang 
130754dfd506SHong Zhang     /* Update DataSection Dofs */
130854dfd506SHong 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 */
1309f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
13109566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
131154dfd506SHong Zhang   }
131254dfd506SHong Zhang   header = &network->header[p];
131354dfd506SHong Zhang   cvalue = &network->cvalue[p];
131454dfd506SHong Zhang 
131554dfd506SHong Zhang   compnum = header->ndata;
13162bf73ac6SHong Zhang 
13172bf73ac6SHong Zhang   header->size[compnum] = component->size;
13189566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
13192bf73ac6SHong Zhang   header->key[compnum] = componentkey;
13202bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
13212bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
13222bf73ac6SHong Zhang 
13232bf73ac6SHong Zhang   /* variables */
13242bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
13252bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
13262bf73ac6SHong Zhang 
13272bf73ac6SHong Zhang   header->ndata++;
13285f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
13295f2c45f1SShri Abhyankar }
13305f2c45f1SShri Abhyankar 
133127f51fceSHong Zhang /*@
13322bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
133327f51fceSHong Zhang 
133427f51fceSHong Zhang   Not Collective
133527f51fceSHong Zhang 
133627f51fceSHong Zhang   Input Parameters:
13372bf73ac6SHong Zhang + dm - the DMNetwork object
13382bf73ac6SHong Zhang . p - vertex/edge point
133999c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
134027f51fceSHong Zhang 
134127f51fceSHong Zhang   Output Parameters:
13422bf73ac6SHong Zhang + compkey - the key obtained when registering the component (use NULL if not required)
13432bf73ac6SHong Zhang . component - the component data (use NULL if not required)
13442bf73ac6SHong Zhang - nvar  - number of variables (use NULL if not required)
134527f51fceSHong Zhang 
134697bb938eSShri Abhyankar   Level: beginner
134727f51fceSHong Zhang 
1348db781477SPatrick Sanan .seealso: `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
134927f51fceSHong Zhang @*/
13509371c9d4SSatish Balay PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar) {
135127f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
13522bf73ac6SHong Zhang   PetscInt                 offset  = 0;
13532bf73ac6SHong Zhang   DMNetworkComponentHeader header;
135427f51fceSHong Zhang 
135527f51fceSHong Zhang   PetscFunctionBegin;
13562bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
13579566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
135827f51fceSHong Zhang     PetscFunctionReturn(0);
135927f51fceSHong Zhang   }
136027f51fceSHong Zhang 
13619566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
136242dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
13635f2c45f1SShri Abhyankar 
13642bf73ac6SHong Zhang   if (compnum >= 0) {
13652bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
13662bf73ac6SHong Zhang     if (component) {
136754dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
13682bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
13692bf73ac6SHong Zhang     }
13702bf73ac6SHong Zhang   }
13715f2c45f1SShri Abhyankar 
13722bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
137354dfd506SHong Zhang 
13745f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
13755f2c45f1SShri Abhyankar }
13765f2c45f1SShri Abhyankar 
13772bf73ac6SHong Zhang /*
13782bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
13792bf73ac6SHong 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.
13802bf73ac6SHong Zhang */
13819371c9d4SSatish Balay PetscErrorCode DMNetworkComponentSetUp(DM dm) {
13825f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1383f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
13845f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
13855f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1386f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
13875f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
13885f2c45f1SShri Abhyankar 
13895f2c45f1SShri Abhyankar   PetscFunctionBegin;
13909566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
13919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1392f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
13939566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
13945f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1395daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
13969566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
13975f2c45f1SShri Abhyankar     /* Copy header */
13985f2c45f1SShri Abhyankar     header     = &network->header[p];
1399f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
14009566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1401f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
14029566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1403aeb78aa7SBarry Smith     headerinfo->size = headerarr;
140454dfd506SHong Zhang     headerarr += header->maxcomps;
14059566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1406aeb78aa7SBarry Smith     headerinfo->key = headerarr;
140754dfd506SHong Zhang     headerarr += header->maxcomps;
14089566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1409aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
141054dfd506SHong Zhang     headerarr += header->maxcomps;
14119566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1412aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
141354dfd506SHong Zhang     headerarr += header->maxcomps;
14149566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1415aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
141654dfd506SHong Zhang 
14175f2c45f1SShri Abhyankar     /* Copy data */
14185f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
14195f2c45f1SShri Abhyankar     ncomp  = header->ndata;
14202bf73ac6SHong Zhang 
14215f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
142254dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
14239566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
14245f2c45f1SShri Abhyankar     }
14255f2c45f1SShri Abhyankar   }
1426aeb78aa7SBarry Smith 
1427daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1428aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1429aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1430aeb78aa7SBarry Smith   }
1431aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
14325f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
14335f2c45f1SShri Abhyankar }
14345f2c45f1SShri Abhyankar 
14355f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
14369371c9d4SSatish Balay static PetscErrorCode DMNetworkVariablesSetUp(DM dm) {
14375f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
14385f2c45f1SShri Abhyankar 
14395f2c45f1SShri Abhyankar   PetscFunctionBegin;
14409566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
14415f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
14425f2c45f1SShri Abhyankar }
14435f2c45f1SShri Abhyankar 
144424121865SAdrian Maldonado /* Get a subsection from a range of points */
14459371c9d4SSatish Balay static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection) {
144624121865SAdrian Maldonado   PetscInt i, nvar;
144724121865SAdrian Maldonado 
144824121865SAdrian Maldonado   PetscFunctionBegin;
14499566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
14509566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
145124121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
14529566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
14539566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
145424121865SAdrian Maldonado   }
145524121865SAdrian Maldonado 
14569566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
145724121865SAdrian Maldonado   PetscFunctionReturn(0);
145824121865SAdrian Maldonado }
145924121865SAdrian Maldonado 
146024121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
14619371c9d4SSatish Balay static PetscErrorCode DMNetworkSetSubMap_private(PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map) {
146224121865SAdrian Maldonado   PetscInt i, *subpoints;
146324121865SAdrian Maldonado 
146424121865SAdrian Maldonado   PetscFunctionBegin;
146524121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
14669566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
14679371c9d4SSatish Balay   for (i = pstart; i < pend; i++) { subpoints[i - pstart] = i; }
14689566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
14699566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
147024121865SAdrian Maldonado   PetscFunctionReturn(0);
147124121865SAdrian Maldonado }
147224121865SAdrian Maldonado 
147324121865SAdrian Maldonado /*@
14742bf73ac6SHong Zhang   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after DMNetworkDistribute
147524121865SAdrian Maldonado 
14762bf73ac6SHong Zhang   Collective on dm
147724121865SAdrian Maldonado 
147824121865SAdrian Maldonado   Input Parameters:
14792bf73ac6SHong Zhang . dm - the DMNetworkObject
148024121865SAdrian Maldonado 
148124121865SAdrian Maldonado   Note: the routine will create alternative orderings for the vertices and edges. Assume global network points are:
148224121865SAdrian Maldonado 
148324121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
148424121865SAdrian Maldonado 
1485caf410d2SHong 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]).
148624121865SAdrian Maldonado 
148724121865SAdrian Maldonado   With this new ordering a local PetscSection, global PetscSection and PetscSF will be created specific to the subset.
148824121865SAdrian Maldonado 
148924121865SAdrian Maldonado   Level: intermediate
149024121865SAdrian Maldonado 
149124121865SAdrian Maldonado @*/
14929371c9d4SSatish Balay PetscErrorCode DMNetworkAssembleGraphStructures(DM dm) {
149324121865SAdrian Maldonado   MPI_Comm    comm;
1494f11a936eSBarry Smith   PetscMPIInt size;
149524121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
149624121865SAdrian Maldonado 
1497eab1376dSHong Zhang   PetscFunctionBegin;
14989566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
14999566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
150024121865SAdrian Maldonado 
150124121865SAdrian Maldonado   /* Create maps for vertices and edges */
1502daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1503daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
150424121865SAdrian Maldonado 
150524121865SAdrian Maldonado   /* Create local sub-sections */
1506daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1507daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
150824121865SAdrian Maldonado 
15099852e123SBarry Smith   if (size > 1) {
15109566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
151122bbedd7SHong Zhang 
15129566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
15139566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
15149566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
151524121865SAdrian Maldonado   } else {
151624121865SAdrian Maldonado     /* create structures for vertex */
15179566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
151824121865SAdrian Maldonado     /* create structures for edge */
15199566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
152024121865SAdrian Maldonado   }
152124121865SAdrian Maldonado 
152224121865SAdrian Maldonado   /* Add viewers */
15239566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
15249566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
15259566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
15269566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
152724121865SAdrian Maldonado   PetscFunctionReturn(0);
152824121865SAdrian Maldonado }
15297b6afd5bSHong Zhang 
1530f11a936eSBarry Smith /*
15315c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
15325c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1533f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1534f11a936eSBarry Smith */
15359371c9d4SSatish Balay static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable) {
1536f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1537f11a936eSBarry Smith   const PetscInt          *edges;
1538f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1539f11a936eSBarry Smith   DMNetworkComponentHeader header;
1540f11a936eSBarry Smith 
1541f11a936eSBarry Smith   PetscFunctionBegin;
15429566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
15439566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1544f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
15459566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1546f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
15479566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1548f11a936eSBarry Smith   }
1549f11a936eSBarry Smith   PetscFunctionReturn(0);
1550f11a936eSBarry Smith }
1551f11a936eSBarry Smith 
15525f2c45f1SShri Abhyankar /*@
15532bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
15545f2c45f1SShri Abhyankar 
15555f2c45f1SShri Abhyankar   Collective
15565f2c45f1SShri Abhyankar 
1557d8d19677SJose E. Roman   Input Parameters:
1558d3464fd4SAdrian Maldonado + DM - the DMNetwork object
15592bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
15605f2c45f1SShri Abhyankar 
15615b3f975aSHong Zhang   Options Database Key:
15625b3f975aSHong Zhang + -dmnetwork_view - Calls DMView() at the conclusion of DMSetUp()
15635b3f975aSHong Zhang - -dmnetwork_view_distributed - Calls DMView() at the conclusion of DMNetworkDistribute()
15645b3f975aSHong Zhang 
15655f2c45f1SShri Abhyankar   Notes:
15668b171c8eSHong Zhang   Distributes the network with <overlap>-overlapping partitioning of the edges.
15675f2c45f1SShri Abhyankar 
15685f2c45f1SShri Abhyankar   Level: intermediate
15695f2c45f1SShri Abhyankar 
1570db781477SPatrick Sanan .seealso: `DMNetworkCreate()`
15715f2c45f1SShri Abhyankar @*/
15729371c9d4SSatish Balay PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap) {
1573d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1574d3464fd4SAdrian Maldonado   PetscMPIInt              size;
1575d3464fd4SAdrian Maldonado   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data);
1576d3464fd4SAdrian Maldonado   DM_Network              *newDMnetwork;
1577caf410d2SHong Zhang   PetscSF                  pointsf = NULL;
15785f2c45f1SShri Abhyankar   DM                       newDM;
1579f11a936eSBarry Smith   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv;
15805c6496baSHong Zhang   PetscInt                 net, *sv;
1581f11a936eSBarry Smith   PetscBT                  btable;
158251ac5effSHong Zhang   PetscPartitioner         part;
1583b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
15845f2c45f1SShri Abhyankar 
15855f2c45f1SShri Abhyankar   PetscFunctionBegin;
15865c6496baSHong Zhang   PetscValidPointer(dm, 1);
15875c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
15889566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
15899566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1590d3464fd4SAdrian Maldonado   if (size == 1) PetscFunctionReturn(0);
1591d3464fd4SAdrian Maldonado 
15925c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
15935b3f975aSHong Zhang 
15942bf73ac6SHong 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. */
1595e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
15969566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
15975f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
159854dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
15999566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
160051ac5effSHong Zhang 
160151ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
16029566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
16039566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
160451ac5effSHong Zhang 
16052bf73ac6SHong Zhang   /* Distribute plex dm */
16069566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
160751ac5effSHong Zhang 
16085f2c45f1SShri Abhyankar   /* Distribute dof section */
16099566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
16109566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
161151ac5effSHong Zhang 
16125f2c45f1SShri Abhyankar   /* Distribute data and associated section */
16139566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
16149566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
161524121865SAdrian Maldonado 
1616daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1617daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1618daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1619daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1620daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1621daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1622daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1623daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1624daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
162524121865SAdrian Maldonado 
16261bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
16279566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
16289566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
16295f2c45f1SShri Abhyankar 
1630b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1631daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1632daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1633daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1634daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1635daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1636daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
16372bf73ac6SHong Zhang 
16382bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
16392bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1640b9c6e19dSShri Abhyankar   */
1641daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1642f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1643daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1644daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1645b9c6e19dSShri Abhyankar   }
1646b9c6e19dSShri Abhyankar 
1647f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1648daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
16499566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
165054dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16515c6496baSHong Zhang 
165254dfd506SHong Zhang     /* Update pointers */
165354dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
165454dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
165554dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
165654dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
165754dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
165854dfd506SHong Zhang 
1659daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1660b9c6e19dSShri Abhyankar   }
1661b9c6e19dSShri Abhyankar 
16625c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
1663*48a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
16645c6496baSHong Zhang 
16655c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1666daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
16679566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
16685f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16695c6496baSHong Zhang 
167054dfd506SHong Zhang     /* Update pointers */
167154dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
167254dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
167354dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
167454dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
167554dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
167654dfd506SHong Zhang 
16772bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
16782bf73ac6SHong Zhang     gidx = header->index;
1679daad07d3SAidan Hamilton     PetscCall(PetscTableFind(newDMnetwork->cloneshared->svtable, gidx + 1, &svtx_idx));
16802bf73ac6SHong Zhang     svtx_idx--;
16812bf73ac6SHong Zhang 
16822bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1683daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
16842bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
16855c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
16869566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1687f11a936eSBarry Smith 
1688daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1689daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
16905c6496baSHong Zhang         net = sv[0];
1691daad07d3SAidan Hamilton         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this proces */
16922bf73ac6SHong Zhang       }
16932bf73ac6SHong Zhang     }
1694b9c6e19dSShri Abhyankar   }
1695b9c6e19dSShri Abhyankar 
16962bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
16972bf73ac6SHong Zhang   nv = 0;
1698daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1699daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1700caf410d2SHong Zhang 
17012bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1702daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1703daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1704daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1705daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1706daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1707daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
17082bf73ac6SHong Zhang 
1709daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1710daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1711caf410d2SHong Zhang 
17122bf73ac6SHong 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. */
1713daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1714b9c6e19dSShri Abhyankar   }
1715daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1716b9c6e19dSShri Abhyankar 
17172bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1718daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
17199566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
17205f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1721daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1722b9c6e19dSShri Abhyankar   }
1723b9c6e19dSShri Abhyankar 
17242bf73ac6SHong Zhang   nv = 0;
1725daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
17269566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
17275f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
17282bf73ac6SHong Zhang 
17292bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1730daad07d3SAidan Hamilton     PetscCall(PetscTableFind(newDMnetwork->cloneshared->svtable, header->index + 1, &svtx_idx));
17312bf73ac6SHong Zhang     svtx_idx--;
17322bf73ac6SHong Zhang     if (svtx_idx < 0) {
1733daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
17342bf73ac6SHong Zhang     } else { /* a shared vertex */
1735daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
17362bf73ac6SHong Zhang 
17375c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
17389566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1739f11a936eSBarry Smith 
1740daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1741daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
17425c6496baSHong Zhang         net = sv[0];
17439371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1744b9c6e19dSShri Abhyankar       }
17452bf73ac6SHong Zhang     }
17462bf73ac6SHong Zhang   }
1747daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1748b9c6e19dSShri Abhyankar 
1749caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1750daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1751caf410d2SHong Zhang 
17522bf73ac6SHong Zhang   /* Free spaces */
17539566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
17549566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
1755*48a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
17562bf73ac6SHong Zhang 
17575b3f975aSHong Zhang   /* View distributed dmnetwork */
17589566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
17595b3f975aSHong Zhang 
1760d3464fd4SAdrian Maldonado   *dm = newDM;
1761e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
17625f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
17635f2c45f1SShri Abhyankar }
17645f2c45f1SShri Abhyankar 
176524121865SAdrian Maldonado /*@C
17662bf73ac6SHong Zhang   PetscSFGetSubSF - Returns an SF for a specific subset of points. Leaves are re-numbered to reflect the new ordering
17672bf73ac6SHong Zhang 
17682bf73ac6SHong Zhang  Collective
176924121865SAdrian Maldonado 
177024121865SAdrian Maldonado   Input Parameters:
17719dddd249SSatish Balay + mainSF - the original SF structure
177224121865SAdrian Maldonado - map - a ISLocalToGlobal mapping that contains the subset of points
177324121865SAdrian Maldonado 
177497bb3fdcSJose E. Roman   Output Parameter:
17759dddd249SSatish Balay . subSF - a subset of the mainSF for the desired subset.
1776ee300463SSatish Balay 
1777ee300463SSatish Balay   Level: intermediate
17787d928bffSSatish Balay @*/
17799371c9d4SSatish Balay PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF) {
178024121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
178124121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
178224121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
178324121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
178424121865SAdrian Maldonado   const PetscInt    *ilocal;
178524121865SAdrian Maldonado   const PetscSFNode *iremote;
178624121865SAdrian Maldonado 
178724121865SAdrian Maldonado   PetscFunctionBegin;
17889566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
178924121865SAdrian Maldonado 
179024121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
17919566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
17929566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
179324121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
179424121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
179524121865SAdrian Maldonado   }
179624121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
17979566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
179824121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
17999566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
18009566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
18019566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
180224121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
18039566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
18049566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
180524121865SAdrian Maldonado   nleaves_sub = 0;
180624121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
180724121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
180824121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
18094b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
181024121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
181124121865SAdrian Maldonado       nleaves_sub += 1;
181224121865SAdrian Maldonado     }
181324121865SAdrian Maldonado   }
18149566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
18159566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
181624121865SAdrian Maldonado 
181724121865SAdrian Maldonado   /* Create new subSF */
18189566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(PETSC_COMM_WORLD, subSF));
18199566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
18209566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
18219566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
18229566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
182324121865SAdrian Maldonado   PetscFunctionReturn(0);
182424121865SAdrian Maldonado }
182524121865SAdrian Maldonado 
18265f2c45f1SShri Abhyankar /*@C
18275f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
18285f2c45f1SShri Abhyankar 
18295f2c45f1SShri Abhyankar   Not Collective
18305f2c45f1SShri Abhyankar 
18315f2c45f1SShri Abhyankar   Input Parameters:
18322bf73ac6SHong Zhang + dm - the DMNetwork object
18335f2c45f1SShri Abhyankar - p  - the vertex point
18345f2c45f1SShri Abhyankar 
1835fd292e60Sprj-   Output Parameters:
18365f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
18372bf73ac6SHong Zhang - edges  - list of edge points
18385f2c45f1SShri Abhyankar 
183997bb938eSShri Abhyankar   Level: beginner
18405f2c45f1SShri Abhyankar 
18415f2c45f1SShri Abhyankar   Fortran Notes:
18425f2c45f1SShri Abhyankar   Since it returns an array, this routine is only available in Fortran 90, and you must
18435f2c45f1SShri Abhyankar   include petsc.h90 in your code.
18445f2c45f1SShri Abhyankar 
1845db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
18465f2c45f1SShri Abhyankar @*/
18479371c9d4SSatish Balay PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[]) {
18485f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
18495f2c45f1SShri Abhyankar 
18505f2c45f1SShri Abhyankar   PetscFunctionBegin;
18519566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
18529566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
18535f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
18545f2c45f1SShri Abhyankar }
18555f2c45f1SShri Abhyankar 
18565f2c45f1SShri Abhyankar /*@C
1857d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
18585f2c45f1SShri Abhyankar 
18595f2c45f1SShri Abhyankar   Not Collective
18605f2c45f1SShri Abhyankar 
18615f2c45f1SShri Abhyankar   Input Parameters:
18622bf73ac6SHong Zhang + dm - the DMNetwork object
18635f2c45f1SShri Abhyankar - p - the edge point
18645f2c45f1SShri Abhyankar 
1865fd292e60Sprj-   Output Parameters:
18665f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
18675f2c45f1SShri Abhyankar 
186897bb938eSShri Abhyankar   Level: beginner
18695f2c45f1SShri Abhyankar 
18705f2c45f1SShri Abhyankar   Fortran Notes:
18715f2c45f1SShri Abhyankar   Since it returns an array, this routine is only available in Fortran 90, and you must
18725f2c45f1SShri Abhyankar   include petsc.h90 in your code.
18735f2c45f1SShri Abhyankar 
1874db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
18755f2c45f1SShri Abhyankar @*/
18769371c9d4SSatish Balay PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[]) {
18775f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
18785f2c45f1SShri Abhyankar 
18795f2c45f1SShri Abhyankar   PetscFunctionBegin;
18809566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
18815f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
18825f2c45f1SShri Abhyankar }
18835f2c45f1SShri Abhyankar 
18845f2c45f1SShri Abhyankar /*@
18852bf73ac6SHong Zhang   DMNetworkIsSharedVertex - Returns TRUE if the vertex is shared by subnetworks
18862bf73ac6SHong Zhang 
18872bf73ac6SHong Zhang   Not Collective
18882bf73ac6SHong Zhang 
18892bf73ac6SHong Zhang   Input Parameters:
18902bf73ac6SHong Zhang + dm - the DMNetwork object
18912bf73ac6SHong Zhang - p - the vertex point
18922bf73ac6SHong Zhang 
18932bf73ac6SHong Zhang   Output Parameter:
18942bf73ac6SHong Zhang . flag - TRUE if the vertex is shared by subnetworks
18952bf73ac6SHong Zhang 
18962bf73ac6SHong Zhang   Level: beginner
18972bf73ac6SHong Zhang 
1898db781477SPatrick Sanan .seealso: `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
18992bf73ac6SHong Zhang @*/
19009371c9d4SSatish Balay PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag) {
19012bf73ac6SHong Zhang   PetscInt i;
19022bf73ac6SHong Zhang 
19032bf73ac6SHong Zhang   PetscFunctionBegin;
19042bf73ac6SHong Zhang   *flag = PETSC_FALSE;
19052bf73ac6SHong Zhang 
19062bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
19072bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
19082bf73ac6SHong Zhang     PetscInt    gidx;
19099566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
1910daad07d3SAidan Hamilton     PetscCall(PetscTableFind(network->cloneshared->svtable, gidx + 1, &i));
19112bf73ac6SHong Zhang     if (i) *flag = PETSC_TRUE;
19122bf73ac6SHong Zhang   } else { /* would be removed? */
19132bf73ac6SHong Zhang     PetscInt        nv;
19142bf73ac6SHong Zhang     const PetscInt *vtx;
19159566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
19162bf73ac6SHong Zhang     for (i = 0; i < nv; i++) {
19172bf73ac6SHong Zhang       if (p == vtx[i]) {
19182bf73ac6SHong Zhang         *flag = PETSC_TRUE;
19192bf73ac6SHong Zhang         break;
19202bf73ac6SHong Zhang       }
19212bf73ac6SHong Zhang     }
19222bf73ac6SHong Zhang   }
19232bf73ac6SHong Zhang   PetscFunctionReturn(0);
19242bf73ac6SHong Zhang }
19252bf73ac6SHong Zhang 
19262bf73ac6SHong Zhang /*@
19275f2c45f1SShri Abhyankar   DMNetworkIsGhostVertex - Returns TRUE if the vertex is a ghost vertex
19285f2c45f1SShri Abhyankar 
19295f2c45f1SShri Abhyankar   Not Collective
19305f2c45f1SShri Abhyankar 
19315f2c45f1SShri Abhyankar   Input Parameters:
19322bf73ac6SHong Zhang + dm - the DMNetwork object
1933a2b725a8SWilliam Gropp - p - the vertex point
19345f2c45f1SShri Abhyankar 
19355f2c45f1SShri Abhyankar   Output Parameter:
19365f2c45f1SShri Abhyankar . isghost - TRUE if the vertex is a ghost point
19375f2c45f1SShri Abhyankar 
193897bb938eSShri Abhyankar   Level: beginner
19395f2c45f1SShri Abhyankar 
1940db781477SPatrick Sanan .seealso: `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
19415f2c45f1SShri Abhyankar @*/
19429371c9d4SSatish Balay PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost) {
19435f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
19445f2c45f1SShri Abhyankar   PetscInt     offsetg;
19455f2c45f1SShri Abhyankar   PetscSection sectiong;
19465f2c45f1SShri Abhyankar 
19475f2c45f1SShri Abhyankar   PetscFunctionBegin;
19485f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
19499566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
19509566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
19515f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
19525f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
19535f2c45f1SShri Abhyankar }
19545f2c45f1SShri Abhyankar 
19559371c9d4SSatish Balay PetscErrorCode DMSetUp_Network(DM dm) {
19565f2c45f1SShri Abhyankar   PetscFunctionBegin;
1957e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
1958daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
19595b3f975aSHong Zhang   /* View dmnetwork */
19609566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
1961e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
19625f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
19635f2c45f1SShri Abhyankar }
19645f2c45f1SShri Abhyankar 
19651ad426b7SHong Zhang /*@
196617df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
19671ad426b7SHong Zhang       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TURE)?
19681ad426b7SHong Zhang 
19691ad426b7SHong Zhang   Collective
19701ad426b7SHong Zhang 
19711ad426b7SHong Zhang   Input Parameters:
19722bf73ac6SHong Zhang + dm - the DMNetwork object
197383b2e829SHong Zhang . eflg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE) if user provides Jacobian for edges
197483b2e829SHong Zhang - vflg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE) if user provides Jacobian for vertices
19751ad426b7SHong Zhang 
19761ad426b7SHong Zhang  Level: intermediate
19771ad426b7SHong Zhang 
19781ad426b7SHong Zhang @*/
19799371c9d4SSatish Balay PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg) {
19801ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
1981daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
19821ad426b7SHong Zhang 
19831ad426b7SHong Zhang   PetscFunctionBegin;
198483b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
198583b2e829SHong Zhang   network->userVertexJacobian = vflg;
19868675203cSHong Zhang 
1987*48a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
19888675203cSHong Zhang 
198966b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
1990daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
199166b4e0ffSHong Zhang     PetscInt        nedges_total;
19928675203cSHong Zhang     const PetscInt *edges;
19938675203cSHong Zhang 
19948675203cSHong Zhang     /* count nvertex_total */
19958675203cSHong Zhang     nedges_total = 0;
19969566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
19978675203cSHong Zhang 
19988675203cSHong Zhang     vptr[0] = 0;
19998675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
20009566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
20018675203cSHong Zhang       nedges_total += nedges;
20028675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
20038675203cSHong Zhang     }
20048675203cSHong Zhang 
20059566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
20068675203cSHong Zhang     network->Jvptr = vptr;
20078675203cSHong Zhang   }
20081ad426b7SHong Zhang   PetscFunctionReturn(0);
20091ad426b7SHong Zhang }
20101ad426b7SHong Zhang 
20111ad426b7SHong Zhang /*@
201283b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
201383b2e829SHong Zhang 
201483b2e829SHong Zhang   Not Collective
201583b2e829SHong Zhang 
201683b2e829SHong Zhang   Input Parameters:
20172bf73ac6SHong Zhang + dm - the DMNetwork object
201883b2e829SHong Zhang . p - the edge point
20193e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
20203e97b6e8SHong Zhang         J[0]: this edge
2021d842c372SHong Zhang         J[1] and J[2]: connected vertices, obtained by calling DMNetworkGetConnectedVertices()
202283b2e829SHong Zhang 
202397bb938eSShri Abhyankar   Level: advanced
202483b2e829SHong Zhang 
2025db781477SPatrick Sanan .seealso: `DMNetworkVertexSetMatrix()`
202683b2e829SHong Zhang @*/
20279371c9d4SSatish Balay PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[]) {
202883b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
202983b2e829SHong Zhang 
203083b2e829SHong Zhang   PetscFunctionBegin;
20315c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
20328675203cSHong Zhang 
20338675203cSHong Zhang   if (J) {
2034883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2035883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2036883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
20378675203cSHong Zhang   }
203883b2e829SHong Zhang   PetscFunctionReturn(0);
203983b2e829SHong Zhang }
204083b2e829SHong Zhang 
204183b2e829SHong Zhang /*@
204276ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
20431ad426b7SHong Zhang 
20441ad426b7SHong Zhang   Not Collective
20451ad426b7SHong Zhang 
20461ad426b7SHong Zhang   Input Parameters:
20471ad426b7SHong Zhang + dm - The DMNetwork object
20481ad426b7SHong Zhang . p - the vertex point
20493e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
20503e97b6e8SHong Zhang         J[0]:       this vertex
20513e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
20523e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
20531ad426b7SHong Zhang 
205497bb938eSShri Abhyankar   Level: advanced
20551ad426b7SHong Zhang 
2056db781477SPatrick Sanan .seealso: `DMNetworkEdgeSetMatrix()`
20571ad426b7SHong Zhang @*/
20589371c9d4SSatish Balay PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[]) {
20595f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2060daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2061883e35e8SHong Zhang   const PetscInt *edges;
20625f2c45f1SShri Abhyankar 
20635f2c45f1SShri Abhyankar   PetscFunctionBegin;
20645c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2065883e35e8SHong Zhang 
20668675203cSHong Zhang   if (J) {
2067883e35e8SHong Zhang     vptr                          = network->Jvptr;
20683e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
20693e97b6e8SHong Zhang 
20703e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
20719566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2072883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
20738675203cSHong Zhang   }
2074883e35e8SHong Zhang   PetscFunctionReturn(0);
2075883e35e8SHong Zhang }
2076883e35e8SHong Zhang 
20779371c9d4SSatish Balay static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz) {
20785cf7da58SHong Zhang   PetscInt    j;
20795cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
20805cf7da58SHong Zhang 
20815cf7da58SHong Zhang   PetscFunctionBegin;
20825cf7da58SHong Zhang   if (!ghost) {
2083*48a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
20845cf7da58SHong Zhang   } else {
2085*48a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
20865cf7da58SHong Zhang   }
20875cf7da58SHong Zhang   PetscFunctionReturn(0);
20885cf7da58SHong Zhang }
20895cf7da58SHong Zhang 
20909371c9d4SSatish Balay static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz) {
20915cf7da58SHong Zhang   PetscInt    j, ncols_u;
20925cf7da58SHong Zhang   PetscScalar val;
20935cf7da58SHong Zhang 
20945cf7da58SHong Zhang   PetscFunctionBegin;
20955cf7da58SHong Zhang   if (!ghost) {
20965cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
20979566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
20985cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
20999566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
21009566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
21015cf7da58SHong Zhang     }
21025cf7da58SHong Zhang   } else {
21035cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
21049566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
21055cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
21069566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
21079566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
21085cf7da58SHong Zhang     }
21095cf7da58SHong Zhang   }
21105cf7da58SHong Zhang   PetscFunctionReturn(0);
21115cf7da58SHong Zhang }
21125cf7da58SHong Zhang 
21139371c9d4SSatish Balay static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz) {
21145cf7da58SHong Zhang   PetscFunctionBegin;
21155cf7da58SHong Zhang   if (Ju) {
21169566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
21175cf7da58SHong Zhang   } else {
21189566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
21195cf7da58SHong Zhang   }
21205cf7da58SHong Zhang   PetscFunctionReturn(0);
21215cf7da58SHong Zhang }
21225cf7da58SHong Zhang 
21239371c9d4SSatish Balay static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J) {
2124883e35e8SHong Zhang   PetscInt     j, *cols;
2125883e35e8SHong Zhang   PetscScalar *zeros;
2126883e35e8SHong Zhang 
2127883e35e8SHong Zhang   PetscFunctionBegin;
21289566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2129883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
21309566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
21319566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
21321ad426b7SHong Zhang   PetscFunctionReturn(0);
21331ad426b7SHong Zhang }
2134a4e85ca8SHong Zhang 
21359371c9d4SSatish Balay static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J) {
21363e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
21373e97b6e8SHong Zhang   const PetscInt *cols;
21383e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
21393e97b6e8SHong Zhang 
21403e97b6e8SHong Zhang   PetscFunctionBegin;
21419566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
214263a3b9bcSJacob 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);
21433e97b6e8SHong Zhang 
21443e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
21459566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
21463e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
21473e97b6e8SHong Zhang       col = cols[j] + cstart;
21489566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
21493e97b6e8SHong Zhang     }
21509566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
21513e97b6e8SHong Zhang   }
21523e97b6e8SHong Zhang   PetscFunctionReturn(0);
21533e97b6e8SHong Zhang }
21541ad426b7SHong Zhang 
21559371c9d4SSatish Balay static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J) {
2156a4e85ca8SHong Zhang   PetscFunctionBegin;
2157a4e85ca8SHong Zhang   if (Ju) {
21589566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2159a4e85ca8SHong Zhang   } else {
21609566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2161a4e85ca8SHong Zhang   }
2162a4e85ca8SHong Zhang   PetscFunctionReturn(0);
2163a4e85ca8SHong Zhang }
2164a4e85ca8SHong Zhang 
216524121865SAdrian 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.
216624121865SAdrian Maldonado */
21679371c9d4SSatish Balay PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog) {
216824121865SAdrian Maldonado   PetscInt  i, size, dof;
216924121865SAdrian Maldonado   PetscInt *glob2loc;
217024121865SAdrian Maldonado 
217124121865SAdrian Maldonado   PetscFunctionBegin;
21729566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
21739566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
217424121865SAdrian Maldonado 
217524121865SAdrian Maldonado   for (i = 0; i < size; i++) {
21769566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
217724121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
217824121865SAdrian Maldonado     glob2loc[i] = dof;
217924121865SAdrian Maldonado   }
218024121865SAdrian Maldonado 
21819566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
218224121865SAdrian Maldonado #if 0
21839566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
218424121865SAdrian Maldonado #endif
218524121865SAdrian Maldonado   PetscFunctionReturn(0);
218624121865SAdrian Maldonado }
218724121865SAdrian Maldonado 
218801ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
21899e1d080bSHong Zhang 
21909371c9d4SSatish Balay PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J) {
21911ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
219224121865SAdrian Maldonado   PetscInt               eDof, vDof;
219324121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
21949e1d080bSHong Zhang   MPI_Comm               comm;
219524121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
219624121865SAdrian Maldonado 
21979e1d080bSHong Zhang   PetscFunctionBegin;
21989566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
219924121865SAdrian Maldonado 
22009566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
22019566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
220224121865SAdrian Maldonado 
22039566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
22049566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
22059566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
220624121865SAdrian Maldonado 
22079566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
22089566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
22099566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
221024121865SAdrian Maldonado 
22119566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
22129566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
22139566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
221424121865SAdrian Maldonado 
22159566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
22169566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
22179566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
221824121865SAdrian Maldonado 
22193f6a6bdaSHong Zhang   bA[0][0] = j11;
22203f6a6bdaSHong Zhang   bA[0][1] = j12;
22213f6a6bdaSHong Zhang   bA[1][0] = j21;
22223f6a6bdaSHong Zhang   bA[1][1] = j22;
222324121865SAdrian Maldonado 
22249566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
22259566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
222624121865SAdrian Maldonado 
22279566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
22289566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
22299566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
22309566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
223124121865SAdrian Maldonado 
22329566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
22339566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
22349566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
22359566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
223624121865SAdrian Maldonado 
22379566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
22389566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
22399566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
22409566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
22419566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
22429566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
22439566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
224424121865SAdrian Maldonado 
22459566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
22469566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
22479566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
224824121865SAdrian Maldonado 
224924121865SAdrian Maldonado   /* Free structures */
22509566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
22519566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
225224121865SAdrian Maldonado   PetscFunctionReturn(0);
22539e1d080bSHong Zhang }
22549e1d080bSHong Zhang 
22559371c9d4SSatish Balay PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J) {
22569e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
22579e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
22589e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
22599e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
22609e1d080bSHong Zhang   Mat             Juser;
22619e1d080bSHong Zhang   PetscSection    sectionGlobal;
22629e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
22639e1d080bSHong Zhang   const PetscInt *edges, *cone;
22649e1d080bSHong Zhang   MPI_Comm        comm;
22659e1d080bSHong Zhang   MatType         mtype;
22669e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
22679e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
22689e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
22699e1d080bSHong Zhang 
22709e1d080bSHong Zhang   PetscFunctionBegin;
22719e1d080bSHong Zhang   mtype = dm->mattype;
22729566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
22739e1d080bSHong Zhang   if (isNest) {
22749566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
22759566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
22769e1d080bSHong Zhang     PetscFunctionReturn(0);
22779e1d080bSHong Zhang   }
22789e1d080bSHong Zhang 
22799e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2280a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
22819566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
22829566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
22831ad426b7SHong Zhang     PetscFunctionReturn(0);
22841ad426b7SHong Zhang   }
22851ad426b7SHong Zhang 
22869566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
22879566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
22889566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
22899566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
22902a945128SHong Zhang 
22919566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
22929566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
229389898e50SHong Zhang 
229489898e50SHong Zhang   /* (1) Set matrix preallocation */
229589898e50SHong Zhang   /*------------------------------*/
22969566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
22979566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
22989566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
22999566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
23009566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
23019566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2302840c2264SHong Zhang 
230389898e50SHong Zhang   /* Set preallocation for edges */
230489898e50SHong Zhang   /*-----------------------------*/
23059566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2306840c2264SHong Zhang 
23079566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2308840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2309840c2264SHong Zhang     /* Get row indices */
23109566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
23119566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2312840c2264SHong Zhang     if (nrows) {
2313840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2314840c2264SHong Zhang 
2315a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
23169566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2317840c2264SHong Zhang       for (v = 0; v < 2; v++) {
23189566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2319840c2264SHong Zhang 
23208675203cSHong Zhang         if (network->Je) {
2321840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
23228675203cSHong Zhang         } else Juser = NULL;
23239566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
23249566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2325840c2264SHong Zhang       }
2326840c2264SHong Zhang 
232789898e50SHong Zhang       /* Set preallocation for edge self */
2328840c2264SHong Zhang       cstart = rstart;
23298675203cSHong Zhang       if (network->Je) {
2330840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
23318675203cSHong Zhang       } else Juser = NULL;
23329566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2333840c2264SHong Zhang     }
2334840c2264SHong Zhang   }
2335840c2264SHong Zhang 
233689898e50SHong Zhang   /* Set preallocation for vertices */
233789898e50SHong Zhang   /*--------------------------------*/
23389566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
23398675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2340840c2264SHong Zhang 
2341840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2342840c2264SHong Zhang     /* Get row indices */
23439566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
23449566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2345840c2264SHong Zhang     if (!nrows) continue;
2346840c2264SHong Zhang 
23479566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2348bdcb62a2SHong Zhang     if (ghost) {
23499566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2350bdcb62a2SHong Zhang     } else {
2351bdcb62a2SHong Zhang       rows_v = rows;
2352bdcb62a2SHong Zhang     }
2353bdcb62a2SHong Zhang 
2354bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2355840c2264SHong Zhang 
2356840c2264SHong Zhang     /* Get supporting edges and connected vertices */
23579566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2358840c2264SHong Zhang 
2359840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2360840c2264SHong Zhang       /* Supporting edges */
23619566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
23629566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2363840c2264SHong Zhang 
23648675203cSHong Zhang       if (network->Jv) {
2365840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
23668675203cSHong Zhang       } else Juser = NULL;
23679566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2368840c2264SHong Zhang 
2369840c2264SHong Zhang       /* Connected vertices */
23709566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2371840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
23729566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2373840c2264SHong Zhang 
23749566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2375840c2264SHong Zhang 
23768675203cSHong Zhang       if (network->Jv) {
2377840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
23788675203cSHong Zhang       } else Juser = NULL;
2379e102a522SHong Zhang       if (ghost_vc || ghost) {
2380e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2381e102a522SHong Zhang       } else {
2382e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2383e102a522SHong Zhang       }
23849566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2385840c2264SHong Zhang     }
2386840c2264SHong Zhang 
238789898e50SHong Zhang     /* Set preallocation for vertex self */
23889566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2389840c2264SHong Zhang     if (!ghost) {
23909566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
23918675203cSHong Zhang       if (network->Jv) {
2392840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
23938675203cSHong Zhang       } else Juser = NULL;
23949566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2395840c2264SHong Zhang     }
23961baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2397840c2264SHong Zhang   }
2398840c2264SHong Zhang 
23999566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
24009566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
24015cf7da58SHong Zhang 
24029566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
24035cf7da58SHong Zhang 
24049566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
24059566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2406840c2264SHong Zhang 
24079566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
24089566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2409840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2410e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2411e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2412840c2264SHong Zhang   }
24139566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
24149566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
24159566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
24169566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2417840c2264SHong Zhang 
24189566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
24199566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
24209566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
24215cf7da58SHong Zhang 
24229566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
24235cf7da58SHong Zhang 
242489898e50SHong Zhang   /* (2) Set matrix entries for edges */
242589898e50SHong Zhang   /*----------------------------------*/
24261ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2427bfbc38dcSHong Zhang     /* Get row indices */
24289566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
24299566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
24304b976069SHong Zhang     if (nrows) {
243117df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
24321ad426b7SHong Zhang 
2433a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
24349566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2435bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
24369566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
24379566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
24383e97b6e8SHong Zhang 
24398675203cSHong Zhang         if (network->Je) {
2440a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
24418675203cSHong Zhang         } else Juser = NULL;
24429566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2443bfbc38dcSHong Zhang       }
244417df6e9eSHong Zhang 
2445bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
24463e97b6e8SHong Zhang       cstart = rstart;
24478675203cSHong Zhang       if (network->Je) {
2448a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
24498675203cSHong Zhang       } else Juser = NULL;
24509566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
24511ad426b7SHong Zhang     }
24524b976069SHong Zhang   }
24531ad426b7SHong Zhang 
2454bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
245583b2e829SHong Zhang   /*---------------------------------*/
24561ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2457bfbc38dcSHong Zhang     /* Get row indices */
24589566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
24599566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
24604b976069SHong Zhang     if (!nrows) continue;
2461596e729fSHong Zhang 
24629566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2463bdcb62a2SHong Zhang     if (ghost) {
24649566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2465bdcb62a2SHong Zhang     } else {
2466bdcb62a2SHong Zhang       rows_v = rows;
2467bdcb62a2SHong Zhang     }
2468bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2469596e729fSHong Zhang 
2470bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
24719566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2472596e729fSHong Zhang 
2473596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2474bfbc38dcSHong Zhang       /* Supporting edges */
24759566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
24769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2477596e729fSHong Zhang 
24788675203cSHong Zhang       if (network->Jv) {
2479a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
24808675203cSHong Zhang       } else Juser = NULL;
24819566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2482596e729fSHong Zhang 
2483bfbc38dcSHong Zhang       /* Connected vertices */
24849566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
24852a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
24862a945128SHong Zhang 
24879566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
24889566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2489a4e85ca8SHong Zhang 
24908675203cSHong Zhang       if (network->Jv) {
2491a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
24928675203cSHong Zhang       } else Juser = NULL;
24939566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2494596e729fSHong Zhang     }
2495596e729fSHong Zhang 
2496bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
24971ad426b7SHong Zhang     if (!ghost) {
24989566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
24998675203cSHong Zhang       if (network->Jv) {
2500a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25018675203cSHong Zhang       } else Juser = NULL;
25029566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2503bdcb62a2SHong Zhang     }
25041baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
25051ad426b7SHong Zhang   }
25069566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2507bdcb62a2SHong Zhang 
25089566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
25099566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2510dd6f46cdSHong Zhang 
25119566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
25125f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
25135f2c45f1SShri Abhyankar }
25145f2c45f1SShri Abhyankar 
25159371c9d4SSatish Balay static PetscErrorCode DMNetworkDestroyComponentData(DM dm) {
2516daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2517daad07d3SAidan Hamilton   PetscInt    j, np;
2518daad07d3SAidan Hamilton 
2519daad07d3SAidan Hamilton   PetscFunctionBegin;
2520daad07d3SAidan Hamilton   if (network->header) {
2521daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2522daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2523daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2524daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2525daad07d3SAidan Hamilton     }
2526daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2527daad07d3SAidan Hamilton   }
2528daad07d3SAidan Hamilton   PetscFunctionReturn(0);
2529daad07d3SAidan Hamilton }
2530daad07d3SAidan Hamilton 
25319371c9d4SSatish Balay PetscErrorCode DMDestroy_Network(DM dm) {
25325f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2533aeb78aa7SBarry Smith   PetscInt    j;
25345f2c45f1SShri Abhyankar 
25355f2c45f1SShri Abhyankar   PetscFunctionBegin;
2536daad07d3SAidan Hamilton   /*
2537daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2538daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2539daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2540daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2541daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2542daad07d3SAidan Hamilton   */
2543daad07d3SAidan Hamilton 
2544daad07d3SAidan Hamilton   /* Always destroy data ON the network */
25459566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
254683b2e829SHong Zhang   if (network->Jv) {
25479566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
25489566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
25491ad426b7SHong Zhang   }
2550daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2551daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2552daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2553daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2554daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
255513c2a604SAdrian Maldonado 
2556daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2557daad07d3SAidan Hamilton 
2558daad07d3SAidan Hamilton   /*
2559daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2560daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2561daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2562daad07d3SAidan Hamilton     PetscSF                           sf;
2563daad07d3SAidan Hamilton   and data ON the network
2564daad07d3SAidan Hamilton     PetscSection                      DofSection;
2565daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2566daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2567daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2568daad07d3SAidan Hamilton   for any clone.
2569daad07d3SAidan Hamilton   */
25709566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
25719566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
25729566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
25739566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
257413c2a604SAdrian Maldonado   /* edge */
25759566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
25769566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
25779566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
25789566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2579daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2580daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2581daad07d3SAidan 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
2582daad07d3SAidan Hamilton      naively think it can be reused. */
2583daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2584daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2585daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2586daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2587daad07d3SAidan Hamilton     PetscCall(PetscTableDestroy(&network->cloneshared->svtable));
2588daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2589daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2590daad07d3SAidan Hamilton   }
2591daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
25925f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
25935f2c45f1SShri Abhyankar }
25945f2c45f1SShri Abhyankar 
25959371c9d4SSatish Balay PetscErrorCode DMView_Network(DM dm, PetscViewer viewer) {
2596caf410d2SHong Zhang   PetscBool   iascii;
2597caf410d2SHong Zhang   PetscMPIInt rank;
25985f2c45f1SShri Abhyankar 
25995f2c45f1SShri Abhyankar   PetscFunctionBegin;
2600caf410d2SHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2601caf410d2SHong Zhang   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
26029566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)dm), &rank));
26039566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2604caf410d2SHong Zhang   if (iascii) {
2605caf410d2SHong Zhang     const PetscInt *cone, *vtx, *edges;
26065c6496baSHong Zhang     PetscInt        vfrom, vto, i, j, nv, ne, nsv, p, nsubnet;
26072bf73ac6SHong Zhang     DM_Network     *network = (DM_Network *)dm->data;
2608caf410d2SHong Zhang 
2609daad07d3SAidan Hamilton     nsubnet = network->cloneshared->Nsubnet; /* num of subnetworks */
2610dd400576SPatrick Sanan     if (rank == 0) {
26119371c9d4SSatish Balay       PetscCall(PetscPrintf(PETSC_COMM_SELF, "  NSubnets: %" PetscInt_FMT "; NEdges: %" PetscInt_FMT "; NVertices: %" PetscInt_FMT "; NSharedVertices: %" PetscInt_FMT ".\n", nsubnet, network->cloneshared->NEdges, network->cloneshared->NVertices,
26129371c9d4SSatish Balay                             network->cloneshared->Nsvtx));
26132bf73ac6SHong Zhang     }
26142bf73ac6SHong Zhang 
26159566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nsv, NULL));
26169566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushSynchronized(viewer));
2617daad07d3SAidan Hamilton     PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "  [%d] nEdges: %" PetscInt_FMT "; nVertices: %" PetscInt_FMT "; nSharedVertices: %" PetscInt_FMT "\n", rank, network->cloneshared->nEdges, network->cloneshared->nVertices, nsv));
2618caf410d2SHong Zhang 
2619caf410d2SHong Zhang     for (i = 0; i < nsubnet; i++) {
26209566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSubnetwork(dm, i, &nv, &ne, &vtx, &edges));
2621caf410d2SHong Zhang       if (ne) {
26229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "     Subnet %" PetscInt_FMT ": nEdges %" PetscInt_FMT ", nVertices(include shared vertices) %" PetscInt_FMT "\n", i, ne, nv));
2623caf410d2SHong Zhang         for (j = 0; j < ne; j++) {
2624caf410d2SHong Zhang           p = edges[j];
26259566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetConnectedVertices(dm, p, &cone));
26269566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetGlobalVertexIndex(dm, cone[0], &vfrom));
26279566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetGlobalVertexIndex(dm, cone[1], &vto));
26289566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetGlobalEdgeIndex(dm, edges[j], &p));
26299566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "       edge %" PetscInt_FMT ": %" PetscInt_FMT " ----> %" PetscInt_FMT "\n", p, vfrom, vto));
2630caf410d2SHong Zhang         }
2631caf410d2SHong Zhang       }
2632caf410d2SHong Zhang     }
26332bf73ac6SHong Zhang 
26342bf73ac6SHong Zhang     /* Shared vertices */
26359566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, NULL, &vtx));
26365c6496baSHong Zhang     if (nsv) {
26375c6496baSHong Zhang       PetscInt        gidx;
26382bf73ac6SHong Zhang       PetscBool       ghost;
26395c6496baSHong Zhang       const PetscInt *sv = NULL;
26405c6496baSHong Zhang 
26419566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "     SharedVertices:\n"));
26425c6496baSHong Zhang       for (i = 0; i < nsv; i++) {
26439566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, vtx[i], &ghost));
26442bf73ac6SHong Zhang         if (ghost) continue;
26452bf73ac6SHong Zhang 
26469566063dSJacob Faibussowitsch         PetscCall(DMNetworkSharedVertexGetInfo(dm, vtx[i], &gidx, &nv, &sv));
26479566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "       svtx %" PetscInt_FMT ": global index %" PetscInt_FMT ", subnet[%" PetscInt_FMT "].%" PetscInt_FMT " ---->\n", i, gidx, sv[0], sv[1]));
2648*48a46eb9SPierre Jolivet         for (j = 1; j < nv; j++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "                                           ----> subnet[%" PetscInt_FMT "].%" PetscInt_FMT "\n", sv[2 * j], sv[2 * j + 1]));
2649caf410d2SHong Zhang       }
2650caf410d2SHong Zhang     }
26519566063dSJacob Faibussowitsch     PetscCall(PetscViewerFlush(viewer));
26529566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopSynchronized(viewer));
26535c6496baSHong Zhang   } else PetscCheck(iascii, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Viewer type %s not yet supported for DMNetwork writing", ((PetscObject)viewer)->type_name);
26545f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
26555f2c45f1SShri Abhyankar }
26565f2c45f1SShri Abhyankar 
26579371c9d4SSatish Balay PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l) {
26585f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
26595f2c45f1SShri Abhyankar 
26605f2c45f1SShri Abhyankar   PetscFunctionBegin;
26619566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
26625f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
26635f2c45f1SShri Abhyankar }
26645f2c45f1SShri Abhyankar 
26659371c9d4SSatish Balay PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l) {
26665f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
26675f2c45f1SShri Abhyankar 
26685f2c45f1SShri Abhyankar   PetscFunctionBegin;
26699566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
26705f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
26715f2c45f1SShri Abhyankar }
26725f2c45f1SShri Abhyankar 
26739371c9d4SSatish Balay PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g) {
26745f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
26755f2c45f1SShri Abhyankar 
26765f2c45f1SShri Abhyankar   PetscFunctionBegin;
26779566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
26785f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
26795f2c45f1SShri Abhyankar }
26805f2c45f1SShri Abhyankar 
26819371c9d4SSatish Balay PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g) {
26825f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
26835f2c45f1SShri Abhyankar 
26845f2c45f1SShri Abhyankar   PetscFunctionBegin;
26859566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
26865f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
26875f2c45f1SShri Abhyankar }
268822bbedd7SHong Zhang 
268922bbedd7SHong Zhang /*@
269064238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
269122bbedd7SHong Zhang 
269222bbedd7SHong Zhang   Not collective
269322bbedd7SHong Zhang 
26947a7aea1fSJed Brown   Input Parameters:
269522bbedd7SHong Zhang + dm - the dm object
269622bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
269722bbedd7SHong Zhang 
26987a7aea1fSJed Brown   Output Parameters:
2699f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
270022bbedd7SHong Zhang 
270197bb938eSShri Abhyankar   Level: advanced
270222bbedd7SHong Zhang 
2703db781477SPatrick Sanan .seealso: `DMNetworkSetVertexLocalToGlobalOrdering()`
270422bbedd7SHong Zhang @*/
27059371c9d4SSatish Balay PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg) {
270622bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2707daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
270822bbedd7SHong Zhang 
270922bbedd7SHong Zhang   PetscFunctionBegin;
27105c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
271122bbedd7SHong Zhang   *vg = vltog[vloc];
271222bbedd7SHong Zhang   PetscFunctionReturn(0);
271322bbedd7SHong Zhang }
271422bbedd7SHong Zhang 
271522bbedd7SHong Zhang /*@
271664238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
271722bbedd7SHong Zhang 
271822bbedd7SHong Zhang   Collective
271922bbedd7SHong Zhang 
272022bbedd7SHong Zhang   Input Parameters:
2721f0fc11ceSJed Brown . dm - the dm object
272222bbedd7SHong Zhang 
272397bb938eSShri Abhyankar   Level: advanced
272422bbedd7SHong Zhang 
2725db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalVertexIndex()`
272622bbedd7SHong Zhang @*/
27279371c9d4SSatish Balay PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm) {
272822bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
272922bbedd7SHong Zhang   MPI_Comm           comm;
27302bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
273122bbedd7SHong Zhang   PetscBool          ghost;
273263029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
273322bbedd7SHong Zhang   const PetscSFNode *iremote;
273422bbedd7SHong Zhang   PetscSF            vsf;
273563029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
273663029d29SHong Zhang   VecScatter         ctx;
273763029d29SHong Zhang   PetscScalar       *varr, val;
273863029d29SHong Zhang   const PetscScalar *varr_read;
273922bbedd7SHong Zhang 
274022bbedd7SHong Zhang   PetscFunctionBegin;
27419566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
27429566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
27439566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
274422bbedd7SHong Zhang 
274522bbedd7SHong Zhang   if (size == 1) {
2746daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
27479566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
274822bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2749daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
275022bbedd7SHong Zhang     PetscFunctionReturn(0);
275122bbedd7SHong Zhang   }
275222bbedd7SHong Zhang 
2753daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2754daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
275522bbedd7SHong Zhang 
2756daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
27579566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
275822bbedd7SHong Zhang   vsf = network->vertex.sf;
275922bbedd7SHong Zhang 
27609566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
27619566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
276222bbedd7SHong Zhang 
27639371c9d4SSatish Balay   for (i = 0; i < size; i++) {
27649371c9d4SSatish Balay     displs[i]     = i;
27659371c9d4SSatish Balay     recvcounts[i] = 1;
27669371c9d4SSatish Balay   }
276722bbedd7SHong Zhang 
276822bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
276922bbedd7SHong Zhang   vrange[0] = 0;
27709566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
277167dd800bSHong Zhang   for (i = 2; i < size + 1; i++) { vrange[i] += vrange[i - 1]; }
277222bbedd7SHong Zhang 
27739566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2774daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
277522bbedd7SHong Zhang 
277663029d29SHong Zhang   /* Set vltog for non-ghost vertices */
277763029d29SHong Zhang   k = 0;
277822bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2779daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
278063029d29SHong Zhang     if (ghost) continue;
278163029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
278222bbedd7SHong Zhang   }
27839566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
278463029d29SHong Zhang 
278563029d29SHong Zhang   /* Set vltog for ghost vertices */
278663029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
27879566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
27889566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
27899566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
27909566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
279163029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
279263029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
279363029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
279463029d29SHong Zhang   }
27959566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
279663029d29SHong Zhang 
279763029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
27989566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
27999566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
28009566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
280163029d29SHong Zhang 
280263029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
28039566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
28049566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
280563029d29SHong Zhang   for (i = 0; i < N; i += 2) {
28062e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
280763029d29SHong Zhang     if (remoterank == rank) {
280863029d29SHong Zhang       k    = i + 1; /* row number */
28092e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
281063029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
28119566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
281263029d29SHong Zhang     }
281363029d29SHong Zhang   }
28149566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
28159566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
28169566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
281763029d29SHong Zhang 
281863029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
28199566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
282063029d29SHong Zhang   k = 0;
282163029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2822daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
282363029d29SHong Zhang     if (!ghost) continue;
28249371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
28259371c9d4SSatish Balay     k++;
282663029d29SHong Zhang   }
28279566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
282863029d29SHong Zhang 
28299566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
28309566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
28319566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
283222bbedd7SHong Zhang   PetscFunctionReturn(0);
283322bbedd7SHong Zhang }
283442dc13f1SHong Zhang 
28359371c9d4SSatish Balay static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx) {
283642dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
283742dc13f1SHong Zhang   DMNetworkComponentHeader header;
283842dc13f1SHong Zhang 
283942dc13f1SHong Zhang   PetscFunctionBegin;
28409566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
284142dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
284242dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
284342dc13f1SHong Zhang 
284442dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
284542dc13f1SHong Zhang     key  = header->key[i];
284642dc13f1SHong Zhang     nvar = header->nvar[i];
284742dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
284842dc13f1SHong Zhang       if (key == keys[j]) {
284942dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
285042dc13f1SHong Zhang           *nidx += nvar;
285142dc13f1SHong Zhang         } else {
285242dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
285342dc13f1SHong Zhang         }
285442dc13f1SHong Zhang       }
285542dc13f1SHong Zhang     }
285642dc13f1SHong Zhang   }
285742dc13f1SHong Zhang   PetscFunctionReturn(0);
285842dc13f1SHong Zhang }
285942dc13f1SHong Zhang 
28609371c9d4SSatish Balay static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx) {
286142dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
286242dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
286342dc13f1SHong Zhang   DMNetworkComponentHeader header;
286442dc13f1SHong Zhang 
286542dc13f1SHong Zhang   PetscFunctionBegin;
28669566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
286742dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
286842dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
286942dc13f1SHong Zhang 
287042dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
287142dc13f1SHong Zhang     key  = header->key[i];
287242dc13f1SHong Zhang     nvar = header->nvar[i];
287342dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
287442dc13f1SHong Zhang       if (key != keys[j]) continue;
287542dc13f1SHong Zhang 
28769566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
287742dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
287842dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
287942dc13f1SHong Zhang       } else {
288042dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
288142dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
288242dc13f1SHong Zhang         }
288342dc13f1SHong Zhang       }
288442dc13f1SHong Zhang     }
288542dc13f1SHong Zhang   }
288642dc13f1SHong Zhang   PetscFunctionReturn(0);
288742dc13f1SHong Zhang }
288842dc13f1SHong Zhang 
288942dc13f1SHong Zhang /*@
289042dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
289142dc13f1SHong Zhang 
289242dc13f1SHong Zhang   Collective
289342dc13f1SHong Zhang 
289442dc13f1SHong Zhang   Input Parameters:
289542dc13f1SHong Zhang + dm - DMNetwork object
289642dc13f1SHong Zhang . numkeys - number of keys
289742dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
289842dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
289942dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
290042dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
290142dc13f1SHong Zhang 
290242dc13f1SHong Zhang   Output Parameters:
290342dc13f1SHong Zhang . is - the index set
290442dc13f1SHong Zhang 
290542dc13f1SHong Zhang   Level: Advanced
290642dc13f1SHong Zhang 
290742dc13f1SHong Zhang   Notes:
290842dc13f1SHong Zhang     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.
290942dc13f1SHong Zhang 
2910db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
291142dc13f1SHong Zhang @*/
29129371c9d4SSatish Balay PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is) {
291342dc13f1SHong Zhang   MPI_Comm    comm;
291442dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
291542dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
291642dc13f1SHong Zhang   PetscBool   ghost;
291742dc13f1SHong Zhang 
291842dc13f1SHong Zhang   PetscFunctionBegin;
29199566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
292042dc13f1SHong Zhang 
292142dc13f1SHong Zhang   /* Check input parameters */
292242dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
292342dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
292463a3b9bcSJacob 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]);
292542dc13f1SHong Zhang   }
292642dc13f1SHong Zhang 
29279566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
29289566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
292942dc13f1SHong Zhang 
293042dc13f1SHong Zhang   /* Get local number of idx */
293142dc13f1SHong Zhang   nidx = 0;
2932*48a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
293342dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
29349566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
293542dc13f1SHong Zhang     if (ghost) continue;
29369566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
293742dc13f1SHong Zhang   }
293842dc13f1SHong Zhang 
293942dc13f1SHong Zhang   /* Compute idx */
29409566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
294142dc13f1SHong Zhang   i = 0;
2942*48a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
294342dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
29449566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
294542dc13f1SHong Zhang     if (ghost) continue;
29469566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
294742dc13f1SHong Zhang   }
294842dc13f1SHong Zhang 
294942dc13f1SHong Zhang   /* Create is */
29509566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
29519566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
295242dc13f1SHong Zhang   PetscFunctionReturn(0);
295342dc13f1SHong Zhang }
295442dc13f1SHong Zhang 
29559371c9d4SSatish Balay static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx) {
295642dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
295742dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
295842dc13f1SHong Zhang   DMNetworkComponentHeader header;
295942dc13f1SHong Zhang 
296042dc13f1SHong Zhang   PetscFunctionBegin;
29619566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
296242dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
296342dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
296442dc13f1SHong Zhang 
296542dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
296642dc13f1SHong Zhang     key  = header->key[i];
296742dc13f1SHong Zhang     nvar = header->nvar[i];
296842dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
296942dc13f1SHong Zhang       if (key != keys[j]) continue;
297042dc13f1SHong Zhang 
29719566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
297242dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
297342dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
297442dc13f1SHong Zhang       } else {
297542dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
297642dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
297742dc13f1SHong Zhang         }
297842dc13f1SHong Zhang       }
297942dc13f1SHong Zhang     }
298042dc13f1SHong Zhang   }
298142dc13f1SHong Zhang   PetscFunctionReturn(0);
298242dc13f1SHong Zhang }
298342dc13f1SHong Zhang 
298442dc13f1SHong Zhang /*@
298542dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
298642dc13f1SHong Zhang 
298742dc13f1SHong Zhang   Not collective
298842dc13f1SHong Zhang 
298942dc13f1SHong Zhang   Input Parameters:
299042dc13f1SHong Zhang + dm - DMNetwork object
299142dc13f1SHong Zhang . numkeys - number of keys
299242dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
299342dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
299442dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
299542dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
299642dc13f1SHong Zhang 
299742dc13f1SHong Zhang   Output Parameters:
299842dc13f1SHong Zhang . is - the index set
299942dc13f1SHong Zhang 
300042dc13f1SHong Zhang   Level: Advanced
300142dc13f1SHong Zhang 
300242dc13f1SHong Zhang   Notes:
300342dc13f1SHong Zhang     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.
300442dc13f1SHong Zhang 
3005db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkCreateIS`, `ISCreateGeneral()`
300642dc13f1SHong Zhang @*/
30079371c9d4SSatish Balay PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is) {
300842dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
300942dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
301042dc13f1SHong Zhang 
301142dc13f1SHong Zhang   PetscFunctionBegin;
301242dc13f1SHong Zhang   /* Check input parameters */
301342dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
301442dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
301563a3b9bcSJacob 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]);
301642dc13f1SHong Zhang   }
301742dc13f1SHong Zhang 
3018daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3019daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
302042dc13f1SHong Zhang 
302142dc13f1SHong Zhang   /* Get local number of idx */
302242dc13f1SHong Zhang   nidx = 0;
3023*48a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
302442dc13f1SHong Zhang 
302542dc13f1SHong Zhang   /* Compute local idx */
30269566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
302742dc13f1SHong Zhang   i = 0;
3028*48a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
302942dc13f1SHong Zhang 
303042dc13f1SHong Zhang   /* Create is */
30319566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
30329566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
303342dc13f1SHong Zhang   PetscFunctionReturn(0);
303442dc13f1SHong Zhang }
3035daad07d3SAidan Hamilton /*@
3036daad07d3SAidan Hamilton   DMNetworkFinalizeComponents - Sets up interal data structures for the sections and components. It is called after registering new components and adding all components
3037daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3038daad07d3SAidan Hamilton 
3039daad07d3SAidan Hamilton   Collective
3040daad07d3SAidan Hamilton 
3041daad07d3SAidan Hamilton   Input Parameters:
3042daad07d3SAidan Hamilton . dm - the dmnetwork object
3043daad07d3SAidan Hamilton 
3044daad07d3SAidan Hamilton   Level: beginner
3045daad07d3SAidan Hamilton 
3046daad07d3SAidan Hamilton .seealso: `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3047daad07d3SAidan Hamilton @*/
30489371c9d4SSatish Balay PetscErrorCode DMNetworkFinalizeComponents(DM dm) {
3049daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3050daad07d3SAidan Hamilton 
3051daad07d3SAidan Hamilton   PetscFunctionBegin;
3052daad07d3SAidan Hamilton   if (network->componentsetup) PetscFunctionReturn(0);
3053daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3054daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3055daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3056daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3057daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
3058daad07d3SAidan Hamilton   PetscFunctionReturn(0);
3059daad07d3SAidan Hamilton }
3060