xref: /petsc/src/dm/impls/network/network.c (revision 6e4289a0dd4d962ed977e39cfbc50d2f2c3b3d96)
1af0996ceSBarry Smith #include <petsc/private/dmnetworkimpl.h> /*I  "petscdmnetwork.h"  I*/
25f2c45f1SShri Abhyankar 
3e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_LayoutSetUp;
4e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_SetUpNetwork;
5e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_Distribute;
6e3b1a053SGetnet Betrie 
754dfd506SHong Zhang /*
854dfd506SHong Zhang   Creates the component header and value objects for a network point
954dfd506SHong Zhang */
10d71ae5a4SJacob Faibussowitsch static PetscErrorCode SetUpNetworkHeaderComponentValue(DM dm, DMNetworkComponentHeader header, DMNetworkComponentValue cvalue)
11d71ae5a4SJacob Faibussowitsch {
1254dfd506SHong Zhang   PetscFunctionBegin;
1354dfd506SHong Zhang   /* Allocate arrays for component information */
149566063dSJacob Faibussowitsch   PetscCall(PetscCalloc5(header->maxcomps, &header->size, header->maxcomps, &header->key, header->maxcomps, &header->offset, header->maxcomps, &header->nvar, header->maxcomps, &header->offsetvarrel));
159566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(header->maxcomps, &cvalue->data));
1654dfd506SHong Zhang 
1754dfd506SHong Zhang   /* The size of the header is the size of struct _p_DMNetworkComponentHeader. Since the struct contains PetscInt pointers we cannot use sizeof(struct). So, we need to explicitly calculate the size.
1854dfd506SHong Zhang    If the data header struct changes then this header size calculation needs to be updated. */
1954dfd506SHong Zhang   header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
2054dfd506SHong Zhang   header->hsize /= sizeof(DMNetworkComponentGenericDataType);
213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2254dfd506SHong Zhang }
2354dfd506SHong Zhang 
24d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeHeaderComponentData(DM dm)
25d71ae5a4SJacob Faibussowitsch {
26daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
27daad07d3SAidan Hamilton   PetscInt    np, p, defaultnumcomp = DMNETWORK_MAX_COMP_AT_POINT_DEFAULT;
28daad07d3SAidan Hamilton 
29daad07d3SAidan Hamilton   PetscFunctionBegin;
30daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
31daad07d3SAidan Hamilton   if (network->header)
32daad07d3SAidan Hamilton     for (p = 0; p < np; p++) {
33daad07d3SAidan Hamilton       network->header[p].maxcomps = defaultnumcomp;
34daad07d3SAidan Hamilton       PetscCall(SetUpNetworkHeaderComponentValue(dm, &network->header[p], &network->cvalue[p]));
35daad07d3SAidan Hamilton     }
36daad07d3SAidan Hamilton 
373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
38daad07d3SAidan Hamilton }
395f2c45f1SShri Abhyankar /*@
40556ed216SShri Abhyankar   DMNetworkGetPlex - Gets the Plex DM associated with this network DM
41556ed216SShri Abhyankar 
42556ed216SShri Abhyankar   Not collective
43556ed216SShri Abhyankar 
44556ed216SShri Abhyankar   Input Parameters:
452bf73ac6SHong Zhang . dm - the dm object
462bf73ac6SHong Zhang 
472bf73ac6SHong Zhang   Output Parameters:
482bf73ac6SHong Zhang . plexdm - the plex dm object
49556ed216SShri Abhyankar 
50556ed216SShri Abhyankar   Level: Advanced
51556ed216SShri Abhyankar 
52db781477SPatrick Sanan .seealso: `DMNetworkCreate()`
53556ed216SShri Abhyankar @*/
54d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetPlex(DM dm, DM *plexdm)
55d71ae5a4SJacob Faibussowitsch {
562bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
57556ed216SShri Abhyankar 
58556ed216SShri Abhyankar   PetscFunctionBegin;
59556ed216SShri Abhyankar   *plexdm = network->plex;
603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
61556ed216SShri Abhyankar }
62556ed216SShri Abhyankar 
63556ed216SShri Abhyankar /*@
642bf73ac6SHong Zhang   DMNetworkGetNumSubNetworks - Gets the the number of subnetworks
6572c3e9f7SHong Zhang 
662bf73ac6SHong Zhang   Not collective
6772c3e9f7SHong Zhang 
68f899ff85SJose E. Roman   Input Parameter:
692bf73ac6SHong Zhang . dm - the dm object
702bf73ac6SHong Zhang 
712bf73ac6SHong Zhang   Output Parameters:
722bf73ac6SHong Zhang + nsubnet - local number of subnetworks
732bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
7472c3e9f7SHong Zhang 
7597bb938eSShri Abhyankar   Level: beginner
7672c3e9f7SHong Zhang 
77db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
7872c3e9f7SHong Zhang @*/
79d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PetscInt *nsubnet, PetscInt *Nsubnet)
80d71ae5a4SJacob Faibussowitsch {
812bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8272c3e9f7SHong Zhang 
8372c3e9f7SHong Zhang   PetscFunctionBegin;
84daad07d3SAidan Hamilton   if (nsubnet) *nsubnet = network->cloneshared->nsubnet;
85daad07d3SAidan Hamilton   if (Nsubnet) *Nsubnet = network->cloneshared->Nsubnet;
863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8772c3e9f7SHong Zhang }
8872c3e9f7SHong Zhang 
8972c3e9f7SHong Zhang /*@
902bf73ac6SHong Zhang   DMNetworkSetNumSubNetworks - Sets the number of subnetworks
915f2c45f1SShri Abhyankar 
92d083f849SBarry Smith   Collective on dm
935f2c45f1SShri Abhyankar 
945f2c45f1SShri Abhyankar   Input Parameters:
955f2c45f1SShri Abhyankar + dm - the dm object
962bf73ac6SHong Zhang . nsubnet - local number of subnetworks
972bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
985f2c45f1SShri Abhyankar 
9997bb938eSShri Abhyankar    Level: beginner
1001b266c99SBarry Smith 
101db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetNumSubNetworks()`
1025f2c45f1SShri Abhyankar @*/
103d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetNumSubNetworks(DM dm, PetscInt nsubnet, PetscInt Nsubnet)
104d71ae5a4SJacob Faibussowitsch {
1055f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1065f2c45f1SShri Abhyankar 
1075f2c45f1SShri Abhyankar   PetscFunctionBegin;
108d5b43468SJose E. Roman   PetscCheck(network->cloneshared->Nsubnet == 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Network sizes already set, cannot resize the network");
1092bf73ac6SHong Zhang 
1105f2c45f1SShri Abhyankar   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1112bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, nsubnet, 2);
1122bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, Nsubnet, 3);
1137765340cSHong Zhang 
1142bf73ac6SHong Zhang   if (Nsubnet == PETSC_DECIDE) {
1155c6496baSHong Zhang     PetscCheck(nsubnet >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Number of local subnetworks %" PetscInt_FMT " cannot be less than 0", nsubnet);
1161c2dc1cbSBarry Smith     PetscCall(MPIU_Allreduce(&nsubnet, &Nsubnet, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
117caf410d2SHong Zhang   }
1185c6496baSHong Zhang   PetscCheck(Nsubnet >= 1, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Number of global subnetworks %" PetscInt_FMT " cannot be less than 1", Nsubnet);
119caf410d2SHong Zhang 
120daad07d3SAidan Hamilton   network->cloneshared->Nsubnet = Nsubnet;
121da81f932SPierre Jolivet   network->cloneshared->nsubnet = 0; /* initial value; will be determined by DMNetworkAddSubnetwork() */
122daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(Nsubnet, &network->cloneshared->subnet));
123caf410d2SHong Zhang 
1242bf73ac6SHong Zhang   /* num of shared vertices */
125daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0;
126daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = 0;
1273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1287765340cSHong Zhang }
1297765340cSHong Zhang 
1305f2c45f1SShri Abhyankar /*@
1312bf73ac6SHong Zhang   DMNetworkAddSubnetwork - Add a subnetwork
1325f2c45f1SShri Abhyankar 
1332bf73ac6SHong Zhang   Collective on dm
1345f2c45f1SShri Abhyankar 
1355f2c45f1SShri Abhyankar   Input Parameters:
136e3e68989SHong Zhang + dm - the dm object
1372bf73ac6SHong Zhang . name - name of the subnetwork
1382bf73ac6SHong Zhang . ne - number of local edges of this subnetwork
1398d1cd658SBarry 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,
1408d1cd658SBarry Smith $            [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc]
1412bf73ac6SHong Zhang 
1422bf73ac6SHong Zhang   Output Parameters:
1432bf73ac6SHong Zhang . netnum - global index of the subnetwork
1445f2c45f1SShri Abhyankar 
1455f2c45f1SShri Abhyankar   Notes:
1465f2c45f1SShri Abhyankar   There is no copy involved in this operation, only the pointer is referenced. The edgelist should
1472bf73ac6SHong Zhang   not be destroyed before the call to DMNetworkLayoutSetUp()
1485f2c45f1SShri Abhyankar 
1498d1cd658SBarry 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,
1508d1cd658SBarry 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.
151f11a936eSBarry Smith 
15297bb938eSShri Abhyankar   Level: beginner
1535f2c45f1SShri Abhyankar 
154e3e68989SHong Zhang   Example usage:
155f11a936eSBarry Smith   Consider the following networks:
156d5b43468SJose E. Roman   1) A single subnetwork:
157e3e68989SHong Zhang .vb
158f11a936eSBarry Smith  network 0:
159f11a936eSBarry Smith  rank[0]:
160f11a936eSBarry Smith    v0 --> v2; v1 --> v2
161f11a936eSBarry Smith  rank[1]:
162f11a936eSBarry Smith    v3 --> v5; v4 --> v5
163e3e68989SHong Zhang .ve
164e3e68989SHong Zhang 
165e3e68989SHong Zhang  The resulting input
166f11a936eSBarry Smith  network 0:
167f11a936eSBarry Smith  rank[0]:
168f11a936eSBarry Smith    ne = 2
169f11a936eSBarry Smith    edgelist = [0 2 | 1 2]
170f11a936eSBarry Smith  rank[1]:
171f11a936eSBarry Smith    ne = 2
172f11a936eSBarry Smith    edgelist = [3 5 | 4 5]
173f11a936eSBarry Smith 
174f11a936eSBarry Smith   2) Two subnetworks:
175f11a936eSBarry Smith .vb
176f11a936eSBarry Smith  subnetwork 0:
177f11a936eSBarry Smith  rank[0]:
178f11a936eSBarry Smith    v0 --> v2; v2 --> v1; v1 --> v3;
179f11a936eSBarry Smith  subnetwork 1:
180f11a936eSBarry Smith  rank[1]:
181f11a936eSBarry Smith    v0 --> v3; v3 --> v2; v2 --> v1;
182f11a936eSBarry Smith .ve
183f11a936eSBarry Smith 
184f11a936eSBarry Smith  The resulting input
185f11a936eSBarry Smith  subnetwork 0:
186f11a936eSBarry Smith  rank[0]:
187f11a936eSBarry Smith    ne = 3
188f11a936eSBarry Smith    edgelist = [0 2 | 2 1 | 1 3]
189f11a936eSBarry Smith  rank[1]:
190f11a936eSBarry Smith    ne = 0
191f11a936eSBarry Smith    edgelist = NULL
192f11a936eSBarry Smith 
193f11a936eSBarry Smith  subnetwork 1:
194f11a936eSBarry Smith  rank[0]:
195f11a936eSBarry Smith    ne = 0
196f11a936eSBarry Smith    edgelist = NULL
197f11a936eSBarry Smith  rank[1]:
198f11a936eSBarry Smith    edgelist = [0 3 | 3 2 | 2 1]
199e3e68989SHong Zhang 
200db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
2015f2c45f1SShri Abhyankar @*/
202d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum)
203d71ae5a4SJacob Faibussowitsch {
2045f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2055c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
206f11a936eSBarry Smith   PetscBT     table;
2075f2c45f1SShri Abhyankar 
2085f2c45f1SShri Abhyankar   PetscFunctionBegin;
209ad540459SPierre Jolivet   for (i = 0; i < ne; i++) PetscCheck(edgelist[2 * i] != edgelist[2 * i + 1], PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Edge %" PetscInt_FMT " has the same vertex %" PetscInt_FMT " at each endpoint", i, edgelist[2 * i]);
210f11a936eSBarry Smith 
2115c6496baSHong Zhang   i = 0;
2125c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2135c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2145c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2155c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2165c6496baSHong Zhang     i++;
2175c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2185c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2195c6496baSHong Zhang     i++;
2205c6496baSHong Zhang   }
2215c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2225c6496baSHong Zhang 
2235c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2249566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2259566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
226f11a936eSBarry Smith   i = 0;
227f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2289566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2299566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
230f11a936eSBarry Smith   }
231f11a936eSBarry Smith   nvtx = 0;
232f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
233f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
234f11a936eSBarry Smith   }
2355c6496baSHong Zhang 
2365c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
2371c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2385c6496baSHong Zhang   Nvtx++;
2399566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
240f11a936eSBarry Smith 
241f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
2421c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
243f11a936eSBarry Smith 
244daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
245c6a7a370SJeremy L Thompson   if (name) PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
246daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
247daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
248daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
249daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
250daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2512bf73ac6SHong Zhang 
2522bf73ac6SHong Zhang   /* ----------------------------------------------------------
2532bf73ac6SHong Zhang    p=v or e;
2542bf73ac6SHong Zhang    subnet[0].pStart   = 0
2552bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2562bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2572bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
258daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
259daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2602bf73ac6SHong Zhang 
261daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
262daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2632bf73ac6SHong Zhang 
2642bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
265daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
266daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
267daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
268daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2692bf73ac6SHong Zhang 
270c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
271daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
272daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2742bf73ac6SHong Zhang }
2752bf73ac6SHong Zhang 
2765c6496baSHong Zhang /*@C
2775c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2782bf73ac6SHong Zhang 
2795c6496baSHong Zhang   Not collective
2805c6496baSHong Zhang 
2815c6496baSHong Zhang   Input Parameters:
2825c6496baSHong Zhang + dm - the DM object
2835c6496baSHong Zhang - v - vertex point
2845c6496baSHong Zhang 
2855c6496baSHong Zhang   Output Parameters:
2865c6496baSHong Zhang + gidx - global number of this shared vertex in the internal dmplex
2875c6496baSHong Zhang . n - number of subnetworks that share this vertex
2885c6496baSHong Zhang - sv - array of size n: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1
2895c6496baSHong Zhang 
2905c6496baSHong Zhang   Level: intermediate
2915c6496baSHong Zhang 
292db781477SPatrick Sanan .seealso: `DMNetworkGetSharedVertices()`
2935c6496baSHong Zhang @*/
294d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PetscInt *gidx, PetscInt *n, const PetscInt **sv)
295d71ae5a4SJacob Faibussowitsch {
2965c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
297daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
2985c6496baSHong Zhang   PetscInt    i, gidx_tmp;
2995c6496baSHong Zhang 
3005c6496baSHong Zhang   PetscFunctionBegin;
3019566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
302eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, gidx_tmp + 1, 0, &i));
3035c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
3045c6496baSHong Zhang 
3055c6496baSHong Zhang   i--;
3065c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3075c6496baSHong Zhang   if (n) *n = svtx[i].n;
3085c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3105c6496baSHong Zhang }
3115c6496baSHong Zhang 
3125c6496baSHong Zhang /*
3135c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3145c6496baSHong Zhang 
3155c6496baSHong Zhang   Input Parameters:
3165c6496baSHong Zhang + Nsvtx - global num of shared vertices
3175c6496baSHong Zhang . svtx - array of shared vertices (global)
3185c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3195c6496baSHong Zhang 
3205c6496baSHong Zhang   Output Parameters:
3215c6496baSHong Zhang + gidx - global index of (net,idx)
3225c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3235c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3245c6496baSHong Zhang */
325d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx)
326d71ae5a4SJacob Faibussowitsch {
3275c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3282bf73ac6SHong Zhang   SVtxType vtype;
3292bf73ac6SHong Zhang 
3302bf73ac6SHong Zhang   PetscFunctionBegin;
3313ba16761SJacob Faibussowitsch   if (!Nsvtx) PetscFunctionReturn(PETSC_SUCCESS);
3322bf73ac6SHong Zhang 
3335c6496baSHong Zhang   g_idx = -1;
3342bf73ac6SHong Zhang   vtype = SVNONE;
3355c6496baSHong Zhang 
3362bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3372bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3385c6496baSHong Zhang       g_idx = svtx[i].gidx;
3392bf73ac6SHong Zhang       vtype = SVFROM;
3402bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3412bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3422bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3432bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3442bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3455c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3462bf73ac6SHong Zhang           vtype = SVTO;
3472bf73ac6SHong Zhang         }
3482bf73ac6SHong Zhang       }
3492bf73ac6SHong Zhang     }
3502bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3512bf73ac6SHong Zhang   }
3525c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3532bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3542bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3562bf73ac6SHong Zhang }
3572bf73ac6SHong Zhang 
3582bf73ac6SHong Zhang /*
3595c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3605c6496baSHong Zhang 
3615c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3625c6496baSHong Zhang   Output: svta, tdata, ta2sv
3632bf73ac6SHong Zhang */
364eec179cfSJacob Faibussowitsch static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscHMapI svta, PetscInt *tdata, PetscInt *ta2sv)
365d71ae5a4SJacob Faibussowitsch {
3665c6496baSHong Zhang   PetscInt net, idx, gidx;
3672bf73ac6SHong Zhang 
3682bf73ac6SHong Zhang   PetscFunctionBegin;
3695c6496baSHong Zhang   net  = sedgelist[k];
3705c6496baSHong Zhang   idx  = sedgelist[k + 1];
371daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
372c76ffc5fSJacob Faibussowitsch   PetscCall(PetscHMapISet(svta, gidx + 1, *tdata + 1));
3735c6496baSHong Zhang 
3745c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3755c6496baSHong Zhang   (*tdata)++;
3763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3772bf73ac6SHong Zhang }
3782bf73ac6SHong Zhang 
3792bf73ac6SHong Zhang /*
3805c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3812bf73ac6SHong Zhang 
3822bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3832bf73ac6SHong Zhang 
3842bf73ac6SHong Zhang   Note: Output svtx is organized as
3852bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3862bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3872bf73ac6SHong Zhang                           ...
3882bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3892bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
3902bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
3912bf73ac6SHong Zhang  */
392d71ae5a4SJacob Faibussowitsch static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist)
393d71ae5a4SJacob Faibussowitsch {
3945c6496baSHong Zhang   SVtx         *svtx = NULL;
3952bf73ac6SHong Zhang   PetscInt     *sv, k, j, nsv, *tdata, **ta2sv;
396eec179cfSJacob Faibussowitsch   PetscHMapI   *svtas;
3977340ca2cSHong Zhang   PetscInt      gidx, net, idx, i, nta, ita, idx_from, idx_to, n, *net_tmp, *idx_tmp, *gidx_tmp;
3982bf73ac6SHong Zhang   DM_Network   *network = (DM_Network *)dm->data;
399eec179cfSJacob Faibussowitsch   PetscHashIter ppos;
4002bf73ac6SHong Zhang 
4012bf73ac6SHong Zhang   PetscFunctionBegin;
4025c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
4039566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
4042bf73ac6SHong Zhang 
4052bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
4067340ca2cSHong Zhang   nta = 0; /* num of svta tables created = num of groups of shared vertices */
4072bf73ac6SHong Zhang 
4082bf73ac6SHong Zhang   /* for j=0 */
409eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4109566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4112bf73ac6SHong Zhang 
4129566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4139566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4149371c9d4SSatish Balay   nta++;
4159371c9d4SSatish Balay   k += 4;
4162bf73ac6SHong Zhang 
4175c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4182bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4192bf73ac6SHong Zhang       /* vfrom */
4209371c9d4SSatish Balay       net  = sedgelist[k];
4219371c9d4SSatish Balay       idx  = sedgelist[k + 1];
422daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
423eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_from));
4242bf73ac6SHong Zhang 
4252bf73ac6SHong Zhang       /* vto */
4269371c9d4SSatish Balay       net  = sedgelist[k + 2];
4279371c9d4SSatish Balay       idx  = sedgelist[k + 3];
428daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
429eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_to));
4302bf73ac6SHong Zhang 
4312bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4329371c9d4SSatish Balay         idx_from--;
4339371c9d4SSatish Balay         idx_to--;
4342bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4359566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4362bf73ac6SHong Zhang           break;
4372bf73ac6SHong Zhang         } else if (idx_to < 0) {
4389566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4392bf73ac6SHong Zhang           break;
4402bf73ac6SHong Zhang         }
4412bf73ac6SHong Zhang       }
4422bf73ac6SHong Zhang     }
4432bf73ac6SHong Zhang 
4442bf73ac6SHong Zhang     if (ita == nta) {
445eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4469566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4472bf73ac6SHong Zhang 
4489566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4499566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4502bf73ac6SHong Zhang       nta++;
4512bf73ac6SHong Zhang     }
4522bf73ac6SHong Zhang     k += 4;
4532bf73ac6SHong Zhang   }
4542bf73ac6SHong Zhang 
4556aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
456eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(nta, &network->cloneshared->svtable));
4575c6496baSHong Zhang 
4585c6496baSHong Zhang   /* (3) Construct svtx from svtas
4597340ca2cSHong Zhang    svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1. */
4609566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4612bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4624f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
463eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetSize(svtas[nsv], &n));
4649566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4657340ca2cSHong Zhang     PetscCall(PetscMalloc3(n, &gidx_tmp, n, &net_tmp, n, &idx_tmp));
4665c6496baSHong Zhang     svtx[nsv].sv   = sv;
4675c6496baSHong Zhang     svtx[nsv].n    = n;
468daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4692bf73ac6SHong Zhang 
470eec179cfSJacob Faibussowitsch     PetscHashIterBegin(svtas[nsv], ppos);
4714f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
472eec179cfSJacob Faibussowitsch       PetscHashIterGetKey(svtas[nsv], ppos, gidx);
473eec179cfSJacob Faibussowitsch       PetscHashIterGetVal(svtas[nsv], ppos, i);
474eec179cfSJacob Faibussowitsch       PetscHashIterNext(svtas[nsv], ppos);
4759371c9d4SSatish Balay       gidx--;
4769371c9d4SSatish Balay       i--;
4775c6496baSHong Zhang       j           = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4787340ca2cSHong Zhang       net_tmp[k]  = sedgelist[j];     /* subnet number */
4797340ca2cSHong Zhang       idx_tmp[k]  = sedgelist[j + 1]; /* index on the subnet */
4807340ca2cSHong Zhang       gidx_tmp[k] = gidx;             /* gidx in un-merged dmnetwork */
4812bf73ac6SHong Zhang     }
4825c6496baSHong Zhang 
4837340ca2cSHong Zhang     /* current implementation requires sv[]=[net,idx] in ascending order of its gidx in un-merged dmnetwork */
4847340ca2cSHong Zhang     PetscCall(PetscSortIntWithArrayPair(n, gidx_tmp, net_tmp, idx_tmp));
4857340ca2cSHong Zhang     svtx[nsv].gidx = gidx_tmp[0]; /* = min(gidx) */
4867340ca2cSHong Zhang     for (k = 0; k < n; k++) {
4877340ca2cSHong Zhang       sv[2 * k]     = net_tmp[k];
4887340ca2cSHong Zhang       sv[2 * k + 1] = idx_tmp[k];
4897340ca2cSHong Zhang     }
4907340ca2cSHong Zhang     PetscCall(PetscFree3(gidx_tmp, net_tmp, idx_tmp));
4917340ca2cSHong Zhang 
4926aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
493c76ffc5fSJacob Faibussowitsch     PetscCall(PetscHMapISet(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1));
4942bf73ac6SHong Zhang   }
4952bf73ac6SHong Zhang 
4962bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
497eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(svtas + j));
4989566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
4992bf73ac6SHong Zhang   }
5009566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
5012bf73ac6SHong Zhang 
502daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
503daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
5043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5052bf73ac6SHong Zhang }
5062bf73ac6SHong Zhang 
5075c6496baSHong Zhang /*
5085c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
5095c6496baSHong Zhang 
5105c6496baSHong Zhang   Input Parameters:
5115c6496baSHong Zhang . dm - the dmnetwork object
5125c6496baSHong Zhang 
5135c6496baSHong Zhang    Output Parameters:
5145c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
5155c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
5165c6496baSHong Zhang */
517d71ae5a4SJacob Faibussowitsch static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr)
518d71ae5a4SJacob Faibussowitsch {
5192bf73ac6SHong Zhang   MPI_Comm    comm;
5202bf73ac6SHong Zhang   PetscMPIInt size, rank, *recvcounts = NULL, *displs = NULL;
521eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
522eac198afSGetnet   PetscInt    i, j, ctr, np;
523daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
524daad07d3SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist;
5255c6496baSHong Zhang   PetscInt    net, idx, gidx, nmerged, *vrange, gidx_from, net_from, sv_idx;
5262bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5275c6496baSHong Zhang   SVtx       *svtx;
5282bf73ac6SHong Zhang 
5292bf73ac6SHong Zhang   PetscFunctionBegin;
5309566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5319566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5329566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5332bf73ac6SHong Zhang 
5345c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5355c6496baSHong Zhang   /* --------------------------------------- */
536daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
537daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
538daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5392bf73ac6SHong Zhang 
540d5b43468SJose E. Roman   /* (2) Merge shared vto vertices to their vfrom vertex with same global vertex index (gidx) */
5415c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5422bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
543daad07d3SAidan Hamilton   PetscCall(PetscMalloc4(size + 1, &vrange, size, &displs, size, &recvcounts, network->cloneshared->nVertices, &vidxlTog));
5449371c9d4SSatish Balay   for (i = 0; i < size; i++) {
5459371c9d4SSatish Balay     displs[i]     = i;
5469371c9d4SSatish Balay     recvcounts[i] = 1;
5479371c9d4SSatish Balay   }
5482bf73ac6SHong Zhang 
5492bf73ac6SHong Zhang   vrange[0] = 0;
550daad07d3SAidan Hamilton   PetscCallMPI(MPI_Allgatherv(&network->cloneshared->nVertices, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
5515c6496baSHong Zhang   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
5522bf73ac6SHong Zhang 
5532bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5549371c9d4SSatish Balay   i                           = 0;
5559371c9d4SSatish Balay   gidx                        = 0;
5562bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
557daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5582bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
559daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5609566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5612bf73ac6SHong Zhang       if (svtype == SVTO) {
562daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5635c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
564daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5655c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
566daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5672bf73ac6SHong Zhang           }
5685c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5695c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5702bf73ac6SHong Zhang         }
5712bf73ac6SHong Zhang       } else {
572daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5735c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
574daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5752bf73ac6SHong Zhang         }
576daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5772bf73ac6SHong Zhang         gidx++;
5782bf73ac6SHong Zhang       }
5792bf73ac6SHong Zhang     }
5802bf73ac6SHong Zhang   }
5812bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
582daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5832bf73ac6SHong Zhang #endif
5842bf73ac6SHong Zhang 
5855c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
5869566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
587daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5882bf73ac6SHong Zhang 
5892bf73ac6SHong Zhang   ctr = 0;
5902bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
591daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5922bf73ac6SHong Zhang       /* vfrom: */
593daad07d3SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5942bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5952bf73ac6SHong Zhang 
5962bf73ac6SHong Zhang       /* vto */
597daad07d3SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5982bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
5992bf73ac6SHong Zhang       ctr++;
6002bf73ac6SHong Zhang     }
6012bf73ac6SHong Zhang   }
6029566063dSJacob Faibussowitsch   PetscCall(PetscFree4(vrange, displs, recvcounts, vidxlTog));
6039566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
6042bf73ac6SHong Zhang 
605eac198afSGetnet   *nmerged_ptr = nmerged;
6063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6075f2c45f1SShri Abhyankar }
6085f2c45f1SShri Abhyankar 
609d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
610d71ae5a4SJacob Faibussowitsch {
611daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
612daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
613daad07d3SAidan Hamilton   MPI_Comm    comm;
614daad07d3SAidan Hamilton 
615daad07d3SAidan Hamilton   PetscFunctionBegin;
616daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
617daad07d3SAidan Hamilton 
618daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
619daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
620daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
621daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
622daad07d3SAidan Hamilton 
623daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
624daad07d3SAidan Hamilton 
625daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
626daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
627daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
628daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
629daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
630daad07d3SAidan Hamilton   }
6313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
632daad07d3SAidan Hamilton }
633daad07d3SAidan Hamilton 
6345f2c45f1SShri Abhyankar /*@
6355f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6365f2c45f1SShri Abhyankar 
637eac198afSGetnet   Not Collective
6385f2c45f1SShri Abhyankar 
6397a7aea1fSJed Brown   Input Parameters:
640f11a936eSBarry Smith . dm - the dmnetwork object
6415f2c45f1SShri Abhyankar 
6425f2c45f1SShri Abhyankar   Notes:
6435f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6445f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6455f2c45f1SShri Abhyankar 
6465f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6475f2c45f1SShri Abhyankar 
64897bb938eSShri Abhyankar   Level: beginner
6495f2c45f1SShri Abhyankar 
650db781477SPatrick Sanan .seealso: `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6515f2c45f1SShri Abhyankar @*/
652d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
653d71ae5a4SJacob Faibussowitsch {
6545f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
655daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
656caf410d2SHong Zhang   const PetscInt *cone;
657caf410d2SHong Zhang   MPI_Comm        comm;
6585503a911SAidan Hamilton   PetscMPIInt     size;
659eac198afSGetnet   PetscSection    sectiong;
6605c6496baSHong Zhang   PetscInt        nmerged = 0;
6616500d4abSHong Zhang 
6626500d4abSHong Zhang   PetscFunctionBegin;
663e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
664daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6652bf73ac6SHong Zhang 
666eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
667eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6689371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6699371c9d4SSatish 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,
6709371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
671eac198afSGetnet   }
672eac198afSGetnet 
6739566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6743ba16761SJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6756500d4abSHong Zhang 
676f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
677daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
678eac198afSGetnet 
679daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6809566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
681eac198afSGetnet   } else { /* subnetworks are not coupled */
6826aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
683eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapICreate(&network->cloneshared->svtable));
684caf410d2SHong Zhang     ctr = 0;
6852bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
686daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
687daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
688daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6896500d4abSHong Zhang         ctr++;
6906500d4abSHong Zhang       }
6916500d4abSHong Zhang     }
692eac198afSGetnet   }
6937765340cSHong Zhang 
6942bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6959566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
6969566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
6979566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
698eac198afSGetnet 
699daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
700daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
7016500d4abSHong Zhang 
702daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
703daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
704daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
705daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
7069566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
707caf410d2SHong Zhang 
708f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
709f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
710f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
711f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
712f11a936eSBarry Smith   */
713daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
714daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
715daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7165c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
717daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
718daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
719f11a936eSBarry Smith 
720daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
721daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7226500d4abSHong Zhang   }
723daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
724caf410d2SHong Zhang 
725caf410d2SHong Zhang   /* Get edge ownership */
726daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7275503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7285503a911SAidan Hamilton   globaledgeoff -= np;
729caf410d2SHong Zhang 
730eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7312bf73ac6SHong Zhang   e = 0;
7322bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
733f11a936eSBarry Smith     ctr = 0;
734daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7352bf73ac6SHong Zhang       /* edge e */
7365503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7372bf73ac6SHong Zhang       network->header[e].subnetid              = i;
738daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7392bf73ac6SHong Zhang 
7402bf73ac6SHong Zhang       /* connected vertices */
7419566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7422bf73ac6SHong Zhang 
7432bf73ac6SHong Zhang       /* vertex cone[0] */
744f11a936eSBarry Smith       v                           = cone[0];
745f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
746f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
747f11a936eSBarry Smith       if (Nsubnet == 1) {
748daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
749f11a936eSBarry Smith       } else {
750daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
751daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
752f11a936eSBarry Smith       }
7532bf73ac6SHong Zhang 
7542bf73ac6SHong Zhang       /* vertex cone[1] */
755f11a936eSBarry Smith       v                           = cone[1];
756f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
757f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
758f11a936eSBarry Smith       if (Nsubnet == 1) {
759daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
760f11a936eSBarry Smith       } else {
761daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
762daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
763f11a936eSBarry Smith       }
7642bf73ac6SHong Zhang 
7659371c9d4SSatish Balay       e++;
7669371c9d4SSatish Balay       ctr++;
7676500d4abSHong Zhang     }
7686500d4abSHong Zhang   }
7695503a911SAidan Hamilton   PetscCall(PetscFree(edges));
770caf410d2SHong Zhang 
771eac198afSGetnet   /* Set local vertex array for the subnetworks */
772eac198afSGetnet   j = 0;
773daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
774eac198afSGetnet     /* local shared vertex */
775eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, network->header[v].index + 1, 0, &i));
776daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7776500d4abSHong Zhang   }
778eac198afSGetnet 
779eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
780eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7819566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
782daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
783daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
784e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7865f2c45f1SShri Abhyankar }
7875f2c45f1SShri Abhyankar 
78894ef8ddeSSatish Balay /*@C
7892bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7902bf73ac6SHong Zhang 
7912bf73ac6SHong Zhang   Not collective
7922727e31bSShri Abhyankar 
7937a7aea1fSJed Brown   Input Parameters:
794caf410d2SHong Zhang + dm - the DM object
7952bf73ac6SHong Zhang - netnum - the global index of the subnetwork
7962727e31bSShri Abhyankar 
7977a7aea1fSJed Brown   Output Parameters:
7982727e31bSShri Abhyankar + nv - number of vertices (local)
7992727e31bSShri Abhyankar . ne - number of edges (local)
8002bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
8012bf73ac6SHong Zhang - edge - local edges of the subnetwork
8022727e31bSShri Abhyankar 
8032727e31bSShri Abhyankar   Notes:
8042727e31bSShri Abhyankar     Cannot call this routine before DMNetworkLayoutSetup()
8052727e31bSShri Abhyankar 
806eac198afSGetnet     The local vertices returned on each rank are determined by DMNetwork. The user does not have any control over what vertices are local.
807eac198afSGetnet 
80806dd6b0eSSatish Balay   Level: intermediate
80906dd6b0eSSatish Balay 
810db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8112727e31bSShri Abhyankar @*/
812d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge)
813d71ae5a4SJacob Faibussowitsch {
814caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8152727e31bSShri Abhyankar 
8162727e31bSShri Abhyankar   PetscFunctionBegin;
817daad07d3SAidan 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);
818daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
819daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
820daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
821daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8232bf73ac6SHong Zhang }
8242bf73ac6SHong Zhang 
8252bf73ac6SHong Zhang /*@
8262bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8272bf73ac6SHong Zhang 
8282bf73ac6SHong Zhang   Collective on dm
8292bf73ac6SHong Zhang 
8302bf73ac6SHong Zhang   Input Parameters:
8312bf73ac6SHong Zhang + dm - the dm object
8322bf73ac6SHong Zhang . anetnum - first subnetwork global numbering returned by DMNetworkAddSubnetwork()
8332bf73ac6SHong Zhang . bnetnum - second subnetwork global numbering returned by DMNetworkAddSubnetwork()
8342bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8352bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8362bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8372bf73ac6SHong Zhang 
8382bf73ac6SHong Zhang   Level: beginner
8392bf73ac6SHong Zhang 
840db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8412bf73ac6SHong Zhang @*/
842d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
843d71ae5a4SJacob Faibussowitsch {
8442bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
845daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8462bf73ac6SHong Zhang 
8472bf73ac6SHong Zhang   PetscFunctionBegin;
8485c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8495c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8502bf73ac6SHong Zhang   if (!Nsvtx) {
8512bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
852daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8532bf73ac6SHong Zhang   }
8542bf73ac6SHong Zhang 
855daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8562bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8579371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8589371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8599371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8609371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8612bf73ac6SHong Zhang     Nsvtx++;
8622bf73ac6SHong Zhang   }
8635c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
864daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8662727e31bSShri Abhyankar }
8672727e31bSShri Abhyankar 
8682727e31bSShri Abhyankar /*@C
8692bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8702bf73ac6SHong Zhang 
8712bf73ac6SHong Zhang   Not collective
872caf410d2SHong Zhang 
873f899ff85SJose E. Roman   Input Parameter:
8742bf73ac6SHong Zhang . dm - the DM object
875caf410d2SHong Zhang 
8767a7aea1fSJed Brown   Output Parameters:
8772bf73ac6SHong Zhang + nsv - number of local shared vertices
8782bf73ac6SHong Zhang - svtx - local shared vertices
879caf410d2SHong Zhang 
880caf410d2SHong Zhang   Notes:
881caf410d2SHong Zhang   Cannot call this routine before DMNetworkLayoutSetup()
882caf410d2SHong Zhang 
883caf410d2SHong Zhang   Level: intermediate
884caf410d2SHong Zhang 
885db781477SPatrick Sanan .seealso: `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
886caf410d2SHong Zhang @*/
887d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx)
888d71ae5a4SJacob Faibussowitsch {
889caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
890caf410d2SHong Zhang 
891caf410d2SHong Zhang   PetscFunctionBegin;
8925c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
893daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
894daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
8953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
896caf410d2SHong Zhang }
897caf410d2SHong Zhang 
898caf410d2SHong Zhang /*@C
8995f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
9005f2c45f1SShri Abhyankar 
901d083f849SBarry Smith   Logically collective on dm
9025f2c45f1SShri Abhyankar 
9037a7aea1fSJed Brown   Input Parameters:
9045f2c45f1SShri Abhyankar + dm - the network object
9055f2c45f1SShri Abhyankar . name - the component name
9065f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
9075f2c45f1SShri Abhyankar 
9087a7aea1fSJed Brown    Output Parameters:
9095f2c45f1SShri Abhyankar .  key - an integer key that defines the component
9105f2c45f1SShri Abhyankar 
91187497f52SBarry Smith    Note:
91287497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9135f2c45f1SShri Abhyankar 
91497bb938eSShri Abhyankar    Level: beginner
9155f2c45f1SShri Abhyankar 
916db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9175f2c45f1SShri Abhyankar @*/
918d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
919d71ae5a4SJacob Faibussowitsch {
9205f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
92154dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9225f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9235f2c45f1SShri Abhyankar   PetscInt            i;
9245f2c45f1SShri Abhyankar 
9255f2c45f1SShri Abhyankar   PetscFunctionBegin;
92648a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
92754dfd506SHong Zhang 
9285f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9299566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9305f2c45f1SShri Abhyankar     if (flg) {
9315f2c45f1SShri Abhyankar       *key = i;
9323ba16761SJacob Faibussowitsch       PetscFunctionReturn(PETSC_SUCCESS);
9335f2c45f1SShri Abhyankar     }
9346d64e262SShri Abhyankar   }
93554dfd506SHong Zhang 
93654dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
93754dfd506SHong Zhang     /* Reached max allowed so resize component */
93854dfd506SHong Zhang     network->max_comps_registered += 2;
9399566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
94054dfd506SHong Zhang     /* Copy over the previous component info */
94154dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
942c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(newcomponent[i].name, network->component[i].name, sizeof(newcomponent[i].name)));
94354dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9445f2c45f1SShri Abhyankar     }
94554dfd506SHong Zhang     /* Free old one */
9469566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
94754dfd506SHong Zhang     /* Update pointer */
94854dfd506SHong Zhang     network->component = newcomponent;
94954dfd506SHong Zhang   }
95054dfd506SHong Zhang 
95154dfd506SHong Zhang   component = &network->component[network->ncomponent];
9525f2c45f1SShri Abhyankar 
953c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(component->name, name, sizeof(component->name)));
9545f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9555f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9565f2c45f1SShri Abhyankar   network->ncomponent++;
9573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9585f2c45f1SShri Abhyankar }
9595f2c45f1SShri Abhyankar 
9605f2c45f1SShri Abhyankar /*@
9618afb7921SAidan Hamilton   DMNetworkGetNumVertices - Get the local and global number of vertices for the entire network.
9628afb7921SAidan Hamilton 
9638afb7921SAidan Hamilton   Not Collective
9648afb7921SAidan Hamilton 
9658afb7921SAidan Hamilton   Input Parameter:
9668afb7921SAidan Hamilton . dm - the DMNetwork object
9678afb7921SAidan Hamilton 
9688afb7921SAidan Hamilton   Output Parameters:
9698afb7921SAidan Hamilton + nVertices - the local number of vertices
9708afb7921SAidan Hamilton - NVertices - the global number of vertices
9718afb7921SAidan Hamilton 
9728afb7921SAidan Hamilton   Level: beginner
9738afb7921SAidan Hamilton 
9748afb7921SAidan Hamilton .seealso: `DMNetworkGetNumEdges()`
9758afb7921SAidan Hamilton @*/
9768afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumVertices(DM dm, PetscInt *nVertices, PetscInt *NVertices)
9778afb7921SAidan Hamilton {
9788afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
9798afb7921SAidan Hamilton 
9808afb7921SAidan Hamilton   PetscFunctionBegin;
9818afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
9828afb7921SAidan Hamilton   if (nVertices) {
9838afb7921SAidan Hamilton     PetscValidIntPointer(nVertices, 2);
9848afb7921SAidan Hamilton     *nVertices = network->cloneshared->nVertices;
9858afb7921SAidan Hamilton   }
9868afb7921SAidan Hamilton   if (NVertices) {
9878afb7921SAidan Hamilton     PetscValidIntPointer(NVertices, 3);
9888afb7921SAidan Hamilton     *NVertices = network->cloneshared->NVertices;
9898afb7921SAidan Hamilton   }
9903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9918afb7921SAidan Hamilton }
9928afb7921SAidan Hamilton 
9938afb7921SAidan Hamilton /*@
9948afb7921SAidan Hamilton   DMNetworkGetNumEdges - Get the local and global number of edges for the entire network.
9958afb7921SAidan Hamilton 
9968afb7921SAidan Hamilton   Not Collective
9978afb7921SAidan Hamilton 
9988afb7921SAidan Hamilton   Input Parameter:
9998afb7921SAidan Hamilton . dm - the DMNetwork object
10008afb7921SAidan Hamilton 
10018afb7921SAidan Hamilton   Output Parameters:
10028afb7921SAidan Hamilton + nEdges - the local number of edges
10038afb7921SAidan Hamilton -  NEdges - the global number of edges
10048afb7921SAidan Hamilton 
10058afb7921SAidan Hamilton   Level: beginner
10068afb7921SAidan Hamilton 
10078afb7921SAidan Hamilton .seealso: `DMNetworkGetNumVertices()`
10088afb7921SAidan Hamilton @*/
10098afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumEdges(DM dm, PetscInt *nEdges, PetscInt *NEdges)
10108afb7921SAidan Hamilton {
10118afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
10128afb7921SAidan Hamilton 
10138afb7921SAidan Hamilton   PetscFunctionBegin;
10148afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
10158afb7921SAidan Hamilton   if (nEdges) {
10168afb7921SAidan Hamilton     PetscValidIntPointer(nEdges, 2);
10178afb7921SAidan Hamilton     *nEdges = network->cloneshared->nEdges;
10188afb7921SAidan Hamilton   }
10198afb7921SAidan Hamilton   if (NEdges) {
10208afb7921SAidan Hamilton     PetscValidIntPointer(NEdges, 3);
10218afb7921SAidan Hamilton     *NEdges = network->cloneshared->NEdges;
10228afb7921SAidan Hamilton   }
10233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10248afb7921SAidan Hamilton }
10258afb7921SAidan Hamilton 
10268afb7921SAidan Hamilton /*@
10272bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
10285f2c45f1SShri Abhyankar 
10295f2c45f1SShri Abhyankar   Not Collective
10305f2c45f1SShri Abhyankar 
1031f899ff85SJose E. Roman   Input Parameter:
10322bf73ac6SHong Zhang . dm - the DMNetwork object
10335f2c45f1SShri Abhyankar 
1034fd292e60Sprj-   Output Parameters:
10352bf73ac6SHong Zhang + vStart - the first vertex point
10362bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
10375f2c45f1SShri Abhyankar 
103897bb938eSShri Abhyankar   Level: beginner
10395f2c45f1SShri Abhyankar 
1040db781477SPatrick Sanan .seealso: `DMNetworkGetEdgeRange()`
10415f2c45f1SShri Abhyankar @*/
1042d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd)
1043d71ae5a4SJacob Faibussowitsch {
10445f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10455f2c45f1SShri Abhyankar 
10465f2c45f1SShri Abhyankar   PetscFunctionBegin;
1047daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
1048daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
10493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10505f2c45f1SShri Abhyankar }
10515f2c45f1SShri Abhyankar 
10525f2c45f1SShri Abhyankar /*@
10532bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
10545f2c45f1SShri Abhyankar 
10555f2c45f1SShri Abhyankar   Not Collective
10565f2c45f1SShri Abhyankar 
1057f899ff85SJose E. Roman   Input Parameter:
10582bf73ac6SHong Zhang . dm - the DMNetwork object
10595f2c45f1SShri Abhyankar 
1060fd292e60Sprj-   Output Parameters:
10615f2c45f1SShri Abhyankar + eStart - The first edge point
10625f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
10635f2c45f1SShri Abhyankar 
106497bb938eSShri Abhyankar   Level: beginner
10655f2c45f1SShri Abhyankar 
1066db781477SPatrick Sanan .seealso: `DMNetworkGetVertexRange()`
10675f2c45f1SShri Abhyankar @*/
1068d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd)
1069d71ae5a4SJacob Faibussowitsch {
10705f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10715f2c45f1SShri Abhyankar 
10725f2c45f1SShri Abhyankar   PetscFunctionBegin;
10735c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1074daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
1075daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
10763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10775f2c45f1SShri Abhyankar }
10785f2c45f1SShri Abhyankar 
1079d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index)
1080d71ae5a4SJacob Faibussowitsch {
10812bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
10825c6496baSHong Zhang 
10835c6496baSHong Zhang   PetscFunctionBegin;
10845c6496baSHong Zhang   if (network->header) {
10855c6496baSHong Zhang     *index = network->header[p].index;
10865c6496baSHong Zhang   } else {
10872bf73ac6SHong Zhang     PetscInt                 offsetp;
10882bf73ac6SHong Zhang     DMNetworkComponentHeader header;
10892bf73ac6SHong Zhang 
10909566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
10912bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
10922bf73ac6SHong Zhang     *index = header->index;
10935c6496baSHong Zhang   }
10943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10952bf73ac6SHong Zhang }
10962bf73ac6SHong Zhang 
1097d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid)
1098d71ae5a4SJacob Faibussowitsch {
1099daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1100daad07d3SAidan Hamilton 
1101daad07d3SAidan Hamilton   PetscFunctionBegin;
1102daad07d3SAidan Hamilton   if (network->header) {
1103daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1104daad07d3SAidan Hamilton   } else {
1105daad07d3SAidan Hamilton     PetscInt                 offsetp;
1106daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1107daad07d3SAidan Hamilton 
1108daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1109daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1110daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1111daad07d3SAidan Hamilton   }
11123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1113daad07d3SAidan Hamilton }
1114daad07d3SAidan Hamilton 
11157b6afd5bSHong Zhang /*@
11162bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
11177b6afd5bSHong Zhang 
11187b6afd5bSHong Zhang   Not Collective
11197b6afd5bSHong Zhang 
11207b6afd5bSHong Zhang   Input Parameters:
11217b6afd5bSHong Zhang + dm - DMNetwork object
1122e85e6aecSHong Zhang - p - edge point
11237b6afd5bSHong Zhang 
1124fd292e60Sprj-   Output Parameters:
11252bf73ac6SHong Zhang . index - the global numbering for the edge
11267b6afd5bSHong Zhang 
11277b6afd5bSHong Zhang   Level: intermediate
11287b6afd5bSHong Zhang 
1129db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalVertexIndex()`
11307b6afd5bSHong Zhang @*/
1131d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index)
1132d71ae5a4SJacob Faibussowitsch {
11337b6afd5bSHong Zhang   PetscFunctionBegin;
11349566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11367b6afd5bSHong Zhang }
11377b6afd5bSHong Zhang 
11385f2c45f1SShri Abhyankar /*@
11392bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1140e85e6aecSHong Zhang 
1141e85e6aecSHong Zhang   Not Collective
1142e85e6aecSHong Zhang 
1143e85e6aecSHong Zhang   Input Parameters:
1144e85e6aecSHong Zhang + dm - DMNetwork object
1145e85e6aecSHong Zhang - p  - vertex point
1146e85e6aecSHong Zhang 
1147fd292e60Sprj-   Output Parameters:
11482bf73ac6SHong Zhang . index - the global numbering for the vertex
1149e85e6aecSHong Zhang 
1150e85e6aecSHong Zhang   Level: intermediate
1151e85e6aecSHong Zhang 
1152db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1153e85e6aecSHong Zhang @*/
1154d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index)
1155d71ae5a4SJacob Faibussowitsch {
1156e85e6aecSHong Zhang   PetscFunctionBegin;
11579566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11599988b915SShri Abhyankar }
11609988b915SShri Abhyankar 
11619988b915SShri Abhyankar /*@
11625f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
11635f2c45f1SShri Abhyankar 
11645f2c45f1SShri Abhyankar   Not Collective
11655f2c45f1SShri Abhyankar 
11665f2c45f1SShri Abhyankar   Input Parameters:
11672bf73ac6SHong Zhang + dm - the DMNetwork object
1168a2b725a8SWilliam Gropp - p - vertex/edge point
11695f2c45f1SShri Abhyankar 
11705f2c45f1SShri Abhyankar   Output Parameters:
11715f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
11725f2c45f1SShri Abhyankar 
117397bb938eSShri Abhyankar   Level: beginner
11745f2c45f1SShri Abhyankar 
1175db781477SPatrick Sanan .seealso: `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
11765f2c45f1SShri Abhyankar @*/
1177d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents)
1178d71ae5a4SJacob Faibussowitsch {
11795f2c45f1SShri Abhyankar   PetscInt    offset;
11805f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
11815f2c45f1SShri Abhyankar 
11825f2c45f1SShri Abhyankar   PetscFunctionBegin;
11839566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
11845f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
11853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11865f2c45f1SShri Abhyankar }
11875f2c45f1SShri Abhyankar 
11885f2c45f1SShri Abhyankar /*@
11892bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
11905f2c45f1SShri Abhyankar 
11915f2c45f1SShri Abhyankar   Not Collective
11925f2c45f1SShri Abhyankar 
11935f2c45f1SShri Abhyankar   Input Parameters:
11942bf73ac6SHong Zhang + dm - the DMNetwork object
1195f2f58720SBarry Smith . p - the edge or vertex point
11962bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
11979988b915SShri Abhyankar 
11989988b915SShri Abhyankar   Output Parameters:
11992bf73ac6SHong Zhang . offset - the local offset
12009988b915SShri Abhyankar 
1201f2f58720SBarry Smith   Notes:
1202f2f58720SBarry Smith     These offsets can be passed to MatSetValuesLocal() for matrices obtained with DMCreateMatrix().
1203f2f58720SBarry Smith 
1204f2f58720SBarry Smith     For vectors obtained with DMCreateLocalVector() the offsets can be used with VecSetValues().
1205f2f58720SBarry Smith 
1206f2f58720SBarry Smith     For vectors obtained with DMCreateLocalVector() and the array obtained with VecGetArray(vec,&array) you can access or set
1207f2f58720SBarry Smith     the vector values with array[offset].
1208f2f58720SBarry Smith 
1209f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() the offsets can be used with VecSetValuesLocal().
1210f2f58720SBarry Smith 
12119988b915SShri Abhyankar   Level: intermediate
12129988b915SShri Abhyankar 
1213db781477SPatrick Sanan .seealso: `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
12149988b915SShri Abhyankar @*/
1215d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset)
1216d71ae5a4SJacob Faibussowitsch {
12179988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12189988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12199988b915SShri Abhyankar   DMNetworkComponentHeader header;
12209988b915SShri Abhyankar 
12219988b915SShri Abhyankar   PetscFunctionBegin;
12229566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
12232bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12242bf73ac6SHong Zhang     *offset = offsetp;
12253ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12262bf73ac6SHong Zhang   }
12272bf73ac6SHong Zhang 
12289566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12299988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12309988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
12313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12329988b915SShri Abhyankar }
12339988b915SShri Abhyankar 
12349988b915SShri Abhyankar /*@
12352bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
12369988b915SShri Abhyankar 
12379988b915SShri Abhyankar   Not Collective
12389988b915SShri Abhyankar 
12399988b915SShri Abhyankar   Input Parameters:
12402bf73ac6SHong Zhang + dm - the DMNetwork object
1241f2f58720SBarry Smith . p - the edge or vertex point
12422bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12439988b915SShri Abhyankar 
12449988b915SShri Abhyankar   Output Parameters:
12459988b915SShri Abhyankar . offsetg - the global offset
12469988b915SShri Abhyankar 
1247f2f58720SBarry Smith   Notes:
1248f2f58720SBarry Smith     These offsets can be passed to MatSetValues() for matrices obtained with DMCreateMatrix().
1249f2f58720SBarry Smith 
1250f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() the offsets can be used with VecSetValues().
1251f2f58720SBarry Smith 
1252f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() and the array obtained with VecGetArray(vec,&array) you can access or set
1253f2f58720SBarry Smith     the vector values with array[offset - rstart] where restart is obtained with VecGetOwnershipRange(v,&rstart,NULL);
1254f2f58720SBarry Smith 
12559988b915SShri Abhyankar   Level: intermediate
12569988b915SShri Abhyankar 
1257db781477SPatrick Sanan .seealso: `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
12589988b915SShri Abhyankar @*/
1259d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg)
1260d71ae5a4SJacob Faibussowitsch {
12619988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12629988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12639988b915SShri Abhyankar   DMNetworkComponentHeader header;
12649988b915SShri Abhyankar 
12659988b915SShri Abhyankar   PetscFunctionBegin;
12669566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
12672bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
12682bf73ac6SHong Zhang 
12692bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12702bf73ac6SHong Zhang     *offsetg = offsetp;
12713ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12722bf73ac6SHong Zhang   }
12739566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12749988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12759988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
12763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12779988b915SShri Abhyankar }
12789988b915SShri Abhyankar 
12799988b915SShri Abhyankar /*@
12802bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
128124121865SAdrian Maldonado 
128224121865SAdrian Maldonado   Not Collective
128324121865SAdrian Maldonado 
128424121865SAdrian Maldonado   Input Parameters:
12852bf73ac6SHong Zhang + dm - the DMNetwork object
128624121865SAdrian Maldonado - p - the edge point
128724121865SAdrian Maldonado 
128824121865SAdrian Maldonado   Output Parameters:
128924121865SAdrian Maldonado . offset - the offset
129024121865SAdrian Maldonado 
129124121865SAdrian Maldonado   Level: intermediate
129224121865SAdrian Maldonado 
1293db781477SPatrick Sanan .seealso: `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
129424121865SAdrian Maldonado @*/
1295d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset)
1296d71ae5a4SJacob Faibussowitsch {
129724121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
129824121865SAdrian Maldonado 
129924121865SAdrian Maldonado   PetscFunctionBegin;
13009566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
13013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
130224121865SAdrian Maldonado }
130324121865SAdrian Maldonado 
130424121865SAdrian Maldonado /*@
13052bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
130624121865SAdrian Maldonado 
130724121865SAdrian Maldonado   Not Collective
130824121865SAdrian Maldonado 
130924121865SAdrian Maldonado   Input Parameters:
13102bf73ac6SHong Zhang + dm - the DMNetwork object
131124121865SAdrian Maldonado - p - the vertex point
131224121865SAdrian Maldonado 
131324121865SAdrian Maldonado   Output Parameters:
131424121865SAdrian Maldonado . offset - the offset
131524121865SAdrian Maldonado 
131624121865SAdrian Maldonado   Level: intermediate
131724121865SAdrian Maldonado 
1318db781477SPatrick Sanan .seealso: `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
131924121865SAdrian Maldonado @*/
1320d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset)
1321d71ae5a4SJacob Faibussowitsch {
132224121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
132324121865SAdrian Maldonado 
132424121865SAdrian Maldonado   PetscFunctionBegin;
1325daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
13269566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
13273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
132824121865SAdrian Maldonado }
13292bf73ac6SHong Zhang 
13305f2c45f1SShri Abhyankar /*@
13312bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
13325f2c45f1SShri Abhyankar 
1333eac198afSGetnet   Collective on dm
13345f2c45f1SShri Abhyankar 
13355f2c45f1SShri Abhyankar   Input Parameters:
13364dc646bcSBarry Smith + dm - the DMNetwork
1337eac198afSGetnet . p - the vertex/edge point. These points are local indices provided by DMNetworkGetSubnetwork()
1338eac198afSGetnet . componentkey - component key returned while registering the component with DMNetworkRegisterComponent()
133924359064SBarry 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
134024359064SBarry Smith               free this space until after DMSetUp() is called.
1341eac198afSGetnet - 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
13425f2c45f1SShri Abhyankar 
1343eac198afSGetnet   Notes:
1344eac198afSGetnet     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.
1345eac198afSGetnet 
1346eac198afSGetnet     DMNetworkLayoutSetUp() must be called before this routine.
1347eac198afSGetnet 
1348eac198afSGetnet   Developer Notes:
1349eac198afSGetnet      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.
135097bb938eSShri Abhyankar   Level: beginner
13515f2c45f1SShri Abhyankar 
1352db781477SPatrick Sanan .seealso: `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
13535f2c45f1SShri Abhyankar @*/
1354d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar)
1355d71ae5a4SJacob Faibussowitsch {
13565f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
13572bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
135854dfd506SHong Zhang   DMNetworkComponentHeader header;
135954dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
136054dfd506SHong Zhang   PetscInt                 compnum;
136154dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
136254dfd506SHong Zhang   void                   **compdata;
13635f2c45f1SShri Abhyankar 
13645f2c45f1SShri Abhyankar   PetscFunctionBegin;
13655c6496baSHong 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);
1366daad07d3SAidan 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.");
1367eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
13689566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
13692bf73ac6SHong Zhang 
1370eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
137154dfd506SHong Zhang   header = &network->header[p];
137254dfd506SHong Zhang   cvalue = &network->cvalue[p];
137354dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1374f11a936eSBarry Smith     PetscInt additional_size;
1375f11a936eSBarry Smith 
137654dfd506SHong Zhang     /* Reached limit so resize header component arrays */
137754dfd506SHong Zhang     header->maxcomps += 2;
137854dfd506SHong Zhang 
137954dfd506SHong Zhang     /* Allocate arrays for component information and value */
13809566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
13819566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
138254dfd506SHong Zhang 
138354dfd506SHong Zhang     /* Recalculate header size */
138454dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
138554dfd506SHong Zhang 
138654dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
138754dfd506SHong Zhang 
138854dfd506SHong Zhang     /* Copy over component info */
13899566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
13909566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
13919566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
13929566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
13939566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
139454dfd506SHong Zhang 
139554dfd506SHong Zhang     /* Copy over component data pointers */
13969566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
139754dfd506SHong Zhang 
139854dfd506SHong Zhang     /* Free old arrays */
13999566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
14009566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
140154dfd506SHong Zhang 
140254dfd506SHong Zhang     /* Update pointers */
140354dfd506SHong Zhang     header->size         = compsize;
140454dfd506SHong Zhang     header->key          = compkey;
140554dfd506SHong Zhang     header->offset       = compoffset;
140654dfd506SHong Zhang     header->nvar         = compnvar;
140754dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
140854dfd506SHong Zhang 
140954dfd506SHong Zhang     cvalue->data = compdata;
141054dfd506SHong Zhang 
141154dfd506SHong Zhang     /* Update DataSection Dofs */
141254dfd506SHong 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 */
1413f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
14149566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
141554dfd506SHong Zhang   }
141654dfd506SHong Zhang   header = &network->header[p];
141754dfd506SHong Zhang   cvalue = &network->cvalue[p];
141854dfd506SHong Zhang 
141954dfd506SHong Zhang   compnum = header->ndata;
14202bf73ac6SHong Zhang 
14212bf73ac6SHong Zhang   header->size[compnum] = component->size;
14229566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
14232bf73ac6SHong Zhang   header->key[compnum] = componentkey;
14242bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
14252bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
14262bf73ac6SHong Zhang 
14272bf73ac6SHong Zhang   /* variables */
14282bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
14292bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
14302bf73ac6SHong Zhang 
14312bf73ac6SHong Zhang   header->ndata++;
14323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14335f2c45f1SShri Abhyankar }
14345f2c45f1SShri Abhyankar 
143527f51fceSHong Zhang /*@
14362bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
143727f51fceSHong Zhang 
143827f51fceSHong Zhang   Not Collective
143927f51fceSHong Zhang 
144027f51fceSHong Zhang   Input Parameters:
14412bf73ac6SHong Zhang + dm - the DMNetwork object
14422bf73ac6SHong Zhang . p - vertex/edge point
144399c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
144427f51fceSHong Zhang 
144527f51fceSHong Zhang   Output Parameters:
14462bf73ac6SHong Zhang + compkey - the key obtained when registering the component (use NULL if not required)
14472bf73ac6SHong Zhang . component - the component data (use NULL if not required)
14482bf73ac6SHong Zhang - nvar  - number of variables (use NULL if not required)
144927f51fceSHong Zhang 
145097bb938eSShri Abhyankar   Level: beginner
145127f51fceSHong Zhang 
1452db781477SPatrick Sanan .seealso: `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
145327f51fceSHong Zhang @*/
1454d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar)
1455d71ae5a4SJacob Faibussowitsch {
145627f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
14572bf73ac6SHong Zhang   PetscInt                 offset  = 0;
14582bf73ac6SHong Zhang   DMNetworkComponentHeader header;
145927f51fceSHong Zhang 
146027f51fceSHong Zhang   PetscFunctionBegin;
14612bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
14629566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
14633ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
146427f51fceSHong Zhang   }
146527f51fceSHong Zhang 
14669566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
146742dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
14685f2c45f1SShri Abhyankar 
14692bf73ac6SHong Zhang   if (compnum >= 0) {
14702bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
14712bf73ac6SHong Zhang     if (component) {
147254dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
14732bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
14742bf73ac6SHong Zhang     }
14752bf73ac6SHong Zhang   }
14765f2c45f1SShri Abhyankar 
14772bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
147854dfd506SHong Zhang 
14793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14805f2c45f1SShri Abhyankar }
14815f2c45f1SShri Abhyankar 
14822bf73ac6SHong Zhang /*
14832bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14842bf73ac6SHong 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.
14852bf73ac6SHong Zhang */
1486d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkComponentSetUp(DM dm)
1487d71ae5a4SJacob Faibussowitsch {
14885f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1489f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
14905f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
14915f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1492f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
14935f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
14945f2c45f1SShri Abhyankar 
14955f2c45f1SShri Abhyankar   PetscFunctionBegin;
14969566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
14979566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1498f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
14999566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
15005f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1501daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
15029566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
15035f2c45f1SShri Abhyankar     /* Copy header */
15045f2c45f1SShri Abhyankar     header     = &network->header[p];
1505f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
15069566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1507f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
15089566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1509aeb78aa7SBarry Smith     headerinfo->size = headerarr;
151054dfd506SHong Zhang     headerarr += header->maxcomps;
15119566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1512aeb78aa7SBarry Smith     headerinfo->key = headerarr;
151354dfd506SHong Zhang     headerarr += header->maxcomps;
15149566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1515aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
151654dfd506SHong Zhang     headerarr += header->maxcomps;
15179566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1518aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
151954dfd506SHong Zhang     headerarr += header->maxcomps;
15209566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1521aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
152254dfd506SHong Zhang 
15235f2c45f1SShri Abhyankar     /* Copy data */
15245f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
15255f2c45f1SShri Abhyankar     ncomp  = header->ndata;
15262bf73ac6SHong Zhang 
15275f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
152854dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
15299566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
15305f2c45f1SShri Abhyankar     }
15315f2c45f1SShri Abhyankar   }
1532aeb78aa7SBarry Smith 
1533daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1534aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1535aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1536aeb78aa7SBarry Smith   }
1537aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
15383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15395f2c45f1SShri Abhyankar }
15405f2c45f1SShri Abhyankar 
15415f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1542d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1543d71ae5a4SJacob Faibussowitsch {
15445f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
15455f2c45f1SShri Abhyankar 
15465f2c45f1SShri Abhyankar   PetscFunctionBegin;
15479566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
15483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15495f2c45f1SShri Abhyankar }
15505f2c45f1SShri Abhyankar 
155124121865SAdrian Maldonado /* Get a subsection from a range of points */
1552d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1553d71ae5a4SJacob Faibussowitsch {
155424121865SAdrian Maldonado   PetscInt i, nvar;
155524121865SAdrian Maldonado 
155624121865SAdrian Maldonado   PetscFunctionBegin;
15579566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
15589566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
155924121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
15609566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
15619566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
156224121865SAdrian Maldonado   }
156324121865SAdrian Maldonado 
15649566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
15653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
156624121865SAdrian Maldonado }
156724121865SAdrian Maldonado 
156824121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1569d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkSetSubMap_private(PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1570d71ae5a4SJacob Faibussowitsch {
157124121865SAdrian Maldonado   PetscInt i, *subpoints;
157224121865SAdrian Maldonado 
157324121865SAdrian Maldonado   PetscFunctionBegin;
157424121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15759566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1576ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
15779566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15789566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
15793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
158024121865SAdrian Maldonado }
158124121865SAdrian Maldonado 
158224121865SAdrian Maldonado /*@
15832bf73ac6SHong Zhang   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after DMNetworkDistribute
158424121865SAdrian Maldonado 
15852bf73ac6SHong Zhang   Collective on dm
158624121865SAdrian Maldonado 
158724121865SAdrian Maldonado   Input Parameters:
15882bf73ac6SHong Zhang . dm - the DMNetworkObject
158924121865SAdrian Maldonado 
159024121865SAdrian Maldonado   Note: the routine will create alternative orderings for the vertices and edges. Assume global network points are:
159124121865SAdrian Maldonado 
159224121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
159324121865SAdrian Maldonado 
1594caf410d2SHong 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]).
159524121865SAdrian Maldonado 
159624121865SAdrian Maldonado   With this new ordering a local PetscSection, global PetscSection and PetscSF will be created specific to the subset.
159724121865SAdrian Maldonado 
159824121865SAdrian Maldonado   Level: intermediate
159924121865SAdrian Maldonado 
160024121865SAdrian Maldonado @*/
1601d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1602d71ae5a4SJacob Faibussowitsch {
160324121865SAdrian Maldonado   MPI_Comm    comm;
1604f11a936eSBarry Smith   PetscMPIInt size;
160524121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
160624121865SAdrian Maldonado 
1607eab1376dSHong Zhang   PetscFunctionBegin;
16089566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
16099566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
161024121865SAdrian Maldonado 
161124121865SAdrian Maldonado   /* Create maps for vertices and edges */
1612daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1613daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
161424121865SAdrian Maldonado 
161524121865SAdrian Maldonado   /* Create local sub-sections */
1616daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1617daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
161824121865SAdrian Maldonado 
16199852e123SBarry Smith   if (size > 1) {
16209566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
162122bbedd7SHong Zhang 
16229566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
16239566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
16249566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
162524121865SAdrian Maldonado   } else {
162624121865SAdrian Maldonado     /* create structures for vertex */
16279566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
162824121865SAdrian Maldonado     /* create structures for edge */
16299566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
163024121865SAdrian Maldonado   }
163124121865SAdrian Maldonado 
163224121865SAdrian Maldonado   /* Add viewers */
16339566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
16349566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
16359566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
16369566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
16373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
163824121865SAdrian Maldonado }
16397b6afd5bSHong Zhang 
1640f11a936eSBarry Smith /*
16415c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
16425c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1643f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1644f11a936eSBarry Smith */
1645d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1646d71ae5a4SJacob Faibussowitsch {
1647f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1648f11a936eSBarry Smith   const PetscInt          *edges;
1649f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1650f11a936eSBarry Smith   DMNetworkComponentHeader header;
1651f11a936eSBarry Smith 
1652f11a936eSBarry Smith   PetscFunctionBegin;
16539566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
16549566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1655f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
16569566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1657f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16589566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1659f11a936eSBarry Smith   }
16603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1661f11a936eSBarry Smith }
1662f11a936eSBarry Smith 
16638afb7921SAidan Hamilton /*
16648afb7921SAidan Hamilton   DMNetworkDistributeCoordinates - Internal function to distribute the coordinate network and coordinates.
16658afb7921SAidan Hamilton 
16668afb7921SAidan Hamilton   Collective
16678afb7921SAidan Hamilton 
16688afb7921SAidan Hamilton   Input Parameters:
16698afb7921SAidan Hamilton   + dm - The original DMNetwork object
16708afb7921SAidan Hamilton   - migrationSF - The PetscSF discribing the migrgration from dm to dmnew
16718afb7921SAidan Hamilton   - newDM - The new distributed dmnetwork object.
16728afb7921SAidan Hamilton */
16738afb7921SAidan Hamilton 
16748afb7921SAidan Hamilton static PetscErrorCode DMNetworkDistributeCoordinates(DM dm, PetscSF migrationSF, DM newDM)
16758afb7921SAidan Hamilton {
16768afb7921SAidan Hamilton   DM_Network              *newDMnetwork = (DM_Network *)((newDM)->data), *newCoordnetwork, *oldCoordnetwork;
16778afb7921SAidan Hamilton   DM                       cdm, newcdm;
16788afb7921SAidan Hamilton   PetscInt                 cdim, bs, p, pStart, pEnd, offset;
16798afb7921SAidan Hamilton   Vec                      oldCoord, newCoord;
16808afb7921SAidan Hamilton   DMNetworkComponentHeader header;
16818afb7921SAidan Hamilton   const char              *name;
16828afb7921SAidan Hamilton 
16838afb7921SAidan Hamilton   PetscFunctionBegin;
16848afb7921SAidan Hamilton   /* Distribute the coordinate network and coordinates */
16858afb7921SAidan Hamilton   PetscCall(DMGetCoordinateDim(dm, &cdim));
16868afb7921SAidan Hamilton   PetscCall(DMSetCoordinateDim(newDM, cdim));
16878afb7921SAidan Hamilton 
16888afb7921SAidan Hamilton   /* Migrate only if original network had coordinates */
16898afb7921SAidan Hamilton   PetscCall(DMGetCoordinatesLocal(dm, &oldCoord));
16908afb7921SAidan Hamilton   if (oldCoord) {
16918afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(dm, &cdm));
16928afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(newDM, &newcdm));
16938afb7921SAidan Hamilton     newCoordnetwork = (DM_Network *)newcdm->data;
16948afb7921SAidan Hamilton     oldCoordnetwork = (DM_Network *)cdm->data;
16958afb7921SAidan Hamilton 
16968afb7921SAidan Hamilton     PetscCall(VecCreate(PETSC_COMM_SELF, &newCoord));
16978afb7921SAidan Hamilton     PetscCall(PetscObjectGetName((PetscObject)oldCoord, &name));
16988afb7921SAidan Hamilton     PetscCall(PetscObjectSetName((PetscObject)newCoord, name));
16998afb7921SAidan Hamilton     PetscCall(VecGetBlockSize(oldCoord, &bs));
17008afb7921SAidan Hamilton     PetscCall(VecSetBlockSize(newCoord, bs));
17018afb7921SAidan Hamilton 
17028afb7921SAidan Hamilton     PetscCall(DMPlexDistributeField(newDMnetwork->plex, migrationSF, oldCoordnetwork->DofSection, oldCoord, newCoordnetwork->DofSection, newCoord));
17038afb7921SAidan Hamilton     PetscCall(DMSetCoordinatesLocal(newDM, newCoord));
17048afb7921SAidan Hamilton 
17058afb7921SAidan Hamilton     PetscCall(VecDestroy(&newCoord));
17068afb7921SAidan Hamilton     /* Migrate the components from the orignal coordinate network to the new coordinate network */
17078afb7921SAidan Hamilton     PetscCall(DMPlexDistributeData(newDMnetwork->plex, migrationSF, oldCoordnetwork->DataSection, MPIU_INT, (void *)oldCoordnetwork->componentdataarray, newCoordnetwork->DataSection, (void **)&newCoordnetwork->componentdataarray));
17088afb7921SAidan Hamilton     /* update the header pointers in the new coordinate network components */
17098afb7921SAidan Hamilton     PetscCall(PetscSectionGetChart(newCoordnetwork->DataSection, &pStart, &pEnd));
17108afb7921SAidan Hamilton     for (p = pStart; p < pEnd; p++) {
17118afb7921SAidan Hamilton       PetscCall(PetscSectionGetOffset(newCoordnetwork->DataSection, p, &offset));
17128afb7921SAidan Hamilton       header = (DMNetworkComponentHeader)(newCoordnetwork->componentdataarray + offset);
17138afb7921SAidan Hamilton       /* Update pointers */
17148afb7921SAidan Hamilton       header->size         = (PetscInt *)(header + 1);
17158afb7921SAidan Hamilton       header->key          = header->size + header->maxcomps;
17168afb7921SAidan Hamilton       header->offset       = header->key + header->maxcomps;
17178afb7921SAidan Hamilton       header->nvar         = header->offset + header->maxcomps;
17188afb7921SAidan Hamilton       header->offsetvarrel = header->nvar + header->maxcomps;
17198afb7921SAidan Hamilton     }
17208afb7921SAidan Hamilton 
17218afb7921SAidan Hamilton     PetscCall(DMSetLocalSection(newCoordnetwork->plex, newCoordnetwork->DofSection));
17228afb7921SAidan Hamilton     PetscCall(DMGetGlobalSection(newCoordnetwork->plex, &newCoordnetwork->GlobalDofSection));
17238afb7921SAidan Hamilton     newCoordnetwork->componentsetup = PETSC_TRUE;
17248afb7921SAidan Hamilton   }
17253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17268afb7921SAidan Hamilton }
17278afb7921SAidan Hamilton 
17285f2c45f1SShri Abhyankar /*@
17292bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
17305f2c45f1SShri Abhyankar 
17315f2c45f1SShri Abhyankar   Collective
17325f2c45f1SShri Abhyankar 
1733d8d19677SJose E. Roman   Input Parameters:
1734d3464fd4SAdrian Maldonado + DM - the DMNetwork object
17352bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
17365f2c45f1SShri Abhyankar 
17375b3f975aSHong Zhang   Options Database Key:
1738*6e4289a0SDuncan Campbell + -dmnetwork_view - Calls `DMView()` at the conclusion of `DMSetUp()`
1739*6e4289a0SDuncan Campbell . -dmnetwork_view_distributed - Calls `DMView()` at the conclusion of `DMNetworkDistribute()`
1740*6e4289a0SDuncan Campbell - -dmnetwork_view_tmpdir - Sets the temporary directory to use when viewing with the `draw` option
17415b3f975aSHong Zhang 
17425f2c45f1SShri Abhyankar   Notes:
17438b171c8eSHong Zhang   Distributes the network with <overlap>-overlapping partitioning of the edges.
17445f2c45f1SShri Abhyankar 
17455f2c45f1SShri Abhyankar   Level: intermediate
17465f2c45f1SShri Abhyankar 
1747db781477SPatrick Sanan .seealso: `DMNetworkCreate()`
17485f2c45f1SShri Abhyankar @*/
1749d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1750d71ae5a4SJacob Faibussowitsch {
1751d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1752d3464fd4SAdrian Maldonado   PetscMPIInt              size;
17538afb7921SAidan Hamilton   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data), *newDMnetwork;
1754caf410d2SHong Zhang   PetscSF                  pointsf      = NULL;
17555f2c45f1SShri Abhyankar   DM                       newDM;
17568afb7921SAidan Hamilton   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv, net;
17578afb7921SAidan Hamilton   PetscInt                *sv;
1758f11a936eSBarry Smith   PetscBT                  btable;
175951ac5effSHong Zhang   PetscPartitioner         part;
1760b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
17615f2c45f1SShri Abhyankar 
17625f2c45f1SShri Abhyankar   PetscFunctionBegin;
17635c6496baSHong Zhang   PetscValidPointer(dm, 1);
17645c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
17659566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
17669566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1767a9750deaSHong Zhang   if (size == 1) {
1768a9750deaSHong Zhang     oldDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1769a9750deaSHong Zhang     PetscFunctionReturn(PETSC_SUCCESS);
1770a9750deaSHong Zhang   }
1771d3464fd4SAdrian Maldonado 
17725c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
17735b3f975aSHong Zhang 
17742bf73ac6SHong 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. */
1775e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
17769566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
17775f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
177854dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
17799566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
178051ac5effSHong Zhang 
178151ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
17829566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
17839566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
178451ac5effSHong Zhang 
17852bf73ac6SHong Zhang   /* Distribute plex dm */
17869566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
178751ac5effSHong Zhang 
17885f2c45f1SShri Abhyankar   /* Distribute dof section */
17899566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
17909566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
179151ac5effSHong Zhang 
17925f2c45f1SShri Abhyankar   /* Distribute data and associated section */
17939566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
17949566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
179524121865SAdrian Maldonado 
1796daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1797daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1798daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1799daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1800daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1801daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1802daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1803daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1804daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
180524121865SAdrian Maldonado 
18061bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
18079566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
18089566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
18095f2c45f1SShri Abhyankar 
1810b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1811daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1812daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1813daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1814daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1815daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1816daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
18172bf73ac6SHong Zhang 
18182bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
18192bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1820b9c6e19dSShri Abhyankar   */
1821daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1822f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1823daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1824daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1825b9c6e19dSShri Abhyankar   }
1826b9c6e19dSShri Abhyankar 
1827f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1828daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18299566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
183054dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18315c6496baSHong Zhang 
183254dfd506SHong Zhang     /* Update pointers */
183354dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
183454dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
183554dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
183654dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
183754dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
183854dfd506SHong Zhang 
1839daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1840b9c6e19dSShri Abhyankar   }
1841b9c6e19dSShri Abhyankar 
18425c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
184348a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
18445c6496baSHong Zhang 
18455c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1846daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
18479566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
18485f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18495c6496baSHong Zhang 
185054dfd506SHong Zhang     /* Update pointers */
185154dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
185254dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
185354dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
185454dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
185554dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
185654dfd506SHong Zhang 
18572bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
18582bf73ac6SHong Zhang     gidx = header->index;
1859eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, gidx + 1, 0, &svtx_idx));
18602bf73ac6SHong Zhang     svtx_idx--;
18612bf73ac6SHong Zhang 
18622bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1863daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
18642bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
18655c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
18669566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1867f11a936eSBarry Smith 
1868daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1869daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
18705c6496baSHong Zhang         net = sv[0];
187135cb6cd3SPierre Jolivet         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this process */
18722bf73ac6SHong Zhang       }
18732bf73ac6SHong Zhang     }
1874b9c6e19dSShri Abhyankar   }
1875b9c6e19dSShri Abhyankar 
18762bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
18772bf73ac6SHong Zhang   nv = 0;
1878daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1879daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1880caf410d2SHong Zhang 
18812bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1882daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1883daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1884daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1885daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1886daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1887daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
18882bf73ac6SHong Zhang 
1889daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1890daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1891caf410d2SHong Zhang 
18922bf73ac6SHong 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. */
1893daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1894b9c6e19dSShri Abhyankar   }
1895daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1896b9c6e19dSShri Abhyankar 
18972bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1898daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18999566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
19005f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1901daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1902b9c6e19dSShri Abhyankar   }
1903b9c6e19dSShri Abhyankar 
19042bf73ac6SHong Zhang   nv = 0;
1905daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
19069566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
19075f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
19082bf73ac6SHong Zhang 
19092bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1910eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, header->index + 1, 0, &svtx_idx));
19112bf73ac6SHong Zhang     svtx_idx--;
19122bf73ac6SHong Zhang     if (svtx_idx < 0) {
1913daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
19142bf73ac6SHong Zhang     } else { /* a shared vertex */
1915daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
19162bf73ac6SHong Zhang 
19175c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
19189566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1919f11a936eSBarry Smith 
1920daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1921daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
19225c6496baSHong Zhang         net = sv[0];
19239371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1924b9c6e19dSShri Abhyankar       }
19252bf73ac6SHong Zhang     }
19262bf73ac6SHong Zhang   }
1927daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1928b9c6e19dSShri Abhyankar 
19298afb7921SAidan Hamilton   PetscCall(DMNetworkDistributeCoordinates(*dm, pointsf, newDM));
1930caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1931daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1932caf410d2SHong Zhang 
19332bf73ac6SHong Zhang   /* Free spaces */
19349566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
19359566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
193648a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
19372bf73ac6SHong Zhang 
19385b3f975aSHong Zhang   /* View distributed dmnetwork */
19399566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
19405b3f975aSHong Zhang 
1941d3464fd4SAdrian Maldonado   *dm = newDM;
1942e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
19433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19445f2c45f1SShri Abhyankar }
19455f2c45f1SShri Abhyankar 
194624121865SAdrian Maldonado /*@C
19472bf73ac6SHong Zhang   PetscSFGetSubSF - Returns an SF for a specific subset of points. Leaves are re-numbered to reflect the new ordering
19482bf73ac6SHong Zhang 
19492bf73ac6SHong Zhang  Collective
195024121865SAdrian Maldonado 
195124121865SAdrian Maldonado   Input Parameters:
19529dddd249SSatish Balay + mainSF - the original SF structure
195324121865SAdrian Maldonado - map - a ISLocalToGlobal mapping that contains the subset of points
195424121865SAdrian Maldonado 
195597bb3fdcSJose E. Roman   Output Parameter:
19569dddd249SSatish Balay . subSF - a subset of the mainSF for the desired subset.
1957ee300463SSatish Balay 
1958ee300463SSatish Balay   Level: intermediate
19597d928bffSSatish Balay @*/
1960d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1961d71ae5a4SJacob Faibussowitsch {
196224121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
196324121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
196424121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
196524121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
196624121865SAdrian Maldonado   const PetscInt    *ilocal;
196724121865SAdrian Maldonado   const PetscSFNode *iremote;
196824121865SAdrian Maldonado 
196924121865SAdrian Maldonado   PetscFunctionBegin;
19709566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
197124121865SAdrian Maldonado 
197224121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
19739566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
19749566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
197524121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
197624121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
197724121865SAdrian Maldonado   }
197824121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
19799566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
198024121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
19819566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
19829566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
19839566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
198424121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
19859566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
19869566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
198724121865SAdrian Maldonado   nleaves_sub = 0;
198824121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
198924121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
199024121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
19914b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
199224121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
199324121865SAdrian Maldonado       nleaves_sub += 1;
199424121865SAdrian Maldonado     }
199524121865SAdrian Maldonado   }
19969566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
19979566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
199824121865SAdrian Maldonado 
199924121865SAdrian Maldonado   /* Create new subSF */
20009566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(PETSC_COMM_WORLD, subSF));
20019566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
20029566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
20039566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
20049566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
20053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
200624121865SAdrian Maldonado }
200724121865SAdrian Maldonado 
20085f2c45f1SShri Abhyankar /*@C
20095f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
20105f2c45f1SShri Abhyankar 
20115f2c45f1SShri Abhyankar   Not Collective
20125f2c45f1SShri Abhyankar 
20135f2c45f1SShri Abhyankar   Input Parameters:
20142bf73ac6SHong Zhang + dm - the DMNetwork object
20155f2c45f1SShri Abhyankar - p  - the vertex point
20165f2c45f1SShri Abhyankar 
2017fd292e60Sprj-   Output Parameters:
20185f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
20192bf73ac6SHong Zhang - edges  - list of edge points
20205f2c45f1SShri Abhyankar 
202197bb938eSShri Abhyankar   Level: beginner
20225f2c45f1SShri Abhyankar 
20235f2c45f1SShri Abhyankar   Fortran Notes:
20245f2c45f1SShri Abhyankar   Since it returns an array, this routine is only available in Fortran 90, and you must
20255f2c45f1SShri Abhyankar   include petsc.h90 in your code.
20265f2c45f1SShri Abhyankar 
2027db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
20285f2c45f1SShri Abhyankar @*/
2029d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[])
2030d71ae5a4SJacob Faibussowitsch {
20315f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20325f2c45f1SShri Abhyankar 
20335f2c45f1SShri Abhyankar   PetscFunctionBegin;
20349566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
20359566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
20363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20375f2c45f1SShri Abhyankar }
20385f2c45f1SShri Abhyankar 
20395f2c45f1SShri Abhyankar /*@C
2040d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
20415f2c45f1SShri Abhyankar 
20425f2c45f1SShri Abhyankar   Not Collective
20435f2c45f1SShri Abhyankar 
20445f2c45f1SShri Abhyankar   Input Parameters:
20452bf73ac6SHong Zhang + dm - the DMNetwork object
20465f2c45f1SShri Abhyankar - p - the edge point
20475f2c45f1SShri Abhyankar 
2048fd292e60Sprj-   Output Parameters:
20495f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
20505f2c45f1SShri Abhyankar 
205197bb938eSShri Abhyankar   Level: beginner
20525f2c45f1SShri Abhyankar 
20535f2c45f1SShri Abhyankar   Fortran Notes:
20545f2c45f1SShri Abhyankar   Since it returns an array, this routine is only available in Fortran 90, and you must
20555f2c45f1SShri Abhyankar   include petsc.h90 in your code.
20565f2c45f1SShri Abhyankar 
2057db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
20585f2c45f1SShri Abhyankar @*/
2059d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
2060d71ae5a4SJacob Faibussowitsch {
20615f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20625f2c45f1SShri Abhyankar 
20635f2c45f1SShri Abhyankar   PetscFunctionBegin;
20649566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
20653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20665f2c45f1SShri Abhyankar }
20675f2c45f1SShri Abhyankar 
20685f2c45f1SShri Abhyankar /*@
20692bf73ac6SHong Zhang   DMNetworkIsSharedVertex - Returns TRUE if the vertex is shared by subnetworks
20702bf73ac6SHong Zhang 
20712bf73ac6SHong Zhang   Not Collective
20722bf73ac6SHong Zhang 
20732bf73ac6SHong Zhang   Input Parameters:
20742bf73ac6SHong Zhang + dm - the DMNetwork object
20752bf73ac6SHong Zhang - p - the vertex point
20762bf73ac6SHong Zhang 
20772bf73ac6SHong Zhang   Output Parameter:
20782bf73ac6SHong Zhang . flag - TRUE if the vertex is shared by subnetworks
20792bf73ac6SHong Zhang 
20802bf73ac6SHong Zhang   Level: beginner
20812bf73ac6SHong Zhang 
2082db781477SPatrick Sanan .seealso: `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
20832bf73ac6SHong Zhang @*/
2084d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
2085d71ae5a4SJacob Faibussowitsch {
20862bf73ac6SHong Zhang   PetscFunctionBegin;
2087eec179cfSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2088eec179cfSJacob Faibussowitsch   PetscValidBoolPointer(flag, 3);
20892bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
20902bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
20912bf73ac6SHong Zhang     PetscInt    gidx;
2092eec179cfSJacob Faibussowitsch 
20939566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
2094eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIHas(network->cloneshared->svtable, gidx + 1, flag));
20952bf73ac6SHong Zhang   } else { /* would be removed? */
20962bf73ac6SHong Zhang     PetscInt        nv;
20972bf73ac6SHong Zhang     const PetscInt *vtx;
2098eec179cfSJacob Faibussowitsch 
20999566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
2100eec179cfSJacob Faibussowitsch     for (PetscInt i = 0; i < nv; i++) {
21012bf73ac6SHong Zhang       if (p == vtx[i]) {
21022bf73ac6SHong Zhang         *flag = PETSC_TRUE;
21033ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
21042bf73ac6SHong Zhang       }
21052bf73ac6SHong Zhang     }
2106eec179cfSJacob Faibussowitsch     *flag = PETSC_FALSE;
21072bf73ac6SHong Zhang   }
21083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21092bf73ac6SHong Zhang }
21102bf73ac6SHong Zhang 
21112bf73ac6SHong Zhang /*@
21125f2c45f1SShri Abhyankar   DMNetworkIsGhostVertex - Returns TRUE if the vertex is a ghost vertex
21135f2c45f1SShri Abhyankar 
21145f2c45f1SShri Abhyankar   Not Collective
21155f2c45f1SShri Abhyankar 
21165f2c45f1SShri Abhyankar   Input Parameters:
21172bf73ac6SHong Zhang + dm - the DMNetwork object
2118a2b725a8SWilliam Gropp - p - the vertex point
21195f2c45f1SShri Abhyankar 
21205f2c45f1SShri Abhyankar   Output Parameter:
21215f2c45f1SShri Abhyankar . isghost - TRUE if the vertex is a ghost point
21225f2c45f1SShri Abhyankar 
212397bb938eSShri Abhyankar   Level: beginner
21245f2c45f1SShri Abhyankar 
2125db781477SPatrick Sanan .seealso: `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
21265f2c45f1SShri Abhyankar @*/
2127d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
2128d71ae5a4SJacob Faibussowitsch {
21295f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
21305f2c45f1SShri Abhyankar   PetscInt     offsetg;
21315f2c45f1SShri Abhyankar   PetscSection sectiong;
21325f2c45f1SShri Abhyankar 
21335f2c45f1SShri Abhyankar   PetscFunctionBegin;
21345f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
21359566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
21369566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
21375f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
21383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21395f2c45f1SShri Abhyankar }
21405f2c45f1SShri Abhyankar 
2141d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
2142d71ae5a4SJacob Faibussowitsch {
21435f2c45f1SShri Abhyankar   PetscFunctionBegin;
2144e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2145daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
21465b3f975aSHong Zhang   /* View dmnetwork */
21479566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2148e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
21493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21505f2c45f1SShri Abhyankar }
21515f2c45f1SShri Abhyankar 
21521ad426b7SHong Zhang /*@
215317df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
21541ad426b7SHong Zhang       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TURE)?
21551ad426b7SHong Zhang 
21561ad426b7SHong Zhang   Collective
21571ad426b7SHong Zhang 
21581ad426b7SHong Zhang   Input Parameters:
21592bf73ac6SHong Zhang + dm - the DMNetwork object
216083b2e829SHong Zhang . eflg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE) if user provides Jacobian for edges
216183b2e829SHong Zhang - vflg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE) if user provides Jacobian for vertices
21621ad426b7SHong Zhang 
21631ad426b7SHong Zhang  Level: intermediate
21641ad426b7SHong Zhang 
21651ad426b7SHong Zhang @*/
2166d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2167d71ae5a4SJacob Faibussowitsch {
21681ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2169daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
21701ad426b7SHong Zhang 
21711ad426b7SHong Zhang   PetscFunctionBegin;
217283b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
217383b2e829SHong Zhang   network->userVertexJacobian = vflg;
21748675203cSHong Zhang 
217548a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
21768675203cSHong Zhang 
217766b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2178daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
217966b4e0ffSHong Zhang     PetscInt        nedges_total;
21808675203cSHong Zhang     const PetscInt *edges;
21818675203cSHong Zhang 
21828675203cSHong Zhang     /* count nvertex_total */
21838675203cSHong Zhang     nedges_total = 0;
21849566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
21858675203cSHong Zhang 
21868675203cSHong Zhang     vptr[0] = 0;
21878675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
21889566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
21898675203cSHong Zhang       nedges_total += nedges;
21908675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
21918675203cSHong Zhang     }
21928675203cSHong Zhang 
21939566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
21948675203cSHong Zhang     network->Jvptr = vptr;
21958675203cSHong Zhang   }
21963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21971ad426b7SHong Zhang }
21981ad426b7SHong Zhang 
21991ad426b7SHong Zhang /*@
220083b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
220183b2e829SHong Zhang 
220283b2e829SHong Zhang   Not Collective
220383b2e829SHong Zhang 
220483b2e829SHong Zhang   Input Parameters:
22052bf73ac6SHong Zhang + dm - the DMNetwork object
220683b2e829SHong Zhang . p - the edge point
22073e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
22083e97b6e8SHong Zhang         J[0]: this edge
2209d842c372SHong Zhang         J[1] and J[2]: connected vertices, obtained by calling DMNetworkGetConnectedVertices()
221083b2e829SHong Zhang 
221197bb938eSShri Abhyankar   Level: advanced
221283b2e829SHong Zhang 
2213db781477SPatrick Sanan .seealso: `DMNetworkVertexSetMatrix()`
221483b2e829SHong Zhang @*/
2215d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2216d71ae5a4SJacob Faibussowitsch {
221783b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
221883b2e829SHong Zhang 
221983b2e829SHong Zhang   PetscFunctionBegin;
22205c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
22218675203cSHong Zhang 
22228675203cSHong Zhang   if (J) {
2223883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2224883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2225883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
22268675203cSHong Zhang   }
22273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
222883b2e829SHong Zhang }
222983b2e829SHong Zhang 
223083b2e829SHong Zhang /*@
223176ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
22321ad426b7SHong Zhang 
22331ad426b7SHong Zhang   Not Collective
22341ad426b7SHong Zhang 
22351ad426b7SHong Zhang   Input Parameters:
22361ad426b7SHong Zhang + dm - The DMNetwork object
22371ad426b7SHong Zhang . p - the vertex point
22383e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
22393e97b6e8SHong Zhang         J[0]:       this vertex
22403e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
22413e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
22421ad426b7SHong Zhang 
224397bb938eSShri Abhyankar   Level: advanced
22441ad426b7SHong Zhang 
2245db781477SPatrick Sanan .seealso: `DMNetworkEdgeSetMatrix()`
22461ad426b7SHong Zhang @*/
2247d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2248d71ae5a4SJacob Faibussowitsch {
22495f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2250daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2251883e35e8SHong Zhang   const PetscInt *edges;
22525f2c45f1SShri Abhyankar 
22535f2c45f1SShri Abhyankar   PetscFunctionBegin;
22545c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2255883e35e8SHong Zhang 
22568675203cSHong Zhang   if (J) {
2257883e35e8SHong Zhang     vptr                          = network->Jvptr;
22583e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
22593e97b6e8SHong Zhang 
22603e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
22619566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2262883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
22638675203cSHong Zhang   }
22643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2265883e35e8SHong Zhang }
2266883e35e8SHong Zhang 
2267d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2268d71ae5a4SJacob Faibussowitsch {
22695cf7da58SHong Zhang   PetscInt    j;
22705cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
22715cf7da58SHong Zhang 
22725cf7da58SHong Zhang   PetscFunctionBegin;
22735cf7da58SHong Zhang   if (!ghost) {
227448a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22755cf7da58SHong Zhang   } else {
227648a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22775cf7da58SHong Zhang   }
22783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22795cf7da58SHong Zhang }
22805cf7da58SHong Zhang 
2281d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2282d71ae5a4SJacob Faibussowitsch {
22835cf7da58SHong Zhang   PetscInt    j, ncols_u;
22845cf7da58SHong Zhang   PetscScalar val;
22855cf7da58SHong Zhang 
22865cf7da58SHong Zhang   PetscFunctionBegin;
22875cf7da58SHong Zhang   if (!ghost) {
22885cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22899566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22905cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22919566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22929566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22935cf7da58SHong Zhang     }
22945cf7da58SHong Zhang   } else {
22955cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22969566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22975cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22989566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22999566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
23005cf7da58SHong Zhang     }
23015cf7da58SHong Zhang   }
23023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23035cf7da58SHong Zhang }
23045cf7da58SHong Zhang 
2305d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2306d71ae5a4SJacob Faibussowitsch {
23075cf7da58SHong Zhang   PetscFunctionBegin;
23085cf7da58SHong Zhang   if (Ju) {
23099566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
23105cf7da58SHong Zhang   } else {
23119566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
23125cf7da58SHong Zhang   }
23133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23145cf7da58SHong Zhang }
23155cf7da58SHong Zhang 
2316d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2317d71ae5a4SJacob Faibussowitsch {
2318883e35e8SHong Zhang   PetscInt     j, *cols;
2319883e35e8SHong Zhang   PetscScalar *zeros;
2320883e35e8SHong Zhang 
2321883e35e8SHong Zhang   PetscFunctionBegin;
23229566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2323883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
23249566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
23259566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
23263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23271ad426b7SHong Zhang }
2328a4e85ca8SHong Zhang 
2329d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2330d71ae5a4SJacob Faibussowitsch {
23313e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
23323e97b6e8SHong Zhang   const PetscInt *cols;
23333e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
23343e97b6e8SHong Zhang 
23353e97b6e8SHong Zhang   PetscFunctionBegin;
23369566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
233763a3b9bcSJacob 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);
23383e97b6e8SHong Zhang 
23393e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
23409566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
23413e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
23423e97b6e8SHong Zhang       col = cols[j] + cstart;
23439566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
23443e97b6e8SHong Zhang     }
23459566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
23463e97b6e8SHong Zhang   }
23473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23483e97b6e8SHong Zhang }
23491ad426b7SHong Zhang 
2350d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2351d71ae5a4SJacob Faibussowitsch {
2352a4e85ca8SHong Zhang   PetscFunctionBegin;
2353a4e85ca8SHong Zhang   if (Ju) {
23549566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2355a4e85ca8SHong Zhang   } else {
23569566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2357a4e85ca8SHong Zhang   }
23583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2359a4e85ca8SHong Zhang }
2360a4e85ca8SHong Zhang 
236124121865SAdrian 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.
236224121865SAdrian Maldonado */
2363d71ae5a4SJacob Faibussowitsch PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2364d71ae5a4SJacob Faibussowitsch {
236524121865SAdrian Maldonado   PetscInt  i, size, dof;
236624121865SAdrian Maldonado   PetscInt *glob2loc;
236724121865SAdrian Maldonado 
236824121865SAdrian Maldonado   PetscFunctionBegin;
23699566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
23709566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
237124121865SAdrian Maldonado 
237224121865SAdrian Maldonado   for (i = 0; i < size; i++) {
23739566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
237424121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
237524121865SAdrian Maldonado     glob2loc[i] = dof;
237624121865SAdrian Maldonado   }
237724121865SAdrian Maldonado 
23789566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
237924121865SAdrian Maldonado #if 0
23809566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
238124121865SAdrian Maldonado #endif
23823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
238324121865SAdrian Maldonado }
238424121865SAdrian Maldonado 
238501ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
23869e1d080bSHong Zhang 
2387d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2388d71ae5a4SJacob Faibussowitsch {
23891ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
239024121865SAdrian Maldonado   PetscInt               eDof, vDof;
239124121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
23929e1d080bSHong Zhang   MPI_Comm               comm;
239324121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
239424121865SAdrian Maldonado 
23959e1d080bSHong Zhang   PetscFunctionBegin;
23969566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
239724121865SAdrian Maldonado 
23989566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
23999566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
240024121865SAdrian Maldonado 
24019566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
24029566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24039566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
240424121865SAdrian Maldonado 
24059566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
24069566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24079566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
240824121865SAdrian Maldonado 
24099566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
24109566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24119566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
241224121865SAdrian Maldonado 
24139566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
24149566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24159566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
241624121865SAdrian Maldonado 
24173f6a6bdaSHong Zhang   bA[0][0] = j11;
24183f6a6bdaSHong Zhang   bA[0][1] = j12;
24193f6a6bdaSHong Zhang   bA[1][0] = j21;
24203f6a6bdaSHong Zhang   bA[1][1] = j22;
242124121865SAdrian Maldonado 
24229566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
24239566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
242424121865SAdrian Maldonado 
24259566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
24269566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
24279566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
24289566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
242924121865SAdrian Maldonado 
24309566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
24319566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
24329566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
24339566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
243424121865SAdrian Maldonado 
24359566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
24369566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
24379566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
24389566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
24399566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
24409566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
24419566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
244224121865SAdrian Maldonado 
24439566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
24449566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
24459566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
244624121865SAdrian Maldonado 
244724121865SAdrian Maldonado   /* Free structures */
24489566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
24499566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
24503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24519e1d080bSHong Zhang }
24529e1d080bSHong Zhang 
2453d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2454d71ae5a4SJacob Faibussowitsch {
24559e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
24569e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
24579e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
24589e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
24599e1d080bSHong Zhang   Mat             Juser;
24609e1d080bSHong Zhang   PetscSection    sectionGlobal;
24619e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
24629e1d080bSHong Zhang   const PetscInt *edges, *cone;
24639e1d080bSHong Zhang   MPI_Comm        comm;
24649e1d080bSHong Zhang   MatType         mtype;
24659e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
24669e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
24679e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
24689e1d080bSHong Zhang 
24699e1d080bSHong Zhang   PetscFunctionBegin;
24709e1d080bSHong Zhang   mtype = dm->mattype;
24719566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
24729e1d080bSHong Zhang   if (isNest) {
24739566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
24749566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24753ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24769e1d080bSHong Zhang   }
24779e1d080bSHong Zhang 
24789e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2479a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
24809566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
24819566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24823ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24831ad426b7SHong Zhang   }
24841ad426b7SHong Zhang 
24859566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
24869566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
24879566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
24889566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
24892a945128SHong Zhang 
24909566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
24919566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
249289898e50SHong Zhang 
249389898e50SHong Zhang   /* (1) Set matrix preallocation */
249489898e50SHong Zhang   /*------------------------------*/
24959566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
24969566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
24979566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
24989566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
24999566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
25009566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2501840c2264SHong Zhang 
250289898e50SHong Zhang   /* Set preallocation for edges */
250389898e50SHong Zhang   /*-----------------------------*/
25049566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2505840c2264SHong Zhang 
25069566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2507840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2508840c2264SHong Zhang     /* Get row indices */
25099566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
25109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2511840c2264SHong Zhang     if (nrows) {
2512840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2513840c2264SHong Zhang 
2514a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
25159566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2516840c2264SHong Zhang       for (v = 0; v < 2; v++) {
25179566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2518840c2264SHong Zhang 
25198675203cSHong Zhang         if (network->Je) {
2520840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
25218675203cSHong Zhang         } else Juser = NULL;
25229566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
25239566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2524840c2264SHong Zhang       }
2525840c2264SHong Zhang 
252689898e50SHong Zhang       /* Set preallocation for edge self */
2527840c2264SHong Zhang       cstart = rstart;
25288675203cSHong Zhang       if (network->Je) {
2529840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25308675203cSHong Zhang       } else Juser = NULL;
25319566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2532840c2264SHong Zhang     }
2533840c2264SHong Zhang   }
2534840c2264SHong Zhang 
253589898e50SHong Zhang   /* Set preallocation for vertices */
253689898e50SHong Zhang   /*--------------------------------*/
25379566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
25388675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2539840c2264SHong Zhang 
2540840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2541840c2264SHong Zhang     /* Get row indices */
25429566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25439566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2544840c2264SHong Zhang     if (!nrows) continue;
2545840c2264SHong Zhang 
25469566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2547bdcb62a2SHong Zhang     if (ghost) {
25489566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2549bdcb62a2SHong Zhang     } else {
2550bdcb62a2SHong Zhang       rows_v = rows;
2551bdcb62a2SHong Zhang     }
2552bdcb62a2SHong Zhang 
2553bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2554840c2264SHong Zhang 
2555840c2264SHong Zhang     /* Get supporting edges and connected vertices */
25569566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2557840c2264SHong Zhang 
2558840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2559840c2264SHong Zhang       /* Supporting edges */
25609566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25619566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2562840c2264SHong Zhang 
25638675203cSHong Zhang       if (network->Jv) {
2564840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25658675203cSHong Zhang       } else Juser = NULL;
25669566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2567840c2264SHong Zhang 
2568840c2264SHong Zhang       /* Connected vertices */
25699566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2570840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25719566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2572840c2264SHong Zhang 
25739566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2574840c2264SHong Zhang 
25758675203cSHong Zhang       if (network->Jv) {
2576840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25778675203cSHong Zhang       } else Juser = NULL;
2578e102a522SHong Zhang       if (ghost_vc || ghost) {
2579e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2580e102a522SHong Zhang       } else {
2581e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2582e102a522SHong Zhang       }
25839566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2584840c2264SHong Zhang     }
2585840c2264SHong Zhang 
258689898e50SHong Zhang     /* Set preallocation for vertex self */
25879566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2588840c2264SHong Zhang     if (!ghost) {
25899566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
25908675203cSHong Zhang       if (network->Jv) {
2591840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25928675203cSHong Zhang       } else Juser = NULL;
25939566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2594840c2264SHong Zhang     }
25951baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2596840c2264SHong Zhang   }
2597840c2264SHong Zhang 
25989566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
25999566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
26005cf7da58SHong Zhang 
26019566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
26025cf7da58SHong Zhang 
26039566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
26049566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2605840c2264SHong Zhang 
26069566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
26079566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2608840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2609e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2610e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2611840c2264SHong Zhang   }
26129566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
26139566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
26149566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
26159566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2616840c2264SHong Zhang 
26179566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
26189566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
26199566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
26205cf7da58SHong Zhang 
26219566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
26225cf7da58SHong Zhang 
262389898e50SHong Zhang   /* (2) Set matrix entries for edges */
262489898e50SHong Zhang   /*----------------------------------*/
26251ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2626bfbc38dcSHong Zhang     /* Get row indices */
26279566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
26289566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
26294b976069SHong Zhang     if (nrows) {
263017df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
26311ad426b7SHong Zhang 
2632a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
26339566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2634bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
26359566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
26369566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
26373e97b6e8SHong Zhang 
26388675203cSHong Zhang         if (network->Je) {
2639a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
26408675203cSHong Zhang         } else Juser = NULL;
26419566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2642bfbc38dcSHong Zhang       }
264317df6e9eSHong Zhang 
2644bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
26453e97b6e8SHong Zhang       cstart = rstart;
26468675203cSHong Zhang       if (network->Je) {
2647a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
26488675203cSHong Zhang       } else Juser = NULL;
26499566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
26501ad426b7SHong Zhang     }
26514b976069SHong Zhang   }
26521ad426b7SHong Zhang 
2653bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
265483b2e829SHong Zhang   /*---------------------------------*/
26551ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2656bfbc38dcSHong Zhang     /* Get row indices */
26579566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
26589566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
26594b976069SHong Zhang     if (!nrows) continue;
2660596e729fSHong Zhang 
26619566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2662bdcb62a2SHong Zhang     if (ghost) {
26639566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2664bdcb62a2SHong Zhang     } else {
2665bdcb62a2SHong Zhang       rows_v = rows;
2666bdcb62a2SHong Zhang     }
2667bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2668596e729fSHong Zhang 
2669bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
26709566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2671596e729fSHong Zhang 
2672596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2673bfbc38dcSHong Zhang       /* Supporting edges */
26749566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
26759566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2676596e729fSHong Zhang 
26778675203cSHong Zhang       if (network->Jv) {
2678a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
26798675203cSHong Zhang       } else Juser = NULL;
26809566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2681596e729fSHong Zhang 
2682bfbc38dcSHong Zhang       /* Connected vertices */
26839566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
26842a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
26852a945128SHong Zhang 
26869566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
26879566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2688a4e85ca8SHong Zhang 
26898675203cSHong Zhang       if (network->Jv) {
2690a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
26918675203cSHong Zhang       } else Juser = NULL;
26929566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2693596e729fSHong Zhang     }
2694596e729fSHong Zhang 
2695bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
26961ad426b7SHong Zhang     if (!ghost) {
26979566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
26988675203cSHong Zhang       if (network->Jv) {
2699a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
27008675203cSHong Zhang       } else Juser = NULL;
27019566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2702bdcb62a2SHong Zhang     }
27031baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
27041ad426b7SHong Zhang   }
27059566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2706bdcb62a2SHong Zhang 
27079566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
27089566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2709dd6f46cdSHong Zhang 
27109566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
27113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27125f2c45f1SShri Abhyankar }
27135f2c45f1SShri Abhyankar 
2714d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2715d71ae5a4SJacob Faibussowitsch {
2716daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2717daad07d3SAidan Hamilton   PetscInt    j, np;
2718daad07d3SAidan Hamilton 
2719daad07d3SAidan Hamilton   PetscFunctionBegin;
2720daad07d3SAidan Hamilton   if (network->header) {
2721daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2722daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2723daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2724daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2725daad07d3SAidan Hamilton     }
2726daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2727daad07d3SAidan Hamilton   }
27283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2729daad07d3SAidan Hamilton }
2730daad07d3SAidan Hamilton 
2731d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2732d71ae5a4SJacob Faibussowitsch {
27335f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2734aeb78aa7SBarry Smith   PetscInt    j;
27355f2c45f1SShri Abhyankar 
27365f2c45f1SShri Abhyankar   PetscFunctionBegin;
2737daad07d3SAidan Hamilton   /*
2738daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2739daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2740daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2741daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2742daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2743daad07d3SAidan Hamilton   */
2744daad07d3SAidan Hamilton 
2745daad07d3SAidan Hamilton   /* Always destroy data ON the network */
27469566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
274783b2e829SHong Zhang   if (network->Jv) {
27489566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
27499566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
27501ad426b7SHong Zhang   }
2751daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2752daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2753daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2754daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2755daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
275613c2a604SAdrian Maldonado 
2757daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2758daad07d3SAidan Hamilton 
2759daad07d3SAidan Hamilton   /*
2760daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2761daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2762daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2763daad07d3SAidan Hamilton     PetscSF                           sf;
2764daad07d3SAidan Hamilton   and data ON the network
2765daad07d3SAidan Hamilton     PetscSection                      DofSection;
2766daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2767daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2768daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2769daad07d3SAidan Hamilton   for any clone.
2770daad07d3SAidan Hamilton   */
27719566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
27729566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
27739566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
27749566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
277513c2a604SAdrian Maldonado   /* edge */
27769566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
27779566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
27789566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
27799566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2780daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2781daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2782daad07d3SAidan 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
2783daad07d3SAidan Hamilton      naively think it can be reused. */
2784daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2785daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2786daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2787daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2788eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(&network->cloneshared->svtable));
2789daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2790daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2791daad07d3SAidan Hamilton   }
2792daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
27933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27945f2c45f1SShri Abhyankar }
27955f2c45f1SShri Abhyankar 
2796d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2797d71ae5a4SJacob Faibussowitsch {
27985f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27995f2c45f1SShri Abhyankar 
28005f2c45f1SShri Abhyankar   PetscFunctionBegin;
28019566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
28023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28035f2c45f1SShri Abhyankar }
28045f2c45f1SShri Abhyankar 
2805d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2806d71ae5a4SJacob Faibussowitsch {
28075f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28085f2c45f1SShri Abhyankar 
28095f2c45f1SShri Abhyankar   PetscFunctionBegin;
28109566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
28113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28125f2c45f1SShri Abhyankar }
28135f2c45f1SShri Abhyankar 
2814d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2815d71ae5a4SJacob Faibussowitsch {
28165f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28175f2c45f1SShri Abhyankar 
28185f2c45f1SShri Abhyankar   PetscFunctionBegin;
28199566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
28203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28215f2c45f1SShri Abhyankar }
28225f2c45f1SShri Abhyankar 
2823d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2824d71ae5a4SJacob Faibussowitsch {
28255f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28265f2c45f1SShri Abhyankar 
28275f2c45f1SShri Abhyankar   PetscFunctionBegin;
28289566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
28293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28305f2c45f1SShri Abhyankar }
283122bbedd7SHong Zhang 
283222bbedd7SHong Zhang /*@
283364238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
283422bbedd7SHong Zhang 
283522bbedd7SHong Zhang   Not collective
283622bbedd7SHong Zhang 
28377a7aea1fSJed Brown   Input Parameters:
283822bbedd7SHong Zhang + dm - the dm object
283922bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
284022bbedd7SHong Zhang 
28417a7aea1fSJed Brown   Output Parameters:
2842f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
284322bbedd7SHong Zhang 
284497bb938eSShri Abhyankar   Level: advanced
284522bbedd7SHong Zhang 
2846db781477SPatrick Sanan .seealso: `DMNetworkSetVertexLocalToGlobalOrdering()`
284722bbedd7SHong Zhang @*/
2848d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2849d71ae5a4SJacob Faibussowitsch {
285022bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2851daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
285222bbedd7SHong Zhang 
285322bbedd7SHong Zhang   PetscFunctionBegin;
28545c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
285522bbedd7SHong Zhang   *vg = vltog[vloc];
28563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
285722bbedd7SHong Zhang }
285822bbedd7SHong Zhang 
285922bbedd7SHong Zhang /*@
286064238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
286122bbedd7SHong Zhang 
286222bbedd7SHong Zhang   Collective
286322bbedd7SHong Zhang 
286422bbedd7SHong Zhang   Input Parameters:
2865f0fc11ceSJed Brown . dm - the dm object
286622bbedd7SHong Zhang 
286797bb938eSShri Abhyankar   Level: advanced
286822bbedd7SHong Zhang 
2869db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalVertexIndex()`
287022bbedd7SHong Zhang @*/
2871d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2872d71ae5a4SJacob Faibussowitsch {
287322bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
287422bbedd7SHong Zhang   MPI_Comm           comm;
28752bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
287622bbedd7SHong Zhang   PetscBool          ghost;
287763029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
287822bbedd7SHong Zhang   const PetscSFNode *iremote;
287922bbedd7SHong Zhang   PetscSF            vsf;
288063029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
288163029d29SHong Zhang   VecScatter         ctx;
288263029d29SHong Zhang   PetscScalar       *varr, val;
288363029d29SHong Zhang   const PetscScalar *varr_read;
288422bbedd7SHong Zhang 
288522bbedd7SHong Zhang   PetscFunctionBegin;
28869566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
28879566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
28889566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
288922bbedd7SHong Zhang 
289022bbedd7SHong Zhang   if (size == 1) {
2891daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
28929566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
289322bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2894daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
28953ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
289622bbedd7SHong Zhang   }
289722bbedd7SHong Zhang 
2898daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2899daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
290022bbedd7SHong Zhang 
2901daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
29029566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
290322bbedd7SHong Zhang   vsf = network->vertex.sf;
290422bbedd7SHong Zhang 
29059566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
29069566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
290722bbedd7SHong Zhang 
29089371c9d4SSatish Balay   for (i = 0; i < size; i++) {
29099371c9d4SSatish Balay     displs[i]     = i;
29109371c9d4SSatish Balay     recvcounts[i] = 1;
29119371c9d4SSatish Balay   }
291222bbedd7SHong Zhang 
291322bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
291422bbedd7SHong Zhang   vrange[0] = 0;
29159566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
2916ad540459SPierre Jolivet   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
291722bbedd7SHong Zhang 
29189566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2919daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
292022bbedd7SHong Zhang 
292163029d29SHong Zhang   /* Set vltog for non-ghost vertices */
292263029d29SHong Zhang   k = 0;
292322bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2924daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
292563029d29SHong Zhang     if (ghost) continue;
292663029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
292722bbedd7SHong Zhang   }
29289566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
292963029d29SHong Zhang 
293063029d29SHong Zhang   /* Set vltog for ghost vertices */
293163029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
29329566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
29339566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
29349566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
29359566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
293663029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
293763029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
293863029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
293963029d29SHong Zhang   }
29409566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
294163029d29SHong Zhang 
294263029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
29439566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
29449566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
29459566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
294663029d29SHong Zhang 
294763029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
29489566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
29499566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
295063029d29SHong Zhang   for (i = 0; i < N; i += 2) {
29512e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
295263029d29SHong Zhang     if (remoterank == rank) {
295363029d29SHong Zhang       k    = i + 1; /* row number */
29542e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
295563029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
29569566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
295763029d29SHong Zhang     }
295863029d29SHong Zhang   }
29599566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
29609566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
29619566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
296263029d29SHong Zhang 
296363029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
29649566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
296563029d29SHong Zhang   k = 0;
296663029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2967daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
296863029d29SHong Zhang     if (!ghost) continue;
29699371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
29709371c9d4SSatish Balay     k++;
297163029d29SHong Zhang   }
29729566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
297363029d29SHong Zhang 
29749566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
29759566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
29769566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
29773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297822bbedd7SHong Zhang }
297942dc13f1SHong Zhang 
2980d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2981d71ae5a4SJacob Faibussowitsch {
298242dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
298342dc13f1SHong Zhang   DMNetworkComponentHeader header;
298442dc13f1SHong Zhang 
298542dc13f1SHong Zhang   PetscFunctionBegin;
29869566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
298742dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
298842dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
298942dc13f1SHong Zhang 
299042dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
299142dc13f1SHong Zhang     key  = header->key[i];
299242dc13f1SHong Zhang     nvar = header->nvar[i];
299342dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
299442dc13f1SHong Zhang       if (key == keys[j]) {
299542dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
299642dc13f1SHong Zhang           *nidx += nvar;
299742dc13f1SHong Zhang         } else {
299842dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
299942dc13f1SHong Zhang         }
300042dc13f1SHong Zhang       }
300142dc13f1SHong Zhang     }
300242dc13f1SHong Zhang   }
30033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
300442dc13f1SHong Zhang }
300542dc13f1SHong Zhang 
3006d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3007d71ae5a4SJacob Faibussowitsch {
300842dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
300942dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
301042dc13f1SHong Zhang   DMNetworkComponentHeader header;
301142dc13f1SHong Zhang 
301242dc13f1SHong Zhang   PetscFunctionBegin;
30139566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
301442dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
301542dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
301642dc13f1SHong Zhang 
301742dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
301842dc13f1SHong Zhang     key  = header->key[i];
301942dc13f1SHong Zhang     nvar = header->nvar[i];
302042dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
302142dc13f1SHong Zhang       if (key != keys[j]) continue;
302242dc13f1SHong Zhang 
30239566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
302442dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
302542dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
302642dc13f1SHong Zhang       } else {
302742dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
302842dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
302942dc13f1SHong Zhang         }
303042dc13f1SHong Zhang       }
303142dc13f1SHong Zhang     }
303242dc13f1SHong Zhang   }
30333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
303442dc13f1SHong Zhang }
303542dc13f1SHong Zhang 
303642dc13f1SHong Zhang /*@
303742dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
303842dc13f1SHong Zhang 
303942dc13f1SHong Zhang   Collective
304042dc13f1SHong Zhang 
304142dc13f1SHong Zhang   Input Parameters:
304242dc13f1SHong Zhang + dm - DMNetwork object
304342dc13f1SHong Zhang . numkeys - number of keys
304442dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
304542dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
304642dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
304742dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
304842dc13f1SHong Zhang 
304942dc13f1SHong Zhang   Output Parameters:
305042dc13f1SHong Zhang . is - the index set
305142dc13f1SHong Zhang 
305242dc13f1SHong Zhang   Level: Advanced
305342dc13f1SHong Zhang 
305442dc13f1SHong Zhang   Notes:
305542dc13f1SHong 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.
305642dc13f1SHong Zhang 
3057db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
305842dc13f1SHong Zhang @*/
3059d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3060d71ae5a4SJacob Faibussowitsch {
306142dc13f1SHong Zhang   MPI_Comm    comm;
306242dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
306342dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
306442dc13f1SHong Zhang   PetscBool   ghost;
306542dc13f1SHong Zhang 
306642dc13f1SHong Zhang   PetscFunctionBegin;
30679566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
306842dc13f1SHong Zhang 
306942dc13f1SHong Zhang   /* Check input parameters */
307042dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
307142dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
307263a3b9bcSJacob 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]);
307342dc13f1SHong Zhang   }
307442dc13f1SHong Zhang 
30759566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
30769566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
307742dc13f1SHong Zhang 
307842dc13f1SHong Zhang   /* Get local number of idx */
307942dc13f1SHong Zhang   nidx = 0;
308048a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
308142dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30829566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
308342dc13f1SHong Zhang     if (ghost) continue;
30849566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
308542dc13f1SHong Zhang   }
308642dc13f1SHong Zhang 
308742dc13f1SHong Zhang   /* Compute idx */
30889566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
308942dc13f1SHong Zhang   i = 0;
309048a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
309142dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30929566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
309342dc13f1SHong Zhang     if (ghost) continue;
30949566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
309542dc13f1SHong Zhang   }
309642dc13f1SHong Zhang 
309742dc13f1SHong Zhang   /* Create is */
30989566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
30999566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
310142dc13f1SHong Zhang }
310242dc13f1SHong Zhang 
3103d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3104d71ae5a4SJacob Faibussowitsch {
310542dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
310642dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
310742dc13f1SHong Zhang   DMNetworkComponentHeader header;
310842dc13f1SHong Zhang 
310942dc13f1SHong Zhang   PetscFunctionBegin;
31109566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
311142dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
311242dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
311342dc13f1SHong Zhang 
311442dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
311542dc13f1SHong Zhang     key  = header->key[i];
311642dc13f1SHong Zhang     nvar = header->nvar[i];
311742dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
311842dc13f1SHong Zhang       if (key != keys[j]) continue;
311942dc13f1SHong Zhang 
31209566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
312142dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
312242dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
312342dc13f1SHong Zhang       } else {
312442dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
312542dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
312642dc13f1SHong Zhang         }
312742dc13f1SHong Zhang       }
312842dc13f1SHong Zhang     }
312942dc13f1SHong Zhang   }
31303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
313142dc13f1SHong Zhang }
313242dc13f1SHong Zhang 
313342dc13f1SHong Zhang /*@
313442dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
313542dc13f1SHong Zhang 
313642dc13f1SHong Zhang   Not collective
313742dc13f1SHong Zhang 
313842dc13f1SHong Zhang   Input Parameters:
313942dc13f1SHong Zhang + dm - DMNetwork object
314042dc13f1SHong Zhang . numkeys - number of keys
314142dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
314242dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
314342dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
314442dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
314542dc13f1SHong Zhang 
314642dc13f1SHong Zhang   Output Parameters:
314742dc13f1SHong Zhang . is - the index set
314842dc13f1SHong Zhang 
314942dc13f1SHong Zhang   Level: Advanced
315042dc13f1SHong Zhang 
315142dc13f1SHong Zhang   Notes:
315242dc13f1SHong 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.
315342dc13f1SHong Zhang 
3154db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkCreateIS`, `ISCreateGeneral()`
315542dc13f1SHong Zhang @*/
3156d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3157d71ae5a4SJacob Faibussowitsch {
315842dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
315942dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
316042dc13f1SHong Zhang 
316142dc13f1SHong Zhang   PetscFunctionBegin;
316242dc13f1SHong Zhang   /* Check input parameters */
316342dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
316442dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
316563a3b9bcSJacob 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]);
316642dc13f1SHong Zhang   }
316742dc13f1SHong Zhang 
3168daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3169daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
317042dc13f1SHong Zhang 
317142dc13f1SHong Zhang   /* Get local number of idx */
317242dc13f1SHong Zhang   nidx = 0;
317348a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
317442dc13f1SHong Zhang 
317542dc13f1SHong Zhang   /* Compute local idx */
31769566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
317742dc13f1SHong Zhang   i = 0;
317848a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
317942dc13f1SHong Zhang 
318042dc13f1SHong Zhang   /* Create is */
31819566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31829566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
318442dc13f1SHong Zhang }
3185daad07d3SAidan Hamilton /*@
3186d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3187daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3188daad07d3SAidan Hamilton 
3189daad07d3SAidan Hamilton   Collective
3190daad07d3SAidan Hamilton 
3191daad07d3SAidan Hamilton   Input Parameters:
3192daad07d3SAidan Hamilton . dm - the dmnetwork object
3193daad07d3SAidan Hamilton 
3194daad07d3SAidan Hamilton   Level: beginner
3195daad07d3SAidan Hamilton 
3196daad07d3SAidan Hamilton .seealso: `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3197daad07d3SAidan Hamilton @*/
3198d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3199d71ae5a4SJacob Faibussowitsch {
3200daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3201daad07d3SAidan Hamilton 
3202daad07d3SAidan Hamilton   PetscFunctionBegin;
32033ba16761SJacob Faibussowitsch   if (network->componentsetup) PetscFunctionReturn(PETSC_SUCCESS);
3204daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3205daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3206daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3207daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3208daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
32093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3210daad07d3SAidan Hamilton }
3211