xref: /petsc/src/dm/impls/network/network.c (revision 5f25b2246b55a8c64bf69fee40a0d75b9b096a54)
1af0996ceSBarry Smith #include <petsc/private/dmnetworkimpl.h> /*I  "petscdmnetwork.h"  I*/
2*5f25b224SDuncan Campbell #include "petscis.h"
35f2c45f1SShri Abhyankar 
4e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_LayoutSetUp;
5e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_SetUpNetwork;
6e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_Distribute;
7e3b1a053SGetnet Betrie 
854dfd506SHong Zhang /*
954dfd506SHong Zhang   Creates the component header and value objects for a network point
1054dfd506SHong Zhang */
11d71ae5a4SJacob Faibussowitsch static PetscErrorCode SetUpNetworkHeaderComponentValue(DM dm, DMNetworkComponentHeader header, DMNetworkComponentValue cvalue)
12d71ae5a4SJacob Faibussowitsch {
1354dfd506SHong Zhang   PetscFunctionBegin;
1454dfd506SHong Zhang   /* Allocate arrays for component information */
159566063dSJacob Faibussowitsch   PetscCall(PetscCalloc5(header->maxcomps, &header->size, header->maxcomps, &header->key, header->maxcomps, &header->offset, header->maxcomps, &header->nvar, header->maxcomps, &header->offsetvarrel));
169566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(header->maxcomps, &cvalue->data));
1754dfd506SHong Zhang 
1854dfd506SHong 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.
1954dfd506SHong Zhang    If the data header struct changes then this header size calculation needs to be updated. */
2054dfd506SHong Zhang   header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
2154dfd506SHong Zhang   header->hsize /= sizeof(DMNetworkComponentGenericDataType);
223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2354dfd506SHong Zhang }
2454dfd506SHong Zhang 
25d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeHeaderComponentData(DM dm)
26d71ae5a4SJacob Faibussowitsch {
27daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
28daad07d3SAidan Hamilton   PetscInt    np, p, defaultnumcomp = DMNETWORK_MAX_COMP_AT_POINT_DEFAULT;
29daad07d3SAidan Hamilton 
30daad07d3SAidan Hamilton   PetscFunctionBegin;
31daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
32daad07d3SAidan Hamilton   if (network->header)
33daad07d3SAidan Hamilton     for (p = 0; p < np; p++) {
34daad07d3SAidan Hamilton       network->header[p].maxcomps = defaultnumcomp;
35daad07d3SAidan Hamilton       PetscCall(SetUpNetworkHeaderComponentValue(dm, &network->header[p], &network->cvalue[p]));
36daad07d3SAidan Hamilton     }
37daad07d3SAidan Hamilton 
383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
39daad07d3SAidan Hamilton }
40*5f25b224SDuncan Campbell 
415f2c45f1SShri Abhyankar /*@
4220f4b53cSBarry Smith   DMNetworkGetPlex - Gets the `DMPLEX` associated with this `DMNETWORK`
43556ed216SShri Abhyankar 
4420f4b53cSBarry Smith   Not Collective
45556ed216SShri Abhyankar 
462fe279fdSBarry Smith   Input Parameter:
4720f4b53cSBarry Smith . dm - the `DMNETWORK` object
482bf73ac6SHong Zhang 
492fe279fdSBarry Smith   Output Parameter:
5020f4b53cSBarry Smith . plexdm - the `DMPLEX` object
51556ed216SShri Abhyankar 
5220f4b53cSBarry Smith   Level: advanced
53556ed216SShri Abhyankar 
5420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMPLEX`, `DMNetworkCreate()`
55556ed216SShri Abhyankar @*/
56d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetPlex(DM dm, DM *plexdm)
57d71ae5a4SJacob Faibussowitsch {
582bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
59556ed216SShri Abhyankar 
60556ed216SShri Abhyankar   PetscFunctionBegin;
61556ed216SShri Abhyankar   *plexdm = network->plex;
623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
63556ed216SShri Abhyankar }
64556ed216SShri Abhyankar 
65556ed216SShri Abhyankar /*@
662bf73ac6SHong Zhang   DMNetworkGetNumSubNetworks - Gets the the number of subnetworks
6772c3e9f7SHong Zhang 
6820f4b53cSBarry Smith   Not Collective
6972c3e9f7SHong Zhang 
70f899ff85SJose E. Roman   Input Parameter:
7120f4b53cSBarry Smith . dm - the `DMNETWORK` object
722bf73ac6SHong Zhang 
732bf73ac6SHong Zhang   Output Parameters:
742bf73ac6SHong Zhang + nsubnet - local number of subnetworks
752bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
7672c3e9f7SHong Zhang 
7797bb938eSShri Abhyankar   Level: beginner
7872c3e9f7SHong Zhang 
7920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
8072c3e9f7SHong Zhang @*/
81d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PetscInt *nsubnet, PetscInt *Nsubnet)
82d71ae5a4SJacob Faibussowitsch {
832bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8472c3e9f7SHong Zhang 
8572c3e9f7SHong Zhang   PetscFunctionBegin;
86daad07d3SAidan Hamilton   if (nsubnet) *nsubnet = network->cloneshared->nsubnet;
87daad07d3SAidan Hamilton   if (Nsubnet) *Nsubnet = network->cloneshared->Nsubnet;
883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8972c3e9f7SHong Zhang }
9072c3e9f7SHong Zhang 
9172c3e9f7SHong Zhang /*@
922bf73ac6SHong Zhang   DMNetworkSetNumSubNetworks - Sets the number of subnetworks
935f2c45f1SShri Abhyankar 
9420f4b53cSBarry Smith   Collective
955f2c45f1SShri Abhyankar 
965f2c45f1SShri Abhyankar   Input Parameters:
9720f4b53cSBarry Smith + dm - the `DMNETWORK` object
982bf73ac6SHong Zhang . nsubnet - local number of subnetworks
992bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
1005f2c45f1SShri Abhyankar 
10197bb938eSShri Abhyankar    Level: beginner
1021b266c99SBarry Smith 
10320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetNumSubNetworks()`
1045f2c45f1SShri Abhyankar @*/
105d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetNumSubNetworks(DM dm, PetscInt nsubnet, PetscInt Nsubnet)
106d71ae5a4SJacob Faibussowitsch {
1075f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1085f2c45f1SShri Abhyankar 
1095f2c45f1SShri Abhyankar   PetscFunctionBegin;
110d5b43468SJose E. Roman   PetscCheck(network->cloneshared->Nsubnet == 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Network sizes already set, cannot resize the network");
1112bf73ac6SHong Zhang 
1125f2c45f1SShri Abhyankar   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1132bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, nsubnet, 2);
1142bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, Nsubnet, 3);
1157765340cSHong Zhang 
1162bf73ac6SHong Zhang   if (Nsubnet == PETSC_DECIDE) {
1175c6496baSHong Zhang     PetscCheck(nsubnet >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Number of local subnetworks %" PetscInt_FMT " cannot be less than 0", nsubnet);
1181c2dc1cbSBarry Smith     PetscCall(MPIU_Allreduce(&nsubnet, &Nsubnet, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
119caf410d2SHong Zhang   }
1205c6496baSHong Zhang   PetscCheck(Nsubnet >= 1, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Number of global subnetworks %" PetscInt_FMT " cannot be less than 1", Nsubnet);
121caf410d2SHong Zhang 
122daad07d3SAidan Hamilton   network->cloneshared->Nsubnet = Nsubnet;
123da81f932SPierre Jolivet   network->cloneshared->nsubnet = 0; /* initial value; will be determined by DMNetworkAddSubnetwork() */
124daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(Nsubnet, &network->cloneshared->subnet));
125caf410d2SHong Zhang 
1262bf73ac6SHong Zhang   /* num of shared vertices */
127daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0;
128daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = 0;
1293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1307765340cSHong Zhang }
1317765340cSHong Zhang 
1325f2c45f1SShri Abhyankar /*@
1332bf73ac6SHong Zhang   DMNetworkAddSubnetwork - Add a subnetwork
1345f2c45f1SShri Abhyankar 
13520f4b53cSBarry Smith   Collective
1365f2c45f1SShri Abhyankar 
1375f2c45f1SShri Abhyankar   Input Parameters:
13820f4b53cSBarry Smith + dm - the `DMNETWORK`  object
1392bf73ac6SHong Zhang . name - name of the subnetwork
1402bf73ac6SHong Zhang . ne - number of local edges of this subnetwork
14120f4b53cSBarry 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
14220f4b53cSBarry Smith               of the vertices) of each edge,
1438d1cd658SBarry Smith $            [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc]
1442bf73ac6SHong Zhang 
1452fe279fdSBarry Smith   Output Parameter:
1462bf73ac6SHong Zhang . netnum - global index of the subnetwork
1475f2c45f1SShri Abhyankar 
14820f4b53cSBarry Smith   Level: beginner
14920f4b53cSBarry Smith 
1505f2c45f1SShri Abhyankar   Notes:
1515f2c45f1SShri Abhyankar   There is no copy involved in this operation, only the pointer is referenced. The edgelist should
15220f4b53cSBarry Smith   not be destroyed before the call to `DMNetworkLayoutSetUp()`
1535f2c45f1SShri Abhyankar 
15420f4b53cSBarry 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.
15520f4b53cSBarry Smith   For a multiple subnetworks,
1568d1cd658SBarry 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.
157f11a936eSBarry Smith 
158e3e68989SHong Zhang   Example usage:
159f11a936eSBarry Smith   Consider the following networks:
160d5b43468SJose E. Roman   1) A single subnetwork:
161e3e68989SHong Zhang .vb
162f11a936eSBarry Smith  network 0:
163f11a936eSBarry Smith  rank[0]:
164f11a936eSBarry Smith    v0 --> v2; v1 --> v2
165f11a936eSBarry Smith  rank[1]:
166f11a936eSBarry Smith    v3 --> v5; v4 --> v5
167e3e68989SHong Zhang .ve
168e3e68989SHong Zhang 
169e3e68989SHong Zhang  The resulting input
170f11a936eSBarry Smith  network 0:
171f11a936eSBarry Smith  rank[0]:
172f11a936eSBarry Smith    ne = 2
173f11a936eSBarry Smith    edgelist = [0 2 | 1 2]
174f11a936eSBarry Smith  rank[1]:
175f11a936eSBarry Smith    ne = 2
176f11a936eSBarry Smith    edgelist = [3 5 | 4 5]
177f11a936eSBarry Smith 
178f11a936eSBarry Smith   2) Two subnetworks:
179f11a936eSBarry Smith .vb
180f11a936eSBarry Smith  subnetwork 0:
181f11a936eSBarry Smith  rank[0]:
182f11a936eSBarry Smith    v0 --> v2; v2 --> v1; v1 --> v3;
183f11a936eSBarry Smith  subnetwork 1:
184f11a936eSBarry Smith  rank[1]:
185f11a936eSBarry Smith    v0 --> v3; v3 --> v2; v2 --> v1;
186f11a936eSBarry Smith .ve
187f11a936eSBarry Smith 
188f11a936eSBarry Smith  The resulting input
189f11a936eSBarry Smith  subnetwork 0:
190f11a936eSBarry Smith  rank[0]:
191f11a936eSBarry Smith    ne = 3
192f11a936eSBarry Smith    edgelist = [0 2 | 2 1 | 1 3]
193f11a936eSBarry Smith  rank[1]:
194f11a936eSBarry Smith    ne = 0
195f11a936eSBarry Smith    edgelist = NULL
196f11a936eSBarry Smith 
197f11a936eSBarry Smith  subnetwork 1:
198f11a936eSBarry Smith  rank[0]:
199f11a936eSBarry Smith    ne = 0
200f11a936eSBarry Smith    edgelist = NULL
201f11a936eSBarry Smith  rank[1]:
202f11a936eSBarry Smith    edgelist = [0 3 | 3 2 | 2 1]
203e3e68989SHong Zhang 
20420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
2055f2c45f1SShri Abhyankar @*/
206d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum)
207d71ae5a4SJacob Faibussowitsch {
2085f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2095c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
210f11a936eSBarry Smith   PetscBT     table;
2115f2c45f1SShri Abhyankar 
2125f2c45f1SShri Abhyankar   PetscFunctionBegin;
213ad540459SPierre 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]);
214f11a936eSBarry Smith 
2155c6496baSHong Zhang   i = 0;
2165c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2175c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2185c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2195c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2205c6496baSHong Zhang     i++;
2215c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2225c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2235c6496baSHong Zhang     i++;
2245c6496baSHong Zhang   }
2255c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2265c6496baSHong Zhang 
2275c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2289566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2299566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
230f11a936eSBarry Smith   i = 0;
231f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2329566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2339566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
234f11a936eSBarry Smith   }
235f11a936eSBarry Smith   nvtx = 0;
236f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
237f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
238f11a936eSBarry Smith   }
2395c6496baSHong Zhang 
2405c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
2411c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2425c6496baSHong Zhang   Nvtx++;
2439566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
244f11a936eSBarry Smith 
245f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
2461c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
247f11a936eSBarry Smith 
248daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
249c6a7a370SJeremy L Thompson   if (name) PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
250daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
251daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
252daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
253daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
254daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2552bf73ac6SHong Zhang 
2562bf73ac6SHong Zhang   /* ----------------------------------------------------------
2572bf73ac6SHong Zhang    p=v or e;
2582bf73ac6SHong Zhang    subnet[0].pStart   = 0
2592bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2602bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2612bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
262daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
263daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2642bf73ac6SHong Zhang 
265daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
266daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2672bf73ac6SHong Zhang 
2682bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
269daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
270daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
271daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
272daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2732bf73ac6SHong Zhang 
274c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(network->cloneshared->subnet[i].name, name, sizeof(network->cloneshared->subnet[i].name)));
275daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
276daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2782bf73ac6SHong Zhang }
2792bf73ac6SHong Zhang 
2805c6496baSHong Zhang /*@C
2815c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2822bf73ac6SHong Zhang 
28320f4b53cSBarry Smith   Not Collective
2845c6496baSHong Zhang 
2855c6496baSHong Zhang   Input Parameters:
28620f4b53cSBarry Smith + dm - the `DM` object
2875c6496baSHong Zhang - v - vertex point
2885c6496baSHong Zhang 
2895c6496baSHong Zhang   Output Parameters:
2905c6496baSHong Zhang + gidx - global number of this shared vertex in the internal dmplex
2915c6496baSHong Zhang . n - number of subnetworks that share this vertex
2925c6496baSHong Zhang - sv - array of size n: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1
2935c6496baSHong Zhang 
2945c6496baSHong Zhang   Level: intermediate
2955c6496baSHong Zhang 
29620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSharedVertices()`
2975c6496baSHong Zhang @*/
298d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PetscInt *gidx, PetscInt *n, const PetscInt **sv)
299d71ae5a4SJacob Faibussowitsch {
3005c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
301daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
3025c6496baSHong Zhang   PetscInt    i, gidx_tmp;
3035c6496baSHong Zhang 
3045c6496baSHong Zhang   PetscFunctionBegin;
3059566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
306eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, gidx_tmp + 1, 0, &i));
3075c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
3085c6496baSHong Zhang 
3095c6496baSHong Zhang   i--;
3105c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3115c6496baSHong Zhang   if (n) *n = svtx[i].n;
3125c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3145c6496baSHong Zhang }
3155c6496baSHong Zhang 
3165c6496baSHong Zhang /*
3175c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3185c6496baSHong Zhang 
3195c6496baSHong Zhang   Input Parameters:
3205c6496baSHong Zhang + Nsvtx - global num of shared vertices
3215c6496baSHong Zhang . svtx - array of shared vertices (global)
3225c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3235c6496baSHong Zhang 
3245c6496baSHong Zhang   Output Parameters:
3255c6496baSHong Zhang + gidx - global index of (net,idx)
3265c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3275c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3285c6496baSHong Zhang */
329d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx)
330d71ae5a4SJacob Faibussowitsch {
3315c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3322bf73ac6SHong Zhang   SVtxType vtype;
3332bf73ac6SHong Zhang 
3342bf73ac6SHong Zhang   PetscFunctionBegin;
3353ba16761SJacob Faibussowitsch   if (!Nsvtx) PetscFunctionReturn(PETSC_SUCCESS);
3362bf73ac6SHong Zhang 
3375c6496baSHong Zhang   g_idx = -1;
3382bf73ac6SHong Zhang   vtype = SVNONE;
3395c6496baSHong Zhang 
3402bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3412bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3425c6496baSHong Zhang       g_idx = svtx[i].gidx;
3432bf73ac6SHong Zhang       vtype = SVFROM;
3442bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3452bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3462bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3472bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3482bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3495c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3502bf73ac6SHong Zhang           vtype = SVTO;
3512bf73ac6SHong Zhang         }
3522bf73ac6SHong Zhang       }
3532bf73ac6SHong Zhang     }
3542bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3552bf73ac6SHong Zhang   }
3565c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3572bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3582bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3602bf73ac6SHong Zhang }
3612bf73ac6SHong Zhang 
3622bf73ac6SHong Zhang /*
3635c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3645c6496baSHong Zhang 
3655c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3665c6496baSHong Zhang   Output: svta, tdata, ta2sv
3672bf73ac6SHong Zhang */
368eec179cfSJacob Faibussowitsch static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscHMapI svta, PetscInt *tdata, PetscInt *ta2sv)
369d71ae5a4SJacob Faibussowitsch {
3705c6496baSHong Zhang   PetscInt net, idx, gidx;
3712bf73ac6SHong Zhang 
3722bf73ac6SHong Zhang   PetscFunctionBegin;
3735c6496baSHong Zhang   net  = sedgelist[k];
3745c6496baSHong Zhang   idx  = sedgelist[k + 1];
375daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
376c76ffc5fSJacob Faibussowitsch   PetscCall(PetscHMapISet(svta, gidx + 1, *tdata + 1));
3775c6496baSHong Zhang 
3785c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3795c6496baSHong Zhang   (*tdata)++;
3803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3812bf73ac6SHong Zhang }
3822bf73ac6SHong Zhang 
3832bf73ac6SHong Zhang /*
3845c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3852bf73ac6SHong Zhang 
3862bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3872bf73ac6SHong Zhang 
3882bf73ac6SHong Zhang   Note: Output svtx is organized as
3892bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3902bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3912bf73ac6SHong Zhang                           ...
3922bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3932bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
3942bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
3952bf73ac6SHong Zhang  */
396d71ae5a4SJacob Faibussowitsch static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist)
397d71ae5a4SJacob Faibussowitsch {
3985c6496baSHong Zhang   SVtx         *svtx = NULL;
3992bf73ac6SHong Zhang   PetscInt     *sv, k, j, nsv, *tdata, **ta2sv;
400eec179cfSJacob Faibussowitsch   PetscHMapI   *svtas;
4017340ca2cSHong Zhang   PetscInt      gidx, net, idx, i, nta, ita, idx_from, idx_to, n, *net_tmp, *idx_tmp, *gidx_tmp;
4022bf73ac6SHong Zhang   DM_Network   *network = (DM_Network *)dm->data;
403eec179cfSJacob Faibussowitsch   PetscHashIter ppos;
4042bf73ac6SHong Zhang 
4052bf73ac6SHong Zhang   PetscFunctionBegin;
4065c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
4079566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
4082bf73ac6SHong Zhang 
4092bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
4107340ca2cSHong Zhang   nta = 0; /* num of svta tables created = num of groups of shared vertices */
4112bf73ac6SHong Zhang 
4122bf73ac6SHong Zhang   /* for j=0 */
413eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4149566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4152bf73ac6SHong Zhang 
4169566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4179566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4189371c9d4SSatish Balay   nta++;
4199371c9d4SSatish Balay   k += 4;
4202bf73ac6SHong Zhang 
4215c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4222bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4232bf73ac6SHong Zhang       /* vfrom */
4249371c9d4SSatish Balay       net  = sedgelist[k];
4259371c9d4SSatish Balay       idx  = sedgelist[k + 1];
426daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
427eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_from));
4282bf73ac6SHong Zhang 
4292bf73ac6SHong Zhang       /* vto */
4309371c9d4SSatish Balay       net  = sedgelist[k + 2];
4319371c9d4SSatish Balay       idx  = sedgelist[k + 3];
432daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
433eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapIGetWithDefault(svtas[ita], gidx + 1, 0, &idx_to));
4342bf73ac6SHong Zhang 
4352bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4369371c9d4SSatish Balay         idx_from--;
4379371c9d4SSatish Balay         idx_to--;
4382bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4399566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4402bf73ac6SHong Zhang           break;
4412bf73ac6SHong Zhang         } else if (idx_to < 0) {
4429566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4432bf73ac6SHong Zhang           break;
4442bf73ac6SHong Zhang         }
4452bf73ac6SHong Zhang       }
4462bf73ac6SHong Zhang     }
4472bf73ac6SHong Zhang 
4482bf73ac6SHong Zhang     if (ita == nta) {
449eec179cfSJacob Faibussowitsch       PetscCall(PetscHMapICreateWithSize(2 * Nsedgelist, svtas + nta));
4509566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4512bf73ac6SHong Zhang 
4529566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4539566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4542bf73ac6SHong Zhang       nta++;
4552bf73ac6SHong Zhang     }
4562bf73ac6SHong Zhang     k += 4;
4572bf73ac6SHong Zhang   }
4582bf73ac6SHong Zhang 
4596aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
460eec179cfSJacob Faibussowitsch   PetscCall(PetscHMapICreateWithSize(nta, &network->cloneshared->svtable));
4615c6496baSHong Zhang 
4625c6496baSHong Zhang   /* (3) Construct svtx from svtas
4637340ca2cSHong Zhang    svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1. */
4649566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4652bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4664f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
467eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetSize(svtas[nsv], &n));
4689566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4697340ca2cSHong Zhang     PetscCall(PetscMalloc3(n, &gidx_tmp, n, &net_tmp, n, &idx_tmp));
4705c6496baSHong Zhang     svtx[nsv].sv   = sv;
4715c6496baSHong Zhang     svtx[nsv].n    = n;
472daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4732bf73ac6SHong Zhang 
474eec179cfSJacob Faibussowitsch     PetscHashIterBegin(svtas[nsv], ppos);
4754f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
476eec179cfSJacob Faibussowitsch       PetscHashIterGetKey(svtas[nsv], ppos, gidx);
477eec179cfSJacob Faibussowitsch       PetscHashIterGetVal(svtas[nsv], ppos, i);
478eec179cfSJacob Faibussowitsch       PetscHashIterNext(svtas[nsv], ppos);
4799371c9d4SSatish Balay       gidx--;
4809371c9d4SSatish Balay       i--;
4815c6496baSHong Zhang       j           = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4827340ca2cSHong Zhang       net_tmp[k]  = sedgelist[j];     /* subnet number */
4837340ca2cSHong Zhang       idx_tmp[k]  = sedgelist[j + 1]; /* index on the subnet */
4847340ca2cSHong Zhang       gidx_tmp[k] = gidx;             /* gidx in un-merged dmnetwork */
4852bf73ac6SHong Zhang     }
4865c6496baSHong Zhang 
4877340ca2cSHong Zhang     /* current implementation requires sv[]=[net,idx] in ascending order of its gidx in un-merged dmnetwork */
4887340ca2cSHong Zhang     PetscCall(PetscSortIntWithArrayPair(n, gidx_tmp, net_tmp, idx_tmp));
4897340ca2cSHong Zhang     svtx[nsv].gidx = gidx_tmp[0]; /* = min(gidx) */
4907340ca2cSHong Zhang     for (k = 0; k < n; k++) {
4917340ca2cSHong Zhang       sv[2 * k]     = net_tmp[k];
4927340ca2cSHong Zhang       sv[2 * k + 1] = idx_tmp[k];
4937340ca2cSHong Zhang     }
4947340ca2cSHong Zhang     PetscCall(PetscFree3(gidx_tmp, net_tmp, idx_tmp));
4957340ca2cSHong Zhang 
4966aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
497c76ffc5fSJacob Faibussowitsch     PetscCall(PetscHMapISet(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1));
4982bf73ac6SHong Zhang   }
4992bf73ac6SHong Zhang 
5002bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
501eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(svtas + j));
5029566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
5032bf73ac6SHong Zhang   }
5049566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
5052bf73ac6SHong Zhang 
506daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
507daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
5083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5092bf73ac6SHong Zhang }
5102bf73ac6SHong Zhang 
5115c6496baSHong Zhang /*
5125c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
5135c6496baSHong Zhang 
5145c6496baSHong Zhang   Input Parameters:
5155c6496baSHong Zhang . dm - the dmnetwork object
5165c6496baSHong Zhang 
5175c6496baSHong Zhang    Output Parameters:
5185c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
5195c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
5205c6496baSHong Zhang */
521d71ae5a4SJacob Faibussowitsch static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr)
522d71ae5a4SJacob Faibussowitsch {
5232bf73ac6SHong Zhang   MPI_Comm    comm;
5242bf73ac6SHong Zhang   PetscMPIInt size, rank, *recvcounts = NULL, *displs = NULL;
525eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
526eac198afSGetnet   PetscInt    i, j, ctr, np;
527daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
528daad07d3SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist;
5295c6496baSHong Zhang   PetscInt    net, idx, gidx, nmerged, *vrange, gidx_from, net_from, sv_idx;
5302bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5315c6496baSHong Zhang   SVtx       *svtx;
5322bf73ac6SHong Zhang 
5332bf73ac6SHong Zhang   PetscFunctionBegin;
5349566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5359566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5369566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5372bf73ac6SHong Zhang 
5385c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5395c6496baSHong Zhang   /* --------------------------------------- */
540daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
541daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
542daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5432bf73ac6SHong Zhang 
544d5b43468SJose E. Roman   /* (2) Merge shared vto vertices to their vfrom vertex with same global vertex index (gidx) */
5455c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5462bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
547daad07d3SAidan Hamilton   PetscCall(PetscMalloc4(size + 1, &vrange, size, &displs, size, &recvcounts, network->cloneshared->nVertices, &vidxlTog));
5489371c9d4SSatish Balay   for (i = 0; i < size; i++) {
5499371c9d4SSatish Balay     displs[i]     = i;
5509371c9d4SSatish Balay     recvcounts[i] = 1;
5519371c9d4SSatish Balay   }
5522bf73ac6SHong Zhang 
5532bf73ac6SHong Zhang   vrange[0] = 0;
554daad07d3SAidan Hamilton   PetscCallMPI(MPI_Allgatherv(&network->cloneshared->nVertices, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
5555c6496baSHong Zhang   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
5562bf73ac6SHong Zhang 
5572bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5589371c9d4SSatish Balay   i                           = 0;
5599371c9d4SSatish Balay   gidx                        = 0;
5602bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
561daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5622bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
563daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5649566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5652bf73ac6SHong Zhang       if (svtype == SVTO) {
566daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5675c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
568daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5695c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
570daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5712bf73ac6SHong Zhang           }
5725c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5735c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5742bf73ac6SHong Zhang         }
5752bf73ac6SHong Zhang       } else {
576daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5775c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
578daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5792bf73ac6SHong Zhang         }
580daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5812bf73ac6SHong Zhang         gidx++;
5822bf73ac6SHong Zhang       }
5832bf73ac6SHong Zhang     }
5842bf73ac6SHong Zhang   }
5852bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
586daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5872bf73ac6SHong Zhang #endif
5882bf73ac6SHong Zhang 
5895c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
590712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
591daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5922bf73ac6SHong Zhang 
5932bf73ac6SHong Zhang   ctr = 0;
5942bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
595daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5962bf73ac6SHong Zhang       /* vfrom: */
597daad07d3SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5982bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5992bf73ac6SHong Zhang 
6002bf73ac6SHong Zhang       /* vto */
601daad07d3SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
6022bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
6032bf73ac6SHong Zhang       ctr++;
6042bf73ac6SHong Zhang     }
6052bf73ac6SHong Zhang   }
6069566063dSJacob Faibussowitsch   PetscCall(PetscFree4(vrange, displs, recvcounts, vidxlTog));
6079566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
6082bf73ac6SHong Zhang 
609eac198afSGetnet   *nmerged_ptr = nmerged;
6103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6115f2c45f1SShri Abhyankar }
6125f2c45f1SShri Abhyankar 
613d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
614d71ae5a4SJacob Faibussowitsch {
615daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
616daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
617daad07d3SAidan Hamilton   MPI_Comm    comm;
618daad07d3SAidan Hamilton 
619daad07d3SAidan Hamilton   PetscFunctionBegin;
620daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
621daad07d3SAidan Hamilton 
622daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
623daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
624daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
625daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
626daad07d3SAidan Hamilton 
627daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
628daad07d3SAidan Hamilton 
629daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
630daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
631daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
632daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
633daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
634daad07d3SAidan Hamilton   }
6353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
636daad07d3SAidan Hamilton }
637daad07d3SAidan Hamilton 
6385f2c45f1SShri Abhyankar /*@
6395f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6405f2c45f1SShri Abhyankar 
641eac198afSGetnet   Not Collective
6425f2c45f1SShri Abhyankar 
6432fe279fdSBarry Smith   Input Parameter:
64420f4b53cSBarry Smith . dm - the `DMNETWORK` object
64520f4b53cSBarry Smith 
64620f4b53cSBarry Smith   Level: beginner
6475f2c45f1SShri Abhyankar 
6485f2c45f1SShri Abhyankar   Notes:
6495f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6505f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6515f2c45f1SShri Abhyankar 
6525f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6535f2c45f1SShri Abhyankar 
65420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6555f2c45f1SShri Abhyankar @*/
656d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
657d71ae5a4SJacob Faibussowitsch {
6585f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
659daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
660caf410d2SHong Zhang   const PetscInt *cone;
661caf410d2SHong Zhang   MPI_Comm        comm;
6625503a911SAidan Hamilton   PetscMPIInt     size;
663eac198afSGetnet   PetscSection    sectiong;
6645c6496baSHong Zhang   PetscInt        nmerged = 0;
6656500d4abSHong Zhang 
6666500d4abSHong Zhang   PetscFunctionBegin;
667e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
668daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6692bf73ac6SHong Zhang 
670eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
671eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6729371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6739371c9d4SSatish 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,
6749371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
675eac198afSGetnet   }
676eac198afSGetnet 
6779566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6783ba16761SJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6796500d4abSHong Zhang 
680f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
681daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
682eac198afSGetnet 
683daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6849566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
685eac198afSGetnet   } else { /* subnetworks are not coupled */
6866aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
687eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapICreate(&network->cloneshared->svtable));
688caf410d2SHong Zhang     ctr = 0;
6892bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
690daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
691daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
692daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6936500d4abSHong Zhang         ctr++;
6946500d4abSHong Zhang       }
6956500d4abSHong Zhang     }
696eac198afSGetnet   }
6977765340cSHong Zhang 
6982bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6999566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
7009566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
7019566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
702eac198afSGetnet 
703daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
704daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
7056500d4abSHong Zhang 
706daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
707daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
708daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
709daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
7109566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
711caf410d2SHong Zhang 
712f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
713f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
714f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
715f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
716f11a936eSBarry Smith   */
717daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
718daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
719daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7205c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
721daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
722daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
723f11a936eSBarry Smith 
724daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
725daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7266500d4abSHong Zhang   }
727daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
728caf410d2SHong Zhang 
729caf410d2SHong Zhang   /* Get edge ownership */
730daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7315503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7325503a911SAidan Hamilton   globaledgeoff -= np;
733caf410d2SHong Zhang 
734eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7352bf73ac6SHong Zhang   e = 0;
7362bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
737f11a936eSBarry Smith     ctr = 0;
738daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7392bf73ac6SHong Zhang       /* edge e */
7405503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7412bf73ac6SHong Zhang       network->header[e].subnetid              = i;
742daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7432bf73ac6SHong Zhang 
7442bf73ac6SHong Zhang       /* connected vertices */
7459566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7462bf73ac6SHong Zhang 
7472bf73ac6SHong Zhang       /* vertex cone[0] */
748f11a936eSBarry Smith       v                           = cone[0];
749f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
750f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
751f11a936eSBarry Smith       if (Nsubnet == 1) {
752daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
753f11a936eSBarry Smith       } else {
754daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
755daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
756f11a936eSBarry Smith       }
7572bf73ac6SHong Zhang 
7582bf73ac6SHong Zhang       /* vertex cone[1] */
759f11a936eSBarry Smith       v                           = cone[1];
760f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
761f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
762f11a936eSBarry Smith       if (Nsubnet == 1) {
763daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
764f11a936eSBarry Smith       } else {
765daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
766daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
767f11a936eSBarry Smith       }
7682bf73ac6SHong Zhang 
7699371c9d4SSatish Balay       e++;
7709371c9d4SSatish Balay       ctr++;
7716500d4abSHong Zhang     }
7726500d4abSHong Zhang   }
7735503a911SAidan Hamilton   PetscCall(PetscFree(edges));
774caf410d2SHong Zhang 
775eac198afSGetnet   /* Set local vertex array for the subnetworks */
776eac198afSGetnet   j = 0;
777daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
778eac198afSGetnet     /* local shared vertex */
779eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(network->cloneshared->svtable, network->header[v].index + 1, 0, &i));
780daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7816500d4abSHong Zhang   }
782eac198afSGetnet 
783eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
784eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7859566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
786daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
787daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
788e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7905f2c45f1SShri Abhyankar }
7915f2c45f1SShri Abhyankar 
79294ef8ddeSSatish Balay /*@C
7932bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7942bf73ac6SHong Zhang 
79520f4b53cSBarry Smith   Not Collective
7962727e31bSShri Abhyankar 
7977a7aea1fSJed Brown   Input Parameters:
79820f4b53cSBarry Smith + dm - the `DMNETWORK` object
7992bf73ac6SHong Zhang - netnum - the global index of the subnetwork
8002727e31bSShri Abhyankar 
8017a7aea1fSJed Brown   Output Parameters:
8022727e31bSShri Abhyankar + nv - number of vertices (local)
8032727e31bSShri Abhyankar . ne - number of edges (local)
8042bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
8052bf73ac6SHong Zhang - edge - local edges of the subnetwork
8062727e31bSShri Abhyankar 
80706dd6b0eSSatish Balay   Level: intermediate
80806dd6b0eSSatish Balay 
80920f4b53cSBarry Smith   Notes:
81020f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
81120f4b53cSBarry Smith 
81220f4b53cSBarry Smith   The local vertices returned on each rank are determined by `DMNETWORK`. The user does not have any control over what vertices are local.
81320f4b53cSBarry Smith 
81420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8152727e31bSShri Abhyankar @*/
816d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge)
817d71ae5a4SJacob Faibussowitsch {
818caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8192727e31bSShri Abhyankar 
8202727e31bSShri Abhyankar   PetscFunctionBegin;
821daad07d3SAidan 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);
822daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
823daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
824daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
825daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8272bf73ac6SHong Zhang }
8282bf73ac6SHong Zhang 
8292bf73ac6SHong Zhang /*@
8302bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8312bf73ac6SHong Zhang 
83220f4b53cSBarry Smith   Collective
8332bf73ac6SHong Zhang 
8342bf73ac6SHong Zhang   Input Parameters:
83520f4b53cSBarry Smith + dm - the `DMNETWORK` object
83620f4b53cSBarry Smith . anetnum - first subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
83720f4b53cSBarry Smith . bnetnum - second subnetwork global numbering returned by `DMNetworkAddSubnetwork()`
8382bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8392bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8402bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8412bf73ac6SHong Zhang 
8422bf73ac6SHong Zhang   Level: beginner
8432bf73ac6SHong Zhang 
84420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8452bf73ac6SHong Zhang @*/
846d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
847d71ae5a4SJacob Faibussowitsch {
8482bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
849daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8502bf73ac6SHong Zhang 
8512bf73ac6SHong Zhang   PetscFunctionBegin;
8525c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8535c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8542bf73ac6SHong Zhang   if (!Nsvtx) {
8552bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
856daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8572bf73ac6SHong Zhang   }
8582bf73ac6SHong Zhang 
859daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8602bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8619371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8629371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8639371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8649371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8652bf73ac6SHong Zhang     Nsvtx++;
8662bf73ac6SHong Zhang   }
8675c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
868daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8702727e31bSShri Abhyankar }
8712727e31bSShri Abhyankar 
8722727e31bSShri Abhyankar /*@C
8732bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8742bf73ac6SHong Zhang 
87520f4b53cSBarry Smith   Not Collective
876caf410d2SHong Zhang 
877f899ff85SJose E. Roman   Input Parameter:
87820f4b53cSBarry Smith . dm - the `DMNETWORK` object
879caf410d2SHong Zhang 
8807a7aea1fSJed Brown   Output Parameters:
8812bf73ac6SHong Zhang + nsv - number of local shared vertices
8822bf73ac6SHong Zhang - svtx - local shared vertices
883caf410d2SHong Zhang 
884caf410d2SHong Zhang   Level: intermediate
885caf410d2SHong Zhang 
88620f4b53cSBarry Smith   Notes:
88720f4b53cSBarry Smith   Cannot call this routine before `DMNetworkLayoutSetup()`
88820f4b53cSBarry Smith 
88920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
890caf410d2SHong Zhang @*/
891d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx)
892d71ae5a4SJacob Faibussowitsch {
893caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
894caf410d2SHong Zhang 
895caf410d2SHong Zhang   PetscFunctionBegin;
8965c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
897daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
898daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
8993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
900caf410d2SHong Zhang }
901caf410d2SHong Zhang 
902caf410d2SHong Zhang /*@C
9035f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
9045f2c45f1SShri Abhyankar 
90520f4b53cSBarry Smith   Logically Collective
9065f2c45f1SShri Abhyankar 
9077a7aea1fSJed Brown   Input Parameters:
90820f4b53cSBarry Smith + dm - the `DMNETWORK` object
9095f2c45f1SShri Abhyankar . name - the component name
9105f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
9115f2c45f1SShri Abhyankar 
9122fe279fdSBarry Smith    Output Parameter:
9135f2c45f1SShri Abhyankar .  key - an integer key that defines the component
9145f2c45f1SShri Abhyankar 
91520f4b53cSBarry Smith    Level: beginner
91620f4b53cSBarry Smith 
91787497f52SBarry Smith    Note:
91887497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9195f2c45f1SShri Abhyankar 
92020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9215f2c45f1SShri Abhyankar @*/
922d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
923d71ae5a4SJacob Faibussowitsch {
9245f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
92554dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9265f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9275f2c45f1SShri Abhyankar   PetscInt            i;
9285f2c45f1SShri Abhyankar 
9295f2c45f1SShri Abhyankar   PetscFunctionBegin;
93048a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
93154dfd506SHong Zhang 
9325f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9339566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9345f2c45f1SShri Abhyankar     if (flg) {
9355f2c45f1SShri Abhyankar       *key = i;
9363ba16761SJacob Faibussowitsch       PetscFunctionReturn(PETSC_SUCCESS);
9375f2c45f1SShri Abhyankar     }
9386d64e262SShri Abhyankar   }
93954dfd506SHong Zhang 
94054dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
94154dfd506SHong Zhang     /* Reached max allowed so resize component */
94254dfd506SHong Zhang     network->max_comps_registered += 2;
9439566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
94454dfd506SHong Zhang     /* Copy over the previous component info */
94554dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
946c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(newcomponent[i].name, network->component[i].name, sizeof(newcomponent[i].name)));
94754dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9485f2c45f1SShri Abhyankar     }
94954dfd506SHong Zhang     /* Free old one */
9509566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
95154dfd506SHong Zhang     /* Update pointer */
95254dfd506SHong Zhang     network->component = newcomponent;
95354dfd506SHong Zhang   }
95454dfd506SHong Zhang 
95554dfd506SHong Zhang   component = &network->component[network->ncomponent];
9565f2c45f1SShri Abhyankar 
957c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(component->name, name, sizeof(component->name)));
9585f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9595f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9605f2c45f1SShri Abhyankar   network->ncomponent++;
9613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9625f2c45f1SShri Abhyankar }
9635f2c45f1SShri Abhyankar 
9645f2c45f1SShri Abhyankar /*@
9658afb7921SAidan Hamilton   DMNetworkGetNumVertices - Get the local and global number of vertices for the entire network.
9668afb7921SAidan Hamilton 
9678afb7921SAidan Hamilton   Not Collective
9688afb7921SAidan Hamilton 
9698afb7921SAidan Hamilton   Input Parameter:
97020f4b53cSBarry Smith . dm - the `DMNETWORK` object
9718afb7921SAidan Hamilton 
9728afb7921SAidan Hamilton   Output Parameters:
9738afb7921SAidan Hamilton + nVertices - the local number of vertices
9748afb7921SAidan Hamilton - NVertices - the global number of vertices
9758afb7921SAidan Hamilton 
9768afb7921SAidan Hamilton   Level: beginner
9778afb7921SAidan Hamilton 
97820f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumEdges()`
9798afb7921SAidan Hamilton @*/
9808afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumVertices(DM dm, PetscInt *nVertices, PetscInt *NVertices)
9818afb7921SAidan Hamilton {
9828afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
9838afb7921SAidan Hamilton 
9848afb7921SAidan Hamilton   PetscFunctionBegin;
9858afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
9868afb7921SAidan Hamilton   if (nVertices) {
9878afb7921SAidan Hamilton     PetscValidIntPointer(nVertices, 2);
9888afb7921SAidan Hamilton     *nVertices = network->cloneshared->nVertices;
9898afb7921SAidan Hamilton   }
9908afb7921SAidan Hamilton   if (NVertices) {
9918afb7921SAidan Hamilton     PetscValidIntPointer(NVertices, 3);
9928afb7921SAidan Hamilton     *NVertices = network->cloneshared->NVertices;
9938afb7921SAidan Hamilton   }
9943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9958afb7921SAidan Hamilton }
9968afb7921SAidan Hamilton 
9978afb7921SAidan Hamilton /*@
9988afb7921SAidan Hamilton   DMNetworkGetNumEdges - Get the local and global number of edges for the entire network.
9998afb7921SAidan Hamilton 
10008afb7921SAidan Hamilton   Not Collective
10018afb7921SAidan Hamilton 
10028afb7921SAidan Hamilton   Input Parameter:
100320f4b53cSBarry Smith . dm - the `DMNETWORK` object
10048afb7921SAidan Hamilton 
10058afb7921SAidan Hamilton   Output Parameters:
10068afb7921SAidan Hamilton + nEdges - the local number of edges
10078afb7921SAidan Hamilton -  NEdges - the global number of edges
10088afb7921SAidan Hamilton 
10098afb7921SAidan Hamilton   Level: beginner
10108afb7921SAidan Hamilton 
101120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetNumVertices()`
10128afb7921SAidan Hamilton @*/
10138afb7921SAidan Hamilton PetscErrorCode DMNetworkGetNumEdges(DM dm, PetscInt *nEdges, PetscInt *NEdges)
10148afb7921SAidan Hamilton {
10158afb7921SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
10168afb7921SAidan Hamilton 
10178afb7921SAidan Hamilton   PetscFunctionBegin;
10188afb7921SAidan Hamilton   PetscValidHeaderSpecificType(dm, DM_CLASSID, 1, DMNETWORK);
10198afb7921SAidan Hamilton   if (nEdges) {
10208afb7921SAidan Hamilton     PetscValidIntPointer(nEdges, 2);
10218afb7921SAidan Hamilton     *nEdges = network->cloneshared->nEdges;
10228afb7921SAidan Hamilton   }
10238afb7921SAidan Hamilton   if (NEdges) {
10248afb7921SAidan Hamilton     PetscValidIntPointer(NEdges, 3);
10258afb7921SAidan Hamilton     *NEdges = network->cloneshared->NEdges;
10268afb7921SAidan Hamilton   }
10273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10288afb7921SAidan Hamilton }
10298afb7921SAidan Hamilton 
10308afb7921SAidan Hamilton /*@
10312bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
10325f2c45f1SShri Abhyankar 
10335f2c45f1SShri Abhyankar   Not Collective
10345f2c45f1SShri Abhyankar 
1035f899ff85SJose E. Roman   Input Parameter:
103620f4b53cSBarry Smith . dm - the `DMNETWORK` object
10375f2c45f1SShri Abhyankar 
1038fd292e60Sprj-   Output Parameters:
10392bf73ac6SHong Zhang + vStart - the first vertex point
10402bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
10415f2c45f1SShri Abhyankar 
104297bb938eSShri Abhyankar   Level: beginner
10435f2c45f1SShri Abhyankar 
104420f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeRange()`
10455f2c45f1SShri Abhyankar @*/
1046d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd)
1047d71ae5a4SJacob Faibussowitsch {
10485f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10495f2c45f1SShri Abhyankar 
10505f2c45f1SShri Abhyankar   PetscFunctionBegin;
1051daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
1052daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
10533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10545f2c45f1SShri Abhyankar }
10555f2c45f1SShri Abhyankar 
10565f2c45f1SShri Abhyankar /*@
10572bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
10585f2c45f1SShri Abhyankar 
10595f2c45f1SShri Abhyankar   Not Collective
10605f2c45f1SShri Abhyankar 
1061f899ff85SJose E. Roman   Input Parameter:
106220f4b53cSBarry Smith . dm - the `DMNETWORK` object
10635f2c45f1SShri Abhyankar 
1064fd292e60Sprj-   Output Parameters:
10655f2c45f1SShri Abhyankar + eStart - The first edge point
10665f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
10675f2c45f1SShri Abhyankar 
106897bb938eSShri Abhyankar   Level: beginner
10695f2c45f1SShri Abhyankar 
107020f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetVertexRange()`
10715f2c45f1SShri Abhyankar @*/
1072d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd)
1073d71ae5a4SJacob Faibussowitsch {
10745f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
10755f2c45f1SShri Abhyankar 
10765f2c45f1SShri Abhyankar   PetscFunctionBegin;
10775c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1078daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
1079daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
10803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10815f2c45f1SShri Abhyankar }
10825f2c45f1SShri Abhyankar 
1083d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index)
1084d71ae5a4SJacob Faibussowitsch {
10852bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
10865c6496baSHong Zhang 
10875c6496baSHong Zhang   PetscFunctionBegin;
10885c6496baSHong Zhang   if (network->header) {
10895c6496baSHong Zhang     *index = network->header[p].index;
10905c6496baSHong Zhang   } else {
10912bf73ac6SHong Zhang     PetscInt                 offsetp;
10922bf73ac6SHong Zhang     DMNetworkComponentHeader header;
10932bf73ac6SHong Zhang 
10949566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
10952bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
10962bf73ac6SHong Zhang     *index = header->index;
10975c6496baSHong Zhang   }
10983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10992bf73ac6SHong Zhang }
11002bf73ac6SHong Zhang 
1101d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid)
1102d71ae5a4SJacob Faibussowitsch {
1103daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1104daad07d3SAidan Hamilton 
1105daad07d3SAidan Hamilton   PetscFunctionBegin;
1106daad07d3SAidan Hamilton   if (network->header) {
1107daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1108daad07d3SAidan Hamilton   } else {
1109daad07d3SAidan Hamilton     PetscInt                 offsetp;
1110daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1111daad07d3SAidan Hamilton 
1112daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1113daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1114daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1115daad07d3SAidan Hamilton   }
11163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1117daad07d3SAidan Hamilton }
1118daad07d3SAidan Hamilton 
11197b6afd5bSHong Zhang /*@
11202bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
11217b6afd5bSHong Zhang 
11227b6afd5bSHong Zhang   Not Collective
11237b6afd5bSHong Zhang 
11247b6afd5bSHong Zhang   Input Parameters:
112520f4b53cSBarry Smith + dm - `DMNETWORK` object
1126e85e6aecSHong Zhang - p - edge point
11277b6afd5bSHong Zhang 
11282fe279fdSBarry Smith   Output Parameter:
11292bf73ac6SHong Zhang . index - the global numbering for the edge
11307b6afd5bSHong Zhang 
11317b6afd5bSHong Zhang   Level: intermediate
11327b6afd5bSHong Zhang 
113320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
11347b6afd5bSHong Zhang @*/
1135d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index)
1136d71ae5a4SJacob Faibussowitsch {
11377b6afd5bSHong Zhang   PetscFunctionBegin;
11389566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11407b6afd5bSHong Zhang }
11417b6afd5bSHong Zhang 
11425f2c45f1SShri Abhyankar /*@
11432bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1144e85e6aecSHong Zhang 
1145e85e6aecSHong Zhang   Not Collective
1146e85e6aecSHong Zhang 
1147e85e6aecSHong Zhang   Input Parameters:
114820f4b53cSBarry Smith + dm - `DMNETWORK` object
1149e85e6aecSHong Zhang - p  - vertex point
1150e85e6aecSHong Zhang 
11512fe279fdSBarry Smith   Output Parameter:
11522bf73ac6SHong Zhang . index - the global numbering for the vertex
1153e85e6aecSHong Zhang 
1154e85e6aecSHong Zhang   Level: intermediate
1155e85e6aecSHong Zhang 
115620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1157e85e6aecSHong Zhang @*/
1158d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index)
1159d71ae5a4SJacob Faibussowitsch {
1160e85e6aecSHong Zhang   PetscFunctionBegin;
11619566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
11623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11639988b915SShri Abhyankar }
11649988b915SShri Abhyankar 
11659988b915SShri Abhyankar /*@
11665f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
11675f2c45f1SShri Abhyankar 
11685f2c45f1SShri Abhyankar   Not Collective
11695f2c45f1SShri Abhyankar 
11705f2c45f1SShri Abhyankar   Input Parameters:
117120f4b53cSBarry Smith + dm - the `DMNETWORK` object
1172a2b725a8SWilliam Gropp - p - vertex/edge point
11735f2c45f1SShri Abhyankar 
11742fe279fdSBarry Smith   Output Parameter:
11755f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
11765f2c45f1SShri Abhyankar 
117797bb938eSShri Abhyankar   Level: beginner
11785f2c45f1SShri Abhyankar 
117920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
11805f2c45f1SShri Abhyankar @*/
1181d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents)
1182d71ae5a4SJacob Faibussowitsch {
11835f2c45f1SShri Abhyankar   PetscInt    offset;
11845f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
11855f2c45f1SShri Abhyankar 
11865f2c45f1SShri Abhyankar   PetscFunctionBegin;
11879566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
11885f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
11893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11905f2c45f1SShri Abhyankar }
11915f2c45f1SShri Abhyankar 
11925f2c45f1SShri Abhyankar /*@
11932bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
11945f2c45f1SShri Abhyankar 
11955f2c45f1SShri Abhyankar   Not Collective
11965f2c45f1SShri Abhyankar 
11975f2c45f1SShri Abhyankar   Input Parameters:
119820f4b53cSBarry Smith + dm - the `DMNETWORK` object
1199f2f58720SBarry Smith . p - the edge or vertex point
12002bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12019988b915SShri Abhyankar 
12022fe279fdSBarry Smith   Output Parameter:
12032bf73ac6SHong Zhang . offset - the local offset
12049988b915SShri Abhyankar 
12059988b915SShri Abhyankar   Level: intermediate
12069988b915SShri Abhyankar 
120720f4b53cSBarry Smith   Notes:
120820f4b53cSBarry Smith     These offsets can be passed to `MatSetValuesLocal()` for matrices obtained with `DMCreateMatrix()`.
120920f4b53cSBarry Smith 
121020f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` the offsets can be used with `VecSetValues()`.
121120f4b53cSBarry Smith 
121220f4b53cSBarry Smith     For vectors obtained with `DMCreateLocalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
121320f4b53cSBarry Smith     the vector values with array[offset].
121420f4b53cSBarry Smith 
121520f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValuesLocal()`.
121620f4b53cSBarry Smith 
121720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
12189988b915SShri Abhyankar @*/
1219d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset)
1220d71ae5a4SJacob Faibussowitsch {
12219988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12229988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12239988b915SShri Abhyankar   DMNetworkComponentHeader header;
12249988b915SShri Abhyankar 
12259988b915SShri Abhyankar   PetscFunctionBegin;
12269566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
12272bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12282bf73ac6SHong Zhang     *offset = offsetp;
12293ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12302bf73ac6SHong Zhang   }
12312bf73ac6SHong Zhang 
12329566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12339988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12349988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
12353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12369988b915SShri Abhyankar }
12379988b915SShri Abhyankar 
12389988b915SShri Abhyankar /*@
12392bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
12409988b915SShri Abhyankar 
12419988b915SShri Abhyankar   Not Collective
12429988b915SShri Abhyankar 
12439988b915SShri Abhyankar   Input Parameters:
124420f4b53cSBarry Smith + dm - the `DMNETWORK` object
1245f2f58720SBarry Smith . p - the edge or vertex point
12462bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
12479988b915SShri Abhyankar 
12482fe279fdSBarry Smith   Output Parameter:
12499988b915SShri Abhyankar . offsetg - the global offset
12509988b915SShri Abhyankar 
12519988b915SShri Abhyankar   Level: intermediate
12529988b915SShri Abhyankar 
125320f4b53cSBarry Smith   Notes:
125420f4b53cSBarry Smith     These offsets can be passed to `MatSetValues()` for matrices obtained with `DMCreateMatrix()`.
125520f4b53cSBarry Smith 
125620f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` the offsets can be used with `VecSetValues()`.
125720f4b53cSBarry Smith 
125820f4b53cSBarry Smith     For vectors obtained with `DMCreateGlobalVector()` and the array obtained with `VecGetArray`(vec,&array) you can access or set
125920f4b53cSBarry Smith     the vector values with array[offset - rstart] where restart is obtained with `VecGetOwnershipRange`(v,&rstart,`NULL`);
126020f4b53cSBarry Smith 
126120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
12629988b915SShri Abhyankar @*/
1263d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg)
1264d71ae5a4SJacob Faibussowitsch {
12659988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
12669988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
12679988b915SShri Abhyankar   DMNetworkComponentHeader header;
12689988b915SShri Abhyankar 
12699988b915SShri Abhyankar   PetscFunctionBegin;
12709566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
12712bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
12722bf73ac6SHong Zhang 
12732bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
12742bf73ac6SHong Zhang     *offsetg = offsetp;
12753ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
12762bf73ac6SHong Zhang   }
12779566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
12789988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12799988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
12803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12819988b915SShri Abhyankar }
12829988b915SShri Abhyankar 
12839988b915SShri Abhyankar /*@
12842bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
128524121865SAdrian Maldonado 
128624121865SAdrian Maldonado   Not Collective
128724121865SAdrian Maldonado 
128824121865SAdrian Maldonado   Input Parameters:
128920f4b53cSBarry Smith + dm - the `DMNETWORK` object
129024121865SAdrian Maldonado - p - the edge point
129124121865SAdrian Maldonado 
12922fe279fdSBarry Smith   Output Parameter:
129324121865SAdrian Maldonado . offset - the offset
129424121865SAdrian Maldonado 
129524121865SAdrian Maldonado   Level: intermediate
129624121865SAdrian Maldonado 
129720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
129824121865SAdrian Maldonado @*/
1299d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset)
1300d71ae5a4SJacob Faibussowitsch {
130124121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
130224121865SAdrian Maldonado 
130324121865SAdrian Maldonado   PetscFunctionBegin;
13049566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
13053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
130624121865SAdrian Maldonado }
130724121865SAdrian Maldonado 
130824121865SAdrian Maldonado /*@
13092bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
131024121865SAdrian Maldonado 
131124121865SAdrian Maldonado   Not Collective
131224121865SAdrian Maldonado 
131324121865SAdrian Maldonado   Input Parameters:
131420f4b53cSBarry Smith + dm - the `DMNETWORK` object
131524121865SAdrian Maldonado - p - the vertex point
131624121865SAdrian Maldonado 
13172fe279fdSBarry Smith   Output Parameter:
131824121865SAdrian Maldonado . offset - the offset
131924121865SAdrian Maldonado 
132024121865SAdrian Maldonado   Level: intermediate
132124121865SAdrian Maldonado 
132220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
132324121865SAdrian Maldonado @*/
1324d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset)
1325d71ae5a4SJacob Faibussowitsch {
132624121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
132724121865SAdrian Maldonado 
132824121865SAdrian Maldonado   PetscFunctionBegin;
1329daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
13309566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
13313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
133224121865SAdrian Maldonado }
13332bf73ac6SHong Zhang 
13345f2c45f1SShri Abhyankar /*@
13352bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
13365f2c45f1SShri Abhyankar 
133720f4b53cSBarry Smith   Collective
13385f2c45f1SShri Abhyankar 
13395f2c45f1SShri Abhyankar   Input Parameters:
13404dc646bcSBarry Smith + dm - the DMNetwork
134120f4b53cSBarry Smith . p - the vertex/edge point. These points are local indices provided by `DMNetworkGetSubnetwork()`
134220f4b53cSBarry Smith . componentkey - component key returned while registering the component with `DMNetworkRegisterComponent()`
134320f4b53cSBarry 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
134420f4b53cSBarry Smith               free this space until after `DMSetUp()` is called.
1345eac198afSGetnet - 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
13465f2c45f1SShri Abhyankar 
134720f4b53cSBarry Smith   Level: beginner
134820f4b53cSBarry Smith 
1349eac198afSGetnet   Notes:
1350eac198afSGetnet     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.
1351eac198afSGetnet 
135220f4b53cSBarry Smith     `DMNetworkLayoutSetUp()` must be called before this routine.
1353eac198afSGetnet 
135420f4b53cSBarry Smith   Developer Note:
135520f4b53cSBarry Smith      The requirement that all the ranks with access to a vertex (as owner or as ghost) add all the components comes from a limitation of the underlying implementation based on `DMPLEX`.
13565f2c45f1SShri Abhyankar 
135720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
13585f2c45f1SShri Abhyankar @*/
1359d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar)
1360d71ae5a4SJacob Faibussowitsch {
13615f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
13622bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
136354dfd506SHong Zhang   DMNetworkComponentHeader header;
136454dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
136554dfd506SHong Zhang   PetscInt                 compnum;
136654dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
136754dfd506SHong Zhang   void                   **compdata;
13685f2c45f1SShri Abhyankar 
13695f2c45f1SShri Abhyankar   PetscFunctionBegin;
13705c6496baSHong 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);
1371daad07d3SAidan 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.");
1372eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
13739566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
13742bf73ac6SHong Zhang 
1375eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
137654dfd506SHong Zhang   header = &network->header[p];
137754dfd506SHong Zhang   cvalue = &network->cvalue[p];
137854dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1379f11a936eSBarry Smith     PetscInt additional_size;
1380f11a936eSBarry Smith 
138154dfd506SHong Zhang     /* Reached limit so resize header component arrays */
138254dfd506SHong Zhang     header->maxcomps += 2;
138354dfd506SHong Zhang 
138454dfd506SHong Zhang     /* Allocate arrays for component information and value */
13859566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
13869566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
138754dfd506SHong Zhang 
138854dfd506SHong Zhang     /* Recalculate header size */
138954dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
139054dfd506SHong Zhang 
139154dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
139254dfd506SHong Zhang 
139354dfd506SHong Zhang     /* Copy over component info */
13949566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
13959566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
13969566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
13979566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
13989566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
139954dfd506SHong Zhang 
140054dfd506SHong Zhang     /* Copy over component data pointers */
14019566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
140254dfd506SHong Zhang 
140354dfd506SHong Zhang     /* Free old arrays */
14049566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
14059566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
140654dfd506SHong Zhang 
140754dfd506SHong Zhang     /* Update pointers */
140854dfd506SHong Zhang     header->size         = compsize;
140954dfd506SHong Zhang     header->key          = compkey;
141054dfd506SHong Zhang     header->offset       = compoffset;
141154dfd506SHong Zhang     header->nvar         = compnvar;
141254dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
141354dfd506SHong Zhang 
141454dfd506SHong Zhang     cvalue->data = compdata;
141554dfd506SHong Zhang 
141654dfd506SHong Zhang     /* Update DataSection Dofs */
141754dfd506SHong 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 */
1418f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
14199566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
142054dfd506SHong Zhang   }
142154dfd506SHong Zhang   header = &network->header[p];
142254dfd506SHong Zhang   cvalue = &network->cvalue[p];
142354dfd506SHong Zhang 
142454dfd506SHong Zhang   compnum = header->ndata;
14252bf73ac6SHong Zhang 
14262bf73ac6SHong Zhang   header->size[compnum] = component->size;
14279566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
14282bf73ac6SHong Zhang   header->key[compnum] = componentkey;
14292bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
14302bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
14312bf73ac6SHong Zhang 
14322bf73ac6SHong Zhang   /* variables */
14332bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
14342bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
14352bf73ac6SHong Zhang 
14362bf73ac6SHong Zhang   header->ndata++;
14373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14385f2c45f1SShri Abhyankar }
14395f2c45f1SShri Abhyankar 
144027f51fceSHong Zhang /*@
14412bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
144227f51fceSHong Zhang 
144327f51fceSHong Zhang   Not Collective
144427f51fceSHong Zhang 
144527f51fceSHong Zhang   Input Parameters:
144620f4b53cSBarry Smith + dm - the `DMNETWORK` object
14472bf73ac6SHong Zhang . p - vertex/edge point
144899c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
144927f51fceSHong Zhang 
145027f51fceSHong Zhang   Output Parameters:
145120f4b53cSBarry Smith + compkey - the key obtained when registering the component (use `NULL` if not required)
145220f4b53cSBarry Smith . component - the component data (use `NULL` if not required)
145320f4b53cSBarry Smith - nvar  - number of variables (use `NULL` if not required)
145427f51fceSHong Zhang 
145597bb938eSShri Abhyankar   Level: beginner
145627f51fceSHong Zhang 
145720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
145827f51fceSHong Zhang @*/
1459d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar)
1460d71ae5a4SJacob Faibussowitsch {
146127f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
14622bf73ac6SHong Zhang   PetscInt                 offset  = 0;
14632bf73ac6SHong Zhang   DMNetworkComponentHeader header;
146427f51fceSHong Zhang 
146527f51fceSHong Zhang   PetscFunctionBegin;
14662bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
14679566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
14683ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
146927f51fceSHong Zhang   }
147027f51fceSHong Zhang 
14719566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
147242dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
14735f2c45f1SShri Abhyankar 
14742bf73ac6SHong Zhang   if (compnum >= 0) {
14752bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
14762bf73ac6SHong Zhang     if (component) {
147754dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
14782bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
14792bf73ac6SHong Zhang     }
14802bf73ac6SHong Zhang   }
14815f2c45f1SShri Abhyankar 
14822bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
148354dfd506SHong Zhang 
14843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14855f2c45f1SShri Abhyankar }
14865f2c45f1SShri Abhyankar 
14872bf73ac6SHong Zhang /*
14882bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14892bf73ac6SHong 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.
14902bf73ac6SHong Zhang */
1491d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkComponentSetUp(DM dm)
1492d71ae5a4SJacob Faibussowitsch {
14935f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1494f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
14955f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
14965f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1497f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
14985f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
14995f2c45f1SShri Abhyankar 
15005f2c45f1SShri Abhyankar   PetscFunctionBegin;
15019566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
15029566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1503f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
15049566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
15055f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1506daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
15079566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
15085f2c45f1SShri Abhyankar     /* Copy header */
15095f2c45f1SShri Abhyankar     header     = &network->header[p];
1510f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
15119566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1512f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
15139566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1514aeb78aa7SBarry Smith     headerinfo->size = headerarr;
151554dfd506SHong Zhang     headerarr += header->maxcomps;
15169566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1517aeb78aa7SBarry Smith     headerinfo->key = headerarr;
151854dfd506SHong Zhang     headerarr += header->maxcomps;
15199566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1520aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
152154dfd506SHong Zhang     headerarr += header->maxcomps;
15229566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1523aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
152454dfd506SHong Zhang     headerarr += header->maxcomps;
15259566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1526aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
152754dfd506SHong Zhang 
15285f2c45f1SShri Abhyankar     /* Copy data */
15295f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
15305f2c45f1SShri Abhyankar     ncomp  = header->ndata;
15312bf73ac6SHong Zhang 
15325f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
153354dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
15349566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
15355f2c45f1SShri Abhyankar     }
15365f2c45f1SShri Abhyankar   }
1537aeb78aa7SBarry Smith 
1538daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1539aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1540aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1541aeb78aa7SBarry Smith   }
1542aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
15433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15445f2c45f1SShri Abhyankar }
15455f2c45f1SShri Abhyankar 
15465f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1547d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1548d71ae5a4SJacob Faibussowitsch {
15495f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
15505f2c45f1SShri Abhyankar 
15515f2c45f1SShri Abhyankar   PetscFunctionBegin;
15529566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
15533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15545f2c45f1SShri Abhyankar }
15555f2c45f1SShri Abhyankar 
155624121865SAdrian Maldonado /* Get a subsection from a range of points */
1557d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1558d71ae5a4SJacob Faibussowitsch {
155924121865SAdrian Maldonado   PetscInt i, nvar;
156024121865SAdrian Maldonado 
156124121865SAdrian Maldonado   PetscFunctionBegin;
15629566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
15639566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
156424121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
15659566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
15669566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
156724121865SAdrian Maldonado   }
156824121865SAdrian Maldonado 
15699566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
15703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
157124121865SAdrian Maldonado }
157224121865SAdrian Maldonado 
157324121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1574e66d8692SHong Zhang static PetscErrorCode DMNetworkSetSubMap_private(DM dm, PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1575d71ae5a4SJacob Faibussowitsch {
157624121865SAdrian Maldonado   PetscInt i, *subpoints;
157724121865SAdrian Maldonado 
157824121865SAdrian Maldonado   PetscFunctionBegin;
157924121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15809566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1581ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
1582e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15839566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
15843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
158524121865SAdrian Maldonado }
158624121865SAdrian Maldonado 
158724121865SAdrian Maldonado /*@
158820f4b53cSBarry Smith   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after `DMNetworkDistribute()`
158924121865SAdrian Maldonado 
159020f4b53cSBarry Smith   Collective
159124121865SAdrian Maldonado 
15922fe279fdSBarry Smith   Input Parameter:
159320f4b53cSBarry Smith . dm - the `DMNETWORK` Object
159424121865SAdrian Maldonado 
159520f4b53cSBarry Smith   Level: intermediate
159620f4b53cSBarry Smith 
159720f4b53cSBarry Smith   Note:
159820f4b53cSBarry Smith   the routine will create alternative orderings for the vertices and edges. Assume global network points are:
159924121865SAdrian Maldonado 
160024121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
160124121865SAdrian Maldonado 
1602caf410d2SHong 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]).
160324121865SAdrian Maldonado 
160420f4b53cSBarry Smith   With this new ordering a local `PetscSection`, global `PetscSection` and` PetscSF` will be created specific to the subset.
160524121865SAdrian Maldonado 
160624121865SAdrian Maldonado @*/
1607d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1608d71ae5a4SJacob Faibussowitsch {
160924121865SAdrian Maldonado   MPI_Comm    comm;
1610f11a936eSBarry Smith   PetscMPIInt size;
161124121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
161224121865SAdrian Maldonado 
1613eab1376dSHong Zhang   PetscFunctionBegin;
16149566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
16159566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
161624121865SAdrian Maldonado 
161724121865SAdrian Maldonado   /* Create maps for vertices and edges */
1618e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1619e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
162024121865SAdrian Maldonado 
162124121865SAdrian Maldonado   /* Create local sub-sections */
1622daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1623daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
162424121865SAdrian Maldonado 
16259852e123SBarry Smith   if (size > 1) {
16269566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
162722bbedd7SHong Zhang 
16289566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
16299566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
16309566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
163124121865SAdrian Maldonado   } else {
163224121865SAdrian Maldonado     /* create structures for vertex */
16339566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
163424121865SAdrian Maldonado     /* create structures for edge */
16359566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
163624121865SAdrian Maldonado   }
163724121865SAdrian Maldonado 
163824121865SAdrian Maldonado   /* Add viewers */
16399566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
16409566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
16419566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
16429566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
16433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
164424121865SAdrian Maldonado }
16457b6afd5bSHong Zhang 
1646f11a936eSBarry Smith /*
16475c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
16485c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1649f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1650f11a936eSBarry Smith */
1651d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1652d71ae5a4SJacob Faibussowitsch {
1653f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1654f11a936eSBarry Smith   const PetscInt          *edges;
1655f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1656f11a936eSBarry Smith   DMNetworkComponentHeader header;
1657f11a936eSBarry Smith 
1658f11a936eSBarry Smith   PetscFunctionBegin;
16599566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
16609566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1661f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
16629566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1663f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16649566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1665f11a936eSBarry Smith   }
16663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1667f11a936eSBarry Smith }
1668f11a936eSBarry Smith 
16698afb7921SAidan Hamilton /*
16708afb7921SAidan Hamilton   DMNetworkDistributeCoordinates - Internal function to distribute the coordinate network and coordinates.
16718afb7921SAidan Hamilton 
16728afb7921SAidan Hamilton   Collective
16738afb7921SAidan Hamilton 
16748afb7921SAidan Hamilton   Input Parameters:
167520f4b53cSBarry Smith   + dm - The original `DMNETWORK` object
1676aaa8cc7dSPierre Jolivet   - migrationSF - The `PetscSF` describing the migration from dm to dmnew
16778afb7921SAidan Hamilton   - newDM - The new distributed dmnetwork object.
16788afb7921SAidan Hamilton */
16798afb7921SAidan Hamilton 
16808afb7921SAidan Hamilton static PetscErrorCode DMNetworkDistributeCoordinates(DM dm, PetscSF migrationSF, DM newDM)
16818afb7921SAidan Hamilton {
16828afb7921SAidan Hamilton   DM_Network              *newDMnetwork = (DM_Network *)((newDM)->data), *newCoordnetwork, *oldCoordnetwork;
16838afb7921SAidan Hamilton   DM                       cdm, newcdm;
16848afb7921SAidan Hamilton   PetscInt                 cdim, bs, p, pStart, pEnd, offset;
16858afb7921SAidan Hamilton   Vec                      oldCoord, newCoord;
16868afb7921SAidan Hamilton   DMNetworkComponentHeader header;
16878afb7921SAidan Hamilton   const char              *name;
16888afb7921SAidan Hamilton 
16898afb7921SAidan Hamilton   PetscFunctionBegin;
16908afb7921SAidan Hamilton   /* Distribute the coordinate network and coordinates */
16918afb7921SAidan Hamilton   PetscCall(DMGetCoordinateDim(dm, &cdim));
16928afb7921SAidan Hamilton   PetscCall(DMSetCoordinateDim(newDM, cdim));
16938afb7921SAidan Hamilton 
16948afb7921SAidan Hamilton   /* Migrate only if original network had coordinates */
16958afb7921SAidan Hamilton   PetscCall(DMGetCoordinatesLocal(dm, &oldCoord));
16968afb7921SAidan Hamilton   if (oldCoord) {
16978afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(dm, &cdm));
16988afb7921SAidan Hamilton     PetscCall(DMGetCoordinateDM(newDM, &newcdm));
16998afb7921SAidan Hamilton     newCoordnetwork = (DM_Network *)newcdm->data;
17008afb7921SAidan Hamilton     oldCoordnetwork = (DM_Network *)cdm->data;
17018afb7921SAidan Hamilton 
17028afb7921SAidan Hamilton     PetscCall(VecCreate(PETSC_COMM_SELF, &newCoord));
17038afb7921SAidan Hamilton     PetscCall(PetscObjectGetName((PetscObject)oldCoord, &name));
17048afb7921SAidan Hamilton     PetscCall(PetscObjectSetName((PetscObject)newCoord, name));
17058afb7921SAidan Hamilton     PetscCall(VecGetBlockSize(oldCoord, &bs));
17068afb7921SAidan Hamilton     PetscCall(VecSetBlockSize(newCoord, bs));
17078afb7921SAidan Hamilton 
17088afb7921SAidan Hamilton     PetscCall(DMPlexDistributeField(newDMnetwork->plex, migrationSF, oldCoordnetwork->DofSection, oldCoord, newCoordnetwork->DofSection, newCoord));
17098afb7921SAidan Hamilton     PetscCall(DMSetCoordinatesLocal(newDM, newCoord));
17108afb7921SAidan Hamilton 
17118afb7921SAidan Hamilton     PetscCall(VecDestroy(&newCoord));
1712aaa8cc7dSPierre Jolivet     /* Migrate the components from the original coordinate network to the new coordinate network */
17138afb7921SAidan Hamilton     PetscCall(DMPlexDistributeData(newDMnetwork->plex, migrationSF, oldCoordnetwork->DataSection, MPIU_INT, (void *)oldCoordnetwork->componentdataarray, newCoordnetwork->DataSection, (void **)&newCoordnetwork->componentdataarray));
17148afb7921SAidan Hamilton     /* update the header pointers in the new coordinate network components */
17158afb7921SAidan Hamilton     PetscCall(PetscSectionGetChart(newCoordnetwork->DataSection, &pStart, &pEnd));
17168afb7921SAidan Hamilton     for (p = pStart; p < pEnd; p++) {
17178afb7921SAidan Hamilton       PetscCall(PetscSectionGetOffset(newCoordnetwork->DataSection, p, &offset));
17188afb7921SAidan Hamilton       header = (DMNetworkComponentHeader)(newCoordnetwork->componentdataarray + offset);
17198afb7921SAidan Hamilton       /* Update pointers */
17208afb7921SAidan Hamilton       header->size         = (PetscInt *)(header + 1);
17218afb7921SAidan Hamilton       header->key          = header->size + header->maxcomps;
17228afb7921SAidan Hamilton       header->offset       = header->key + header->maxcomps;
17238afb7921SAidan Hamilton       header->nvar         = header->offset + header->maxcomps;
17248afb7921SAidan Hamilton       header->offsetvarrel = header->nvar + header->maxcomps;
17258afb7921SAidan Hamilton     }
17268afb7921SAidan Hamilton 
17278afb7921SAidan Hamilton     PetscCall(DMSetLocalSection(newCoordnetwork->plex, newCoordnetwork->DofSection));
17288afb7921SAidan Hamilton     PetscCall(DMGetGlobalSection(newCoordnetwork->plex, &newCoordnetwork->GlobalDofSection));
17298afb7921SAidan Hamilton     newCoordnetwork->componentsetup = PETSC_TRUE;
17308afb7921SAidan Hamilton   }
17313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17328afb7921SAidan Hamilton }
17338afb7921SAidan Hamilton 
17345f2c45f1SShri Abhyankar /*@
17352bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
17365f2c45f1SShri Abhyankar 
17375f2c45f1SShri Abhyankar   Collective
17385f2c45f1SShri Abhyankar 
1739d8d19677SJose E. Roman   Input Parameters:
174020f4b53cSBarry Smith + DM - the `DMNETWORK` object
17412bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
17425f2c45f1SShri Abhyankar 
174320f4b53cSBarry Smith   Options Database Keys:
17446e4289a0SDuncan Campbell + -dmnetwork_view - Calls `DMView()` at the conclusion of `DMSetUp()`
17456e4289a0SDuncan Campbell . -dmnetwork_view_distributed - Calls `DMView()` at the conclusion of `DMNetworkDistribute()`
1746*5f25b224SDuncan Campbell . -dmnetwork_view_tmpdir - Sets the temporary directory to use when viewing with the `draw` option
1747*5f25b224SDuncan Campbell . -dmnetwork_view_all_ranks - Displays all of the subnetworks for each MPI rank
1748*5f25b224SDuncan Campbell . -dmnetwork_view_rank_range - Displays the subnetworks for the ranks in a comma-separated list
1749*5f25b224SDuncan Campbell . -dmnetwork_view_no_vertices - Disables displaying the vertices in the network visualization
1750*5f25b224SDuncan Campbell - -dmnetwork_view_no_numbering - Disables displaying the numbering of edges and vertices in the network visualization
17515b3f975aSHong Zhang 
17525f2c45f1SShri Abhyankar   Level: intermediate
17535f2c45f1SShri Abhyankar 
175420f4b53cSBarry Smith   Note:
175520f4b53cSBarry Smith   Distributes the network with <overlap>-overlapping partitioning of the edges.
175620f4b53cSBarry Smith 
175720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`
17585f2c45f1SShri Abhyankar @*/
1759d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1760d71ae5a4SJacob Faibussowitsch {
1761d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1762d3464fd4SAdrian Maldonado   PetscMPIInt              size;
17638afb7921SAidan Hamilton   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data), *newDMnetwork;
1764caf410d2SHong Zhang   PetscSF                  pointsf      = NULL;
17655f2c45f1SShri Abhyankar   DM                       newDM;
17668afb7921SAidan Hamilton   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv, net;
17678afb7921SAidan Hamilton   PetscInt                *sv;
1768f11a936eSBarry Smith   PetscBT                  btable;
176951ac5effSHong Zhang   PetscPartitioner         part;
1770b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
17715f2c45f1SShri Abhyankar 
17725f2c45f1SShri Abhyankar   PetscFunctionBegin;
17735c6496baSHong Zhang   PetscValidPointer(dm, 1);
17745c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
17759566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
17769566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1777a9750deaSHong Zhang   if (size == 1) {
1778a9750deaSHong Zhang     oldDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1779a9750deaSHong Zhang     PetscFunctionReturn(PETSC_SUCCESS);
1780a9750deaSHong Zhang   }
1781d3464fd4SAdrian Maldonado 
17825c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
17835b3f975aSHong Zhang 
17842bf73ac6SHong 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. */
1785e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
17869566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
17875f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
178854dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
17899566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
179051ac5effSHong Zhang 
179151ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
17929566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
17939566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
179451ac5effSHong Zhang 
17952bf73ac6SHong Zhang   /* Distribute plex dm */
17969566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
179751ac5effSHong Zhang 
17985f2c45f1SShri Abhyankar   /* Distribute dof section */
17999566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
18009566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
180151ac5effSHong Zhang 
18025f2c45f1SShri Abhyankar   /* Distribute data and associated section */
18039566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
18049566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
180524121865SAdrian Maldonado 
1806daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1807daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1808daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1809daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1810daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1811daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1812daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1813daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1814daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
181524121865SAdrian Maldonado 
18161bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
18179566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
18189566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
18195f2c45f1SShri Abhyankar 
1820b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1821daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1822daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1823daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1824daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1825daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1826daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
18272bf73ac6SHong Zhang 
18282bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
18292bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1830b9c6e19dSShri Abhyankar   */
1831daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1832f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1833daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1834daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1835b9c6e19dSShri Abhyankar   }
1836b9c6e19dSShri Abhyankar 
1837f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1838daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
18399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
184054dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18415c6496baSHong Zhang 
184254dfd506SHong Zhang     /* Update pointers */
184354dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
184454dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
184554dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
184654dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
184754dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
184854dfd506SHong Zhang 
1849daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1850b9c6e19dSShri Abhyankar   }
1851b9c6e19dSShri Abhyankar 
18525c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
185348a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
18545c6496baSHong Zhang 
18555c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1856daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
18579566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
18585f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
18595c6496baSHong Zhang 
186054dfd506SHong Zhang     /* Update pointers */
186154dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
186254dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
186354dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
186454dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
186554dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
186654dfd506SHong Zhang 
18672bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
18682bf73ac6SHong Zhang     gidx = header->index;
1869eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, gidx + 1, 0, &svtx_idx));
18702bf73ac6SHong Zhang     svtx_idx--;
18712bf73ac6SHong Zhang 
18722bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1873daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
18742bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
18755c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
18769566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1877f11a936eSBarry Smith 
1878daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1879daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
18805c6496baSHong Zhang         net = sv[0];
188135cb6cd3SPierre Jolivet         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this process */
18822bf73ac6SHong Zhang       }
18832bf73ac6SHong Zhang     }
1884b9c6e19dSShri Abhyankar   }
1885b9c6e19dSShri Abhyankar 
18862bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
18872bf73ac6SHong Zhang   nv = 0;
1888daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1889daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1890caf410d2SHong Zhang 
18912bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1892daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1893daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1894daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1895daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1896daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1897daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
18982bf73ac6SHong Zhang 
1899daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1900daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1901caf410d2SHong Zhang 
19022bf73ac6SHong 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. */
1903daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1904b9c6e19dSShri Abhyankar   }
1905daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1906b9c6e19dSShri Abhyankar 
19072bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1908daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
19099566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
19105f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1911daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1912b9c6e19dSShri Abhyankar   }
1913b9c6e19dSShri Abhyankar 
19142bf73ac6SHong Zhang   nv = 0;
1915daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
19169566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
19175f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
19182bf73ac6SHong Zhang 
19192bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1920eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIGetWithDefault(newDMnetwork->cloneshared->svtable, header->index + 1, 0, &svtx_idx));
19212bf73ac6SHong Zhang     svtx_idx--;
19222bf73ac6SHong Zhang     if (svtx_idx < 0) {
1923daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
19242bf73ac6SHong Zhang     } else { /* a shared vertex */
1925daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
19262bf73ac6SHong Zhang 
19275c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
19289566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1929f11a936eSBarry Smith 
1930daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1931daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
19325c6496baSHong Zhang         net = sv[0];
19339371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1934b9c6e19dSShri Abhyankar       }
19352bf73ac6SHong Zhang     }
19362bf73ac6SHong Zhang   }
1937daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1938b9c6e19dSShri Abhyankar 
19398afb7921SAidan Hamilton   PetscCall(DMNetworkDistributeCoordinates(*dm, pointsf, newDM));
1940caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1941daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1942caf410d2SHong Zhang 
19432bf73ac6SHong Zhang   /* Free spaces */
19449566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
19459566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
194648a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
19472bf73ac6SHong Zhang 
19485b3f975aSHong Zhang   /* View distributed dmnetwork */
19499566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
19505b3f975aSHong Zhang 
1951d3464fd4SAdrian Maldonado   *dm = newDM;
1952e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
19533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19545f2c45f1SShri Abhyankar }
19555f2c45f1SShri Abhyankar 
195624121865SAdrian Maldonado /*@C
195720f4b53cSBarry Smith   PetscSFGetSubSF - Returns an `PetscSF` for a specific subset of points. Leaves are re-numbered to reflect the new ordering
19582bf73ac6SHong Zhang 
19592bf73ac6SHong Zhang  Collective
196024121865SAdrian Maldonado 
196124121865SAdrian Maldonado   Input Parameters:
196220f4b53cSBarry Smith + mainSF - `PetscSF` structure
196320f4b53cSBarry Smith - map - a `ISLocalToGlobalMapping` that contains the subset of points
196424121865SAdrian Maldonado 
196597bb3fdcSJose E. Roman   Output Parameter:
196620f4b53cSBarry Smith . subSF - a subset of the `mainSF` for the desired subset.
1967ee300463SSatish Balay 
1968ee300463SSatish Balay   Level: intermediate
196920f4b53cSBarry Smith 
197020f4b53cSBarry Smith .seealso: `PetscSF`
19717d928bffSSatish Balay @*/
1972d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1973d71ae5a4SJacob Faibussowitsch {
197424121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
197524121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
197624121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
197724121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
197824121865SAdrian Maldonado   const PetscInt    *ilocal;
197924121865SAdrian Maldonado   const PetscSFNode *iremote;
198024121865SAdrian Maldonado 
198124121865SAdrian Maldonado   PetscFunctionBegin;
19829566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
198324121865SAdrian Maldonado 
198424121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
19859566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
19869566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
198724121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
198824121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
198924121865SAdrian Maldonado   }
199024121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
19919566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
199224121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
19939566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
19949566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
19959566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
199624121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
19979566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
19989566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
199924121865SAdrian Maldonado   nleaves_sub = 0;
200024121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
200124121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
200224121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
20034b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
200424121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
200524121865SAdrian Maldonado       nleaves_sub += 1;
200624121865SAdrian Maldonado     }
200724121865SAdrian Maldonado   }
20089566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
20099566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
201024121865SAdrian Maldonado 
201124121865SAdrian Maldonado   /* Create new subSF */
2012e66d8692SHong Zhang   PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)mainsf), subSF));
20139566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
20149566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
20159566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
20169566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
20173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
201824121865SAdrian Maldonado }
201924121865SAdrian Maldonado 
20205f2c45f1SShri Abhyankar /*@C
20215f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
20225f2c45f1SShri Abhyankar 
20235f2c45f1SShri Abhyankar   Not Collective
20245f2c45f1SShri Abhyankar 
20255f2c45f1SShri Abhyankar   Input Parameters:
202620f4b53cSBarry Smith + dm - the `DMNETWORK` object
20275f2c45f1SShri Abhyankar - p  - the vertex point
20285f2c45f1SShri Abhyankar 
2029fd292e60Sprj-   Output Parameters:
20305f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
20312bf73ac6SHong Zhang - edges  - list of edge points
20325f2c45f1SShri Abhyankar 
203397bb938eSShri Abhyankar   Level: beginner
20345f2c45f1SShri Abhyankar 
203520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
20365f2c45f1SShri Abhyankar @*/
2037d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[])
2038d71ae5a4SJacob Faibussowitsch {
20395f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20405f2c45f1SShri Abhyankar 
20415f2c45f1SShri Abhyankar   PetscFunctionBegin;
20429566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
20439566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
20443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20455f2c45f1SShri Abhyankar }
20465f2c45f1SShri Abhyankar 
20475f2c45f1SShri Abhyankar /*@C
2048d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
20495f2c45f1SShri Abhyankar 
20505f2c45f1SShri Abhyankar   Not Collective
20515f2c45f1SShri Abhyankar 
20525f2c45f1SShri Abhyankar   Input Parameters:
205320f4b53cSBarry Smith + dm - the `DMNETWORK` object
20545f2c45f1SShri Abhyankar - p - the edge point
20555f2c45f1SShri Abhyankar 
20562fe279fdSBarry Smith   Output Parameter:
20575f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
20585f2c45f1SShri Abhyankar 
205997bb938eSShri Abhyankar   Level: beginner
20605f2c45f1SShri Abhyankar 
206120f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
20625f2c45f1SShri Abhyankar @*/
2063d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
2064d71ae5a4SJacob Faibussowitsch {
20655f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
20665f2c45f1SShri Abhyankar 
20675f2c45f1SShri Abhyankar   PetscFunctionBegin;
20689566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
20693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20705f2c45f1SShri Abhyankar }
20715f2c45f1SShri Abhyankar 
20725f2c45f1SShri Abhyankar /*@
207320f4b53cSBarry Smith   DMNetworkIsSharedVertex - Returns `PETSC_TRUE` if the vertex is shared by subnetworks
20742bf73ac6SHong Zhang 
20752bf73ac6SHong Zhang   Not Collective
20762bf73ac6SHong Zhang 
20772bf73ac6SHong Zhang   Input Parameters:
207820f4b53cSBarry Smith + dm - the `DMNETWORK` object
20792bf73ac6SHong Zhang - p - the vertex point
20802bf73ac6SHong Zhang 
20812bf73ac6SHong Zhang   Output Parameter:
208220f4b53cSBarry Smith . flag - `PETSC_TRUE` if the vertex is shared by subnetworks
20832bf73ac6SHong Zhang 
20842bf73ac6SHong Zhang   Level: beginner
20852bf73ac6SHong Zhang 
208620f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
20872bf73ac6SHong Zhang @*/
2088d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
2089d71ae5a4SJacob Faibussowitsch {
20902bf73ac6SHong Zhang   PetscFunctionBegin;
2091eec179cfSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2092eec179cfSJacob Faibussowitsch   PetscValidBoolPointer(flag, 3);
20932bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
20942bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
20952bf73ac6SHong Zhang     PetscInt    gidx;
2096eec179cfSJacob Faibussowitsch 
20979566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
2098eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIHas(network->cloneshared->svtable, gidx + 1, flag));
20992bf73ac6SHong Zhang   } else { /* would be removed? */
21002bf73ac6SHong Zhang     PetscInt        nv;
21012bf73ac6SHong Zhang     const PetscInt *vtx;
2102eec179cfSJacob Faibussowitsch 
21039566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
2104eec179cfSJacob Faibussowitsch     for (PetscInt i = 0; i < nv; i++) {
21052bf73ac6SHong Zhang       if (p == vtx[i]) {
21062bf73ac6SHong Zhang         *flag = PETSC_TRUE;
21073ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
21082bf73ac6SHong Zhang       }
21092bf73ac6SHong Zhang     }
2110eec179cfSJacob Faibussowitsch     *flag = PETSC_FALSE;
21112bf73ac6SHong Zhang   }
21123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21132bf73ac6SHong Zhang }
21142bf73ac6SHong Zhang 
21152bf73ac6SHong Zhang /*@
211620f4b53cSBarry Smith   DMNetworkIsGhostVertex - Returns `PETSC_TRUE` if the vertex is a ghost vertex
21175f2c45f1SShri Abhyankar 
21185f2c45f1SShri Abhyankar   Not Collective
21195f2c45f1SShri Abhyankar 
21205f2c45f1SShri Abhyankar   Input Parameters:
212120f4b53cSBarry Smith + dm - the `DMNETWORK` object
2122a2b725a8SWilliam Gropp - p - the vertex point
21235f2c45f1SShri Abhyankar 
21245f2c45f1SShri Abhyankar   Output Parameter:
212520f4b53cSBarry Smith . isghost - `PETSC_TRUE` if the vertex is a ghost point
21265f2c45f1SShri Abhyankar 
212797bb938eSShri Abhyankar   Level: beginner
21285f2c45f1SShri Abhyankar 
212920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
21305f2c45f1SShri Abhyankar @*/
2131d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
2132d71ae5a4SJacob Faibussowitsch {
21335f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
21345f2c45f1SShri Abhyankar   PetscInt     offsetg;
21355f2c45f1SShri Abhyankar   PetscSection sectiong;
21365f2c45f1SShri Abhyankar 
21375f2c45f1SShri Abhyankar   PetscFunctionBegin;
21385f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
21399566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
21409566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
21415f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
21423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21435f2c45f1SShri Abhyankar }
21445f2c45f1SShri Abhyankar 
2145d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
2146d71ae5a4SJacob Faibussowitsch {
21475f2c45f1SShri Abhyankar   PetscFunctionBegin;
2148e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2149daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
21505b3f975aSHong Zhang   /* View dmnetwork */
21519566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2152e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
21533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21545f2c45f1SShri Abhyankar }
21555f2c45f1SShri Abhyankar 
21561ad426b7SHong Zhang /*@
215717df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
215820f4b53cSBarry Smith       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TRUE)?
21591ad426b7SHong Zhang 
21601ad426b7SHong Zhang   Collective
21611ad426b7SHong Zhang 
21621ad426b7SHong Zhang   Input Parameters:
216320f4b53cSBarry Smith + dm - the `DMNETWORK` object
216420f4b53cSBarry Smith . eflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for edges
216520f4b53cSBarry Smith - vflg - turn the option on (`PETSC_TRUE`) or off (`PETSC_FALSE`) if user provides Jacobian for vertices
21661ad426b7SHong Zhang 
21671ad426b7SHong Zhang  Level: intermediate
21681ad426b7SHong Zhang 
21691ad426b7SHong Zhang @*/
2170d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2171d71ae5a4SJacob Faibussowitsch {
21721ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2173daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
21741ad426b7SHong Zhang 
21751ad426b7SHong Zhang   PetscFunctionBegin;
217683b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
217783b2e829SHong Zhang   network->userVertexJacobian = vflg;
21788675203cSHong Zhang 
217948a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
21808675203cSHong Zhang 
218166b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2182daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
218366b4e0ffSHong Zhang     PetscInt        nedges_total;
21848675203cSHong Zhang     const PetscInt *edges;
21858675203cSHong Zhang 
21868675203cSHong Zhang     /* count nvertex_total */
21878675203cSHong Zhang     nedges_total = 0;
21889566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
21898675203cSHong Zhang 
21908675203cSHong Zhang     vptr[0] = 0;
21918675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
21929566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
21938675203cSHong Zhang       nedges_total += nedges;
21948675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
21958675203cSHong Zhang     }
21968675203cSHong Zhang 
21979566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
21988675203cSHong Zhang     network->Jvptr = vptr;
21998675203cSHong Zhang   }
22003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22011ad426b7SHong Zhang }
22021ad426b7SHong Zhang 
22031ad426b7SHong Zhang /*@
220483b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
220583b2e829SHong Zhang 
220683b2e829SHong Zhang   Not Collective
220783b2e829SHong Zhang 
220883b2e829SHong Zhang   Input Parameters:
220920f4b53cSBarry Smith + dm - the `DMNETWORK` object
221083b2e829SHong Zhang . p - the edge point
22113e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
22123e97b6e8SHong Zhang         J[0]: this edge
221320f4b53cSBarry Smith         J[1] and J[2]: connected vertices, obtained by calling `DMNetworkGetConnectedVertices()`
221483b2e829SHong Zhang 
221597bb938eSShri Abhyankar   Level: advanced
221683b2e829SHong Zhang 
221720f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkVertexSetMatrix()`
221883b2e829SHong Zhang @*/
2219d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2220d71ae5a4SJacob Faibussowitsch {
222183b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
222283b2e829SHong Zhang 
222383b2e829SHong Zhang   PetscFunctionBegin;
22245c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
22258675203cSHong Zhang 
22268675203cSHong Zhang   if (J) {
2227883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2228883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2229883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
22308675203cSHong Zhang   }
22313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
223283b2e829SHong Zhang }
223383b2e829SHong Zhang 
223483b2e829SHong Zhang /*@
223576ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
22361ad426b7SHong Zhang 
22371ad426b7SHong Zhang   Not Collective
22381ad426b7SHong Zhang 
22391ad426b7SHong Zhang   Input Parameters:
224020f4b53cSBarry Smith + dm - The `DMNETWORK` object
22411ad426b7SHong Zhang . p - the vertex point
22423e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
22433e97b6e8SHong Zhang         J[0]:       this vertex
22443e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
22453e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
22461ad426b7SHong Zhang 
224797bb938eSShri Abhyankar   Level: advanced
22481ad426b7SHong Zhang 
224920f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkEdgeSetMatrix()`
22501ad426b7SHong Zhang @*/
2251d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2252d71ae5a4SJacob Faibussowitsch {
22535f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2254daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2255883e35e8SHong Zhang   const PetscInt *edges;
22565f2c45f1SShri Abhyankar 
22575f2c45f1SShri Abhyankar   PetscFunctionBegin;
22585c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2259883e35e8SHong Zhang 
22608675203cSHong Zhang   if (J) {
2261883e35e8SHong Zhang     vptr                          = network->Jvptr;
22623e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
22633e97b6e8SHong Zhang 
22643e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
22659566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2266883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
22678675203cSHong Zhang   }
22683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2269883e35e8SHong Zhang }
2270883e35e8SHong Zhang 
2271d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2272d71ae5a4SJacob Faibussowitsch {
22735cf7da58SHong Zhang   PetscInt    j;
22745cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
22755cf7da58SHong Zhang 
22765cf7da58SHong Zhang   PetscFunctionBegin;
22775cf7da58SHong Zhang   if (!ghost) {
227848a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22795cf7da58SHong Zhang   } else {
228048a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
22815cf7da58SHong Zhang   }
22823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22835cf7da58SHong Zhang }
22845cf7da58SHong Zhang 
2285d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2286d71ae5a4SJacob Faibussowitsch {
22875cf7da58SHong Zhang   PetscInt    j, ncols_u;
22885cf7da58SHong Zhang   PetscScalar val;
22895cf7da58SHong Zhang 
22905cf7da58SHong Zhang   PetscFunctionBegin;
22915cf7da58SHong Zhang   if (!ghost) {
22925cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
22939566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
22945cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
22959566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
22969566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
22975cf7da58SHong Zhang     }
22985cf7da58SHong Zhang   } else {
22995cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
23009566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
23015cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
23029566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
23039566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
23045cf7da58SHong Zhang     }
23055cf7da58SHong Zhang   }
23063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23075cf7da58SHong Zhang }
23085cf7da58SHong Zhang 
2309d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2310d71ae5a4SJacob Faibussowitsch {
23115cf7da58SHong Zhang   PetscFunctionBegin;
23125cf7da58SHong Zhang   if (Ju) {
23139566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
23145cf7da58SHong Zhang   } else {
23159566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
23165cf7da58SHong Zhang   }
23173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23185cf7da58SHong Zhang }
23195cf7da58SHong Zhang 
2320d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2321d71ae5a4SJacob Faibussowitsch {
2322883e35e8SHong Zhang   PetscInt     j, *cols;
2323883e35e8SHong Zhang   PetscScalar *zeros;
2324883e35e8SHong Zhang 
2325883e35e8SHong Zhang   PetscFunctionBegin;
23269566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2327883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
23289566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
23299566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
23303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23311ad426b7SHong Zhang }
2332a4e85ca8SHong Zhang 
2333d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2334d71ae5a4SJacob Faibussowitsch {
23353e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
23363e97b6e8SHong Zhang   const PetscInt *cols;
23373e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
23383e97b6e8SHong Zhang 
23393e97b6e8SHong Zhang   PetscFunctionBegin;
23409566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
234163a3b9bcSJacob 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);
23423e97b6e8SHong Zhang 
23433e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
23449566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
23453e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
23463e97b6e8SHong Zhang       col = cols[j] + cstart;
23479566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
23483e97b6e8SHong Zhang     }
23499566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
23503e97b6e8SHong Zhang   }
23513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23523e97b6e8SHong Zhang }
23531ad426b7SHong Zhang 
2354d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2355d71ae5a4SJacob Faibussowitsch {
2356a4e85ca8SHong Zhang   PetscFunctionBegin;
2357a4e85ca8SHong Zhang   if (Ju) {
23589566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2359a4e85ca8SHong Zhang   } else {
23609566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2361a4e85ca8SHong Zhang   }
23623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2363a4e85ca8SHong Zhang }
2364a4e85ca8SHong Zhang 
236524121865SAdrian 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.
236624121865SAdrian Maldonado */
2367d71ae5a4SJacob Faibussowitsch PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2368d71ae5a4SJacob Faibussowitsch {
236924121865SAdrian Maldonado   PetscInt  i, size, dof;
237024121865SAdrian Maldonado   PetscInt *glob2loc;
237124121865SAdrian Maldonado 
237224121865SAdrian Maldonado   PetscFunctionBegin;
23739566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
23749566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
237524121865SAdrian Maldonado 
237624121865SAdrian Maldonado   for (i = 0; i < size; i++) {
23779566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
237824121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
237924121865SAdrian Maldonado     glob2loc[i] = dof;
238024121865SAdrian Maldonado   }
238124121865SAdrian Maldonado 
2382e66d8692SHong Zhang   PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)globalsec), 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
238324121865SAdrian Maldonado #if 0
23849566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
238524121865SAdrian Maldonado #endif
23863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
238724121865SAdrian Maldonado }
238824121865SAdrian Maldonado 
238901ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
23909e1d080bSHong Zhang 
2391d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2392d71ae5a4SJacob Faibussowitsch {
23931ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
239424121865SAdrian Maldonado   PetscInt               eDof, vDof;
239524121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
23969e1d080bSHong Zhang   MPI_Comm               comm;
239724121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
239824121865SAdrian Maldonado 
23999e1d080bSHong Zhang   PetscFunctionBegin;
24009566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
240124121865SAdrian Maldonado 
24029566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
24039566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
240424121865SAdrian Maldonado 
24059566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
24069566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24079566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
240824121865SAdrian Maldonado 
24099566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
24109566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24119566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
241224121865SAdrian Maldonado 
24139566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
24149566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
24159566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
241624121865SAdrian Maldonado 
24179566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
24189566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
24199566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
242024121865SAdrian Maldonado 
24213f6a6bdaSHong Zhang   bA[0][0] = j11;
24223f6a6bdaSHong Zhang   bA[0][1] = j12;
24233f6a6bdaSHong Zhang   bA[1][0] = j21;
24243f6a6bdaSHong Zhang   bA[1][1] = j22;
242524121865SAdrian Maldonado 
24269566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
24279566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
242824121865SAdrian Maldonado 
24299566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
24309566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
24319566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
24329566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
243324121865SAdrian Maldonado 
24349566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
24359566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
24369566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
24379566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
243824121865SAdrian Maldonado 
24399566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
24409566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
24419566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
24429566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
24439566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
24449566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
24459566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
244624121865SAdrian Maldonado 
24479566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
24489566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
24499566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
245024121865SAdrian Maldonado 
245124121865SAdrian Maldonado   /* Free structures */
24529566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
24539566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
24543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24559e1d080bSHong Zhang }
24569e1d080bSHong Zhang 
2457d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2458d71ae5a4SJacob Faibussowitsch {
24599e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
24609e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
24619e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
24629e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
24639e1d080bSHong Zhang   Mat             Juser;
24649e1d080bSHong Zhang   PetscSection    sectionGlobal;
24659e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
24669e1d080bSHong Zhang   const PetscInt *edges, *cone;
24679e1d080bSHong Zhang   MPI_Comm        comm;
24689e1d080bSHong Zhang   MatType         mtype;
24699e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
24709e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
24719e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
24729e1d080bSHong Zhang 
24739e1d080bSHong Zhang   PetscFunctionBegin;
24749e1d080bSHong Zhang   mtype = dm->mattype;
24759566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
24769e1d080bSHong Zhang   if (isNest) {
24779566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
24789566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24793ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24809e1d080bSHong Zhang   }
24819e1d080bSHong Zhang 
24829e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2483a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
24849566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
24859566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
24863ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
24871ad426b7SHong Zhang   }
24881ad426b7SHong Zhang 
24899566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
24909566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
24919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
24929566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
24932a945128SHong Zhang 
24949566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
24959566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
249689898e50SHong Zhang 
249789898e50SHong Zhang   /* (1) Set matrix preallocation */
249889898e50SHong Zhang   /*------------------------------*/
24999566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
25009566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
25019566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
25029566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
25039566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
25049566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2505840c2264SHong Zhang 
250689898e50SHong Zhang   /* Set preallocation for edges */
250789898e50SHong Zhang   /*-----------------------------*/
25089566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2509840c2264SHong Zhang 
25109566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2511840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2512840c2264SHong Zhang     /* Get row indices */
25139566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
25149566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2515840c2264SHong Zhang     if (nrows) {
2516840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2517840c2264SHong Zhang 
2518a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
25199566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2520840c2264SHong Zhang       for (v = 0; v < 2; v++) {
25219566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2522840c2264SHong Zhang 
25238675203cSHong Zhang         if (network->Je) {
2524840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
25258675203cSHong Zhang         } else Juser = NULL;
25269566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
25279566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2528840c2264SHong Zhang       }
2529840c2264SHong Zhang 
253089898e50SHong Zhang       /* Set preallocation for edge self */
2531840c2264SHong Zhang       cstart = rstart;
25328675203cSHong Zhang       if (network->Je) {
2533840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25348675203cSHong Zhang       } else Juser = NULL;
25359566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2536840c2264SHong Zhang     }
2537840c2264SHong Zhang   }
2538840c2264SHong Zhang 
253989898e50SHong Zhang   /* Set preallocation for vertices */
254089898e50SHong Zhang   /*--------------------------------*/
25419566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
25428675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2543840c2264SHong Zhang 
2544840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2545840c2264SHong Zhang     /* Get row indices */
25469566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25479566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2548840c2264SHong Zhang     if (!nrows) continue;
2549840c2264SHong Zhang 
25509566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2551bdcb62a2SHong Zhang     if (ghost) {
25529566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2553bdcb62a2SHong Zhang     } else {
2554bdcb62a2SHong Zhang       rows_v = rows;
2555bdcb62a2SHong Zhang     }
2556bdcb62a2SHong Zhang 
2557bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2558840c2264SHong Zhang 
2559840c2264SHong Zhang     /* Get supporting edges and connected vertices */
25609566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2561840c2264SHong Zhang 
2562840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2563840c2264SHong Zhang       /* Supporting edges */
25649566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25659566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2566840c2264SHong Zhang 
25678675203cSHong Zhang       if (network->Jv) {
2568840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25698675203cSHong Zhang       } else Juser = NULL;
25709566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2571840c2264SHong Zhang 
2572840c2264SHong Zhang       /* Connected vertices */
25739566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2574840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25759566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2576840c2264SHong Zhang 
25779566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2578840c2264SHong Zhang 
25798675203cSHong Zhang       if (network->Jv) {
2580840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25818675203cSHong Zhang       } else Juser = NULL;
2582e102a522SHong Zhang       if (ghost_vc || ghost) {
2583e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2584e102a522SHong Zhang       } else {
2585e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2586e102a522SHong Zhang       }
25879566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2588840c2264SHong Zhang     }
2589840c2264SHong Zhang 
259089898e50SHong Zhang     /* Set preallocation for vertex self */
25919566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2592840c2264SHong Zhang     if (!ghost) {
25939566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
25948675203cSHong Zhang       if (network->Jv) {
2595840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25968675203cSHong Zhang       } else Juser = NULL;
25979566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2598840c2264SHong Zhang     }
25991baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2600840c2264SHong Zhang   }
2601840c2264SHong Zhang 
26029566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
26039566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
26045cf7da58SHong Zhang 
26059566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
26065cf7da58SHong Zhang 
26079566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
26089566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2609840c2264SHong Zhang 
26109566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
26119566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2612840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2613e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2614e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2615840c2264SHong Zhang   }
26169566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
26179566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
26189566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
26199566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2620840c2264SHong Zhang 
26219566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
26229566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
26239566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
26245cf7da58SHong Zhang 
26259566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
26265cf7da58SHong Zhang 
262789898e50SHong Zhang   /* (2) Set matrix entries for edges */
262889898e50SHong Zhang   /*----------------------------------*/
26291ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2630bfbc38dcSHong Zhang     /* Get row indices */
26319566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
26329566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
26334b976069SHong Zhang     if (nrows) {
263417df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
26351ad426b7SHong Zhang 
2636a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
26379566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2638bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
26399566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
26409566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
26413e97b6e8SHong Zhang 
26428675203cSHong Zhang         if (network->Je) {
2643a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
26448675203cSHong Zhang         } else Juser = NULL;
26459566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2646bfbc38dcSHong Zhang       }
264717df6e9eSHong Zhang 
2648bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
26493e97b6e8SHong Zhang       cstart = rstart;
26508675203cSHong Zhang       if (network->Je) {
2651a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
26528675203cSHong Zhang       } else Juser = NULL;
26539566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
26541ad426b7SHong Zhang     }
26554b976069SHong Zhang   }
26561ad426b7SHong Zhang 
2657bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
265883b2e829SHong Zhang   /*---------------------------------*/
26591ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2660bfbc38dcSHong Zhang     /* Get row indices */
26619566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
26629566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
26634b976069SHong Zhang     if (!nrows) continue;
2664596e729fSHong Zhang 
26659566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2666bdcb62a2SHong Zhang     if (ghost) {
26679566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2668bdcb62a2SHong Zhang     } else {
2669bdcb62a2SHong Zhang       rows_v = rows;
2670bdcb62a2SHong Zhang     }
2671bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2672596e729fSHong Zhang 
2673bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
26749566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2675596e729fSHong Zhang 
2676596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2677bfbc38dcSHong Zhang       /* Supporting edges */
26789566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
26799566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2680596e729fSHong Zhang 
26818675203cSHong Zhang       if (network->Jv) {
2682a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
26838675203cSHong Zhang       } else Juser = NULL;
26849566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2685596e729fSHong Zhang 
2686bfbc38dcSHong Zhang       /* Connected vertices */
26879566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
26882a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
26892a945128SHong Zhang 
26909566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
26919566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2692a4e85ca8SHong Zhang 
26938675203cSHong Zhang       if (network->Jv) {
2694a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
26958675203cSHong Zhang       } else Juser = NULL;
26969566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2697596e729fSHong Zhang     }
2698596e729fSHong Zhang 
2699bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
27001ad426b7SHong Zhang     if (!ghost) {
27019566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
27028675203cSHong Zhang       if (network->Jv) {
2703a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
27048675203cSHong Zhang       } else Juser = NULL;
27059566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2706bdcb62a2SHong Zhang     }
27071baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
27081ad426b7SHong Zhang   }
27099566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2710bdcb62a2SHong Zhang 
27119566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
27129566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2713dd6f46cdSHong Zhang 
27149566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
27153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27165f2c45f1SShri Abhyankar }
27175f2c45f1SShri Abhyankar 
2718d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2719d71ae5a4SJacob Faibussowitsch {
2720daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2721daad07d3SAidan Hamilton   PetscInt    j, np;
2722daad07d3SAidan Hamilton 
2723daad07d3SAidan Hamilton   PetscFunctionBegin;
2724daad07d3SAidan Hamilton   if (network->header) {
2725daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2726daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2727daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2728daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2729daad07d3SAidan Hamilton     }
2730daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2731daad07d3SAidan Hamilton   }
27323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2733daad07d3SAidan Hamilton }
2734daad07d3SAidan Hamilton 
2735d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2736d71ae5a4SJacob Faibussowitsch {
27375f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2738aeb78aa7SBarry Smith   PetscInt    j;
27395f2c45f1SShri Abhyankar 
27405f2c45f1SShri Abhyankar   PetscFunctionBegin;
2741daad07d3SAidan Hamilton   /*
2742daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2743daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2744daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2745daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2746daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2747daad07d3SAidan Hamilton   */
2748daad07d3SAidan Hamilton 
2749daad07d3SAidan Hamilton   /* Always destroy data ON the network */
27509566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
275183b2e829SHong Zhang   if (network->Jv) {
27529566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
27539566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
27541ad426b7SHong Zhang   }
2755daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2756daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2757daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2758daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2759daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
276013c2a604SAdrian Maldonado 
2761daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2762daad07d3SAidan Hamilton 
2763daad07d3SAidan Hamilton   /*
2764daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2765daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2766daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2767daad07d3SAidan Hamilton     PetscSF                           sf;
2768daad07d3SAidan Hamilton   and data ON the network
2769daad07d3SAidan Hamilton     PetscSection                      DofSection;
2770daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2771daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2772daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2773daad07d3SAidan Hamilton   for any clone.
2774daad07d3SAidan Hamilton   */
27759566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
27769566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
27779566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
27789566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
277913c2a604SAdrian Maldonado   /* edge */
27809566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
27819566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
27829566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
27839566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2784*5f25b224SDuncan Campbell   /* viewer options */
2785*5f25b224SDuncan Campbell   PetscCall(ISDestroy(&network->vieweroptions.viewranks));
2786daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2787daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2788daad07d3SAidan 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
2789daad07d3SAidan Hamilton      naively think it can be reused. */
2790daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2791daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2792daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2793daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2794eec179cfSJacob Faibussowitsch     PetscCall(PetscHMapIDestroy(&network->cloneshared->svtable));
2795daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2796daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2797daad07d3SAidan Hamilton   }
2798daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
27993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28005f2c45f1SShri Abhyankar }
28015f2c45f1SShri Abhyankar 
2802d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2803d71ae5a4SJacob Faibussowitsch {
28045f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28055f2c45f1SShri Abhyankar 
28065f2c45f1SShri Abhyankar   PetscFunctionBegin;
28079566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
28083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28095f2c45f1SShri Abhyankar }
28105f2c45f1SShri Abhyankar 
2811d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2812d71ae5a4SJacob Faibussowitsch {
28135f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28145f2c45f1SShri Abhyankar 
28155f2c45f1SShri Abhyankar   PetscFunctionBegin;
28169566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
28173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28185f2c45f1SShri Abhyankar }
28195f2c45f1SShri Abhyankar 
2820d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2821d71ae5a4SJacob Faibussowitsch {
28225f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28235f2c45f1SShri Abhyankar 
28245f2c45f1SShri Abhyankar   PetscFunctionBegin;
28259566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
28263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28275f2c45f1SShri Abhyankar }
28285f2c45f1SShri Abhyankar 
2829d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2830d71ae5a4SJacob Faibussowitsch {
28315f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
28325f2c45f1SShri Abhyankar 
28335f2c45f1SShri Abhyankar   PetscFunctionBegin;
28349566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
28353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28365f2c45f1SShri Abhyankar }
283722bbedd7SHong Zhang 
283822bbedd7SHong Zhang /*@
283964238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
284022bbedd7SHong Zhang 
284120f4b53cSBarry Smith   Not Collective
284222bbedd7SHong Zhang 
28437a7aea1fSJed Brown   Input Parameters:
284420f4b53cSBarry Smith + dm - the `DMNETWORK` object
284522bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
284622bbedd7SHong Zhang 
28472fe279fdSBarry Smith   Output Parameter:
2848f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
284922bbedd7SHong Zhang 
285097bb938eSShri Abhyankar   Level: advanced
285122bbedd7SHong Zhang 
285220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkSetVertexLocalToGlobalOrdering()`
285322bbedd7SHong Zhang @*/
2854d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2855d71ae5a4SJacob Faibussowitsch {
285622bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2857daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
285822bbedd7SHong Zhang 
285922bbedd7SHong Zhang   PetscFunctionBegin;
28605c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
286122bbedd7SHong Zhang   *vg = vltog[vloc];
28623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
286322bbedd7SHong Zhang }
286422bbedd7SHong Zhang 
286522bbedd7SHong Zhang /*@
286664238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
286722bbedd7SHong Zhang 
286822bbedd7SHong Zhang   Collective
286922bbedd7SHong Zhang 
287022bbedd7SHong Zhang   Input Parameters:
287120f4b53cSBarry Smith . dm - the `DMNETWORK` object
287222bbedd7SHong Zhang 
287397bb938eSShri Abhyankar   Level: advanced
287422bbedd7SHong Zhang 
287520f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkGetGlobalVertexIndex()`
287622bbedd7SHong Zhang @*/
2877d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2878d71ae5a4SJacob Faibussowitsch {
287922bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
288022bbedd7SHong Zhang   MPI_Comm           comm;
28812bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
288222bbedd7SHong Zhang   PetscBool          ghost;
288363029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
288422bbedd7SHong Zhang   const PetscSFNode *iremote;
288522bbedd7SHong Zhang   PetscSF            vsf;
288663029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
288763029d29SHong Zhang   VecScatter         ctx;
288863029d29SHong Zhang   PetscScalar       *varr, val;
288963029d29SHong Zhang   const PetscScalar *varr_read;
289022bbedd7SHong Zhang 
289122bbedd7SHong Zhang   PetscFunctionBegin;
28929566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
28939566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
28949566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
289522bbedd7SHong Zhang 
289622bbedd7SHong Zhang   if (size == 1) {
2897daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
28989566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
289922bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2900daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
29013ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
290222bbedd7SHong Zhang   }
290322bbedd7SHong Zhang 
2904daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2905daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
290622bbedd7SHong Zhang 
2907e66d8692SHong Zhang   PetscCall(DMNetworkSetSubMap_private(dm, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
29089566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
290922bbedd7SHong Zhang   vsf = network->vertex.sf;
291022bbedd7SHong Zhang 
29119566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
29129566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
291322bbedd7SHong Zhang 
29149371c9d4SSatish Balay   for (i = 0; i < size; i++) {
29159371c9d4SSatish Balay     displs[i]     = i;
29169371c9d4SSatish Balay     recvcounts[i] = 1;
29179371c9d4SSatish Balay   }
291822bbedd7SHong Zhang 
291922bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
292022bbedd7SHong Zhang   vrange[0] = 0;
29219566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
2922ad540459SPierre Jolivet   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
292322bbedd7SHong Zhang 
29249566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2925daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
292622bbedd7SHong Zhang 
292763029d29SHong Zhang   /* Set vltog for non-ghost vertices */
292863029d29SHong Zhang   k = 0;
292922bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2930daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
293163029d29SHong Zhang     if (ghost) continue;
293263029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
293322bbedd7SHong Zhang   }
29349566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
293563029d29SHong Zhang 
293663029d29SHong Zhang   /* Set vltog for ghost vertices */
293763029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
29389566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
29399566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
29409566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
29419566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
294263029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
294363029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
294463029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
294563029d29SHong Zhang   }
29469566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
294763029d29SHong Zhang 
294863029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
29499566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
29509566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
29519566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
295263029d29SHong Zhang 
295363029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
29549566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
29559566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
295663029d29SHong Zhang   for (i = 0; i < N; i += 2) {
29572e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
295863029d29SHong Zhang     if (remoterank == rank) {
295963029d29SHong Zhang       k    = i + 1; /* row number */
29602e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
296163029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
29629566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
296363029d29SHong Zhang     }
296463029d29SHong Zhang   }
29659566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
29669566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
29679566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
296863029d29SHong Zhang 
296963029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
29709566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
297163029d29SHong Zhang   k = 0;
297263029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2973daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
297463029d29SHong Zhang     if (!ghost) continue;
29759371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
29769371c9d4SSatish Balay     k++;
297763029d29SHong Zhang   }
29789566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
297963029d29SHong Zhang 
29809566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
29819566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
29829566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
29833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
298422bbedd7SHong Zhang }
298542dc13f1SHong Zhang 
2986d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2987d71ae5a4SJacob Faibussowitsch {
298842dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
298942dc13f1SHong Zhang   DMNetworkComponentHeader header;
299042dc13f1SHong Zhang 
299142dc13f1SHong Zhang   PetscFunctionBegin;
29929566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
299342dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
299442dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
299542dc13f1SHong Zhang 
299642dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
299742dc13f1SHong Zhang     key  = header->key[i];
299842dc13f1SHong Zhang     nvar = header->nvar[i];
299942dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
300042dc13f1SHong Zhang       if (key == keys[j]) {
300142dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
300242dc13f1SHong Zhang           *nidx += nvar;
300342dc13f1SHong Zhang         } else {
300442dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
300542dc13f1SHong Zhang         }
300642dc13f1SHong Zhang       }
300742dc13f1SHong Zhang     }
300842dc13f1SHong Zhang   }
30093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
301042dc13f1SHong Zhang }
301142dc13f1SHong Zhang 
3012d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3013d71ae5a4SJacob Faibussowitsch {
301442dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
301542dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
301642dc13f1SHong Zhang   DMNetworkComponentHeader header;
301742dc13f1SHong Zhang 
301842dc13f1SHong Zhang   PetscFunctionBegin;
30199566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
302042dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
302142dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
302242dc13f1SHong Zhang 
302342dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
302442dc13f1SHong Zhang     key  = header->key[i];
302542dc13f1SHong Zhang     nvar = header->nvar[i];
302642dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
302742dc13f1SHong Zhang       if (key != keys[j]) continue;
302842dc13f1SHong Zhang 
30299566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
303042dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
303142dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
303242dc13f1SHong Zhang       } else {
303342dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
303442dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
303542dc13f1SHong Zhang         }
303642dc13f1SHong Zhang       }
303742dc13f1SHong Zhang     }
303842dc13f1SHong Zhang   }
30393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
304042dc13f1SHong Zhang }
304142dc13f1SHong Zhang 
304242dc13f1SHong Zhang /*@
304342dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
304442dc13f1SHong Zhang 
304542dc13f1SHong Zhang   Collective
304642dc13f1SHong Zhang 
304742dc13f1SHong Zhang   Input Parameters:
304820f4b53cSBarry Smith + dm - `DMNETWORK` object
304942dc13f1SHong Zhang . numkeys - number of keys
305042dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
305142dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
305242dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
305342dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
305442dc13f1SHong Zhang 
30552fe279fdSBarry Smith   Output Parameter:
305642dc13f1SHong Zhang . is - the index set
305742dc13f1SHong Zhang 
305820f4b53cSBarry Smith   Level: advanced
305942dc13f1SHong Zhang 
306042dc13f1SHong Zhang   Notes:
306120f4b53cSBarry Smith     Use blocksize[i] of -1 to indicate select all the variables of the i-th component, for which nselectvar[i] and selectedvar[i] are ignored. Use` NULL`, `NULL`, `NULL` to indicate for all selected components one wishes to obtain all the values of that component. For example, `DMNetworkCreateIS`(dm,1,&key,NULL,NULL,NULL,&is) will return an is that extracts all the variables for the 0-th component.
306242dc13f1SHong Zhang 
306320f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
306442dc13f1SHong Zhang @*/
3065d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3066d71ae5a4SJacob Faibussowitsch {
306742dc13f1SHong Zhang   MPI_Comm    comm;
306842dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
306942dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
307042dc13f1SHong Zhang   PetscBool   ghost;
307142dc13f1SHong Zhang 
307242dc13f1SHong Zhang   PetscFunctionBegin;
30739566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
307442dc13f1SHong Zhang 
307542dc13f1SHong Zhang   /* Check input parameters */
307642dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
307742dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
307863a3b9bcSJacob 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]);
307942dc13f1SHong Zhang   }
308042dc13f1SHong Zhang 
30819566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
30829566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
308342dc13f1SHong Zhang 
308442dc13f1SHong Zhang   /* Get local number of idx */
308542dc13f1SHong Zhang   nidx = 0;
308648a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
308742dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30889566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
308942dc13f1SHong Zhang     if (ghost) continue;
30909566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
309142dc13f1SHong Zhang   }
309242dc13f1SHong Zhang 
309342dc13f1SHong Zhang   /* Compute idx */
30949566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
309542dc13f1SHong Zhang   i = 0;
309648a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
309742dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30989566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
309942dc13f1SHong Zhang     if (ghost) continue;
31009566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
310142dc13f1SHong Zhang   }
310242dc13f1SHong Zhang 
310342dc13f1SHong Zhang   /* Create is */
31049566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
31059566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
310742dc13f1SHong Zhang }
310842dc13f1SHong Zhang 
3109d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3110d71ae5a4SJacob Faibussowitsch {
311142dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
311242dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
311342dc13f1SHong Zhang   DMNetworkComponentHeader header;
311442dc13f1SHong Zhang 
311542dc13f1SHong Zhang   PetscFunctionBegin;
31169566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
311742dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
311842dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
311942dc13f1SHong Zhang 
312042dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
312142dc13f1SHong Zhang     key  = header->key[i];
312242dc13f1SHong Zhang     nvar = header->nvar[i];
312342dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
312442dc13f1SHong Zhang       if (key != keys[j]) continue;
312542dc13f1SHong Zhang 
31269566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
312742dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
312842dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
312942dc13f1SHong Zhang       } else {
313042dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
313142dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
313242dc13f1SHong Zhang         }
313342dc13f1SHong Zhang       }
313442dc13f1SHong Zhang     }
313542dc13f1SHong Zhang   }
31363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
313742dc13f1SHong Zhang }
313842dc13f1SHong Zhang 
313942dc13f1SHong Zhang /*@
314042dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
314142dc13f1SHong Zhang 
314220f4b53cSBarry Smith   Not Collective
314342dc13f1SHong Zhang 
314442dc13f1SHong Zhang   Input Parameters:
314520f4b53cSBarry Smith + dm - `DMNETWORK` object
314642dc13f1SHong Zhang . numkeys - number of keys
314742dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
314842dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
314942dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
315042dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
315142dc13f1SHong Zhang 
31522fe279fdSBarry Smith   Output Parameter:
315342dc13f1SHong Zhang . is - the index set
315442dc13f1SHong Zhang 
315520f4b53cSBarry Smith   Level: advanced
315642dc13f1SHong Zhang 
315742dc13f1SHong Zhang   Notes:
315820f4b53cSBarry Smith     Use blocksize[i] of -1 to indicate select all the variables of the i-th component, for which nselectvar[i] and selectedvar[i] are ignored. Use `NULL`, `NULL`, `NULL` to indicate for all selected components one wishes to obtain all the values of that component. For example, `DMNetworkCreateLocalIS`(dm,1,&key,`NULL`,`NULL`,`NULL`,&is) will return an is that extracts all the variables for the 0-th component.
315942dc13f1SHong Zhang 
3160*5f25b224SDuncan Campbell .seealso: `DM`, `DMNETWORK`, `DMNetworkCreate()`, `DMNetworkCreateIS()`, `ISCreateGeneral()`
316142dc13f1SHong Zhang @*/
3162d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3163d71ae5a4SJacob Faibussowitsch {
316442dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
316542dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
316642dc13f1SHong Zhang 
316742dc13f1SHong Zhang   PetscFunctionBegin;
316842dc13f1SHong Zhang   /* Check input parameters */
316942dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
317042dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
317163a3b9bcSJacob 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]);
317242dc13f1SHong Zhang   }
317342dc13f1SHong Zhang 
3174daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3175daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
317642dc13f1SHong Zhang 
317742dc13f1SHong Zhang   /* Get local number of idx */
317842dc13f1SHong Zhang   nidx = 0;
317948a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
318042dc13f1SHong Zhang 
318142dc13f1SHong Zhang   /* Compute local idx */
31829566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
318342dc13f1SHong Zhang   i = 0;
318448a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
318542dc13f1SHong Zhang 
318642dc13f1SHong Zhang   /* Create is */
31879566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31889566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
31893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
319042dc13f1SHong Zhang }
3191daad07d3SAidan Hamilton /*@
3192d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3193daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3194daad07d3SAidan Hamilton 
3195daad07d3SAidan Hamilton   Collective
3196daad07d3SAidan Hamilton 
31972fe279fdSBarry Smith   Input Parameter:
319820f4b53cSBarry Smith . dm - the `DMNETWORK` object
3199daad07d3SAidan Hamilton 
3200daad07d3SAidan Hamilton   Level: beginner
3201daad07d3SAidan Hamilton 
320220f4b53cSBarry Smith .seealso: `DM`, `DMNETWORK`, `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3203daad07d3SAidan Hamilton @*/
3204d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3205d71ae5a4SJacob Faibussowitsch {
3206daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3207daad07d3SAidan Hamilton 
3208daad07d3SAidan Hamilton   PetscFunctionBegin;
32093ba16761SJacob Faibussowitsch   if (network->componentsetup) PetscFunctionReturn(PETSC_SUCCESS);
3210daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3211daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3212daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3213daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3214daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
32153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3216daad07d3SAidan Hamilton }
3217