xref: /petsc/src/dm/impls/network/network.c (revision d5b43468fb8780a8feea140ccd6fa3e6a50411cc)
1af0996ceSBarry Smith #include <petsc/private/dmnetworkimpl.h> /*I  "petscdmnetwork.h"  I*/
25f2c45f1SShri Abhyankar 
3e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_LayoutSetUp;
4e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_SetUpNetwork;
5e3b1a053SGetnet Betrie PetscLogEvent DMNetwork_Distribute;
6e3b1a053SGetnet Betrie 
754dfd506SHong Zhang /*
854dfd506SHong Zhang   Creates the component header and value objects for a network point
954dfd506SHong Zhang */
10d71ae5a4SJacob Faibussowitsch static PetscErrorCode SetUpNetworkHeaderComponentValue(DM dm, DMNetworkComponentHeader header, DMNetworkComponentValue cvalue)
11d71ae5a4SJacob Faibussowitsch {
1254dfd506SHong Zhang   PetscFunctionBegin;
1354dfd506SHong Zhang   /* Allocate arrays for component information */
149566063dSJacob Faibussowitsch   PetscCall(PetscCalloc5(header->maxcomps, &header->size, header->maxcomps, &header->key, header->maxcomps, &header->offset, header->maxcomps, &header->nvar, header->maxcomps, &header->offsetvarrel));
159566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(header->maxcomps, &cvalue->data));
1654dfd506SHong Zhang 
1754dfd506SHong Zhang   /* The size of the header is the size of struct _p_DMNetworkComponentHeader. Since the struct contains PetscInt pointers we cannot use sizeof(struct). So, we need to explicitly calculate the size.
1854dfd506SHong Zhang    If the data header struct changes then this header size calculation needs to be updated. */
1954dfd506SHong Zhang   header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
2054dfd506SHong Zhang   header->hsize /= sizeof(DMNetworkComponentGenericDataType);
2154dfd506SHong Zhang   PetscFunctionReturn(0);
2254dfd506SHong Zhang }
2354dfd506SHong Zhang 
24d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeHeaderComponentData(DM dm)
25d71ae5a4SJacob Faibussowitsch {
26daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
27daad07d3SAidan Hamilton   PetscInt    np, p, defaultnumcomp = DMNETWORK_MAX_COMP_AT_POINT_DEFAULT;
28daad07d3SAidan Hamilton 
29daad07d3SAidan Hamilton   PetscFunctionBegin;
30daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
31daad07d3SAidan Hamilton   if (network->header)
32daad07d3SAidan Hamilton     for (p = 0; p < np; p++) {
33daad07d3SAidan Hamilton       network->header[p].maxcomps = defaultnumcomp;
34daad07d3SAidan Hamilton       PetscCall(SetUpNetworkHeaderComponentValue(dm, &network->header[p], &network->cvalue[p]));
35daad07d3SAidan Hamilton     }
36daad07d3SAidan Hamilton 
37daad07d3SAidan Hamilton   PetscFunctionReturn(0);
38daad07d3SAidan Hamilton }
395f2c45f1SShri Abhyankar /*@
40556ed216SShri Abhyankar   DMNetworkGetPlex - Gets the Plex DM associated with this network DM
41556ed216SShri Abhyankar 
42556ed216SShri Abhyankar   Not collective
43556ed216SShri Abhyankar 
44556ed216SShri Abhyankar   Input Parameters:
452bf73ac6SHong Zhang . dm - the dm object
462bf73ac6SHong Zhang 
472bf73ac6SHong Zhang   Output Parameters:
482bf73ac6SHong Zhang . plexdm - the plex dm object
49556ed216SShri Abhyankar 
50556ed216SShri Abhyankar   Level: Advanced
51556ed216SShri Abhyankar 
52db781477SPatrick Sanan .seealso: `DMNetworkCreate()`
53556ed216SShri Abhyankar @*/
54d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetPlex(DM dm, DM *plexdm)
55d71ae5a4SJacob Faibussowitsch {
562bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
57556ed216SShri Abhyankar 
58556ed216SShri Abhyankar   PetscFunctionBegin;
59556ed216SShri Abhyankar   *plexdm = network->plex;
60556ed216SShri Abhyankar   PetscFunctionReturn(0);
61556ed216SShri Abhyankar }
62556ed216SShri Abhyankar 
63556ed216SShri Abhyankar /*@
642bf73ac6SHong Zhang   DMNetworkGetNumSubNetworks - Gets the the number of subnetworks
6572c3e9f7SHong Zhang 
662bf73ac6SHong Zhang   Not collective
6772c3e9f7SHong Zhang 
68f899ff85SJose E. Roman   Input Parameter:
692bf73ac6SHong Zhang . dm - the dm object
702bf73ac6SHong Zhang 
712bf73ac6SHong Zhang   Output Parameters:
722bf73ac6SHong Zhang + nsubnet - local number of subnetworks
732bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
7472c3e9f7SHong Zhang 
7597bb938eSShri Abhyankar   Level: beginner
7672c3e9f7SHong Zhang 
77db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkSetNumSubNetworks()`
7872c3e9f7SHong Zhang @*/
79d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumSubNetworks(DM dm, PetscInt *nsubnet, PetscInt *Nsubnet)
80d71ae5a4SJacob Faibussowitsch {
812bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8272c3e9f7SHong Zhang 
8372c3e9f7SHong Zhang   PetscFunctionBegin;
84daad07d3SAidan Hamilton   if (nsubnet) *nsubnet = network->cloneshared->nsubnet;
85daad07d3SAidan Hamilton   if (Nsubnet) *Nsubnet = network->cloneshared->Nsubnet;
8672c3e9f7SHong Zhang   PetscFunctionReturn(0);
8772c3e9f7SHong Zhang }
8872c3e9f7SHong Zhang 
8972c3e9f7SHong Zhang /*@
902bf73ac6SHong Zhang   DMNetworkSetNumSubNetworks - Sets the number of subnetworks
915f2c45f1SShri Abhyankar 
92d083f849SBarry Smith   Collective on dm
935f2c45f1SShri Abhyankar 
945f2c45f1SShri Abhyankar   Input Parameters:
955f2c45f1SShri Abhyankar + dm - the dm object
962bf73ac6SHong Zhang . nsubnet - local number of subnetworks
972bf73ac6SHong Zhang - Nsubnet - global number of subnetworks
985f2c45f1SShri Abhyankar 
9997bb938eSShri Abhyankar    Level: beginner
1001b266c99SBarry Smith 
101db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetNumSubNetworks()`
1025f2c45f1SShri Abhyankar @*/
103d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetNumSubNetworks(DM dm, PetscInt nsubnet, PetscInt Nsubnet)
104d71ae5a4SJacob Faibussowitsch {
1055f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
1065f2c45f1SShri Abhyankar 
1075f2c45f1SShri Abhyankar   PetscFunctionBegin;
108*d5b43468SJose E. Roman   PetscCheck(network->cloneshared->Nsubnet == 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Network sizes already set, cannot resize the network");
1092bf73ac6SHong Zhang 
1105f2c45f1SShri Abhyankar   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1112bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, nsubnet, 2);
1122bf73ac6SHong Zhang   PetscValidLogicalCollectiveInt(dm, Nsubnet, 3);
1137765340cSHong Zhang 
1142bf73ac6SHong Zhang   if (Nsubnet == PETSC_DECIDE) {
1155c6496baSHong Zhang     PetscCheck(nsubnet >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Number of local subnetworks %" PetscInt_FMT " cannot be less than 0", nsubnet);
1161c2dc1cbSBarry Smith     PetscCall(MPIU_Allreduce(&nsubnet, &Nsubnet, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
117caf410d2SHong Zhang   }
1185c6496baSHong Zhang   PetscCheck(Nsubnet >= 1, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_INCOMP, "Number of global subnetworks %" PetscInt_FMT " cannot be less than 1", Nsubnet);
119caf410d2SHong Zhang 
120daad07d3SAidan Hamilton   network->cloneshared->Nsubnet = Nsubnet;
121daad07d3SAidan Hamilton   network->cloneshared->nsubnet = 0; /* initial value; will be determind by DMNetworkAddSubnetwork() */
122daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(Nsubnet, &network->cloneshared->subnet));
123caf410d2SHong Zhang 
1242bf73ac6SHong Zhang   /* num of shared vertices */
125daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0;
126daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = 0;
1277765340cSHong Zhang   PetscFunctionReturn(0);
1287765340cSHong Zhang }
1297765340cSHong Zhang 
1305f2c45f1SShri Abhyankar /*@
1312bf73ac6SHong Zhang   DMNetworkAddSubnetwork - Add a subnetwork
1325f2c45f1SShri Abhyankar 
1332bf73ac6SHong Zhang   Collective on dm
1345f2c45f1SShri Abhyankar 
1355f2c45f1SShri Abhyankar   Input Parameters:
136e3e68989SHong Zhang + dm - the dm object
1372bf73ac6SHong Zhang . name - name of the subnetwork
1382bf73ac6SHong Zhang . ne - number of local edges of this subnetwork
1398d1cd658SBarry Smith - edgelist - list of edges for this subnetwork, this is a one dimensional array with pairs of entries being the two vertices (in global numbering of the vertices) of each edge,
1408d1cd658SBarry Smith $            [first vertex of first edge, second vertex of first edge, first vertex of second edge, second vertex of second edge, etc]
1412bf73ac6SHong Zhang 
1422bf73ac6SHong Zhang   Output Parameters:
1432bf73ac6SHong Zhang . netnum - global index of the subnetwork
1445f2c45f1SShri Abhyankar 
1455f2c45f1SShri Abhyankar   Notes:
1465f2c45f1SShri Abhyankar   There is no copy involved in this operation, only the pointer is referenced. The edgelist should
1472bf73ac6SHong Zhang   not be destroyed before the call to DMNetworkLayoutSetUp()
1485f2c45f1SShri Abhyankar 
1498d1cd658SBarry Smith   A network can comprise of a single subnetwork OR multiple subnetworks. For a single subnetwork, the subnetwork can be read either in serial or parallel. For a multiple subnetworks,
1508d1cd658SBarry Smith   each subnetwork topology needs to be set on a unique rank and the communicator size needs to be at least equal to the number of subnetworks.
151f11a936eSBarry Smith 
15297bb938eSShri Abhyankar   Level: beginner
1535f2c45f1SShri Abhyankar 
154e3e68989SHong Zhang   Example usage:
155f11a936eSBarry Smith   Consider the following networks:
156*d5b43468SJose E. Roman   1) A single subnetwork:
157e3e68989SHong Zhang .vb
158f11a936eSBarry Smith  network 0:
159f11a936eSBarry Smith  rank[0]:
160f11a936eSBarry Smith    v0 --> v2; v1 --> v2
161f11a936eSBarry Smith  rank[1]:
162f11a936eSBarry Smith    v3 --> v5; v4 --> v5
163e3e68989SHong Zhang .ve
164e3e68989SHong Zhang 
165e3e68989SHong Zhang  The resulting input
166f11a936eSBarry Smith  network 0:
167f11a936eSBarry Smith  rank[0]:
168f11a936eSBarry Smith    ne = 2
169f11a936eSBarry Smith    edgelist = [0 2 | 1 2]
170f11a936eSBarry Smith  rank[1]:
171f11a936eSBarry Smith    ne = 2
172f11a936eSBarry Smith    edgelist = [3 5 | 4 5]
173f11a936eSBarry Smith 
174f11a936eSBarry Smith   2) Two subnetworks:
175f11a936eSBarry Smith .vb
176f11a936eSBarry Smith  subnetwork 0:
177f11a936eSBarry Smith  rank[0]:
178f11a936eSBarry Smith    v0 --> v2; v2 --> v1; v1 --> v3;
179f11a936eSBarry Smith  subnetwork 1:
180f11a936eSBarry Smith  rank[1]:
181f11a936eSBarry Smith    v0 --> v3; v3 --> v2; v2 --> v1;
182f11a936eSBarry Smith .ve
183f11a936eSBarry Smith 
184f11a936eSBarry Smith  The resulting input
185f11a936eSBarry Smith  subnetwork 0:
186f11a936eSBarry Smith  rank[0]:
187f11a936eSBarry Smith    ne = 3
188f11a936eSBarry Smith    edgelist = [0 2 | 2 1 | 1 3]
189f11a936eSBarry Smith  rank[1]:
190f11a936eSBarry Smith    ne = 0
191f11a936eSBarry Smith    edgelist = NULL
192f11a936eSBarry Smith 
193f11a936eSBarry Smith  subnetwork 1:
194f11a936eSBarry Smith  rank[0]:
195f11a936eSBarry Smith    ne = 0
196f11a936eSBarry Smith    edgelist = NULL
197f11a936eSBarry Smith  rank[1]:
198f11a936eSBarry Smith    edgelist = [0 3 | 3 2 | 2 1]
199e3e68989SHong Zhang 
200db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkSetNumSubnetworks()`
2015f2c45f1SShri Abhyankar @*/
202d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSubnetwork(DM dm, const char *name, PetscInt ne, PetscInt edgelist[], PetscInt *netnum)
203d71ae5a4SJacob Faibussowitsch {
2045f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2055c6496baSHong Zhang   PetscInt    i, Nedge, j, Nvtx, nvtx, nvtx_min = -1, nvtx_max = 0;
206f11a936eSBarry Smith   PetscBT     table;
2075f2c45f1SShri Abhyankar 
2085f2c45f1SShri Abhyankar   PetscFunctionBegin;
209ad540459SPierre Jolivet   for (i = 0; i < ne; i++) PetscCheck(edgelist[2 * i] != edgelist[2 * i + 1], PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Edge %" PetscInt_FMT " has the same vertex %" PetscInt_FMT " at each endpoint", i, edgelist[2 * i]);
210f11a936eSBarry Smith 
2115c6496baSHong Zhang   i = 0;
2125c6496baSHong Zhang   if (ne) nvtx_min = nvtx_max = edgelist[0];
2135c6496baSHong Zhang   for (j = 0; j < ne; j++) {
2145c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2155c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2165c6496baSHong Zhang     i++;
2175c6496baSHong Zhang     nvtx_min = PetscMin(nvtx_min, edgelist[i]);
2185c6496baSHong Zhang     nvtx_max = PetscMax(nvtx_max, edgelist[i]);
2195c6496baSHong Zhang     i++;
2205c6496baSHong Zhang   }
2215c6496baSHong Zhang   Nvtx = nvtx_max - nvtx_min + 1; /* approximated total local nvtx for this subnet */
2225c6496baSHong Zhang 
2235c6496baSHong Zhang   /* Get exact local nvtx for this subnet: counting local values between nvtx_min and nvtx_max */
2249566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(Nvtx, &table));
2259566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nvtx, table));
226f11a936eSBarry Smith   i = 0;
227f11a936eSBarry Smith   for (j = 0; j < ne; j++) {
2289566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
2299566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(table, edgelist[i++] - nvtx_min));
230f11a936eSBarry Smith   }
231f11a936eSBarry Smith   nvtx = 0;
232f11a936eSBarry Smith   for (j = 0; j < Nvtx; j++) {
233f11a936eSBarry Smith     if (PetscBTLookup(table, j)) nvtx++;
234f11a936eSBarry Smith   }
2355c6496baSHong Zhang 
2365c6496baSHong Zhang   /* Get global total Nvtx = max(edgelist[])+1 for this subnet */
2371c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&nvtx_max, &Nvtx, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
2385c6496baSHong Zhang   Nvtx++;
2399566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&table));
240f11a936eSBarry Smith 
241f11a936eSBarry Smith   /* Get global total Nedge for this subnet */
2421c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&ne, &Nedge, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)dm)));
243f11a936eSBarry Smith 
244daad07d3SAidan Hamilton   i = network->cloneshared->nsubnet;
24548a46eb9SPierre Jolivet   if (name) PetscCall(PetscStrcpy(network->cloneshared->subnet[i].name, name));
246daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nvtx     = nvtx; /* include ghost vertices */
247daad07d3SAidan Hamilton   network->cloneshared->subnet[i].nedge    = ne;
248daad07d3SAidan Hamilton   network->cloneshared->subnet[i].edgelist = edgelist;
249daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nvtx     = Nvtx;
250daad07d3SAidan Hamilton   network->cloneshared->subnet[i].Nedge    = Nedge;
2512bf73ac6SHong Zhang 
2522bf73ac6SHong Zhang   /* ----------------------------------------------------------
2532bf73ac6SHong Zhang    p=v or e;
2542bf73ac6SHong Zhang    subnet[0].pStart   = 0
2552bf73ac6SHong Zhang    subnet[i+1].pStart = subnet[i].pEnd = subnet[i].pStart + (nE[i] or NV[i])
2562bf73ac6SHong Zhang    ----------------------------------------------------------------------- */
2572bf73ac6SHong Zhang   /* GLOBAL subnet[].vStart and vEnd, used by DMNetworkLayoutSetUp() */
258daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vStart = network->cloneshared->NVertices;
259daad07d3SAidan Hamilton   network->cloneshared->subnet[i].vEnd   = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].Nvtx; /* global vEnd of subnet[i] */
2602bf73ac6SHong Zhang 
261daad07d3SAidan Hamilton   network->cloneshared->nVertices += nvtx; /* include ghost vertices */
262daad07d3SAidan Hamilton   network->cloneshared->NVertices += network->cloneshared->subnet[i].Nvtx;
2632bf73ac6SHong Zhang 
2642bf73ac6SHong Zhang   /* LOCAL subnet[].eStart and eEnd, used by DMNetworkLayoutSetUp() */
265daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eStart = network->cloneshared->nEdges;
266daad07d3SAidan Hamilton   network->cloneshared->subnet[i].eEnd   = network->cloneshared->subnet[i].eStart + ne;
267daad07d3SAidan Hamilton   network->cloneshared->nEdges += ne;
268daad07d3SAidan Hamilton   network->cloneshared->NEdges += network->cloneshared->subnet[i].Nedge;
2692bf73ac6SHong Zhang 
270daad07d3SAidan Hamilton   PetscCall(PetscStrcpy(network->cloneshared->subnet[i].name, name));
271daad07d3SAidan Hamilton   if (netnum) *netnum = network->cloneshared->nsubnet;
272daad07d3SAidan Hamilton   network->cloneshared->nsubnet++;
2732bf73ac6SHong Zhang   PetscFunctionReturn(0);
2742bf73ac6SHong Zhang }
2752bf73ac6SHong Zhang 
2765c6496baSHong Zhang /*@C
2775c6496baSHong Zhang   DMNetworkSharedVertexGetInfo - Get info of a shared vertex struct, see petsc/private/dmnetworkimpl.h
2782bf73ac6SHong Zhang 
2795c6496baSHong Zhang   Not collective
2805c6496baSHong Zhang 
2815c6496baSHong Zhang   Input Parameters:
2825c6496baSHong Zhang + dm - the DM object
2835c6496baSHong Zhang - v - vertex point
2845c6496baSHong Zhang 
2855c6496baSHong Zhang   Output Parameters:
2865c6496baSHong Zhang + gidx - global number of this shared vertex in the internal dmplex
2875c6496baSHong Zhang . n - number of subnetworks that share this vertex
2885c6496baSHong Zhang - sv - array of size n: sv[2*i,2*i+1]=(net[i], idx[i]), i=0,...,n-1
2895c6496baSHong Zhang 
2905c6496baSHong Zhang   Level: intermediate
2915c6496baSHong Zhang 
292db781477SPatrick Sanan .seealso: `DMNetworkGetSharedVertices()`
2935c6496baSHong Zhang @*/
294d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSharedVertexGetInfo(DM dm, PetscInt v, PetscInt *gidx, PetscInt *n, const PetscInt **sv)
295d71ae5a4SJacob Faibussowitsch {
2965c6496baSHong Zhang   DM_Network *network = (DM_Network *)dm->data;
297daad07d3SAidan Hamilton   SVtx       *svtx    = network->cloneshared->svtx;
2985c6496baSHong Zhang   PetscInt    i, gidx_tmp;
2995c6496baSHong Zhang 
3005c6496baSHong Zhang   PetscFunctionBegin;
3019566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetGlobalVertexIndex(dm, v, &gidx_tmp));
302daad07d3SAidan Hamilton   PetscCall(PetscTableFind(network->cloneshared->svtable, gidx_tmp + 1, &i));
3035c6496baSHong Zhang   PetscCheck(i > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "input vertex is not a shared vertex");
3045c6496baSHong Zhang 
3055c6496baSHong Zhang   i--;
3065c6496baSHong Zhang   if (gidx) *gidx = gidx_tmp;
3075c6496baSHong Zhang   if (n) *n = svtx[i].n;
3085c6496baSHong Zhang   if (sv) *sv = svtx[i].sv;
3095c6496baSHong Zhang   PetscFunctionReturn(0);
3105c6496baSHong Zhang }
3115c6496baSHong Zhang 
3125c6496baSHong Zhang /*
3135c6496baSHong Zhang   VtxGetInfo - Get info of an input vertex=(net,idx)
3145c6496baSHong Zhang 
3155c6496baSHong Zhang   Input Parameters:
3165c6496baSHong Zhang + Nsvtx - global num of shared vertices
3175c6496baSHong Zhang . svtx - array of shared vertices (global)
3185c6496baSHong Zhang - (net,idx) - subnet number and local index for a vertex
3195c6496baSHong Zhang 
3205c6496baSHong Zhang   Output Parameters:
3215c6496baSHong Zhang + gidx - global index of (net,idx)
3225c6496baSHong Zhang . svtype - see petsc/private/dmnetworkimpl.h
3235c6496baSHong Zhang - svtx_idx - ordering in the svtx array
3245c6496baSHong Zhang */
325d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode VtxGetInfo(PetscInt Nsvtx, SVtx *svtx, PetscInt net, PetscInt idx, PetscInt *gidx, SVtxType *svtype, PetscInt *svtx_idx)
326d71ae5a4SJacob Faibussowitsch {
3275c6496baSHong Zhang   PetscInt i, j, *svto, g_idx;
3282bf73ac6SHong Zhang   SVtxType vtype;
3292bf73ac6SHong Zhang 
3302bf73ac6SHong Zhang   PetscFunctionBegin;
3312bf73ac6SHong Zhang   if (!Nsvtx) PetscFunctionReturn(0);
3322bf73ac6SHong Zhang 
3335c6496baSHong Zhang   g_idx = -1;
3342bf73ac6SHong Zhang   vtype = SVNONE;
3355c6496baSHong Zhang 
3362bf73ac6SHong Zhang   for (i = 0; i < Nsvtx; i++) {
3372bf73ac6SHong Zhang     if (net == svtx[i].sv[0] && idx == svtx[i].sv[1]) {
3385c6496baSHong Zhang       g_idx = svtx[i].gidx;
3392bf73ac6SHong Zhang       vtype = SVFROM;
3402bf73ac6SHong Zhang     } else { /* loop over svtx[i].n */
3412bf73ac6SHong Zhang       for (j = 1; j < svtx[i].n; j++) {
3422bf73ac6SHong Zhang         svto = svtx[i].sv + 2 * j;
3432bf73ac6SHong Zhang         if (net == svto[0] && idx == svto[1]) {
3442bf73ac6SHong Zhang           /* input vertex net.idx is a shared to_vertex, output its global index and its svtype */
3455c6496baSHong Zhang           g_idx = svtx[i].gidx; /* output gidx for to_vertex */
3462bf73ac6SHong Zhang           vtype = SVTO;
3472bf73ac6SHong Zhang         }
3482bf73ac6SHong Zhang       }
3492bf73ac6SHong Zhang     }
3502bf73ac6SHong Zhang     if (vtype != SVNONE) break;
3512bf73ac6SHong Zhang   }
3525c6496baSHong Zhang   if (gidx) *gidx = g_idx;
3532bf73ac6SHong Zhang   if (svtype) *svtype = vtype;
3542bf73ac6SHong Zhang   if (svtx_idx) *svtx_idx = i;
3552bf73ac6SHong Zhang   PetscFunctionReturn(0);
3562bf73ac6SHong Zhang }
3572bf73ac6SHong Zhang 
3582bf73ac6SHong Zhang /*
3595c6496baSHong Zhang   TableAddSVtx - Add a new shared vertice from sedgelist[k] to a ctable svta
3605c6496baSHong Zhang 
3615c6496baSHong Zhang   Input:  network, sedgelist, k, svta
3625c6496baSHong Zhang   Output: svta, tdata, ta2sv
3632bf73ac6SHong Zhang */
364d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode TableAddSVtx(DM_Network *network, PetscInt *sedgelist, PetscInt k, PetscTable svta, PetscInt *tdata, PetscInt *ta2sv)
365d71ae5a4SJacob Faibussowitsch {
3665c6496baSHong Zhang   PetscInt net, idx, gidx;
3672bf73ac6SHong Zhang 
3682bf73ac6SHong Zhang   PetscFunctionBegin;
3695c6496baSHong Zhang   net  = sedgelist[k];
3705c6496baSHong Zhang   idx  = sedgelist[k + 1];
371daad07d3SAidan Hamilton   gidx = network->cloneshared->subnet[net].vStart + idx;
3729566063dSJacob Faibussowitsch   PetscCall(PetscTableAdd(svta, gidx + 1, *tdata + 1, INSERT_VALUES));
3735c6496baSHong Zhang 
3745c6496baSHong Zhang   ta2sv[*tdata] = k; /* maps tdata to index of sedgelist */
3755c6496baSHong Zhang   (*tdata)++;
3762bf73ac6SHong Zhang   PetscFunctionReturn(0);
3772bf73ac6SHong Zhang }
3782bf73ac6SHong Zhang 
3792bf73ac6SHong Zhang /*
3805c6496baSHong Zhang   SharedVtxCreate - Create an array of global shared vertices. See SVtx and SVtxType in dmnetworkimpl.h
3812bf73ac6SHong Zhang 
3822bf73ac6SHong Zhang   Input:  dm, Nsedgelist, sedgelist
3832bf73ac6SHong Zhang 
3842bf73ac6SHong Zhang   Note: Output svtx is organized as
3852bf73ac6SHong Zhang         sv(net[0],idx[0]) --> sv(net[1],idx[1])
3862bf73ac6SHong Zhang                           --> sv(net[1],idx[1])
3872bf73ac6SHong Zhang                           ...
3882bf73ac6SHong Zhang                           --> sv(net[n-1],idx[n-1])
3892bf73ac6SHong Zhang         and net[0] < net[1] < ... < net[n-1]
3902bf73ac6SHong Zhang         where sv[0] has SVFROM type, sv[i], i>0, has SVTO type.
3912bf73ac6SHong Zhang  */
392d71ae5a4SJacob Faibussowitsch static PetscErrorCode SharedVtxCreate(DM dm, PetscInt Nsedgelist, PetscInt *sedgelist)
393d71ae5a4SJacob Faibussowitsch {
3945c6496baSHong Zhang   SVtx              *svtx = NULL;
3952bf73ac6SHong Zhang   PetscInt          *sv, k, j, nsv, *tdata, **ta2sv;
3962bf73ac6SHong Zhang   PetscTable        *svtas;
3975c6496baSHong Zhang   PetscInt           gidx, net, idx, i, nta, ita, idx_from, idx_to, n;
3982bf73ac6SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
3992bf73ac6SHong Zhang   PetscTablePosition ppos;
4002bf73ac6SHong Zhang 
4012bf73ac6SHong Zhang   PetscFunctionBegin;
4025c6496baSHong Zhang   /* (1) Crete an array of ctables svtas to map (net,idx) -> gidx; a svtas[] for a shared/merged vertex */
4039566063dSJacob Faibussowitsch   PetscCall(PetscCalloc3(Nsedgelist, &svtas, Nsedgelist, &tdata, 2 * Nsedgelist, &ta2sv));
4042bf73ac6SHong Zhang 
4052bf73ac6SHong Zhang   k   = 0; /* sedgelist vertex counter j = 4*k */
4065c6496baSHong Zhang   nta = 0; /* num of svta tables created */
4072bf73ac6SHong Zhang 
4082bf73ac6SHong Zhang   /* for j=0 */
409daad07d3SAidan Hamilton   PetscCall(PetscTableCreate(2 * Nsedgelist, network->cloneshared->NVertices + 1, &svtas[nta]));
4109566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4112bf73ac6SHong Zhang 
4129566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4139566063dSJacob Faibussowitsch   PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4149371c9d4SSatish Balay   nta++;
4159371c9d4SSatish Balay   k += 4;
4162bf73ac6SHong Zhang 
4175c6496baSHong Zhang   for (j = 1; j < Nsedgelist; j++) { /* j: sedgelist counter */
4182bf73ac6SHong Zhang     for (ita = 0; ita < nta; ita++) {
4192bf73ac6SHong Zhang       /* vfrom */
4209371c9d4SSatish Balay       net  = sedgelist[k];
4219371c9d4SSatish Balay       idx  = sedgelist[k + 1];
422daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx; /* global index of the vertex net.idx before merging shared vertices */
4239566063dSJacob Faibussowitsch       PetscCall(PetscTableFind(svtas[ita], gidx + 1, &idx_from));
4242bf73ac6SHong Zhang 
4252bf73ac6SHong Zhang       /* vto */
4269371c9d4SSatish Balay       net  = sedgelist[k + 2];
4279371c9d4SSatish Balay       idx  = sedgelist[k + 3];
428daad07d3SAidan Hamilton       gidx = network->cloneshared->subnet[net].vStart + idx;
4299566063dSJacob Faibussowitsch       PetscCall(PetscTableFind(svtas[ita], gidx + 1, &idx_to));
4302bf73ac6SHong Zhang 
4312bf73ac6SHong Zhang       if (idx_from || idx_to) { /* vfrom or vto is on table svtas[ita] */
4329371c9d4SSatish Balay         idx_from--;
4339371c9d4SSatish Balay         idx_to--;
4342bf73ac6SHong Zhang         if (idx_from < 0) { /* vto is on svtas[ita] */
4359566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k, svtas[ita], &tdata[ita], ta2sv[ita]));
4362bf73ac6SHong Zhang           break;
4372bf73ac6SHong Zhang         } else if (idx_to < 0) {
4389566063dSJacob Faibussowitsch           PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[ita], &tdata[ita], ta2sv[ita]));
4392bf73ac6SHong Zhang           break;
4402bf73ac6SHong Zhang         }
4412bf73ac6SHong Zhang       }
4422bf73ac6SHong Zhang     }
4432bf73ac6SHong Zhang 
4442bf73ac6SHong Zhang     if (ita == nta) {
445daad07d3SAidan Hamilton       PetscCall(PetscTableCreate(2 * Nsedgelist, network->cloneshared->NVertices + 1, &svtas[nta]));
4469566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(2 * Nsedgelist, &ta2sv[nta]));
4472bf73ac6SHong Zhang 
4489566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k, svtas[nta], &tdata[nta], ta2sv[nta]));
4499566063dSJacob Faibussowitsch       PetscCall(TableAddSVtx(network, sedgelist, k + 2, svtas[nta], &tdata[nta], ta2sv[nta]));
4502bf73ac6SHong Zhang       nta++;
4512bf73ac6SHong Zhang     }
4522bf73ac6SHong Zhang     k += 4;
4532bf73ac6SHong Zhang   }
4542bf73ac6SHong Zhang 
4556aad120cSJose E. Roman   /* (2) Create svtable for query shared vertices using gidx */
456daad07d3SAidan Hamilton   PetscCall(PetscTableCreate(nta, network->cloneshared->NVertices + 1, &network->cloneshared->svtable));
4575c6496baSHong Zhang 
4585c6496baSHong Zhang   /* (3) Construct svtx from svtas
4595c6496baSHong Zhang      svtx: array of SVtx: sv[0]=(net[0],idx[0]) to vertices sv[k], k=1,...,n-1;
4604f5c2772SJose E. Roman      net[k], k=0, ...,n-1, are in ascending order */
4619566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nta, &svtx));
4622bf73ac6SHong Zhang   for (nsv = 0; nsv < nta; nsv++) {
4634f5c2772SJose E. Roman     /* for a single svtx, put shared vertices in ascending order of gidx */
4649566063dSJacob Faibussowitsch     PetscCall(PetscTableGetCount(svtas[nsv], &n));
4659566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * n, &sv));
4665c6496baSHong Zhang     svtx[nsv].sv   = sv;
4675c6496baSHong Zhang     svtx[nsv].n    = n;
468daad07d3SAidan Hamilton     svtx[nsv].gidx = network->cloneshared->NVertices; /* initialization */
4692bf73ac6SHong Zhang 
4709566063dSJacob Faibussowitsch     PetscCall(PetscTableGetHeadPosition(svtas[nsv], &ppos));
4714f5c2772SJose E. Roman     for (k = 0; k < n; k++) { /* gidx is sorted in ascending order */
4729566063dSJacob Faibussowitsch       PetscCall(PetscTableGetNext(svtas[nsv], &ppos, &gidx, &i));
4739371c9d4SSatish Balay       gidx--;
4749371c9d4SSatish Balay       i--;
4752bf73ac6SHong Zhang 
4765c6496baSHong Zhang       if (svtx[nsv].gidx > gidx) svtx[nsv].gidx = gidx; /*svtx[nsv].gidx = min(gidx) */
4775c6496baSHong Zhang 
4785c6496baSHong Zhang       j             = ta2sv[nsv][i];    /* maps i to index of sedgelist */
4795c6496baSHong Zhang       sv[2 * k]     = sedgelist[j];     /* subnet number */
4805c6496baSHong Zhang       sv[2 * k + 1] = sedgelist[j + 1]; /* index on the subnet */
4812bf73ac6SHong Zhang     }
4825c6496baSHong Zhang 
4836aad120cSJose E. Roman     /* Setup svtable for query shared vertices */
484daad07d3SAidan Hamilton     PetscCall(PetscTableAdd(network->cloneshared->svtable, svtx[nsv].gidx + 1, nsv + 1, INSERT_VALUES));
4852bf73ac6SHong Zhang   }
4862bf73ac6SHong Zhang 
4872bf73ac6SHong Zhang   for (j = 0; j < nta; j++) {
4889566063dSJacob Faibussowitsch     PetscCall(PetscTableDestroy(&svtas[j]));
4899566063dSJacob Faibussowitsch     PetscCall(PetscFree(ta2sv[j]));
4902bf73ac6SHong Zhang   }
4919566063dSJacob Faibussowitsch   PetscCall(PetscFree3(svtas, tdata, ta2sv));
4922bf73ac6SHong Zhang 
493daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = nta;
494daad07d3SAidan Hamilton   network->cloneshared->svtx  = svtx;
4952bf73ac6SHong Zhang   PetscFunctionReturn(0);
4962bf73ac6SHong Zhang }
4972bf73ac6SHong Zhang 
4985c6496baSHong Zhang /*
4995c6496baSHong Zhang   GetEdgelist_Coupling - Get an integrated edgelist for dmplex from user-provided subnet[].edgelist when subnets are coupled by shared vertices
5005c6496baSHong Zhang 
5015c6496baSHong Zhang   Input Parameters:
5025c6496baSHong Zhang . dm - the dmnetwork object
5035c6496baSHong Zhang 
5045c6496baSHong Zhang    Output Parameters:
5055c6496baSHong Zhang +  edges - the integrated edgelist for dmplex
5065c6496baSHong Zhang -  nmerged_ptr - num of vertices being merged
5075c6496baSHong Zhang */
508d71ae5a4SJacob Faibussowitsch static PetscErrorCode GetEdgelist_Coupling(DM dm, PetscInt *edges, PetscInt *nmerged_ptr)
509d71ae5a4SJacob Faibussowitsch {
5102bf73ac6SHong Zhang   MPI_Comm    comm;
5112bf73ac6SHong Zhang   PetscMPIInt size, rank, *recvcounts = NULL, *displs = NULL;
512eac198afSGetnet   DM_Network *network = (DM_Network *)dm->data;
513eac198afSGetnet   PetscInt    i, j, ctr, np;
514daad07d3SAidan Hamilton   PetscInt   *vidxlTog, Nsv, Nsubnet = network->cloneshared->Nsubnet;
515daad07d3SAidan Hamilton   PetscInt   *sedgelist = network->cloneshared->sedgelist;
5165c6496baSHong Zhang   PetscInt    net, idx, gidx, nmerged, *vrange, gidx_from, net_from, sv_idx;
5172bf73ac6SHong Zhang   SVtxType    svtype = SVNONE;
5185c6496baSHong Zhang   SVtx       *svtx;
5192bf73ac6SHong Zhang 
5202bf73ac6SHong Zhang   PetscFunctionBegin;
5219566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
5229566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
5239566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5242bf73ac6SHong Zhang 
5255c6496baSHong Zhang   /* (1) Create global svtx[] from sedgelist */
5265c6496baSHong Zhang   /* --------------------------------------- */
527daad07d3SAidan Hamilton   PetscCall(SharedVtxCreate(dm, network->cloneshared->Nsvtx, sedgelist));
528daad07d3SAidan Hamilton   Nsv  = network->cloneshared->Nsvtx;
529daad07d3SAidan Hamilton   svtx = network->cloneshared->svtx;
5302bf73ac6SHong Zhang 
531*d5b43468SJose E. Roman   /* (2) Merge shared vto vertices to their vfrom vertex with same global vertex index (gidx) */
5325c6496baSHong Zhang   /* --------------------------------------------------------------------------------------- */
5332bf73ac6SHong Zhang   /* (2.1) compute vrage[rank]: global index of 1st local vertex in proc[rank] */
534daad07d3SAidan Hamilton   PetscCall(PetscMalloc4(size + 1, &vrange, size, &displs, size, &recvcounts, network->cloneshared->nVertices, &vidxlTog));
5359371c9d4SSatish Balay   for (i = 0; i < size; i++) {
5369371c9d4SSatish Balay     displs[i]     = i;
5379371c9d4SSatish Balay     recvcounts[i] = 1;
5389371c9d4SSatish Balay   }
5392bf73ac6SHong Zhang 
5402bf73ac6SHong Zhang   vrange[0] = 0;
541daad07d3SAidan Hamilton   PetscCallMPI(MPI_Allgatherv(&network->cloneshared->nVertices, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
5425c6496baSHong Zhang   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
5432bf73ac6SHong Zhang 
5442bf73ac6SHong Zhang   /* (2.2) Create vidxlTog: maps UN-MERGED local vertex index i to global index gidx (plex, excluding ghost vertices) */
5459371c9d4SSatish Balay   i                           = 0;
5469371c9d4SSatish Balay   gidx                        = 0;
5472bf73ac6SHong Zhang   nmerged                     = 0; /* local num of merged vertices */
548daad07d3SAidan Hamilton   network->cloneshared->nsvtx = 0; /* local num of SVtx structs, including ghosts */
5492bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
550daad07d3SAidan Hamilton     for (idx = 0; idx < network->cloneshared->subnet[net].Nvtx; idx++) { /* Note: global subnet[net].Nvtx */
5519566063dSJacob Faibussowitsch       PetscCall(VtxGetInfo(Nsv, svtx, net, idx, &gidx_from, &svtype, &sv_idx));
5522bf73ac6SHong Zhang       if (svtype == SVTO) {
553daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) { /* this proc owns sv_to */
5545c6496baSHong Zhang           net_from = svtx[sv_idx].sv[0];              /* subnet number of its shared vertex */
555daad07d3SAidan Hamilton           if (network->cloneshared->subnet[net_from].nvtx == 0) {
5565c6496baSHong Zhang             /* this proc does not own v_from, thus a ghost local vertex */
557daad07d3SAidan Hamilton             network->cloneshared->nsvtx++;
5582bf73ac6SHong Zhang           }
5595c6496baSHong Zhang           vidxlTog[i++] = gidx_from; /* gidx before merging! Bug??? */
5605c6496baSHong Zhang           nmerged++;                 /* a shared vertex -- merged */
5612bf73ac6SHong Zhang         }
5622bf73ac6SHong Zhang       } else {
563daad07d3SAidan Hamilton         if (svtype == SVFROM && network->cloneshared->subnet[net].nvtx) {
5645c6496baSHong Zhang           /* this proc owns this v_from, a new local shared vertex */
565daad07d3SAidan Hamilton           network->cloneshared->nsvtx++;
5662bf73ac6SHong Zhang         }
567daad07d3SAidan Hamilton         if (network->cloneshared->subnet[net].nvtx) vidxlTog[i++] = gidx;
5682bf73ac6SHong Zhang         gidx++;
5692bf73ac6SHong Zhang       }
5702bf73ac6SHong Zhang     }
5712bf73ac6SHong Zhang   }
5722bf73ac6SHong Zhang #if defined(PETSC_USE_DEBUG)
573daad07d3SAidan Hamilton   PetscCheck(i == network->cloneshared->nVertices, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "%" PetscInt_FMT " != %" PetscInt_FMT " nVertices", i, network->cloneshared->nVertices);
5742bf73ac6SHong Zhang #endif
5752bf73ac6SHong Zhang 
5765c6496baSHong Zhang   /* (2.3) Shared vertices in the subnetworks are merged, update global NVertices: np = sum(local nmerged) */
5779566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&nmerged, &np, 1, MPIU_INT, MPI_SUM, comm));
578daad07d3SAidan Hamilton   network->cloneshared->NVertices -= np;
5792bf73ac6SHong Zhang 
5802bf73ac6SHong Zhang   ctr = 0;
5812bf73ac6SHong Zhang   for (net = 0; net < Nsubnet; net++) {
582daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[net].nedge; j++) {
5832bf73ac6SHong Zhang       /* vfrom: */
584daad07d3SAidan Hamilton       i              = network->cloneshared->subnet[net].edgelist[2 * j] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5852bf73ac6SHong Zhang       edges[2 * ctr] = vidxlTog[i];
5862bf73ac6SHong Zhang 
5872bf73ac6SHong Zhang       /* vto */
588daad07d3SAidan Hamilton       i                  = network->cloneshared->subnet[net].edgelist[2 * j + 1] + (network->cloneshared->subnet[net].vStart - vrange[rank]);
5892bf73ac6SHong Zhang       edges[2 * ctr + 1] = vidxlTog[i];
5902bf73ac6SHong Zhang       ctr++;
5912bf73ac6SHong Zhang     }
5922bf73ac6SHong Zhang   }
5939566063dSJacob Faibussowitsch   PetscCall(PetscFree4(vrange, displs, recvcounts, vidxlTog));
5949566063dSJacob Faibussowitsch   PetscCall(PetscFree(sedgelist)); /* created in DMNetworkAddSharedVertices() */
5952bf73ac6SHong Zhang 
596eac198afSGetnet   *nmerged_ptr = nmerged;
5975f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
5985f2c45f1SShri Abhyankar }
5995f2c45f1SShri Abhyankar 
600d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkInitializeNonTopological(DM dm)
601d71ae5a4SJacob Faibussowitsch {
602daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
603daad07d3SAidan Hamilton   PetscInt    p, pStart = network->cloneshared->pStart, pEnd = network->cloneshared->pEnd;
604daad07d3SAidan Hamilton   MPI_Comm    comm;
605daad07d3SAidan Hamilton 
606daad07d3SAidan Hamilton   PetscFunctionBegin;
607daad07d3SAidan Hamilton   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
608daad07d3SAidan Hamilton 
609daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DataSection));
610daad07d3SAidan Hamilton   PetscCall(PetscSectionCreate(comm, &network->DofSection));
611daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DataSection, pStart, pEnd));
612daad07d3SAidan Hamilton   PetscCall(PetscSectionSetChart(network->DofSection, pStart, pEnd));
613daad07d3SAidan Hamilton 
614daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeHeaderComponentData(dm));
615daad07d3SAidan Hamilton 
616daad07d3SAidan Hamilton   for (p = 0; p < pEnd - pStart; p++) {
617daad07d3SAidan Hamilton     network->header[p].ndata           = 0;
618daad07d3SAidan Hamilton     network->header[p].offset[0]       = 0;
619daad07d3SAidan Hamilton     network->header[p].offsetvarrel[0] = 0;
620daad07d3SAidan Hamilton     PetscCall(PetscSectionAddDof(network->DataSection, p, network->header[p].hsize));
621daad07d3SAidan Hamilton   }
622daad07d3SAidan Hamilton   PetscFunctionReturn(0);
623daad07d3SAidan Hamilton }
624daad07d3SAidan Hamilton 
6255f2c45f1SShri Abhyankar /*@
6265f2c45f1SShri Abhyankar   DMNetworkLayoutSetUp - Sets up the bare layout (graph) for the network
6275f2c45f1SShri Abhyankar 
628eac198afSGetnet   Not Collective
6295f2c45f1SShri Abhyankar 
6307a7aea1fSJed Brown   Input Parameters:
631f11a936eSBarry Smith . dm - the dmnetwork object
6325f2c45f1SShri Abhyankar 
6335f2c45f1SShri Abhyankar   Notes:
6345f2c45f1SShri Abhyankar   This routine should be called after the network sizes and edgelists have been provided. It creates
6355f2c45f1SShri Abhyankar   the bare layout of the network and sets up the network to begin insertion of components.
6365f2c45f1SShri Abhyankar 
6375f2c45f1SShri Abhyankar   All the components should be registered before calling this routine.
6385f2c45f1SShri Abhyankar 
63997bb938eSShri Abhyankar   Level: beginner
6405f2c45f1SShri Abhyankar 
641db781477SPatrick Sanan .seealso: `DMNetworkSetNumSubNetworks()`, `DMNetworkAddSubnetwork()`
6425f2c45f1SShri Abhyankar @*/
643d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkLayoutSetUp(DM dm)
644d71ae5a4SJacob Faibussowitsch {
6455f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
646daad07d3SAidan Hamilton   PetscInt        i, j, ctr, Nsubnet = network->cloneshared->Nsubnet, np, *edges, *subnetvtx, *subnetedge, e, v, vfrom, vto, net, globaledgeoff;
647caf410d2SHong Zhang   const PetscInt *cone;
648caf410d2SHong Zhang   MPI_Comm        comm;
6495503a911SAidan Hamilton   PetscMPIInt     size;
650eac198afSGetnet   PetscSection    sectiong;
6515c6496baSHong Zhang   PetscInt        nmerged = 0;
6526500d4abSHong Zhang 
6536500d4abSHong Zhang   PetscFunctionBegin;
654e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
655daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->nsubnet == Nsubnet, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Must call DMNetworkAddSubnetwork() %" PetscInt_FMT " times", Nsubnet);
6562bf73ac6SHong Zhang 
657eac198afSGetnet   /* This implementation requires user input each subnet by a single processor when Nsubnet>1, thus subnet[net].nvtx=subnet[net].Nvtx when net>0 */
658eac198afSGetnet   for (net = 1; net < Nsubnet; net++) {
6599371c9d4SSatish Balay     if (network->cloneshared->subnet[net].nvtx)
6609371c9d4SSatish 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,
6619371c9d4SSatish Balay                  network->cloneshared->subnet[net].nvtx, network->cloneshared->subnet[net].Nvtx);
662eac198afSGetnet   }
663eac198afSGetnet 
6649566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
6655503a911SAidan Hamilton   PetscCall(MPI_Comm_size(comm, &size));
6666500d4abSHong Zhang 
667f11a936eSBarry Smith   /* Create LOCAL edgelist in global vertex ordering for the network by concatenating local input edgelists of the subnetworks */
668daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(2 * network->cloneshared->nEdges, &edges));
669eac198afSGetnet 
670daad07d3SAidan Hamilton   if (network->cloneshared->Nsvtx) { /* subnetworks are coupled via shared vertices */
6719566063dSJacob Faibussowitsch     PetscCall(GetEdgelist_Coupling(dm, edges, &nmerged));
672eac198afSGetnet   } else { /* subnetworks are not coupled */
6736aad120cSJose E. Roman     /* Create a 0-size svtable for query shared vertices */
674daad07d3SAidan Hamilton     PetscCall(PetscTableCreate(0, network->cloneshared->NVertices + 1, &network->cloneshared->svtable));
675caf410d2SHong Zhang     ctr = 0;
6762bf73ac6SHong Zhang     for (i = 0; i < Nsubnet; i++) {
677daad07d3SAidan Hamilton       for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
678daad07d3SAidan Hamilton         edges[2 * ctr]     = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j];
679daad07d3SAidan Hamilton         edges[2 * ctr + 1] = network->cloneshared->subnet[i].vStart + network->cloneshared->subnet[i].edgelist[2 * j + 1];
6806500d4abSHong Zhang         ctr++;
6816500d4abSHong Zhang       }
6826500d4abSHong Zhang     }
683eac198afSGetnet   }
6847765340cSHong Zhang 
6852bf73ac6SHong Zhang   /* Create network->plex; One dimensional network, numCorners=2 */
6869566063dSJacob Faibussowitsch   PetscCall(DMCreate(comm, &network->plex));
6879566063dSJacob Faibussowitsch   PetscCall(DMSetType(network->plex, DMPLEX));
6889566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(network->plex, 1));
689eac198afSGetnet 
690daad07d3SAidan Hamilton   if (size == 1) PetscCall(DMPlexBuildFromCellList(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, 2, edges));
691daad07d3SAidan Hamilton   else PetscCall(DMPlexBuildFromCellListParallel(network->plex, network->cloneshared->nEdges, PETSC_DECIDE, PETSC_DECIDE, 2, edges, NULL, NULL));
6926500d4abSHong Zhang 
693daad07d3SAidan Hamilton   PetscCall(DMPlexGetChart(network->plex, &network->cloneshared->pStart, &network->cloneshared->pEnd));
694daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 0, &network->cloneshared->eStart, &network->cloneshared->eEnd));
695daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(network->plex, 1, &network->cloneshared->vStart, &network->cloneshared->vEnd));
696daad07d3SAidan Hamilton   np = network->cloneshared->pEnd - network->cloneshared->pStart;
6979566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(np, &network->header, np, &network->cvalue));
698caf410d2SHong Zhang 
699f11a936eSBarry Smith   /* Create edge and vertex arrays for the subnetworks
700f11a936eSBarry Smith      This implementation assumes that DMNetwork reads
701f11a936eSBarry Smith      (1) a single subnetwork in parallel; or
702f11a936eSBarry Smith      (2) n subnetworks using n processors, one subnetwork/processor.
703f11a936eSBarry Smith   */
704daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(network->cloneshared->nEdges, &subnetedge, network->cloneshared->nVertices + network->cloneshared->nsvtx, &subnetvtx)); /* Maps local edge/vertex to local subnetwork's edge/vertex */
705daad07d3SAidan Hamilton   network->cloneshared->subnetedge = subnetedge;
706daad07d3SAidan Hamilton   network->cloneshared->subnetvtx  = subnetvtx;
7075c6496baSHong Zhang   for (j = 0; j < Nsubnet; j++) {
708daad07d3SAidan Hamilton     network->cloneshared->subnet[j].edges = subnetedge;
709daad07d3SAidan Hamilton     subnetedge += network->cloneshared->subnet[j].nedge;
710f11a936eSBarry Smith 
711daad07d3SAidan Hamilton     network->cloneshared->subnet[j].vertices = subnetvtx;
712daad07d3SAidan Hamilton     subnetvtx += network->cloneshared->subnet[j].nvtx;
7136500d4abSHong Zhang   }
714daad07d3SAidan Hamilton   network->cloneshared->svertices = subnetvtx;
715caf410d2SHong Zhang 
716caf410d2SHong Zhang   /* Get edge ownership */
717daad07d3SAidan Hamilton   np = network->cloneshared->eEnd - network->cloneshared->eStart;
7185503a911SAidan Hamilton   PetscCallMPI(MPI_Scan(&np, &globaledgeoff, 1, MPIU_INT, MPI_SUM, comm));
7195503a911SAidan Hamilton   globaledgeoff -= np;
720caf410d2SHong Zhang 
721eac198afSGetnet   /* Setup local edge and vertex arrays for subnetworks */
7222bf73ac6SHong Zhang   e = 0;
7232bf73ac6SHong Zhang   for (i = 0; i < Nsubnet; i++) {
724f11a936eSBarry Smith     ctr = 0;
725daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->subnet[i].nedge; j++) {
7262bf73ac6SHong Zhang       /* edge e */
7275503a911SAidan Hamilton       network->header[e].index                 = e + globaledgeoff; /* Global edge index */
7282bf73ac6SHong Zhang       network->header[e].subnetid              = i;
729daad07d3SAidan Hamilton       network->cloneshared->subnet[i].edges[j] = e;
7302bf73ac6SHong Zhang 
7312bf73ac6SHong Zhang       /* connected vertices */
7329566063dSJacob Faibussowitsch       PetscCall(DMPlexGetCone(network->plex, e, &cone));
7332bf73ac6SHong Zhang 
7342bf73ac6SHong Zhang       /* vertex cone[0] */
735f11a936eSBarry Smith       v                           = cone[0];
736f11a936eSBarry Smith       network->header[v].index    = edges[2 * e]; /* Global vertex index */
737f11a936eSBarry Smith       network->header[v].subnetid = i;            /* Subnetwork id */
738f11a936eSBarry Smith       if (Nsubnet == 1) {
739daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
740f11a936eSBarry Smith       } else {
741daad07d3SAidan Hamilton         vfrom                                           = network->cloneshared->subnet[i].edgelist[2 * ctr]; /* =subnet[i].idx, Global index! */
742daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vfrom] = v;                                                 /* user's subnet[].dix = petsc's v */
743f11a936eSBarry Smith       }
7442bf73ac6SHong Zhang 
7452bf73ac6SHong Zhang       /* vertex cone[1] */
746f11a936eSBarry Smith       v                           = cone[1];
747f11a936eSBarry Smith       network->header[v].index    = edges[2 * e + 1]; /* Global vertex index */
748f11a936eSBarry Smith       network->header[v].subnetid = i;                /* Subnetwork id */
749f11a936eSBarry Smith       if (Nsubnet == 1) {
750daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[v - network->cloneshared->vStart] = v; /* user's subnet[].idx = petsc's v */
751f11a936eSBarry Smith       } else {
752daad07d3SAidan Hamilton         vto                                           = network->cloneshared->subnet[i].edgelist[2 * ctr + 1]; /* =subnet[i].idx, Global index! */
753daad07d3SAidan Hamilton         network->cloneshared->subnet[i].vertices[vto] = v;                                                     /* user's subnet[].dix = petsc's v */
754f11a936eSBarry Smith       }
7552bf73ac6SHong Zhang 
7569371c9d4SSatish Balay       e++;
7579371c9d4SSatish Balay       ctr++;
7586500d4abSHong Zhang     }
7596500d4abSHong Zhang   }
7605503a911SAidan Hamilton   PetscCall(PetscFree(edges));
761caf410d2SHong Zhang 
762eac198afSGetnet   /* Set local vertex array for the subnetworks */
763eac198afSGetnet   j = 0;
764daad07d3SAidan Hamilton   for (v = network->cloneshared->vStart; v < network->cloneshared->vEnd; v++) {
765eac198afSGetnet     /* local shared vertex */
766daad07d3SAidan Hamilton     PetscCall(PetscTableFind(network->cloneshared->svtable, network->header[v].index + 1, &i));
767daad07d3SAidan Hamilton     if (i) network->cloneshared->svertices[j++] = v;
7686500d4abSHong Zhang   }
769eac198afSGetnet 
770eac198afSGetnet   /* Create a global section to be used by DMNetworkIsGhostVertex() which is a non-collective routine */
771eac198afSGetnet   /* see snes_tutorials_network-ex1_4 */
7729566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
773daad07d3SAidan Hamilton   /* Initialize non-topological data structures  */
774daad07d3SAidan Hamilton   PetscCall(DMNetworkInitializeNonTopological(dm));
775e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_LayoutSetUp, dm, 0, 0, 0));
7765f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
7775f2c45f1SShri Abhyankar }
7785f2c45f1SShri Abhyankar 
77994ef8ddeSSatish Balay /*@C
7802bf73ac6SHong Zhang   DMNetworkGetSubnetwork - Returns the information about a requested subnetwork
7812bf73ac6SHong Zhang 
7822bf73ac6SHong Zhang   Not collective
7832727e31bSShri Abhyankar 
7847a7aea1fSJed Brown   Input Parameters:
785caf410d2SHong Zhang + dm - the DM object
7862bf73ac6SHong Zhang - netnum - the global index of the subnetwork
7872727e31bSShri Abhyankar 
7887a7aea1fSJed Brown   Output Parameters:
7892727e31bSShri Abhyankar + nv - number of vertices (local)
7902727e31bSShri Abhyankar . ne - number of edges (local)
7912bf73ac6SHong Zhang . vtx - local vertices of the subnetwork
7922bf73ac6SHong Zhang - edge - local edges of the subnetwork
7932727e31bSShri Abhyankar 
7942727e31bSShri Abhyankar   Notes:
7952727e31bSShri Abhyankar     Cannot call this routine before DMNetworkLayoutSetup()
7962727e31bSShri Abhyankar 
797eac198afSGetnet     The local vertices returned on each rank are determined by DMNetwork. The user does not have any control over what vertices are local.
798eac198afSGetnet 
79906dd6b0eSSatish Balay   Level: intermediate
80006dd6b0eSSatish Balay 
801db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkLayoutSetUp()`
8022727e31bSShri Abhyankar @*/
803d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetwork(DM dm, PetscInt netnum, PetscInt *nv, PetscInt *ne, const PetscInt **vtx, const PetscInt **edge)
804d71ae5a4SJacob Faibussowitsch {
805caf410d2SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
8062727e31bSShri Abhyankar 
8072727e31bSShri Abhyankar   PetscFunctionBegin;
808daad07d3SAidan 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);
809daad07d3SAidan Hamilton   if (nv) *nv = network->cloneshared->subnet[netnum].nvtx;
810daad07d3SAidan Hamilton   if (ne) *ne = network->cloneshared->subnet[netnum].nedge;
811daad07d3SAidan Hamilton   if (vtx) *vtx = network->cloneshared->subnet[netnum].vertices;
812daad07d3SAidan Hamilton   if (edge) *edge = network->cloneshared->subnet[netnum].edges;
8132bf73ac6SHong Zhang   PetscFunctionReturn(0);
8142bf73ac6SHong Zhang }
8152bf73ac6SHong Zhang 
8162bf73ac6SHong Zhang /*@
8172bf73ac6SHong Zhang   DMNetworkAddSharedVertices - Add shared vertices that connect two given subnetworks
8182bf73ac6SHong Zhang 
8192bf73ac6SHong Zhang   Collective on dm
8202bf73ac6SHong Zhang 
8212bf73ac6SHong Zhang   Input Parameters:
8222bf73ac6SHong Zhang + dm - the dm object
8232bf73ac6SHong Zhang . anetnum - first subnetwork global numbering returned by DMNetworkAddSubnetwork()
8242bf73ac6SHong Zhang . bnetnum - second subnetwork global numbering returned by DMNetworkAddSubnetwork()
8252bf73ac6SHong Zhang . nsvtx - number of vertices that are shared by the two subnetworks
8262bf73ac6SHong Zhang . asvtx - vertex index in the first subnetwork
8272bf73ac6SHong Zhang - bsvtx - vertex index in the second subnetwork
8282bf73ac6SHong Zhang 
8292bf73ac6SHong Zhang   Level: beginner
8302bf73ac6SHong Zhang 
831db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkAddSubnetwork()`, `DMNetworkGetSharedVertices()`
8322bf73ac6SHong Zhang @*/
833d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddSharedVertices(DM dm, PetscInt anetnum, PetscInt bnetnum, PetscInt nsvtx, PetscInt asvtx[], PetscInt bsvtx[])
834d71ae5a4SJacob Faibussowitsch {
8352bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
836daad07d3SAidan Hamilton   PetscInt    i, nsubnet = network->cloneshared->Nsubnet, *sedgelist, Nsvtx = network->cloneshared->Nsvtx;
8372bf73ac6SHong Zhang 
8382bf73ac6SHong Zhang   PetscFunctionBegin;
8395c6496baSHong Zhang   PetscCheck(anetnum != bnetnum, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "Subnetworks must have different netnum");
8405c6496baSHong Zhang   PetscCheck(anetnum >= 0 && bnetnum >= 0, PetscObjectComm((PetscObject)dm), PETSC_ERR_USER, "netnum cannot be negative");
8412bf73ac6SHong Zhang   if (!Nsvtx) {
8422bf73ac6SHong Zhang     /* allocate network->sedgelist to hold at most 2*nsubnet pairs of shared vertices */
843daad07d3SAidan Hamilton     PetscCall(PetscMalloc1(2 * 4 * nsubnet, &network->cloneshared->sedgelist));
8442bf73ac6SHong Zhang   }
8452bf73ac6SHong Zhang 
846daad07d3SAidan Hamilton   sedgelist = network->cloneshared->sedgelist;
8472bf73ac6SHong Zhang   for (i = 0; i < nsvtx; i++) {
8489371c9d4SSatish Balay     sedgelist[4 * Nsvtx]     = anetnum;
8499371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 1] = asvtx[i];
8509371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 2] = bnetnum;
8519371c9d4SSatish Balay     sedgelist[4 * Nsvtx + 3] = bsvtx[i];
8522bf73ac6SHong Zhang     Nsvtx++;
8532bf73ac6SHong Zhang   }
8545c6496baSHong Zhang   PetscCheck(Nsvtx <= 2 * nsubnet, PETSC_COMM_SELF, PETSC_ERR_SUP, "allocate more space for coupling edgelist");
855daad07d3SAidan Hamilton   network->cloneshared->Nsvtx = Nsvtx;
8562727e31bSShri Abhyankar   PetscFunctionReturn(0);
8572727e31bSShri Abhyankar }
8582727e31bSShri Abhyankar 
8592727e31bSShri Abhyankar /*@C
8602bf73ac6SHong Zhang   DMNetworkGetSharedVertices - Returns the info for the shared vertices
8612bf73ac6SHong Zhang 
8622bf73ac6SHong Zhang   Not collective
863caf410d2SHong Zhang 
864f899ff85SJose E. Roman   Input Parameter:
8652bf73ac6SHong Zhang . dm - the DM object
866caf410d2SHong Zhang 
8677a7aea1fSJed Brown   Output Parameters:
8682bf73ac6SHong Zhang + nsv - number of local shared vertices
8692bf73ac6SHong Zhang - svtx - local shared vertices
870caf410d2SHong Zhang 
871caf410d2SHong Zhang   Notes:
872caf410d2SHong Zhang   Cannot call this routine before DMNetworkLayoutSetup()
873caf410d2SHong Zhang 
874caf410d2SHong Zhang   Level: intermediate
875caf410d2SHong Zhang 
876db781477SPatrick Sanan .seealso: `DMNetworkGetSubnetwork()`, `DMNetworkLayoutSetUp()`, `DMNetworkAddSharedVertices()`
877caf410d2SHong Zhang @*/
878d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSharedVertices(DM dm, PetscInt *nsv, const PetscInt **svtx)
879d71ae5a4SJacob Faibussowitsch {
880caf410d2SHong Zhang   DM_Network *net = (DM_Network *)dm->data;
881caf410d2SHong Zhang 
882caf410d2SHong Zhang   PetscFunctionBegin;
8835c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
884daad07d3SAidan Hamilton   if (nsv) *nsv = net->cloneshared->nsvtx;
885daad07d3SAidan Hamilton   if (svtx) *svtx = net->cloneshared->svertices;
886caf410d2SHong Zhang   PetscFunctionReturn(0);
887caf410d2SHong Zhang }
888caf410d2SHong Zhang 
889caf410d2SHong Zhang /*@C
8905f2c45f1SShri Abhyankar   DMNetworkRegisterComponent - Registers the network component
8915f2c45f1SShri Abhyankar 
892d083f849SBarry Smith   Logically collective on dm
8935f2c45f1SShri Abhyankar 
8947a7aea1fSJed Brown   Input Parameters:
8955f2c45f1SShri Abhyankar + dm - the network object
8965f2c45f1SShri Abhyankar . name - the component name
8975f2c45f1SShri Abhyankar - size - the storage size in bytes for this component data
8985f2c45f1SShri Abhyankar 
8997a7aea1fSJed Brown    Output Parameters:
9005f2c45f1SShri Abhyankar .  key - an integer key that defines the component
9015f2c45f1SShri Abhyankar 
90287497f52SBarry Smith    Note:
90387497f52SBarry Smith    This routine should be called by all processors before calling `DMNetworkLayoutSetup()`.
9045f2c45f1SShri Abhyankar 
90597bb938eSShri Abhyankar    Level: beginner
9065f2c45f1SShri Abhyankar 
907db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkLayoutSetUp()`
9085f2c45f1SShri Abhyankar @*/
909d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkRegisterComponent(DM dm, const char *name, size_t size, PetscInt *key)
910d71ae5a4SJacob Faibussowitsch {
9115f2c45f1SShri Abhyankar   DM_Network         *network   = (DM_Network *)dm->data;
91254dfd506SHong Zhang   DMNetworkComponent *component = NULL, *newcomponent = NULL;
9135f2c45f1SShri Abhyankar   PetscBool           flg = PETSC_FALSE;
9145f2c45f1SShri Abhyankar   PetscInt            i;
9155f2c45f1SShri Abhyankar 
9165f2c45f1SShri Abhyankar   PetscFunctionBegin;
91748a46eb9SPierre Jolivet   if (!network->component) PetscCall(PetscCalloc1(network->max_comps_registered, &network->component));
91854dfd506SHong Zhang 
9195f2c45f1SShri Abhyankar   for (i = 0; i < network->ncomponent; i++) {
9209566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(network->component[i].name, name, &flg));
9215f2c45f1SShri Abhyankar     if (flg) {
9225f2c45f1SShri Abhyankar       *key = i;
9235f2c45f1SShri Abhyankar       PetscFunctionReturn(0);
9245f2c45f1SShri Abhyankar     }
9256d64e262SShri Abhyankar   }
92654dfd506SHong Zhang 
92754dfd506SHong Zhang   if (network->ncomponent == network->max_comps_registered) {
92854dfd506SHong Zhang     /* Reached max allowed so resize component */
92954dfd506SHong Zhang     network->max_comps_registered += 2;
9309566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(network->max_comps_registered, &newcomponent));
93154dfd506SHong Zhang     /* Copy over the previous component info */
93254dfd506SHong Zhang     for (i = 0; i < network->ncomponent; i++) {
9339566063dSJacob Faibussowitsch       PetscCall(PetscStrcpy(newcomponent[i].name, network->component[i].name));
93454dfd506SHong Zhang       newcomponent[i].size = network->component[i].size;
9355f2c45f1SShri Abhyankar     }
93654dfd506SHong Zhang     /* Free old one */
9379566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->component));
93854dfd506SHong Zhang     /* Update pointer */
93954dfd506SHong Zhang     network->component = newcomponent;
94054dfd506SHong Zhang   }
94154dfd506SHong Zhang 
94254dfd506SHong Zhang   component = &network->component[network->ncomponent];
9435f2c45f1SShri Abhyankar 
9449566063dSJacob Faibussowitsch   PetscCall(PetscStrcpy(component->name, name));
9455f2c45f1SShri Abhyankar   component->size = size / sizeof(DMNetworkComponentGenericDataType);
9465f2c45f1SShri Abhyankar   *key            = network->ncomponent;
9475f2c45f1SShri Abhyankar   network->ncomponent++;
9485f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
9495f2c45f1SShri Abhyankar }
9505f2c45f1SShri Abhyankar 
9515f2c45f1SShri Abhyankar /*@
9522bf73ac6SHong Zhang   DMNetworkGetVertexRange - Get the bounds [start, end) for the local vertices
9535f2c45f1SShri Abhyankar 
9545f2c45f1SShri Abhyankar   Not Collective
9555f2c45f1SShri Abhyankar 
956f899ff85SJose E. Roman   Input Parameter:
9572bf73ac6SHong Zhang . dm - the DMNetwork object
9585f2c45f1SShri Abhyankar 
959fd292e60Sprj-   Output Parameters:
9602bf73ac6SHong Zhang + vStart - the first vertex point
9612bf73ac6SHong Zhang - vEnd - one beyond the last vertex point
9625f2c45f1SShri Abhyankar 
96397bb938eSShri Abhyankar   Level: beginner
9645f2c45f1SShri Abhyankar 
965db781477SPatrick Sanan .seealso: `DMNetworkGetEdgeRange()`
9665f2c45f1SShri Abhyankar @*/
967d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexRange(DM dm, PetscInt *vStart, PetscInt *vEnd)
968d71ae5a4SJacob Faibussowitsch {
9695f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
9705f2c45f1SShri Abhyankar 
9715f2c45f1SShri Abhyankar   PetscFunctionBegin;
972daad07d3SAidan Hamilton   if (vStart) *vStart = network->cloneshared->vStart;
973daad07d3SAidan Hamilton   if (vEnd) *vEnd = network->cloneshared->vEnd;
9745f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
9755f2c45f1SShri Abhyankar }
9765f2c45f1SShri Abhyankar 
9775f2c45f1SShri Abhyankar /*@
9782bf73ac6SHong Zhang   DMNetworkGetEdgeRange - Get the bounds [start, end) for the local edges
9795f2c45f1SShri Abhyankar 
9805f2c45f1SShri Abhyankar   Not Collective
9815f2c45f1SShri Abhyankar 
982f899ff85SJose E. Roman   Input Parameter:
9832bf73ac6SHong Zhang . dm - the DMNetwork object
9845f2c45f1SShri Abhyankar 
985fd292e60Sprj-   Output Parameters:
9865f2c45f1SShri Abhyankar + eStart - The first edge point
9875f2c45f1SShri Abhyankar - eEnd - One beyond the last edge point
9885f2c45f1SShri Abhyankar 
98997bb938eSShri Abhyankar   Level: beginner
9905f2c45f1SShri Abhyankar 
991db781477SPatrick Sanan .seealso: `DMNetworkGetVertexRange()`
9925f2c45f1SShri Abhyankar @*/
993d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeRange(DM dm, PetscInt *eStart, PetscInt *eEnd)
994d71ae5a4SJacob Faibussowitsch {
9955f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
9965f2c45f1SShri Abhyankar 
9975f2c45f1SShri Abhyankar   PetscFunctionBegin;
9985c6496baSHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
999daad07d3SAidan Hamilton   if (eStart) *eStart = network->cloneshared->eStart;
1000daad07d3SAidan Hamilton   if (eEnd) *eEnd = network->cloneshared->eEnd;
10015f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
10025f2c45f1SShri Abhyankar }
10035f2c45f1SShri Abhyankar 
1004d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetIndex(DM dm, PetscInt p, PetscInt *index)
1005d71ae5a4SJacob Faibussowitsch {
10062bf73ac6SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
10075c6496baSHong Zhang 
10085c6496baSHong Zhang   PetscFunctionBegin;
10095c6496baSHong Zhang   if (network->header) {
10105c6496baSHong Zhang     *index = network->header[p].index;
10115c6496baSHong Zhang   } else {
10122bf73ac6SHong Zhang     PetscInt                 offsetp;
10132bf73ac6SHong Zhang     DMNetworkComponentHeader header;
10142bf73ac6SHong Zhang 
10159566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
10162bf73ac6SHong Zhang     header = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
10172bf73ac6SHong Zhang     *index = header->index;
10185c6496baSHong Zhang   }
10192bf73ac6SHong Zhang   PetscFunctionReturn(0);
10202bf73ac6SHong Zhang }
10212bf73ac6SHong Zhang 
1022d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSubnetID(DM dm, PetscInt p, PetscInt *subnetid)
1023d71ae5a4SJacob Faibussowitsch {
1024daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
1025daad07d3SAidan Hamilton 
1026daad07d3SAidan Hamilton   PetscFunctionBegin;
1027daad07d3SAidan Hamilton   if (network->header) {
1028daad07d3SAidan Hamilton     *subnetid = network->header[p].subnetid;
1029daad07d3SAidan Hamilton   } else {
1030daad07d3SAidan Hamilton     PetscInt                 offsetp;
1031daad07d3SAidan Hamilton     DMNetworkComponentHeader header;
1032daad07d3SAidan Hamilton 
1033daad07d3SAidan Hamilton     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
1034daad07d3SAidan Hamilton     header    = (DMNetworkComponentHeader)(network->componentdataarray + offsetp);
1035daad07d3SAidan Hamilton     *subnetid = header->subnetid;
1036daad07d3SAidan Hamilton   }
1037daad07d3SAidan Hamilton   PetscFunctionReturn(0);
1038daad07d3SAidan Hamilton }
1039daad07d3SAidan Hamilton 
10407b6afd5bSHong Zhang /*@
10412bf73ac6SHong Zhang   DMNetworkGetGlobalEdgeIndex - Get the global numbering for the edge on the network
10427b6afd5bSHong Zhang 
10437b6afd5bSHong Zhang   Not Collective
10447b6afd5bSHong Zhang 
10457b6afd5bSHong Zhang   Input Parameters:
10467b6afd5bSHong Zhang + dm - DMNetwork object
1047e85e6aecSHong Zhang - p - edge point
10487b6afd5bSHong Zhang 
1049fd292e60Sprj-   Output Parameters:
10502bf73ac6SHong Zhang . index - the global numbering for the edge
10517b6afd5bSHong Zhang 
10527b6afd5bSHong Zhang   Level: intermediate
10537b6afd5bSHong Zhang 
1054db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalVertexIndex()`
10557b6afd5bSHong Zhang @*/
1056d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalEdgeIndex(DM dm, PetscInt p, PetscInt *index)
1057d71ae5a4SJacob Faibussowitsch {
10587b6afd5bSHong Zhang   PetscFunctionBegin;
10599566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
10607b6afd5bSHong Zhang   PetscFunctionReturn(0);
10617b6afd5bSHong Zhang }
10627b6afd5bSHong Zhang 
10635f2c45f1SShri Abhyankar /*@
10642bf73ac6SHong Zhang   DMNetworkGetGlobalVertexIndex - Get the global numbering for the vertex on the network
1065e85e6aecSHong Zhang 
1066e85e6aecSHong Zhang   Not Collective
1067e85e6aecSHong Zhang 
1068e85e6aecSHong Zhang   Input Parameters:
1069e85e6aecSHong Zhang + dm - DMNetwork object
1070e85e6aecSHong Zhang - p  - vertex point
1071e85e6aecSHong Zhang 
1072fd292e60Sprj-   Output Parameters:
10732bf73ac6SHong Zhang . index - the global numbering for the vertex
1074e85e6aecSHong Zhang 
1075e85e6aecSHong Zhang   Level: intermediate
1076e85e6aecSHong Zhang 
1077db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalEdgeIndex()`, `DMNetworkGetLocalVertexIndex()`
1078e85e6aecSHong Zhang @*/
1079d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVertexIndex(DM dm, PetscInt p, PetscInt *index)
1080d71ae5a4SJacob Faibussowitsch {
1081e85e6aecSHong Zhang   PetscFunctionBegin;
10829566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetIndex(dm, p, index));
10839988b915SShri Abhyankar   PetscFunctionReturn(0);
10849988b915SShri Abhyankar }
10859988b915SShri Abhyankar 
10869988b915SShri Abhyankar /*@
10875f2c45f1SShri Abhyankar   DMNetworkGetNumComponents - Get the number of components at a vertex/edge
10885f2c45f1SShri Abhyankar 
10895f2c45f1SShri Abhyankar   Not Collective
10905f2c45f1SShri Abhyankar 
10915f2c45f1SShri Abhyankar   Input Parameters:
10922bf73ac6SHong Zhang + dm - the DMNetwork object
1093a2b725a8SWilliam Gropp - p - vertex/edge point
10945f2c45f1SShri Abhyankar 
10955f2c45f1SShri Abhyankar   Output Parameters:
10965f2c45f1SShri Abhyankar . numcomponents - Number of components at the vertex/edge
10975f2c45f1SShri Abhyankar 
109897bb938eSShri Abhyankar   Level: beginner
10995f2c45f1SShri Abhyankar 
1100db781477SPatrick Sanan .seealso: `DMNetworkRegisterComponent()`, `DMNetworkAddComponent()`
11015f2c45f1SShri Abhyankar @*/
1102d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetNumComponents(DM dm, PetscInt p, PetscInt *numcomponents)
1103d71ae5a4SJacob Faibussowitsch {
11045f2c45f1SShri Abhyankar   PetscInt    offset;
11055f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
11065f2c45f1SShri Abhyankar 
11075f2c45f1SShri Abhyankar   PetscFunctionBegin;
11089566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
11095f2c45f1SShri Abhyankar   *numcomponents = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
11105f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
11115f2c45f1SShri Abhyankar }
11125f2c45f1SShri Abhyankar 
11135f2c45f1SShri Abhyankar /*@
11142bf73ac6SHong Zhang   DMNetworkGetLocalVecOffset - Get the offset for accessing the variables associated with a component at the given vertex/edge from the local vector
11155f2c45f1SShri Abhyankar 
11165f2c45f1SShri Abhyankar   Not Collective
11175f2c45f1SShri Abhyankar 
11185f2c45f1SShri Abhyankar   Input Parameters:
11192bf73ac6SHong Zhang + dm - the DMNetwork object
1120f2f58720SBarry Smith . p - the edge or vertex point
11212bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
11229988b915SShri Abhyankar 
11239988b915SShri Abhyankar   Output Parameters:
11242bf73ac6SHong Zhang . offset - the local offset
11259988b915SShri Abhyankar 
1126f2f58720SBarry Smith   Notes:
1127f2f58720SBarry Smith     These offsets can be passed to MatSetValuesLocal() for matrices obtained with DMCreateMatrix().
1128f2f58720SBarry Smith 
1129f2f58720SBarry Smith     For vectors obtained with DMCreateLocalVector() the offsets can be used with VecSetValues().
1130f2f58720SBarry Smith 
1131f2f58720SBarry Smith     For vectors obtained with DMCreateLocalVector() and the array obtained with VecGetArray(vec,&array) you can access or set
1132f2f58720SBarry Smith     the vector values with array[offset].
1133f2f58720SBarry Smith 
1134f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() the offsets can be used with VecSetValuesLocal().
1135f2f58720SBarry Smith 
11369988b915SShri Abhyankar   Level: intermediate
11379988b915SShri Abhyankar 
1138db781477SPatrick Sanan .seealso: `DMGetLocalVector()`, `DMNetworkGetComponent()`, `DMNetworkGetGlobalVecOffset()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValuesLocal()`, `MatSetValuesLocal()`
11399988b915SShri Abhyankar @*/
1140d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetLocalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offset)
1141d71ae5a4SJacob Faibussowitsch {
11429988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
11439988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
11449988b915SShri Abhyankar   DMNetworkComponentHeader header;
11459988b915SShri Abhyankar 
11469988b915SShri Abhyankar   PetscFunctionBegin;
11479566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->localSection, p, &offsetp));
11482bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
11492bf73ac6SHong Zhang     *offset = offsetp;
11502bf73ac6SHong Zhang     PetscFunctionReturn(0);
11512bf73ac6SHong Zhang   }
11522bf73ac6SHong Zhang 
11539566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
11549988b915SShri Abhyankar   header  = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
11559988b915SShri Abhyankar   *offset = offsetp + header->offsetvarrel[compnum];
11569988b915SShri Abhyankar   PetscFunctionReturn(0);
11579988b915SShri Abhyankar }
11589988b915SShri Abhyankar 
11599988b915SShri Abhyankar /*@
11602bf73ac6SHong Zhang   DMNetworkGetGlobalVecOffset - Get the global offset for accessing the variables associated with a component for the given vertex/edge from the global vector
11619988b915SShri Abhyankar 
11629988b915SShri Abhyankar   Not Collective
11639988b915SShri Abhyankar 
11649988b915SShri Abhyankar   Input Parameters:
11652bf73ac6SHong Zhang + dm - the DMNetwork object
1166f2f58720SBarry Smith . p - the edge or vertex point
11672bf73ac6SHong Zhang - compnum - component number; use ALL_COMPONENTS if no specific component is requested
11689988b915SShri Abhyankar 
11699988b915SShri Abhyankar   Output Parameters:
11709988b915SShri Abhyankar . offsetg - the global offset
11719988b915SShri Abhyankar 
1172f2f58720SBarry Smith   Notes:
1173f2f58720SBarry Smith     These offsets can be passed to MatSetValues() for matrices obtained with DMCreateMatrix().
1174f2f58720SBarry Smith 
1175f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() the offsets can be used with VecSetValues().
1176f2f58720SBarry Smith 
1177f2f58720SBarry Smith     For vectors obtained with DMCreateGlobalVector() and the array obtained with VecGetArray(vec,&array) you can access or set
1178f2f58720SBarry Smith     the vector values with array[offset - rstart] where restart is obtained with VecGetOwnershipRange(v,&rstart,NULL);
1179f2f58720SBarry Smith 
11809988b915SShri Abhyankar   Level: intermediate
11819988b915SShri Abhyankar 
1182db781477SPatrick Sanan .seealso: `DMNetworkGetLocalVecOffset()`, `DMGetGlobalVector()`, `DMNetworkGetComponent()`, `DMCreateGlobalVector()`, `VecGetArray()`, `VecSetValues()`, `MatSetValues()`
11839988b915SShri Abhyankar @*/
1184d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetGlobalVecOffset(DM dm, PetscInt p, PetscInt compnum, PetscInt *offsetg)
1185d71ae5a4SJacob Faibussowitsch {
11869988b915SShri Abhyankar   DM_Network              *network = (DM_Network *)dm->data;
11879988b915SShri Abhyankar   PetscInt                 offsetp, offsetd;
11889988b915SShri Abhyankar   DMNetworkComponentHeader header;
11899988b915SShri Abhyankar 
11909988b915SShri Abhyankar   PetscFunctionBegin;
11919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->plex->globalSection, p, &offsetp));
11922bf73ac6SHong Zhang   if (offsetp < 0) offsetp = -(offsetp + 1); /* Convert to actual global offset for ghost vertex */
11932bf73ac6SHong Zhang 
11942bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
11952bf73ac6SHong Zhang     *offsetg = offsetp;
11962bf73ac6SHong Zhang     PetscFunctionReturn(0);
11972bf73ac6SHong Zhang   }
11989566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetd));
11999988b915SShri Abhyankar   header   = (DMNetworkComponentHeader)(network->componentdataarray + offsetd);
12009988b915SShri Abhyankar   *offsetg = offsetp + header->offsetvarrel[compnum];
12019988b915SShri Abhyankar   PetscFunctionReturn(0);
12029988b915SShri Abhyankar }
12039988b915SShri Abhyankar 
12049988b915SShri Abhyankar /*@
12052bf73ac6SHong Zhang   DMNetworkGetEdgeOffset - Get the offset for accessing the variables associated with the given edge from the local subvector
120624121865SAdrian Maldonado 
120724121865SAdrian Maldonado   Not Collective
120824121865SAdrian Maldonado 
120924121865SAdrian Maldonado   Input Parameters:
12102bf73ac6SHong Zhang + dm - the DMNetwork object
121124121865SAdrian Maldonado - p - the edge point
121224121865SAdrian Maldonado 
121324121865SAdrian Maldonado   Output Parameters:
121424121865SAdrian Maldonado . offset - the offset
121524121865SAdrian Maldonado 
121624121865SAdrian Maldonado   Level: intermediate
121724121865SAdrian Maldonado 
1218db781477SPatrick Sanan .seealso: `DMNetworkGetLocalVecOffset()`, `DMGetLocalVector()`
121924121865SAdrian Maldonado @*/
1220d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetEdgeOffset(DM dm, PetscInt p, PetscInt *offset)
1221d71ae5a4SJacob Faibussowitsch {
122224121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
122324121865SAdrian Maldonado 
122424121865SAdrian Maldonado   PetscFunctionBegin;
12259566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->edge.DofSection, p, offset));
122624121865SAdrian Maldonado   PetscFunctionReturn(0);
122724121865SAdrian Maldonado }
122824121865SAdrian Maldonado 
122924121865SAdrian Maldonado /*@
12302bf73ac6SHong Zhang   DMNetworkGetVertexOffset - Get the offset for accessing the variables associated with the given vertex from the local subvector
123124121865SAdrian Maldonado 
123224121865SAdrian Maldonado   Not Collective
123324121865SAdrian Maldonado 
123424121865SAdrian Maldonado   Input Parameters:
12352bf73ac6SHong Zhang + dm - the DMNetwork object
123624121865SAdrian Maldonado - p - the vertex point
123724121865SAdrian Maldonado 
123824121865SAdrian Maldonado   Output Parameters:
123924121865SAdrian Maldonado . offset - the offset
124024121865SAdrian Maldonado 
124124121865SAdrian Maldonado   Level: intermediate
124224121865SAdrian Maldonado 
1243db781477SPatrick Sanan .seealso: `DMNetworkGetEdgeOffset()`, `DMGetLocalVector()`
124424121865SAdrian Maldonado @*/
1245d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexOffset(DM dm, PetscInt p, PetscInt *offset)
1246d71ae5a4SJacob Faibussowitsch {
124724121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
124824121865SAdrian Maldonado 
124924121865SAdrian Maldonado   PetscFunctionBegin;
1250daad07d3SAidan Hamilton   p -= network->cloneshared->vStart;
12519566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->vertex.DofSection, p, offset));
125224121865SAdrian Maldonado   PetscFunctionReturn(0);
125324121865SAdrian Maldonado }
12542bf73ac6SHong Zhang 
12555f2c45f1SShri Abhyankar /*@
12562bf73ac6SHong Zhang   DMNetworkAddComponent - Adds a network component and number of variables at the given point (vertex/edge)
12575f2c45f1SShri Abhyankar 
1258eac198afSGetnet   Collective on dm
12595f2c45f1SShri Abhyankar 
12605f2c45f1SShri Abhyankar   Input Parameters:
12614dc646bcSBarry Smith + dm - the DMNetwork
1262eac198afSGetnet . p - the vertex/edge point. These points are local indices provided by DMNetworkGetSubnetwork()
1263eac198afSGetnet . componentkey - component key returned while registering the component with DMNetworkRegisterComponent()
126424359064SBarry 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
126524359064SBarry Smith               free this space until after DMSetUp() is called.
1266eac198afSGetnet - 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
12675f2c45f1SShri Abhyankar 
1268eac198afSGetnet   Notes:
1269eac198afSGetnet     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.
1270eac198afSGetnet 
1271eac198afSGetnet     DMNetworkLayoutSetUp() must be called before this routine.
1272eac198afSGetnet 
1273eac198afSGetnet   Developer Notes:
1274eac198afSGetnet      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.
127597bb938eSShri Abhyankar   Level: beginner
12765f2c45f1SShri Abhyankar 
1277db781477SPatrick Sanan .seealso: `DMNetworkGetComponent()`, `DMNetworkGetSubnetwork()`, `DMNetworkIsGhostVertex()`, `DMNetworkLayoutSetUp()`
12785f2c45f1SShri Abhyankar @*/
1279d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAddComponent(DM dm, PetscInt p, PetscInt componentkey, void *compvalue, PetscInt nvar)
1280d71ae5a4SJacob Faibussowitsch {
12815f2c45f1SShri Abhyankar   DM_Network              *network   = (DM_Network *)dm->data;
12822bf73ac6SHong Zhang   DMNetworkComponent      *component = &network->component[componentkey];
128354dfd506SHong Zhang   DMNetworkComponentHeader header;
128454dfd506SHong Zhang   DMNetworkComponentValue  cvalue;
128554dfd506SHong Zhang   PetscInt                 compnum;
128654dfd506SHong Zhang   PetscInt                *compsize, *compkey, *compoffset, *compnvar, *compoffsetvarrel;
128754dfd506SHong Zhang   void                   **compdata;
12885f2c45f1SShri Abhyankar 
12895f2c45f1SShri Abhyankar   PetscFunctionBegin;
12905c6496baSHong 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);
1291daad07d3SAidan 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.");
1292eac198afSGetnet   /* The owning rank and all ghost ranks add nvar */
12939566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DofSection, p, nvar));
12942bf73ac6SHong Zhang 
1295eac198afSGetnet   /* The owning rank and all ghost ranks add a component, including compvalue=NULL */
129654dfd506SHong Zhang   header = &network->header[p];
129754dfd506SHong Zhang   cvalue = &network->cvalue[p];
129854dfd506SHong Zhang   if (header->ndata == header->maxcomps) {
1299f11a936eSBarry Smith     PetscInt additional_size;
1300f11a936eSBarry Smith 
130154dfd506SHong Zhang     /* Reached limit so resize header component arrays */
130254dfd506SHong Zhang     header->maxcomps += 2;
130354dfd506SHong Zhang 
130454dfd506SHong Zhang     /* Allocate arrays for component information and value */
13059566063dSJacob Faibussowitsch     PetscCall(PetscCalloc5(header->maxcomps, &compsize, header->maxcomps, &compkey, header->maxcomps, &compoffset, header->maxcomps, &compnvar, header->maxcomps, &compoffsetvarrel));
13069566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(header->maxcomps, &compdata));
130754dfd506SHong Zhang 
130854dfd506SHong Zhang     /* Recalculate header size */
130954dfd506SHong Zhang     header->hsize = sizeof(struct _p_DMNetworkComponentHeader) + 5 * header->maxcomps * sizeof(PetscInt);
131054dfd506SHong Zhang 
131154dfd506SHong Zhang     header->hsize /= sizeof(DMNetworkComponentGenericDataType);
131254dfd506SHong Zhang 
131354dfd506SHong Zhang     /* Copy over component info */
13149566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compsize, header->size, header->ndata * sizeof(PetscInt)));
13159566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compkey, header->key, header->ndata * sizeof(PetscInt)));
13169566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffset, header->offset, header->ndata * sizeof(PetscInt)));
13179566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compnvar, header->nvar, header->ndata * sizeof(PetscInt)));
13189566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compoffsetvarrel, header->offsetvarrel, header->ndata * sizeof(PetscInt)));
131954dfd506SHong Zhang 
132054dfd506SHong Zhang     /* Copy over component data pointers */
13219566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(compdata, cvalue->data, header->ndata * sizeof(void *)));
132254dfd506SHong Zhang 
132354dfd506SHong Zhang     /* Free old arrays */
13249566063dSJacob Faibussowitsch     PetscCall(PetscFree5(header->size, header->key, header->offset, header->nvar, header->offsetvarrel));
13259566063dSJacob Faibussowitsch     PetscCall(PetscFree(cvalue->data));
132654dfd506SHong Zhang 
132754dfd506SHong Zhang     /* Update pointers */
132854dfd506SHong Zhang     header->size         = compsize;
132954dfd506SHong Zhang     header->key          = compkey;
133054dfd506SHong Zhang     header->offset       = compoffset;
133154dfd506SHong Zhang     header->nvar         = compnvar;
133254dfd506SHong Zhang     header->offsetvarrel = compoffsetvarrel;
133354dfd506SHong Zhang 
133454dfd506SHong Zhang     cvalue->data = compdata;
133554dfd506SHong Zhang 
133654dfd506SHong Zhang     /* Update DataSection Dofs */
133754dfd506SHong 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 */
1338f11a936eSBarry Smith     additional_size = (5 * (header->maxcomps - header->ndata) * sizeof(PetscInt)) / sizeof(DMNetworkComponentGenericDataType);
13399566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(network->DataSection, p, additional_size));
134054dfd506SHong Zhang   }
134154dfd506SHong Zhang   header = &network->header[p];
134254dfd506SHong Zhang   cvalue = &network->cvalue[p];
134354dfd506SHong Zhang 
134454dfd506SHong Zhang   compnum = header->ndata;
13452bf73ac6SHong Zhang 
13462bf73ac6SHong Zhang   header->size[compnum] = component->size;
13479566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(network->DataSection, p, component->size));
13482bf73ac6SHong Zhang   header->key[compnum] = componentkey;
13492bf73ac6SHong Zhang   if (compnum != 0) header->offset[compnum] = header->offset[compnum - 1] + header->size[compnum - 1];
13502bf73ac6SHong Zhang   cvalue->data[compnum] = (void *)compvalue;
13512bf73ac6SHong Zhang 
13522bf73ac6SHong Zhang   /* variables */
13532bf73ac6SHong Zhang   header->nvar[compnum] += nvar;
13542bf73ac6SHong Zhang   if (compnum != 0) header->offsetvarrel[compnum] = header->offsetvarrel[compnum - 1] + header->nvar[compnum - 1];
13552bf73ac6SHong Zhang 
13562bf73ac6SHong Zhang   header->ndata++;
13575f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
13585f2c45f1SShri Abhyankar }
13595f2c45f1SShri Abhyankar 
136027f51fceSHong Zhang /*@
13612bf73ac6SHong Zhang   DMNetworkGetComponent - Gets the component key, the component data, and the number of variables at a given network point
136227f51fceSHong Zhang 
136327f51fceSHong Zhang   Not Collective
136427f51fceSHong Zhang 
136527f51fceSHong Zhang   Input Parameters:
13662bf73ac6SHong Zhang + dm - the DMNetwork object
13672bf73ac6SHong Zhang . p - vertex/edge point
136899c90e12SSatish Balay - compnum - component number; use ALL_COMPONENTS if sum up all the components
136927f51fceSHong Zhang 
137027f51fceSHong Zhang   Output Parameters:
13712bf73ac6SHong Zhang + compkey - the key obtained when registering the component (use NULL if not required)
13722bf73ac6SHong Zhang . component - the component data (use NULL if not required)
13732bf73ac6SHong Zhang - nvar  - number of variables (use NULL if not required)
137427f51fceSHong Zhang 
137597bb938eSShri Abhyankar   Level: beginner
137627f51fceSHong Zhang 
1377db781477SPatrick Sanan .seealso: `DMNetworkAddComponent()`, `DMNetworkGetNumComponents()`
137827f51fceSHong Zhang @*/
1379d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetComponent(DM dm, PetscInt p, PetscInt compnum, PetscInt *compkey, void **component, PetscInt *nvar)
1380d71ae5a4SJacob Faibussowitsch {
138127f51fceSHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
13822bf73ac6SHong Zhang   PetscInt                 offset  = 0;
13832bf73ac6SHong Zhang   DMNetworkComponentHeader header;
138427f51fceSHong Zhang 
138527f51fceSHong Zhang   PetscFunctionBegin;
13862bf73ac6SHong Zhang   if (compnum == ALL_COMPONENTS) {
13879566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, p, nvar));
138827f51fceSHong Zhang     PetscFunctionReturn(0);
138927f51fceSHong Zhang   }
139027f51fceSHong Zhang 
13919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
139242dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
13935f2c45f1SShri Abhyankar 
13942bf73ac6SHong Zhang   if (compnum >= 0) {
13952bf73ac6SHong Zhang     if (compkey) *compkey = header->key[compnum];
13962bf73ac6SHong Zhang     if (component) {
139754dfd506SHong Zhang       offset += header->hsize + header->offset[compnum];
13982bf73ac6SHong Zhang       *component = network->componentdataarray + offset;
13992bf73ac6SHong Zhang     }
14002bf73ac6SHong Zhang   }
14015f2c45f1SShri Abhyankar 
14022bf73ac6SHong Zhang   if (nvar) *nvar = header->nvar[compnum];
140354dfd506SHong Zhang 
14045f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
14055f2c45f1SShri Abhyankar }
14065f2c45f1SShri Abhyankar 
14072bf73ac6SHong Zhang /*
14082bf73ac6SHong Zhang  Sets up the array that holds the data for all components and its associated section.
14092bf73ac6SHong 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.
14102bf73ac6SHong Zhang */
1411d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkComponentSetUp(DM dm)
1412d71ae5a4SJacob Faibussowitsch {
14135f2c45f1SShri Abhyankar   DM_Network                        *network = (DM_Network *)dm->data;
1414f11a936eSBarry Smith   PetscInt                           arr_size, p, offset, offsetp, ncomp, i, *headerarr;
14155f2c45f1SShri Abhyankar   DMNetworkComponentHeader           header;
14165f2c45f1SShri Abhyankar   DMNetworkComponentValue            cvalue;
1417f11a936eSBarry Smith   DMNetworkComponentHeader           headerinfo;
14185f2c45f1SShri Abhyankar   DMNetworkComponentGenericDataType *componentdataarray;
14195f2c45f1SShri Abhyankar 
14205f2c45f1SShri Abhyankar   PetscFunctionBegin;
14219566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DataSection));
14229566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(network->DataSection, &arr_size));
1423f11a936eSBarry Smith   /* arr_size+1 fixes pipeline test of opensolaris-misc for src/dm/tests/ex10.c -- Do not know why */
14249566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(arr_size + 1, &network->componentdataarray));
14255f2c45f1SShri Abhyankar   componentdataarray = network->componentdataarray;
1426daad07d3SAidan Hamilton   for (p = network->cloneshared->pStart; p < network->cloneshared->pEnd; p++) {
14279566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(network->DataSection, p, &offsetp));
14285f2c45f1SShri Abhyankar     /* Copy header */
14295f2c45f1SShri Abhyankar     header     = &network->header[p];
1430f11a936eSBarry Smith     headerinfo = (DMNetworkComponentHeader)(componentdataarray + offsetp);
14319566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerinfo, header, sizeof(struct _p_DMNetworkComponentHeader)));
1432f11a936eSBarry Smith     headerarr = (PetscInt *)(headerinfo + 1);
14339566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->size, header->maxcomps * sizeof(PetscInt)));
1434aeb78aa7SBarry Smith     headerinfo->size = headerarr;
143554dfd506SHong Zhang     headerarr += header->maxcomps;
14369566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->key, header->maxcomps * sizeof(PetscInt)));
1437aeb78aa7SBarry Smith     headerinfo->key = headerarr;
143854dfd506SHong Zhang     headerarr += header->maxcomps;
14399566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offset, header->maxcomps * sizeof(PetscInt)));
1440aeb78aa7SBarry Smith     headerinfo->offset = headerarr;
144154dfd506SHong Zhang     headerarr += header->maxcomps;
14429566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->nvar, header->maxcomps * sizeof(PetscInt)));
1443aeb78aa7SBarry Smith     headerinfo->nvar = headerarr;
144454dfd506SHong Zhang     headerarr += header->maxcomps;
14459566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(headerarr, header->offsetvarrel, header->maxcomps * sizeof(PetscInt)));
1446aeb78aa7SBarry Smith     headerinfo->offsetvarrel = headerarr;
144754dfd506SHong Zhang 
14485f2c45f1SShri Abhyankar     /* Copy data */
14495f2c45f1SShri Abhyankar     cvalue = &network->cvalue[p];
14505f2c45f1SShri Abhyankar     ncomp  = header->ndata;
14512bf73ac6SHong Zhang 
14525f2c45f1SShri Abhyankar     for (i = 0; i < ncomp; i++) {
145354dfd506SHong Zhang       offset = offsetp + header->hsize + header->offset[i];
14549566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(componentdataarray + offset, cvalue->data[i], header->size[i] * sizeof(DMNetworkComponentGenericDataType)));
14555f2c45f1SShri Abhyankar     }
14565f2c45f1SShri Abhyankar   }
1457aeb78aa7SBarry Smith 
1458daad07d3SAidan Hamilton   for (i = network->cloneshared->pStart; i < network->cloneshared->pEnd; i++) {
1459aeb78aa7SBarry Smith     PetscCall(PetscFree5(network->header[i].size, network->header[i].key, network->header[i].offset, network->header[i].nvar, network->header[i].offsetvarrel));
1460aeb78aa7SBarry Smith     PetscCall(PetscFree(network->cvalue[i].data));
1461aeb78aa7SBarry Smith   }
1462aeb78aa7SBarry Smith   PetscCall(PetscFree2(network->header, network->cvalue));
14635f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
14645f2c45f1SShri Abhyankar }
14655f2c45f1SShri Abhyankar 
14665f2c45f1SShri Abhyankar /* Sets up the section for dofs. This routine is called during DMSetUp() */
1467d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkVariablesSetUp(DM dm)
1468d71ae5a4SJacob Faibussowitsch {
14695f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
14705f2c45f1SShri Abhyankar 
14715f2c45f1SShri Abhyankar   PetscFunctionBegin;
14729566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(network->DofSection));
14735f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
14745f2c45f1SShri Abhyankar }
14755f2c45f1SShri Abhyankar 
147624121865SAdrian Maldonado /* Get a subsection from a range of points */
1477d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkGetSubSection_private(PetscSection main, PetscInt pstart, PetscInt pend, PetscSection *subsection)
1478d71ae5a4SJacob Faibussowitsch {
147924121865SAdrian Maldonado   PetscInt i, nvar;
148024121865SAdrian Maldonado 
148124121865SAdrian Maldonado   PetscFunctionBegin;
14829566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)main), subsection));
14839566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subsection, 0, pend - pstart));
148424121865SAdrian Maldonado   for (i = pstart; i < pend; i++) {
14859566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(main, i, &nvar));
14869566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subsection, i - pstart, nvar));
148724121865SAdrian Maldonado   }
148824121865SAdrian Maldonado 
14899566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subsection));
149024121865SAdrian Maldonado   PetscFunctionReturn(0);
149124121865SAdrian Maldonado }
149224121865SAdrian Maldonado 
149324121865SAdrian Maldonado /* Create a submap of points with a GlobalToLocal structure */
1494d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkSetSubMap_private(PetscInt pstart, PetscInt pend, ISLocalToGlobalMapping *map)
1495d71ae5a4SJacob Faibussowitsch {
149624121865SAdrian Maldonado   PetscInt i, *subpoints;
149724121865SAdrian Maldonado 
149824121865SAdrian Maldonado   PetscFunctionBegin;
149924121865SAdrian Maldonado   /* Create index sets to map from "points" to "subpoints" */
15009566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(pend - pstart, &subpoints));
1501ad540459SPierre Jolivet   for (i = pstart; i < pend; i++) subpoints[i - pstart] = i;
15029566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, pend - pstart, subpoints, PETSC_COPY_VALUES, map));
15039566063dSJacob Faibussowitsch   PetscCall(PetscFree(subpoints));
150424121865SAdrian Maldonado   PetscFunctionReturn(0);
150524121865SAdrian Maldonado }
150624121865SAdrian Maldonado 
150724121865SAdrian Maldonado /*@
15082bf73ac6SHong Zhang   DMNetworkAssembleGraphStructures - Assembles vertex and edge data structures. Must be called after DMNetworkDistribute
150924121865SAdrian Maldonado 
15102bf73ac6SHong Zhang   Collective on dm
151124121865SAdrian Maldonado 
151224121865SAdrian Maldonado   Input Parameters:
15132bf73ac6SHong Zhang . dm - the DMNetworkObject
151424121865SAdrian Maldonado 
151524121865SAdrian Maldonado   Note: the routine will create alternative orderings for the vertices and edges. Assume global network points are:
151624121865SAdrian Maldonado 
151724121865SAdrian Maldonado   points = [0 1 2 3 4 5 6]
151824121865SAdrian Maldonado 
1519caf410d2SHong 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]).
152024121865SAdrian Maldonado 
152124121865SAdrian Maldonado   With this new ordering a local PetscSection, global PetscSection and PetscSF will be created specific to the subset.
152224121865SAdrian Maldonado 
152324121865SAdrian Maldonado   Level: intermediate
152424121865SAdrian Maldonado 
152524121865SAdrian Maldonado @*/
1526d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkAssembleGraphStructures(DM dm)
1527d71ae5a4SJacob Faibussowitsch {
152824121865SAdrian Maldonado   MPI_Comm    comm;
1529f11a936eSBarry Smith   PetscMPIInt size;
153024121865SAdrian Maldonado   DM_Network *network = (DM_Network *)dm->data;
153124121865SAdrian Maldonado 
1532eab1376dSHong Zhang   PetscFunctionBegin;
15339566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
15349566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
153524121865SAdrian Maldonado 
153624121865SAdrian Maldonado   /* Create maps for vertices and edges */
1537daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
1538daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.mapping));
153924121865SAdrian Maldonado 
154024121865SAdrian Maldonado   /* Create local sub-sections */
1541daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.DofSection));
1542daad07d3SAidan Hamilton   PetscCall(DMNetworkGetSubSection_private(network->DofSection, network->cloneshared->eStart, network->cloneshared->eEnd, &network->edge.DofSection));
154324121865SAdrian Maldonado 
15449852e123SBarry Smith   if (size > 1) {
15459566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
154622bbedd7SHong Zhang 
15479566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->vertex.DofSection, network->vertex.sf, PETSC_FALSE, PETSC_FALSE, &network->vertex.GlobalDofSection));
15489566063dSJacob Faibussowitsch     PetscCall(PetscSFGetSubSF(network->plex->sf, network->edge.mapping, &network->edge.sf));
15499566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(network->edge.DofSection, network->edge.sf, PETSC_FALSE, PETSC_FALSE, &network->edge.GlobalDofSection));
155024121865SAdrian Maldonado   } else {
155124121865SAdrian Maldonado     /* create structures for vertex */
15529566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->vertex.DofSection, &network->vertex.GlobalDofSection));
155324121865SAdrian Maldonado     /* create structures for edge */
15549566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(network->edge.DofSection, &network->edge.GlobalDofSection));
155524121865SAdrian Maldonado   }
155624121865SAdrian Maldonado 
155724121865SAdrian Maldonado   /* Add viewers */
15589566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->edge.GlobalDofSection, "Global edge dof section"));
15599566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)network->vertex.GlobalDofSection, "Global vertex dof section"));
15609566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->edge.GlobalDofSection, NULL, "-edge_global_section_view"));
15619566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(network->vertex.GlobalDofSection, NULL, "-vertex_global_section_view"));
156224121865SAdrian Maldonado   PetscFunctionReturn(0);
156324121865SAdrian Maldonado }
15647b6afd5bSHong Zhang 
1565f11a936eSBarry Smith /*
15665c6496baSHong Zhang    Setup a lookup btable for the input v's owning subnetworks
15675c6496baSHong Zhang    - add all owing subnetworks that connect to this v to the btable
1568f11a936eSBarry Smith      vertex_subnetid = supportingedge_subnetid
1569f11a936eSBarry Smith */
1570d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode SetSubnetIdLookupBT(DM dm, PetscInt v, PetscInt Nsubnet, PetscBT btable)
1571d71ae5a4SJacob Faibussowitsch {
1572f11a936eSBarry Smith   PetscInt                 e, nedges, offset;
1573f11a936eSBarry Smith   const PetscInt          *edges;
1574f11a936eSBarry Smith   DM_Network              *newDMnetwork = (DM_Network *)dm->data;
1575f11a936eSBarry Smith   DMNetworkComponentHeader header;
1576f11a936eSBarry Smith 
1577f11a936eSBarry Smith   PetscFunctionBegin;
15789566063dSJacob Faibussowitsch   PetscCall(PetscBTMemzero(Nsubnet, btable));
15799566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
1580f11a936eSBarry Smith   for (e = 0; e < nedges; e++) {
15819566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, edges[e], &offset));
1582f11a936eSBarry Smith     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
15839566063dSJacob Faibussowitsch     PetscCall(PetscBTSet(btable, header->subnetid));
1584f11a936eSBarry Smith   }
1585f11a936eSBarry Smith   PetscFunctionReturn(0);
1586f11a936eSBarry Smith }
1587f11a936eSBarry Smith 
15885f2c45f1SShri Abhyankar /*@
15892bf73ac6SHong Zhang   DMNetworkDistribute - Distributes the network and moves associated component data
15905f2c45f1SShri Abhyankar 
15915f2c45f1SShri Abhyankar   Collective
15925f2c45f1SShri Abhyankar 
1593d8d19677SJose E. Roman   Input Parameters:
1594d3464fd4SAdrian Maldonado + DM - the DMNetwork object
15952bf73ac6SHong Zhang - overlap - the overlap of partitions, 0 is the default
15965f2c45f1SShri Abhyankar 
15975b3f975aSHong Zhang   Options Database Key:
15985b3f975aSHong Zhang + -dmnetwork_view - Calls DMView() at the conclusion of DMSetUp()
15995b3f975aSHong Zhang - -dmnetwork_view_distributed - Calls DMView() at the conclusion of DMNetworkDistribute()
16005b3f975aSHong Zhang 
16015f2c45f1SShri Abhyankar   Notes:
16028b171c8eSHong Zhang   Distributes the network with <overlap>-overlapping partitioning of the edges.
16035f2c45f1SShri Abhyankar 
16045f2c45f1SShri Abhyankar   Level: intermediate
16055f2c45f1SShri Abhyankar 
1606db781477SPatrick Sanan .seealso: `DMNetworkCreate()`
16075f2c45f1SShri Abhyankar @*/
1608d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkDistribute(DM *dm, PetscInt overlap)
1609d71ae5a4SJacob Faibussowitsch {
1610d3464fd4SAdrian Maldonado   MPI_Comm                 comm;
1611d3464fd4SAdrian Maldonado   PetscMPIInt              size;
1612d3464fd4SAdrian Maldonado   DM_Network              *oldDMnetwork = (DM_Network *)((*dm)->data);
1613d3464fd4SAdrian Maldonado   DM_Network              *newDMnetwork;
1614caf410d2SHong Zhang   PetscSF                  pointsf = NULL;
16155f2c45f1SShri Abhyankar   DM                       newDM;
1616f11a936eSBarry Smith   PetscInt                 j, e, v, offset, *subnetvtx, *subnetedge, Nsubnet, gidx, svtx_idx, nv;
16175c6496baSHong Zhang   PetscInt                 net, *sv;
1618f11a936eSBarry Smith   PetscBT                  btable;
161951ac5effSHong Zhang   PetscPartitioner         part;
1620b9c6e19dSShri Abhyankar   DMNetworkComponentHeader header;
16215f2c45f1SShri Abhyankar 
16225f2c45f1SShri Abhyankar   PetscFunctionBegin;
16235c6496baSHong Zhang   PetscValidPointer(dm, 1);
16245c6496baSHong Zhang   PetscValidHeaderSpecific(*dm, DM_CLASSID, 1);
16259566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)*dm, &comm));
16269566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1627d3464fd4SAdrian Maldonado   if (size == 1) PetscFunctionReturn(0);
1628d3464fd4SAdrian Maldonado 
16295c6496baSHong Zhang   PetscCheck(!overlap, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "overlap %" PetscInt_FMT " != 0 is not supported yet", overlap);
16305b3f975aSHong Zhang 
16312bf73ac6SHong 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. */
1632e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_Distribute, dm, 0, 0, 0));
16339566063dSJacob Faibussowitsch   PetscCall(DMNetworkCreate(PetscObjectComm((PetscObject)*dm), &newDM));
16345f2c45f1SShri Abhyankar   newDMnetwork                       = (DM_Network *)newDM->data;
163554dfd506SHong Zhang   newDMnetwork->max_comps_registered = oldDMnetwork->max_comps_registered;
16369566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(newDMnetwork->max_comps_registered, &newDMnetwork->component));
163751ac5effSHong Zhang 
163851ac5effSHong Zhang   /* Enable runtime options for petscpartitioner */
16399566063dSJacob Faibussowitsch   PetscCall(DMPlexGetPartitioner(oldDMnetwork->plex, &part));
16409566063dSJacob Faibussowitsch   PetscCall(PetscPartitionerSetFromOptions(part));
164151ac5effSHong Zhang 
16422bf73ac6SHong Zhang   /* Distribute plex dm */
16439566063dSJacob Faibussowitsch   PetscCall(DMPlexDistribute(oldDMnetwork->plex, overlap, &pointsf, &newDMnetwork->plex));
164451ac5effSHong Zhang 
16455f2c45f1SShri Abhyankar   /* Distribute dof section */
16469566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DofSection));
16479566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(pointsf, oldDMnetwork->DofSection, NULL, newDMnetwork->DofSection));
164851ac5effSHong Zhang 
16495f2c45f1SShri Abhyankar   /* Distribute data and associated section */
16509566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &newDMnetwork->DataSection));
16519566063dSJacob Faibussowitsch   PetscCall(DMPlexDistributeData(newDMnetwork->plex, pointsf, oldDMnetwork->DataSection, MPIU_INT, (void *)oldDMnetwork->componentdataarray, newDMnetwork->DataSection, (void **)&newDMnetwork->componentdataarray));
165224121865SAdrian Maldonado 
1653daad07d3SAidan Hamilton   PetscCall(PetscSectionGetChart(newDMnetwork->DataSection, &newDMnetwork->cloneshared->pStart, &newDMnetwork->cloneshared->pEnd));
1654daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 0, &newDMnetwork->cloneshared->eStart, &newDMnetwork->cloneshared->eEnd));
1655daad07d3SAidan Hamilton   PetscCall(DMPlexGetHeightStratum(newDMnetwork->plex, 1, &newDMnetwork->cloneshared->vStart, &newDMnetwork->cloneshared->vEnd));
1656daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nEdges    = newDMnetwork->cloneshared->eEnd - newDMnetwork->cloneshared->eStart;
1657daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nVertices = newDMnetwork->cloneshared->vEnd - newDMnetwork->cloneshared->vStart;
1658daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NVertices = oldDMnetwork->cloneshared->NVertices;
1659daad07d3SAidan Hamilton   newDMnetwork->cloneshared->NEdges    = oldDMnetwork->cloneshared->NEdges;
1660daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtable   = oldDMnetwork->cloneshared->svtable; /* global table! */
1661daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtable   = NULL;
166224121865SAdrian Maldonado 
16631bb6d2a8SBarry Smith   /* Set Dof section as the section for dm */
16649566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(newDMnetwork->plex, newDMnetwork->DofSection));
16659566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(newDMnetwork->plex, &newDMnetwork->GlobalDofSection));
16665f2c45f1SShri Abhyankar 
1667b9c6e19dSShri Abhyankar   /* Setup subnetwork info in the newDM */
1668daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsubnet = oldDMnetwork->cloneshared->Nsubnet;
1669daad07d3SAidan Hamilton   newDMnetwork->cloneshared->Nsvtx   = oldDMnetwork->cloneshared->Nsvtx;
1670daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->Nsvtx   = 0;
1671daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svtx    = oldDMnetwork->cloneshared->svtx; /* global vertices! */
1672daad07d3SAidan Hamilton   oldDMnetwork->cloneshared->svtx    = NULL;
1673daad07d3SAidan Hamilton   PetscCall(PetscCalloc1(newDMnetwork->cloneshared->Nsubnet, &newDMnetwork->cloneshared->subnet));
16742bf73ac6SHong Zhang 
16752bf73ac6SHong Zhang   /* Copy over the global number of vertices and edges in each subnetwork.
16762bf73ac6SHong Zhang      Note: these are calculated in DMNetworkLayoutSetUp()
1677b9c6e19dSShri Abhyankar   */
1678daad07d3SAidan Hamilton   Nsubnet = newDMnetwork->cloneshared->Nsubnet;
1679f11a936eSBarry Smith   for (j = 0; j < Nsubnet; j++) {
1680daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nvtx  = oldDMnetwork->cloneshared->subnet[j].Nvtx;
1681daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].Nedge = oldDMnetwork->cloneshared->subnet[j].Nedge;
1682b9c6e19dSShri Abhyankar   }
1683b9c6e19dSShri Abhyankar 
1684f11a936eSBarry Smith   /* Count local nedges for subnetworks */
1685daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
16869566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
168754dfd506SHong Zhang     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
16885c6496baSHong Zhang 
168954dfd506SHong Zhang     /* Update pointers */
169054dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
169154dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
169254dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
169354dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
169454dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
169554dfd506SHong Zhang 
1696daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].nedge++;
1697b9c6e19dSShri Abhyankar   }
1698b9c6e19dSShri Abhyankar 
16995c6496baSHong Zhang   /* Setup a btable to keep track subnetworks owned by this process at a shared vertex */
170048a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTCreate(Nsubnet, &btable));
17015c6496baSHong Zhang 
17025c6496baSHong Zhang   /* Count local nvtx for subnetworks */
1703daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
17049566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
17055f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
17065c6496baSHong Zhang 
170754dfd506SHong Zhang     /* Update pointers */
170854dfd506SHong Zhang     header->size         = (PetscInt *)(header + 1);
170954dfd506SHong Zhang     header->key          = header->size + header->maxcomps;
171054dfd506SHong Zhang     header->offset       = header->key + header->maxcomps;
171154dfd506SHong Zhang     header->nvar         = header->offset + header->maxcomps;
171254dfd506SHong Zhang     header->offsetvarrel = header->nvar + header->maxcomps;
171354dfd506SHong Zhang 
17142bf73ac6SHong Zhang     /* shared vertices: use gidx=header->index to check if v is a shared vertex */
17152bf73ac6SHong Zhang     gidx = header->index;
1716daad07d3SAidan Hamilton     PetscCall(PetscTableFind(newDMnetwork->cloneshared->svtable, gidx + 1, &svtx_idx));
17172bf73ac6SHong Zhang     svtx_idx--;
17182bf73ac6SHong Zhang 
17192bf73ac6SHong Zhang     if (svtx_idx < 0) { /* not a shared vertex */
1720daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++;
17212bf73ac6SHong Zhang     } else { /* a shared vertex belongs to more than one subnetworks, it is being counted by multiple subnets */
17225c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
17239566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1724f11a936eSBarry Smith 
1725daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1726daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
17275c6496baSHong Zhang         net = sv[0];
1728daad07d3SAidan Hamilton         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].nvtx++; /* sv is on net owned by this proces */
17292bf73ac6SHong Zhang       }
17302bf73ac6SHong Zhang     }
1731b9c6e19dSShri Abhyankar   }
1732b9c6e19dSShri Abhyankar 
17332bf73ac6SHong Zhang   /* Get total local nvtx for subnetworks */
17342bf73ac6SHong Zhang   nv = 0;
1735daad07d3SAidan Hamilton   for (j = 0; j < Nsubnet; j++) nv += newDMnetwork->cloneshared->subnet[j].nvtx;
1736daad07d3SAidan Hamilton   nv += newDMnetwork->cloneshared->Nsvtx;
1737caf410d2SHong Zhang 
17382bf73ac6SHong Zhang   /* Now create the vertices and edge arrays for the subnetworks */
1739daad07d3SAidan Hamilton   PetscCall(PetscCalloc2(newDMnetwork->cloneshared->nEdges, &subnetedge, nv, &subnetvtx)); /* Maps local vertex to local subnetwork's vertex */
1740daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetedge = subnetedge;
1741daad07d3SAidan Hamilton   newDMnetwork->cloneshared->subnetvtx  = subnetvtx;
1742daad07d3SAidan Hamilton   for (j = 0; j < newDMnetwork->cloneshared->Nsubnet; j++) {
1743daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].edges = subnetedge;
1744daad07d3SAidan Hamilton     subnetedge += newDMnetwork->cloneshared->subnet[j].nedge;
17452bf73ac6SHong Zhang 
1746daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].vertices = subnetvtx;
1747daad07d3SAidan Hamilton     subnetvtx += newDMnetwork->cloneshared->subnet[j].nvtx;
1748caf410d2SHong Zhang 
17492bf73ac6SHong 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. */
1750daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[j].nvtx = newDMnetwork->cloneshared->subnet[j].nedge = 0;
1751b9c6e19dSShri Abhyankar   }
1752daad07d3SAidan Hamilton   newDMnetwork->cloneshared->svertices = subnetvtx;
1753b9c6e19dSShri Abhyankar 
17542bf73ac6SHong Zhang   /* Set the edges and vertices in each subnetwork */
1755daad07d3SAidan Hamilton   for (e = newDMnetwork->cloneshared->eStart; e < newDMnetwork->cloneshared->eEnd; e++) {
17569566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, e, &offset));
17575f80ce2aSJacob Faibussowitsch     header                                                                                                                 = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
1758daad07d3SAidan Hamilton     newDMnetwork->cloneshared->subnet[header->subnetid].edges[newDMnetwork->cloneshared->subnet[header->subnetid].nedge++] = e;
1759b9c6e19dSShri Abhyankar   }
1760b9c6e19dSShri Abhyankar 
17612bf73ac6SHong Zhang   nv = 0;
1762daad07d3SAidan Hamilton   for (v = newDMnetwork->cloneshared->vStart; v < newDMnetwork->cloneshared->vEnd; v++) {
17639566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(newDMnetwork->DataSection, v, &offset));
17645f80ce2aSJacob Faibussowitsch     header = (DMNetworkComponentHeader)(newDMnetwork->componentdataarray + offset);
17652bf73ac6SHong Zhang 
17662bf73ac6SHong Zhang     /* coupling vertices: use gidx = header->index to check if v is a coupling vertex */
1767daad07d3SAidan Hamilton     PetscCall(PetscTableFind(newDMnetwork->cloneshared->svtable, header->index + 1, &svtx_idx));
17682bf73ac6SHong Zhang     svtx_idx--;
17692bf73ac6SHong Zhang     if (svtx_idx < 0) {
1770daad07d3SAidan Hamilton       newDMnetwork->cloneshared->subnet[header->subnetid].vertices[newDMnetwork->cloneshared->subnet[header->subnetid].nvtx++] = v;
17712bf73ac6SHong Zhang     } else { /* a shared vertex */
1772daad07d3SAidan Hamilton       newDMnetwork->cloneshared->svertices[nv++] = v;
17732bf73ac6SHong Zhang 
17745c6496baSHong Zhang       /* Setup a lookup btable for this v's owning subnetworks */
17759566063dSJacob Faibussowitsch       PetscCall(SetSubnetIdLookupBT(newDM, v, Nsubnet, btable));
1776f11a936eSBarry Smith 
1777daad07d3SAidan Hamilton       for (j = 0; j < newDMnetwork->cloneshared->svtx[svtx_idx].n; j++) {
1778daad07d3SAidan Hamilton         sv  = newDMnetwork->cloneshared->svtx[svtx_idx].sv + 2 * j;
17795c6496baSHong Zhang         net = sv[0];
17809371c9d4SSatish Balay         if (PetscBTLookup(btable, net)) newDMnetwork->cloneshared->subnet[net].vertices[newDMnetwork->cloneshared->subnet[net].nvtx++] = v;
1781b9c6e19dSShri Abhyankar       }
17822bf73ac6SHong Zhang     }
17832bf73ac6SHong Zhang   }
1784daad07d3SAidan Hamilton   newDMnetwork->cloneshared->nsvtx = nv; /* num of local shared vertices */
1785b9c6e19dSShri Abhyankar 
1786caf410d2SHong Zhang   newDM->setupcalled                          = (*dm)->setupcalled;
1787daad07d3SAidan Hamilton   newDMnetwork->cloneshared->distributecalled = PETSC_TRUE;
1788caf410d2SHong Zhang 
17892bf73ac6SHong Zhang   /* Free spaces */
17909566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&pointsf));
17919566063dSJacob Faibussowitsch   PetscCall(DMDestroy(dm));
179248a46eb9SPierre Jolivet   if (newDMnetwork->cloneshared->Nsvtx) PetscCall(PetscBTDestroy(&btable));
17932bf73ac6SHong Zhang 
17945b3f975aSHong Zhang   /* View distributed dmnetwork */
17959566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(newDM, NULL, "-dmnetwork_view_distributed"));
17965b3f975aSHong Zhang 
1797d3464fd4SAdrian Maldonado   *dm = newDM;
1798e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_Distribute, dm, 0, 0, 0));
17995f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
18005f2c45f1SShri Abhyankar }
18015f2c45f1SShri Abhyankar 
180224121865SAdrian Maldonado /*@C
18032bf73ac6SHong Zhang   PetscSFGetSubSF - Returns an SF for a specific subset of points. Leaves are re-numbered to reflect the new ordering
18042bf73ac6SHong Zhang 
18052bf73ac6SHong Zhang  Collective
180624121865SAdrian Maldonado 
180724121865SAdrian Maldonado   Input Parameters:
18089dddd249SSatish Balay + mainSF - the original SF structure
180924121865SAdrian Maldonado - map - a ISLocalToGlobal mapping that contains the subset of points
181024121865SAdrian Maldonado 
181197bb3fdcSJose E. Roman   Output Parameter:
18129dddd249SSatish Balay . subSF - a subset of the mainSF for the desired subset.
1813ee300463SSatish Balay 
1814ee300463SSatish Balay   Level: intermediate
18157d928bffSSatish Balay @*/
1816d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSFGetSubSF(PetscSF mainsf, ISLocalToGlobalMapping map, PetscSF *subSF)
1817d71ae5a4SJacob Faibussowitsch {
181824121865SAdrian Maldonado   PetscInt           nroots, nleaves, *ilocal_sub;
181924121865SAdrian Maldonado   PetscInt           i, *ilocal_map, nroots_sub, nleaves_sub = 0;
182024121865SAdrian Maldonado   PetscInt          *local_points, *remote_points;
182124121865SAdrian Maldonado   PetscSFNode       *iremote_sub;
182224121865SAdrian Maldonado   const PetscInt    *ilocal;
182324121865SAdrian Maldonado   const PetscSFNode *iremote;
182424121865SAdrian Maldonado 
182524121865SAdrian Maldonado   PetscFunctionBegin;
18269566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(mainsf, &nroots, &nleaves, &ilocal, &iremote));
182724121865SAdrian Maldonado 
182824121865SAdrian Maldonado   /* Look for leaves that pertain to the subset of points. Get the local ordering */
18299566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves, &ilocal_map));
18309566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nleaves, ilocal, NULL, ilocal_map));
183124121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
183224121865SAdrian Maldonado     if (ilocal_map[i] != -1) nleaves_sub += 1;
183324121865SAdrian Maldonado   }
183424121865SAdrian Maldonado   /* Re-number ilocal with subset numbering. Need information from roots */
18359566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nroots, &local_points, nroots, &remote_points));
183624121865SAdrian Maldonado   for (i = 0; i < nroots; i++) local_points[i] = i;
18379566063dSJacob Faibussowitsch   PetscCall(ISGlobalToLocalMappingApply(map, IS_GTOLM_MASK, nroots, local_points, NULL, local_points));
18389566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
18399566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(mainsf, MPIU_INT, local_points, remote_points, MPI_REPLACE));
184024121865SAdrian Maldonado   /* Fill up graph using local (that is, local to the subset) numbering. */
18419566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &ilocal_sub));
18429566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nleaves_sub, &iremote_sub));
184324121865SAdrian Maldonado   nleaves_sub = 0;
184424121865SAdrian Maldonado   for (i = 0; i < nleaves; i++) {
184524121865SAdrian Maldonado     if (ilocal_map[i] != -1) {
184624121865SAdrian Maldonado       ilocal_sub[nleaves_sub]        = ilocal_map[i];
18474b70a8deSAdrian Maldonado       iremote_sub[nleaves_sub].rank  = iremote[i].rank;
184824121865SAdrian Maldonado       iremote_sub[nleaves_sub].index = remote_points[ilocal[i]];
184924121865SAdrian Maldonado       nleaves_sub += 1;
185024121865SAdrian Maldonado     }
185124121865SAdrian Maldonado   }
18529566063dSJacob Faibussowitsch   PetscCall(PetscFree2(local_points, remote_points));
18539566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingGetSize(map, &nroots_sub));
185424121865SAdrian Maldonado 
185524121865SAdrian Maldonado   /* Create new subSF */
18569566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(PETSC_COMM_WORLD, subSF));
18579566063dSJacob Faibussowitsch   PetscCall(PetscSFSetFromOptions(*subSF));
18589566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(*subSF, nroots_sub, nleaves_sub, ilocal_sub, PETSC_OWN_POINTER, iremote_sub, PETSC_COPY_VALUES));
18599566063dSJacob Faibussowitsch   PetscCall(PetscFree(ilocal_map));
18609566063dSJacob Faibussowitsch   PetscCall(PetscFree(iremote_sub));
186124121865SAdrian Maldonado   PetscFunctionReturn(0);
186224121865SAdrian Maldonado }
186324121865SAdrian Maldonado 
18645f2c45f1SShri Abhyankar /*@C
18655f2c45f1SShri Abhyankar   DMNetworkGetSupportingEdges - Return the supporting edges for this vertex point
18665f2c45f1SShri Abhyankar 
18675f2c45f1SShri Abhyankar   Not Collective
18685f2c45f1SShri Abhyankar 
18695f2c45f1SShri Abhyankar   Input Parameters:
18702bf73ac6SHong Zhang + dm - the DMNetwork object
18715f2c45f1SShri Abhyankar - p  - the vertex point
18725f2c45f1SShri Abhyankar 
1873fd292e60Sprj-   Output Parameters:
18745f2c45f1SShri Abhyankar + nedges - number of edges connected to this vertex point
18752bf73ac6SHong Zhang - edges  - list of edge points
18765f2c45f1SShri Abhyankar 
187797bb938eSShri Abhyankar   Level: beginner
18785f2c45f1SShri Abhyankar 
18795f2c45f1SShri Abhyankar   Fortran Notes:
18805f2c45f1SShri Abhyankar   Since it returns an array, this routine is only available in Fortran 90, and you must
18815f2c45f1SShri Abhyankar   include petsc.h90 in your code.
18825f2c45f1SShri Abhyankar 
1883db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetConnectedVertices()`
18845f2c45f1SShri Abhyankar @*/
1885d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetSupportingEdges(DM dm, PetscInt vertex, PetscInt *nedges, const PetscInt *edges[])
1886d71ae5a4SJacob Faibussowitsch {
18875f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
18885f2c45f1SShri Abhyankar 
18895f2c45f1SShri Abhyankar   PetscFunctionBegin;
18909566063dSJacob Faibussowitsch   PetscCall(DMPlexGetSupportSize(network->plex, vertex, nedges));
18919566063dSJacob Faibussowitsch   if (edges) PetscCall(DMPlexGetSupport(network->plex, vertex, edges));
18925f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
18935f2c45f1SShri Abhyankar }
18945f2c45f1SShri Abhyankar 
18955f2c45f1SShri Abhyankar /*@C
1896d842c372SHong Zhang   DMNetworkGetConnectedVertices - Return the connected vertices for this edge point
18975f2c45f1SShri Abhyankar 
18985f2c45f1SShri Abhyankar   Not Collective
18995f2c45f1SShri Abhyankar 
19005f2c45f1SShri Abhyankar   Input Parameters:
19012bf73ac6SHong Zhang + dm - the DMNetwork object
19025f2c45f1SShri Abhyankar - p - the edge point
19035f2c45f1SShri Abhyankar 
1904fd292e60Sprj-   Output Parameters:
19055f2c45f1SShri Abhyankar . vertices - vertices connected to this edge
19065f2c45f1SShri Abhyankar 
190797bb938eSShri Abhyankar   Level: beginner
19085f2c45f1SShri Abhyankar 
19095f2c45f1SShri Abhyankar   Fortran Notes:
19105f2c45f1SShri Abhyankar   Since it returns an array, this routine is only available in Fortran 90, and you must
19115f2c45f1SShri Abhyankar   include petsc.h90 in your code.
19125f2c45f1SShri Abhyankar 
1913db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkGetSupportingEdges()`
19145f2c45f1SShri Abhyankar @*/
1915d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetConnectedVertices(DM dm, PetscInt edge, const PetscInt *vertices[])
1916d71ae5a4SJacob Faibussowitsch {
19175f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
19185f2c45f1SShri Abhyankar 
19195f2c45f1SShri Abhyankar   PetscFunctionBegin;
19209566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCone(network->plex, edge, vertices));
19215f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
19225f2c45f1SShri Abhyankar }
19235f2c45f1SShri Abhyankar 
19245f2c45f1SShri Abhyankar /*@
19252bf73ac6SHong Zhang   DMNetworkIsSharedVertex - Returns TRUE if the vertex is shared by subnetworks
19262bf73ac6SHong Zhang 
19272bf73ac6SHong Zhang   Not Collective
19282bf73ac6SHong Zhang 
19292bf73ac6SHong Zhang   Input Parameters:
19302bf73ac6SHong Zhang + dm - the DMNetwork object
19312bf73ac6SHong Zhang - p - the vertex point
19322bf73ac6SHong Zhang 
19332bf73ac6SHong Zhang   Output Parameter:
19342bf73ac6SHong Zhang . flag - TRUE if the vertex is shared by subnetworks
19352bf73ac6SHong Zhang 
19362bf73ac6SHong Zhang   Level: beginner
19372bf73ac6SHong Zhang 
1938db781477SPatrick Sanan .seealso: `DMNetworkAddSharedVertices()`, `DMNetworkIsGhostVertex()`
19392bf73ac6SHong Zhang @*/
1940d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsSharedVertex(DM dm, PetscInt p, PetscBool *flag)
1941d71ae5a4SJacob Faibussowitsch {
19422bf73ac6SHong Zhang   PetscInt i;
19432bf73ac6SHong Zhang 
19442bf73ac6SHong Zhang   PetscFunctionBegin;
19452bf73ac6SHong Zhang   *flag = PETSC_FALSE;
19462bf73ac6SHong Zhang 
19472bf73ac6SHong Zhang   if (dm->setupcalled) { /* DMNetworkGetGlobalVertexIndex() requires DMSetUp() be called */
19482bf73ac6SHong Zhang     DM_Network *network = (DM_Network *)dm->data;
19492bf73ac6SHong Zhang     PetscInt    gidx;
19509566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVertexIndex(dm, p, &gidx));
1951daad07d3SAidan Hamilton     PetscCall(PetscTableFind(network->cloneshared->svtable, gidx + 1, &i));
19522bf73ac6SHong Zhang     if (i) *flag = PETSC_TRUE;
19532bf73ac6SHong Zhang   } else { /* would be removed? */
19542bf73ac6SHong Zhang     PetscInt        nv;
19552bf73ac6SHong Zhang     const PetscInt *vtx;
19569566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nv, &vtx));
19572bf73ac6SHong Zhang     for (i = 0; i < nv; i++) {
19582bf73ac6SHong Zhang       if (p == vtx[i]) {
19592bf73ac6SHong Zhang         *flag = PETSC_TRUE;
19602bf73ac6SHong Zhang         break;
19612bf73ac6SHong Zhang       }
19622bf73ac6SHong Zhang     }
19632bf73ac6SHong Zhang   }
19642bf73ac6SHong Zhang   PetscFunctionReturn(0);
19652bf73ac6SHong Zhang }
19662bf73ac6SHong Zhang 
19672bf73ac6SHong Zhang /*@
19685f2c45f1SShri Abhyankar   DMNetworkIsGhostVertex - Returns TRUE if the vertex is a ghost vertex
19695f2c45f1SShri Abhyankar 
19705f2c45f1SShri Abhyankar   Not Collective
19715f2c45f1SShri Abhyankar 
19725f2c45f1SShri Abhyankar   Input Parameters:
19732bf73ac6SHong Zhang + dm - the DMNetwork object
1974a2b725a8SWilliam Gropp - p - the vertex point
19755f2c45f1SShri Abhyankar 
19765f2c45f1SShri Abhyankar   Output Parameter:
19775f2c45f1SShri Abhyankar . isghost - TRUE if the vertex is a ghost point
19785f2c45f1SShri Abhyankar 
197997bb938eSShri Abhyankar   Level: beginner
19805f2c45f1SShri Abhyankar 
1981db781477SPatrick Sanan .seealso: `DMNetworkGetConnectedVertices()`, `DMNetworkGetVertexRange()`, `DMNetworkIsSharedVertex()`
19825f2c45f1SShri Abhyankar @*/
1983d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkIsGhostVertex(DM dm, PetscInt p, PetscBool *isghost)
1984d71ae5a4SJacob Faibussowitsch {
19855f2c45f1SShri Abhyankar   DM_Network  *network = (DM_Network *)dm->data;
19865f2c45f1SShri Abhyankar   PetscInt     offsetg;
19875f2c45f1SShri Abhyankar   PetscSection sectiong;
19885f2c45f1SShri Abhyankar 
19895f2c45f1SShri Abhyankar   PetscFunctionBegin;
19905f2c45f1SShri Abhyankar   *isghost = PETSC_FALSE;
19919566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectiong));
19929566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(sectiong, p, &offsetg));
19935f2c45f1SShri Abhyankar   if (offsetg < 0) *isghost = PETSC_TRUE;
19945f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
19955f2c45f1SShri Abhyankar }
19965f2c45f1SShri Abhyankar 
1997d71ae5a4SJacob Faibussowitsch PetscErrorCode DMSetUp_Network(DM dm)
1998d71ae5a4SJacob Faibussowitsch {
19995f2c45f1SShri Abhyankar   PetscFunctionBegin;
2000e3b1a053SGetnet Betrie   PetscCall(PetscLogEventBegin(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
2001daad07d3SAidan Hamilton   PetscCall(DMNetworkFinalizeComponents(dm));
20025b3f975aSHong Zhang   /* View dmnetwork */
20039566063dSJacob Faibussowitsch   PetscCall(DMViewFromOptions(dm, NULL, "-dmnetwork_view"));
2004e3b1a053SGetnet Betrie   PetscCall(PetscLogEventEnd(DMNetwork_SetUpNetwork, dm, 0, 0, 0));
20055f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
20065f2c45f1SShri Abhyankar }
20075f2c45f1SShri Abhyankar 
20081ad426b7SHong Zhang /*@
200917df6e9eSHong Zhang   DMNetworkHasJacobian - Sets global flag for using user's sub Jacobian matrices
20101ad426b7SHong Zhang       -- replaced by DMNetworkSetOption(network,userjacobian,PETSC_TURE)?
20111ad426b7SHong Zhang 
20121ad426b7SHong Zhang   Collective
20131ad426b7SHong Zhang 
20141ad426b7SHong Zhang   Input Parameters:
20152bf73ac6SHong Zhang + dm - the DMNetwork object
201683b2e829SHong Zhang . eflg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE) if user provides Jacobian for edges
201783b2e829SHong Zhang - vflg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE) if user provides Jacobian for vertices
20181ad426b7SHong Zhang 
20191ad426b7SHong Zhang  Level: intermediate
20201ad426b7SHong Zhang 
20211ad426b7SHong Zhang @*/
2022d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkHasJacobian(DM dm, PetscBool eflg, PetscBool vflg)
2023d71ae5a4SJacob Faibussowitsch {
20241ad426b7SHong Zhang   DM_Network *network   = (DM_Network *)dm->data;
2025daad07d3SAidan Hamilton   PetscInt    nVertices = network->cloneshared->nVertices;
20261ad426b7SHong Zhang 
20271ad426b7SHong Zhang   PetscFunctionBegin;
202883b2e829SHong Zhang   network->userEdgeJacobian   = eflg;
202983b2e829SHong Zhang   network->userVertexJacobian = vflg;
20308675203cSHong Zhang 
203148a46eb9SPierre Jolivet   if (eflg && !network->Je) PetscCall(PetscCalloc1(3 * network->cloneshared->nEdges, &network->Je));
20328675203cSHong Zhang 
203366b4e0ffSHong Zhang   if (vflg && !network->Jv && nVertices) {
2034daad07d3SAidan Hamilton     PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
203566b4e0ffSHong Zhang     PetscInt        nedges_total;
20368675203cSHong Zhang     const PetscInt *edges;
20378675203cSHong Zhang 
20388675203cSHong Zhang     /* count nvertex_total */
20398675203cSHong Zhang     nedges_total = 0;
20409566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nVertices + 1, &vptr));
20418675203cSHong Zhang 
20428675203cSHong Zhang     vptr[0] = 0;
20438675203cSHong Zhang     for (i = 0; i < nVertices; i++) {
20449566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSupportingEdges(dm, i + vStart, &nedges, &edges));
20458675203cSHong Zhang       nedges_total += nedges;
20468675203cSHong Zhang       vptr[i + 1] = vptr[i] + 2 * nedges + 1;
20478675203cSHong Zhang     }
20488675203cSHong Zhang 
20499566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(2 * nedges_total + nVertices, &network->Jv));
20508675203cSHong Zhang     network->Jvptr = vptr;
20518675203cSHong Zhang   }
20521ad426b7SHong Zhang   PetscFunctionReturn(0);
20531ad426b7SHong Zhang }
20541ad426b7SHong Zhang 
20551ad426b7SHong Zhang /*@
205683b2e829SHong Zhang   DMNetworkEdgeSetMatrix - Sets user-provided Jacobian matrices for this edge to the network
205783b2e829SHong Zhang 
205883b2e829SHong Zhang   Not Collective
205983b2e829SHong Zhang 
206083b2e829SHong Zhang   Input Parameters:
20612bf73ac6SHong Zhang + dm - the DMNetwork object
206283b2e829SHong Zhang . p - the edge point
20633e97b6e8SHong Zhang - J - array (size = 3) of Jacobian submatrices for this edge point:
20643e97b6e8SHong Zhang         J[0]: this edge
2065d842c372SHong Zhang         J[1] and J[2]: connected vertices, obtained by calling DMNetworkGetConnectedVertices()
206683b2e829SHong Zhang 
206797bb938eSShri Abhyankar   Level: advanced
206883b2e829SHong Zhang 
2069db781477SPatrick Sanan .seealso: `DMNetworkVertexSetMatrix()`
207083b2e829SHong Zhang @*/
2071d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkEdgeSetMatrix(DM dm, PetscInt p, Mat J[])
2072d71ae5a4SJacob Faibussowitsch {
207383b2e829SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
207483b2e829SHong Zhang 
207583b2e829SHong Zhang   PetscFunctionBegin;
20765c6496baSHong Zhang   PetscCheck(network->Je, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkEdgeSetMatrix");
20778675203cSHong Zhang 
20788675203cSHong Zhang   if (J) {
2079883e35e8SHong Zhang     network->Je[3 * p]     = J[0];
2080883e35e8SHong Zhang     network->Je[3 * p + 1] = J[1];
2081883e35e8SHong Zhang     network->Je[3 * p + 2] = J[2];
20828675203cSHong Zhang   }
208383b2e829SHong Zhang   PetscFunctionReturn(0);
208483b2e829SHong Zhang }
208583b2e829SHong Zhang 
208683b2e829SHong Zhang /*@
208776ddfea5SHong Zhang   DMNetworkVertexSetMatrix - Sets user-provided Jacobian matrix for this vertex to the network
20881ad426b7SHong Zhang 
20891ad426b7SHong Zhang   Not Collective
20901ad426b7SHong Zhang 
20911ad426b7SHong Zhang   Input Parameters:
20921ad426b7SHong Zhang + dm - The DMNetwork object
20931ad426b7SHong Zhang . p - the vertex point
20943e97b6e8SHong Zhang - J - array of Jacobian (size = 2*(num of supporting edges) + 1) submatrices for this vertex point:
20953e97b6e8SHong Zhang         J[0]:       this vertex
20963e97b6e8SHong Zhang         J[1+2*i]:   i-th supporting edge
20973e97b6e8SHong Zhang         J[1+2*i+1]: i-th connected vertex
20981ad426b7SHong Zhang 
209997bb938eSShri Abhyankar   Level: advanced
21001ad426b7SHong Zhang 
2101db781477SPatrick Sanan .seealso: `DMNetworkEdgeSetMatrix()`
21021ad426b7SHong Zhang @*/
2103d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkVertexSetMatrix(DM dm, PetscInt p, Mat J[])
2104d71ae5a4SJacob Faibussowitsch {
21055f2c45f1SShri Abhyankar   DM_Network     *network = (DM_Network *)dm->data;
2106daad07d3SAidan Hamilton   PetscInt        i, *vptr, nedges, vStart = network->cloneshared->vStart;
2107883e35e8SHong Zhang   const PetscInt *edges;
21085f2c45f1SShri Abhyankar 
21095f2c45f1SShri Abhyankar   PetscFunctionBegin;
21105c6496baSHong Zhang   PetscCheck(network->Jv, PetscObjectComm((PetscObject)dm), PETSC_ERR_ORDER, "Must call DMNetworkHasJacobian() collectively before calling DMNetworkVertexSetMatrix");
2111883e35e8SHong Zhang 
21128675203cSHong Zhang   if (J) {
2113883e35e8SHong Zhang     vptr                          = network->Jvptr;
21143e97b6e8SHong Zhang     network->Jv[vptr[p - vStart]] = J[0]; /* Set Jacobian for this vertex */
21153e97b6e8SHong Zhang 
21163e97b6e8SHong Zhang     /* Set Jacobian for each supporting edge and connected vertex */
21179566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, p, &nedges, &edges));
2118883e35e8SHong Zhang     for (i = 1; i <= 2 * nedges; i++) network->Jv[vptr[p - vStart] + i] = J[i];
21198675203cSHong Zhang   }
2120883e35e8SHong Zhang   PetscFunctionReturn(0);
2121883e35e8SHong Zhang }
2122883e35e8SHong Zhang 
2123d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2124d71ae5a4SJacob Faibussowitsch {
21255cf7da58SHong Zhang   PetscInt    j;
21265cf7da58SHong Zhang   PetscScalar val = (PetscScalar)ncols;
21275cf7da58SHong Zhang 
21285cf7da58SHong Zhang   PetscFunctionBegin;
21295cf7da58SHong Zhang   if (!ghost) {
213048a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
21315cf7da58SHong Zhang   } else {
213248a46eb9SPierre Jolivet     for (j = 0; j < nrows; j++) PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
21335cf7da58SHong Zhang   }
21345cf7da58SHong Zhang   PetscFunctionReturn(0);
21355cf7da58SHong Zhang }
21365cf7da58SHong Zhang 
2137d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2138d71ae5a4SJacob Faibussowitsch {
21395cf7da58SHong Zhang   PetscInt    j, ncols_u;
21405cf7da58SHong Zhang   PetscScalar val;
21415cf7da58SHong Zhang 
21425cf7da58SHong Zhang   PetscFunctionBegin;
21435cf7da58SHong Zhang   if (!ghost) {
21445cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
21459566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
21465cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
21479566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vdnz, 1, &rows[j], &val, ADD_VALUES));
21489566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
21495cf7da58SHong Zhang     }
21505cf7da58SHong Zhang   } else {
21515cf7da58SHong Zhang     for (j = 0; j < nrows; j++) {
21529566063dSJacob Faibussowitsch       PetscCall(MatGetRow(Ju, j, &ncols_u, NULL, NULL));
21535cf7da58SHong Zhang       val = (PetscScalar)ncols_u;
21549566063dSJacob Faibussowitsch       PetscCall(VecSetValues(vonz, 1, &rows[j], &val, ADD_VALUES));
21559566063dSJacob Faibussowitsch       PetscCall(MatRestoreRow(Ju, j, &ncols_u, NULL, NULL));
21565cf7da58SHong Zhang     }
21575cf7da58SHong Zhang   }
21585cf7da58SHong Zhang   PetscFunctionReturn(0);
21595cf7da58SHong Zhang }
21605cf7da58SHong Zhang 
2161d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetPreallocationblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscBool ghost, Vec vdnz, Vec vonz)
2162d71ae5a4SJacob Faibussowitsch {
21635cf7da58SHong Zhang   PetscFunctionBegin;
21645cf7da58SHong Zhang   if (Ju) {
21659566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationUserblock_private(Ju, nrows, rows, ncols, ghost, vdnz, vonz));
21665cf7da58SHong Zhang   } else {
21679566063dSJacob Faibussowitsch     PetscCall(MatSetPreallocationDenseblock_private(nrows, rows, ncols, ghost, vdnz, vonz));
21685cf7da58SHong Zhang   }
21695cf7da58SHong Zhang   PetscFunctionReturn(0);
21705cf7da58SHong Zhang }
21715cf7da58SHong Zhang 
2172d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetDenseblock_private(PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2173d71ae5a4SJacob Faibussowitsch {
2174883e35e8SHong Zhang   PetscInt     j, *cols;
2175883e35e8SHong Zhang   PetscScalar *zeros;
2176883e35e8SHong Zhang 
2177883e35e8SHong Zhang   PetscFunctionBegin;
21789566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(ncols, &cols, nrows * ncols, &zeros));
2179883e35e8SHong Zhang   for (j = 0; j < ncols; j++) cols[j] = j + cstart;
21809566063dSJacob Faibussowitsch   PetscCall(MatSetValues(*J, nrows, rows, ncols, cols, zeros, INSERT_VALUES));
21819566063dSJacob Faibussowitsch   PetscCall(PetscFree2(cols, zeros));
21821ad426b7SHong Zhang   PetscFunctionReturn(0);
21831ad426b7SHong Zhang }
2184a4e85ca8SHong Zhang 
2185d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetUserblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2186d71ae5a4SJacob Faibussowitsch {
21873e97b6e8SHong Zhang   PetscInt        j, M, N, row, col, ncols_u;
21883e97b6e8SHong Zhang   const PetscInt *cols;
21893e97b6e8SHong Zhang   PetscScalar     zero = 0.0;
21903e97b6e8SHong Zhang 
21913e97b6e8SHong Zhang   PetscFunctionBegin;
21929566063dSJacob Faibussowitsch   PetscCall(MatGetSize(Ju, &M, &N));
219363a3b9bcSJacob 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);
21943e97b6e8SHong Zhang 
21953e97b6e8SHong Zhang   for (row = 0; row < nrows; row++) {
21969566063dSJacob Faibussowitsch     PetscCall(MatGetRow(Ju, row, &ncols_u, &cols, NULL));
21973e97b6e8SHong Zhang     for (j = 0; j < ncols_u; j++) {
21983e97b6e8SHong Zhang       col = cols[j] + cstart;
21999566063dSJacob Faibussowitsch       PetscCall(MatSetValues(*J, 1, &rows[row], 1, &col, &zero, INSERT_VALUES));
22003e97b6e8SHong Zhang     }
22019566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(Ju, row, &ncols_u, &cols, NULL));
22023e97b6e8SHong Zhang   }
22033e97b6e8SHong Zhang   PetscFunctionReturn(0);
22043e97b6e8SHong Zhang }
22051ad426b7SHong Zhang 
2206d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode MatSetblock_private(Mat Ju, PetscInt nrows, PetscInt *rows, PetscInt ncols, PetscInt cstart, Mat *J)
2207d71ae5a4SJacob Faibussowitsch {
2208a4e85ca8SHong Zhang   PetscFunctionBegin;
2209a4e85ca8SHong Zhang   if (Ju) {
22109566063dSJacob Faibussowitsch     PetscCall(MatSetUserblock_private(Ju, nrows, rows, ncols, cstart, J));
2211a4e85ca8SHong Zhang   } else {
22129566063dSJacob Faibussowitsch     PetscCall(MatSetDenseblock_private(nrows, rows, ncols, cstart, J));
2213a4e85ca8SHong Zhang   }
2214a4e85ca8SHong Zhang   PetscFunctionReturn(0);
2215a4e85ca8SHong Zhang }
2216a4e85ca8SHong Zhang 
221724121865SAdrian 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.
221824121865SAdrian Maldonado */
2219d71ae5a4SJacob Faibussowitsch PetscErrorCode CreateSubGlobalToLocalMapping_private(PetscSection globalsec, PetscSection localsec, ISLocalToGlobalMapping *ltog)
2220d71ae5a4SJacob Faibussowitsch {
222124121865SAdrian Maldonado   PetscInt  i, size, dof;
222224121865SAdrian Maldonado   PetscInt *glob2loc;
222324121865SAdrian Maldonado 
222424121865SAdrian Maldonado   PetscFunctionBegin;
22259566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(localsec, &size));
22269566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &glob2loc));
222724121865SAdrian Maldonado 
222824121865SAdrian Maldonado   for (i = 0; i < size; i++) {
22299566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalsec, i, &dof));
223024121865SAdrian Maldonado     dof         = (dof >= 0) ? dof : -(dof + 1);
223124121865SAdrian Maldonado     glob2loc[i] = dof;
223224121865SAdrian Maldonado   }
223324121865SAdrian Maldonado 
22349566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingCreate(PETSC_COMM_WORLD, 1, size, glob2loc, PETSC_OWN_POINTER, ltog));
223524121865SAdrian Maldonado #if 0
22369566063dSJacob Faibussowitsch   PetscCall(PetscIntView(size,glob2loc,PETSC_VIEWER_STDOUT_WORLD));
223724121865SAdrian Maldonado #endif
223824121865SAdrian Maldonado   PetscFunctionReturn(0);
223924121865SAdrian Maldonado }
224024121865SAdrian Maldonado 
224101ad2aeeSHong Zhang #include <petsc/private/matimpl.h>
22429e1d080bSHong Zhang 
2243d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network_Nest(DM dm, Mat *J)
2244d71ae5a4SJacob Faibussowitsch {
22451ad426b7SHong Zhang   DM_Network            *network = (DM_Network *)dm->data;
224624121865SAdrian Maldonado   PetscInt               eDof, vDof;
224724121865SAdrian Maldonado   Mat                    j11, j12, j21, j22, bA[2][2];
22489e1d080bSHong Zhang   MPI_Comm               comm;
224924121865SAdrian Maldonado   ISLocalToGlobalMapping eISMap, vISMap;
225024121865SAdrian Maldonado 
22519e1d080bSHong Zhang   PetscFunctionBegin;
22529566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
225324121865SAdrian Maldonado 
22549566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->edge.GlobalDofSection, &eDof));
22559566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(network->vertex.GlobalDofSection, &vDof));
225624121865SAdrian Maldonado 
22579566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j11));
22589566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j11, eDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
22599566063dSJacob Faibussowitsch   PetscCall(MatSetType(j11, MATMPIAIJ));
226024121865SAdrian Maldonado 
22619566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j12));
22629566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j12, eDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
22639566063dSJacob Faibussowitsch   PetscCall(MatSetType(j12, MATMPIAIJ));
226424121865SAdrian Maldonado 
22659566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j21));
22669566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j21, vDof, eDof, PETSC_DETERMINE, PETSC_DETERMINE));
22679566063dSJacob Faibussowitsch   PetscCall(MatSetType(j21, MATMPIAIJ));
226824121865SAdrian Maldonado 
22699566063dSJacob Faibussowitsch   PetscCall(MatCreate(comm, &j22));
22709566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(j22, vDof, vDof, PETSC_DETERMINE, PETSC_DETERMINE));
22719566063dSJacob Faibussowitsch   PetscCall(MatSetType(j22, MATMPIAIJ));
227224121865SAdrian Maldonado 
22733f6a6bdaSHong Zhang   bA[0][0] = j11;
22743f6a6bdaSHong Zhang   bA[0][1] = j12;
22753f6a6bdaSHong Zhang   bA[1][0] = j21;
22763f6a6bdaSHong Zhang   bA[1][1] = j22;
227724121865SAdrian Maldonado 
22789566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->edge.GlobalDofSection, network->edge.DofSection, &eISMap));
22799566063dSJacob Faibussowitsch   PetscCall(CreateSubGlobalToLocalMapping_private(network->vertex.GlobalDofSection, network->vertex.DofSection, &vISMap));
228024121865SAdrian Maldonado 
22819566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j11, eISMap, eISMap));
22829566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j12, eISMap, vISMap));
22839566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j21, vISMap, eISMap));
22849566063dSJacob Faibussowitsch   PetscCall(MatSetLocalToGlobalMapping(j22, vISMap, vISMap));
228524121865SAdrian Maldonado 
22869566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j11));
22879566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j12));
22889566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j21));
22899566063dSJacob Faibussowitsch   PetscCall(MatSetUp(j22));
229024121865SAdrian Maldonado 
22919566063dSJacob Faibussowitsch   PetscCall(MatCreateNest(comm, 2, NULL, 2, NULL, &bA[0][0], J));
22929566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*J));
22939566063dSJacob Faibussowitsch   PetscCall(MatNestSetVecType(*J, VECNEST));
22949566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j11));
22959566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j12));
22969566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j21));
22979566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&j22));
229824121865SAdrian Maldonado 
22999566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
23009566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
23019566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
230224121865SAdrian Maldonado 
230324121865SAdrian Maldonado   /* Free structures */
23049566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&eISMap));
23059566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&vISMap));
230624121865SAdrian Maldonado   PetscFunctionReturn(0);
23079e1d080bSHong Zhang }
23089e1d080bSHong Zhang 
2309d71ae5a4SJacob Faibussowitsch PetscErrorCode DMCreateMatrix_Network(DM dm, Mat *J)
2310d71ae5a4SJacob Faibussowitsch {
23119e1d080bSHong Zhang   DM_Network     *network = (DM_Network *)dm->data;
23129e1d080bSHong Zhang   PetscInt        eStart, eEnd, vStart, vEnd, rstart, nrows, *rows, localSize;
23139e1d080bSHong Zhang   PetscInt        cstart, ncols, j, e, v;
23149e1d080bSHong Zhang   PetscBool       ghost, ghost_vc, ghost2, isNest;
23159e1d080bSHong Zhang   Mat             Juser;
23169e1d080bSHong Zhang   PetscSection    sectionGlobal;
23179e1d080bSHong Zhang   PetscInt        nedges, *vptr = NULL, vc, *rows_v; /* suppress maybe-uninitialized warning */
23189e1d080bSHong Zhang   const PetscInt *edges, *cone;
23199e1d080bSHong Zhang   MPI_Comm        comm;
23209e1d080bSHong Zhang   MatType         mtype;
23219e1d080bSHong Zhang   Vec             vd_nz, vo_nz;
23229e1d080bSHong Zhang   PetscInt       *dnnz, *onnz;
23239e1d080bSHong Zhang   PetscScalar    *vdnz, *vonz;
23249e1d080bSHong Zhang 
23259e1d080bSHong Zhang   PetscFunctionBegin;
23269e1d080bSHong Zhang   mtype = dm->mattype;
23279566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(mtype, MATNEST, &isNest));
23289e1d080bSHong Zhang   if (isNest) {
23299566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Network_Nest(dm, J));
23309566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
23319e1d080bSHong Zhang     PetscFunctionReturn(0);
23329e1d080bSHong Zhang   }
23339e1d080bSHong Zhang 
23349e1d080bSHong Zhang   if (!network->userEdgeJacobian && !network->userVertexJacobian) {
2335a4e85ca8SHong Zhang     /* user does not provide Jacobian blocks */
23369566063dSJacob Faibussowitsch     PetscCall(DMCreateMatrix_Plex(network->plex, J));
23379566063dSJacob Faibussowitsch     PetscCall(MatSetDM(*J, dm));
23381ad426b7SHong Zhang     PetscFunctionReturn(0);
23391ad426b7SHong Zhang   }
23401ad426b7SHong Zhang 
23419566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)dm), J));
23429566063dSJacob Faibussowitsch   PetscCall(DMGetGlobalSection(network->plex, &sectionGlobal));
23439566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(sectionGlobal, &localSize));
23449566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(*J, localSize, localSize, PETSC_DETERMINE, PETSC_DETERMINE));
23452a945128SHong Zhang 
23469566063dSJacob Faibussowitsch   PetscCall(MatSetType(*J, MATAIJ));
23479566063dSJacob Faibussowitsch   PetscCall(MatSetFromOptions(*J));
234889898e50SHong Zhang 
234989898e50SHong Zhang   /* (1) Set matrix preallocation */
235089898e50SHong Zhang   /*------------------------------*/
23519566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
23529566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &vd_nz));
23539566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(vd_nz, localSize, PETSC_DECIDE));
23549566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(vd_nz));
23559566063dSJacob Faibussowitsch   PetscCall(VecSet(vd_nz, 0.0));
23569566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(vd_nz, &vo_nz));
2357840c2264SHong Zhang 
235889898e50SHong Zhang   /* Set preallocation for edges */
235989898e50SHong Zhang   /*-----------------------------*/
23609566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &eStart, &eEnd));
2361840c2264SHong Zhang 
23629566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(localSize, &rows));
2363840c2264SHong Zhang   for (e = eStart; e < eEnd; e++) {
2364840c2264SHong Zhang     /* Get row indices */
23659566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
23669566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
2367840c2264SHong Zhang     if (nrows) {
2368840c2264SHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
2369840c2264SHong Zhang 
2370a5b23f4aSJose E. Roman       /* Set preallocation for connected vertices */
23719566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2372840c2264SHong Zhang       for (v = 0; v < 2; v++) {
23739566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
2374840c2264SHong Zhang 
23758675203cSHong Zhang         if (network->Je) {
2376840c2264SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
23778675203cSHong Zhang         } else Juser = NULL;
23789566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, cone[v], &ghost));
23799566063dSJacob Faibussowitsch         PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, ncols, ghost, vd_nz, vo_nz));
2380840c2264SHong Zhang       }
2381840c2264SHong Zhang 
238289898e50SHong Zhang       /* Set preallocation for edge self */
2383840c2264SHong Zhang       cstart = rstart;
23848675203cSHong Zhang       if (network->Je) {
2385840c2264SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
23868675203cSHong Zhang       } else Juser = NULL;
23879566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows, nrows, PETSC_FALSE, vd_nz, vo_nz));
2388840c2264SHong Zhang     }
2389840c2264SHong Zhang   }
2390840c2264SHong Zhang 
239189898e50SHong Zhang   /* Set preallocation for vertices */
239289898e50SHong Zhang   /*--------------------------------*/
23939566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vStart, &vEnd));
23948675203cSHong Zhang   if (vEnd - vStart) vptr = network->Jvptr;
2395840c2264SHong Zhang 
2396840c2264SHong Zhang   for (v = vStart; v < vEnd; v++) {
2397840c2264SHong Zhang     /* Get row indices */
23989566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
23999566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
2400840c2264SHong Zhang     if (!nrows) continue;
2401840c2264SHong Zhang 
24029566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2403bdcb62a2SHong Zhang     if (ghost) {
24049566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2405bdcb62a2SHong Zhang     } else {
2406bdcb62a2SHong Zhang       rows_v = rows;
2407bdcb62a2SHong Zhang     }
2408bdcb62a2SHong Zhang 
2409bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2410840c2264SHong Zhang 
2411840c2264SHong Zhang     /* Get supporting edges and connected vertices */
24129566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2413840c2264SHong Zhang 
2414840c2264SHong Zhang     for (e = 0; e < nedges; e++) {
2415840c2264SHong Zhang       /* Supporting edges */
24169566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
24179566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2418840c2264SHong Zhang 
24198675203cSHong Zhang       if (network->Jv) {
2420840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
24218675203cSHong Zhang       } else Juser = NULL;
24229566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost, vd_nz, vo_nz));
2423840c2264SHong Zhang 
2424840c2264SHong Zhang       /* Connected vertices */
24259566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
2426840c2264SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
24279566063dSJacob Faibussowitsch       PetscCall(DMNetworkIsGhostVertex(dm, vc, &ghost_vc));
2428840c2264SHong Zhang 
24299566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2430840c2264SHong Zhang 
24318675203cSHong Zhang       if (network->Jv) {
2432840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
24338675203cSHong Zhang       } else Juser = NULL;
2434e102a522SHong Zhang       if (ghost_vc || ghost) {
2435e102a522SHong Zhang         ghost2 = PETSC_TRUE;
2436e102a522SHong Zhang       } else {
2437e102a522SHong Zhang         ghost2 = PETSC_FALSE;
2438e102a522SHong Zhang       }
24399566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, ncols, ghost2, vd_nz, vo_nz));
2440840c2264SHong Zhang     }
2441840c2264SHong Zhang 
244289898e50SHong Zhang     /* Set preallocation for vertex self */
24439566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2444840c2264SHong Zhang     if (!ghost) {
24459566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
24468675203cSHong Zhang       if (network->Jv) {
2447840c2264SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
24488675203cSHong Zhang       } else Juser = NULL;
24499566063dSJacob Faibussowitsch       PetscCall(MatSetPreallocationblock_private(Juser, nrows, rows_v, nrows, PETSC_FALSE, vd_nz, vo_nz));
2450840c2264SHong Zhang     }
24511baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
2452840c2264SHong Zhang   }
2453840c2264SHong Zhang 
24549566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vd_nz));
24559566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(vo_nz));
24565cf7da58SHong Zhang 
24579566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(localSize, &dnnz, localSize, &onnz));
24585cf7da58SHong Zhang 
24599566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vd_nz));
24609566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(vo_nz));
2461840c2264SHong Zhang 
24629566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vd_nz, &vdnz));
24639566063dSJacob Faibussowitsch   PetscCall(VecGetArray(vo_nz, &vonz));
2464840c2264SHong Zhang   for (j = 0; j < localSize; j++) {
2465e102a522SHong Zhang     dnnz[j] = (PetscInt)PetscRealPart(vdnz[j]);
2466e102a522SHong Zhang     onnz[j] = (PetscInt)PetscRealPart(vonz[j]);
2467840c2264SHong Zhang   }
24689566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vd_nz, &vdnz));
24699566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(vo_nz, &vonz));
24709566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vd_nz));
24719566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&vo_nz));
2472840c2264SHong Zhang 
24739566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJSetPreallocation(*J, 0, dnnz));
24749566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJSetPreallocation(*J, 0, dnnz, 0, onnz));
24759566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*J, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
24765cf7da58SHong Zhang 
24779566063dSJacob Faibussowitsch   PetscCall(PetscFree2(dnnz, onnz));
24785cf7da58SHong Zhang 
247989898e50SHong Zhang   /* (2) Set matrix entries for edges */
248089898e50SHong Zhang   /*----------------------------------*/
24811ad426b7SHong Zhang   for (e = eStart; e < eEnd; e++) {
2482bfbc38dcSHong Zhang     /* Get row indices */
24839566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, e, ALL_COMPONENTS, &rstart));
24849566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, e, &nrows));
24854b976069SHong Zhang     if (nrows) {
248617df6e9eSHong Zhang       for (j = 0; j < nrows; j++) rows[j] = j + rstart;
24871ad426b7SHong Zhang 
2488a5b23f4aSJose E. Roman       /* Set matrix entries for connected vertices */
24899566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, e, &cone));
2490bfbc38dcSHong Zhang       for (v = 0; v < 2; v++) {
24919566063dSJacob Faibussowitsch         PetscCall(DMNetworkGetGlobalVecOffset(dm, cone[v], ALL_COMPONENTS, &cstart));
24929566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(network->DofSection, cone[v], &ncols));
24933e97b6e8SHong Zhang 
24948675203cSHong Zhang         if (network->Je) {
2495a4e85ca8SHong Zhang           Juser = network->Je[3 * e + 1 + v]; /* Jacobian(e,v) */
24968675203cSHong Zhang         } else Juser = NULL;
24979566063dSJacob Faibussowitsch         PetscCall(MatSetblock_private(Juser, nrows, rows, ncols, cstart, J));
2498bfbc38dcSHong Zhang       }
249917df6e9eSHong Zhang 
2500bfbc38dcSHong Zhang       /* Set matrix entries for edge self */
25013e97b6e8SHong Zhang       cstart = rstart;
25028675203cSHong Zhang       if (network->Je) {
2503a4e85ca8SHong Zhang         Juser = network->Je[3 * e]; /* Jacobian(e,e) */
25048675203cSHong Zhang       } else Juser = NULL;
25059566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows, nrows, cstart, J));
25061ad426b7SHong Zhang     }
25074b976069SHong Zhang   }
25081ad426b7SHong Zhang 
2509bfbc38dcSHong Zhang   /* Set matrix entries for vertices */
251083b2e829SHong Zhang   /*---------------------------------*/
25111ad426b7SHong Zhang   for (v = vStart; v < vEnd; v++) {
2512bfbc38dcSHong Zhang     /* Get row indices */
25139566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &rstart));
25149566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(network->DofSection, v, &nrows));
25154b976069SHong Zhang     if (!nrows) continue;
2516596e729fSHong Zhang 
25179566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, v, &ghost));
2518bdcb62a2SHong Zhang     if (ghost) {
25199566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrows, &rows_v));
2520bdcb62a2SHong Zhang     } else {
2521bdcb62a2SHong Zhang       rows_v = rows;
2522bdcb62a2SHong Zhang     }
2523bdcb62a2SHong Zhang     for (j = 0; j < nrows; j++) rows_v[j] = j + rstart;
2524596e729fSHong Zhang 
2525bfbc38dcSHong Zhang     /* Get supporting edges and connected vertices */
25269566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSupportingEdges(dm, v, &nedges, &edges));
2527596e729fSHong Zhang 
2528596e729fSHong Zhang     for (e = 0; e < nedges; e++) {
2529bfbc38dcSHong Zhang       /* Supporting edges */
25309566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, edges[e], ALL_COMPONENTS, &cstart));
25319566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, edges[e], &ncols));
2532596e729fSHong Zhang 
25338675203cSHong Zhang       if (network->Jv) {
2534a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 1]; /* Jacobian(v,e) */
25358675203cSHong Zhang       } else Juser = NULL;
25369566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2537596e729fSHong Zhang 
2538bfbc38dcSHong Zhang       /* Connected vertices */
25399566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetConnectedVertices(dm, edges[e], &cone));
25402a945128SHong Zhang       vc = (v == cone[0]) ? cone[1] : cone[0];
25412a945128SHong Zhang 
25429566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, vc, ALL_COMPONENTS, &cstart));
25439566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(network->DofSection, vc, &ncols));
2544a4e85ca8SHong Zhang 
25458675203cSHong Zhang       if (network->Jv) {
2546a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart] + 2 * e + 2]; /* Jacobian(v,vc) */
25478675203cSHong Zhang       } else Juser = NULL;
25489566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, ncols, cstart, J));
2549596e729fSHong Zhang     }
2550596e729fSHong Zhang 
2551bfbc38dcSHong Zhang     /* Set matrix entries for vertex self */
25521ad426b7SHong Zhang     if (!ghost) {
25539566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, v, ALL_COMPONENTS, &cstart));
25548675203cSHong Zhang       if (network->Jv) {
2555a4e85ca8SHong Zhang         Juser = network->Jv[vptr[v - vStart]]; /* Jacobian(v,v) */
25568675203cSHong Zhang       } else Juser = NULL;
25579566063dSJacob Faibussowitsch       PetscCall(MatSetblock_private(Juser, nrows, rows_v, nrows, cstart, J));
2558bdcb62a2SHong Zhang     }
25591baa6e33SBarry Smith     if (ghost) PetscCall(PetscFree(rows_v));
25601ad426b7SHong Zhang   }
25619566063dSJacob Faibussowitsch   PetscCall(PetscFree(rows));
2562bdcb62a2SHong Zhang 
25639566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(*J, MAT_FINAL_ASSEMBLY));
25649566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(*J, MAT_FINAL_ASSEMBLY));
2565dd6f46cdSHong Zhang 
25669566063dSJacob Faibussowitsch   PetscCall(MatSetDM(*J, dm));
25675f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
25685f2c45f1SShri Abhyankar }
25695f2c45f1SShri Abhyankar 
2570d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMNetworkDestroyComponentData(DM dm)
2571d71ae5a4SJacob Faibussowitsch {
2572daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
2573daad07d3SAidan Hamilton   PetscInt    j, np;
2574daad07d3SAidan Hamilton 
2575daad07d3SAidan Hamilton   PetscFunctionBegin;
2576daad07d3SAidan Hamilton   if (network->header) {
2577daad07d3SAidan Hamilton     np = network->cloneshared->pEnd - network->cloneshared->pStart;
2578daad07d3SAidan Hamilton     for (j = 0; j < np; j++) {
2579daad07d3SAidan Hamilton       PetscCall(PetscFree5(network->header[j].size, network->header[j].key, network->header[j].offset, network->header[j].nvar, network->header[j].offsetvarrel));
2580daad07d3SAidan Hamilton       PetscCall(PetscFree(network->cvalue[j].data));
2581daad07d3SAidan Hamilton     }
2582daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->header, network->cvalue));
2583daad07d3SAidan Hamilton   }
2584daad07d3SAidan Hamilton   PetscFunctionReturn(0);
2585daad07d3SAidan Hamilton }
2586daad07d3SAidan Hamilton 
2587d71ae5a4SJacob Faibussowitsch PetscErrorCode DMDestroy_Network(DM dm)
2588d71ae5a4SJacob Faibussowitsch {
25895f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
2590aeb78aa7SBarry Smith   PetscInt    j;
25915f2c45f1SShri Abhyankar 
25925f2c45f1SShri Abhyankar   PetscFunctionBegin;
2593daad07d3SAidan Hamilton   /*
2594daad07d3SAidan Hamilton     Developers Note: Due to the mixed topological definition of DMNetwork and data defined ON the
2595daad07d3SAidan Hamilton     network like DofSection, DataSection, *componentdataarray, and friends, when cloning, we share
2596daad07d3SAidan Hamilton     only the true topological data, and make our own data ON the network. Thus refct only refers
2597daad07d3SAidan Hamilton     to the number of references to topological data, and data ON the network is always destroyed.
2598daad07d3SAidan Hamilton     It is understood this is atypical for a DM, but is very intentional.
2599daad07d3SAidan Hamilton   */
2600daad07d3SAidan Hamilton 
2601daad07d3SAidan Hamilton   /* Always destroy data ON the network */
26029566063dSJacob Faibussowitsch   PetscCall(PetscFree(network->Je));
260383b2e829SHong Zhang   if (network->Jv) {
26049566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jvptr));
26059566063dSJacob Faibussowitsch     PetscCall(PetscFree(network->Jv));
26061ad426b7SHong Zhang   }
2607daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DataSection));
2608daad07d3SAidan Hamilton   PetscCall(PetscSectionDestroy(&network->DofSection));
2609daad07d3SAidan Hamilton   PetscCall(PetscFree(network->component));
2610daad07d3SAidan Hamilton   PetscCall(PetscFree(network->componentdataarray));
2611daad07d3SAidan Hamilton   PetscCall(DMNetworkDestroyComponentData(dm));
261213c2a604SAdrian Maldonado 
2613daad07d3SAidan Hamilton   PetscCall(DMDestroy(&network->plex)); /* this is cloned in DMClone_Network, so safe to destroy */
2614daad07d3SAidan Hamilton 
2615daad07d3SAidan Hamilton   /*
2616daad07d3SAidan Hamilton   Developers Note: The DMNetworkVertexInfo and DMNetworkEdgeInfo data structures are completely
2617daad07d3SAidan Hamilton   destroyed as they are again a mix of topological data:
2618daad07d3SAidan Hamilton     ISLocalToGlobalMapping            mapping;
2619daad07d3SAidan Hamilton     PetscSF                           sf;
2620daad07d3SAidan Hamilton   and data ON the network
2621daad07d3SAidan Hamilton     PetscSection                      DofSection;
2622daad07d3SAidan Hamilton     PetscSection                      GlobalDofSection;
2623daad07d3SAidan Hamilton   And the only way to access them currently is through DMNetworkAssembleGraphStructures which assembles
2624daad07d3SAidan Hamilton   everything. So we must destroy everything and require DMNetworkAssembleGraphStructures is called again
2625daad07d3SAidan Hamilton   for any clone.
2626daad07d3SAidan Hamilton   */
26279566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->vertex.mapping));
26289566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.DofSection));
26299566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->vertex.GlobalDofSection));
26309566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->vertex.sf));
263113c2a604SAdrian Maldonado   /* edge */
26329566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&network->edge.mapping));
26339566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.DofSection));
26349566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&network->edge.GlobalDofSection));
26359566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&network->edge.sf));
2636daad07d3SAidan Hamilton   /* Destroy the potentially cloneshared data */
2637daad07d3SAidan Hamilton   if (--network->cloneshared->refct <= 0) {
2638daad07d3SAidan 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
2639daad07d3SAidan Hamilton      naively think it can be reused. */
2640daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->vltog));
2641daad07d3SAidan Hamilton     for (j = 0; j < network->cloneshared->Nsvtx; j++) PetscCall(PetscFree(network->cloneshared->svtx[j].sv));
2642daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->svtx));
2643daad07d3SAidan Hamilton     PetscCall(PetscFree2(network->cloneshared->subnetedge, network->cloneshared->subnetvtx));
2644daad07d3SAidan Hamilton     PetscCall(PetscTableDestroy(&network->cloneshared->svtable));
2645daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared->subnet));
2646daad07d3SAidan Hamilton     PetscCall(PetscFree(network->cloneshared));
2647daad07d3SAidan Hamilton   }
2648daad07d3SAidan Hamilton   PetscCall(PetscFree(network)); /* Always freed as this structure is copied in a clone, not cloneshared */
26495f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
26505f2c45f1SShri Abhyankar }
26515f2c45f1SShri Abhyankar 
2652d71ae5a4SJacob Faibussowitsch PetscErrorCode DMView_Network(DM dm, PetscViewer viewer)
2653d71ae5a4SJacob Faibussowitsch {
2654caf410d2SHong Zhang   PetscBool   iascii;
2655caf410d2SHong Zhang   PetscMPIInt rank;
26565f2c45f1SShri Abhyankar 
26575f2c45f1SShri Abhyankar   PetscFunctionBegin;
2658caf410d2SHong Zhang   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2659caf410d2SHong Zhang   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
26609566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)dm), &rank));
26619566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2662caf410d2SHong Zhang   if (iascii) {
2663caf410d2SHong Zhang     const PetscInt *cone, *vtx, *edges;
26645c6496baSHong Zhang     PetscInt        vfrom, vto, i, j, nv, ne, nsv, p, nsubnet;
26652bf73ac6SHong Zhang     DM_Network     *network = (DM_Network *)dm->data;
2666caf410d2SHong Zhang 
2667daad07d3SAidan Hamilton     nsubnet = network->cloneshared->Nsubnet; /* num of subnetworks */
2668dd400576SPatrick Sanan     if (rank == 0) {
26699371c9d4SSatish Balay       PetscCall(PetscPrintf(PETSC_COMM_SELF, "  NSubnets: %" PetscInt_FMT "; NEdges: %" PetscInt_FMT "; NVertices: %" PetscInt_FMT "; NSharedVertices: %" PetscInt_FMT ".\n", nsubnet, network->cloneshared->NEdges, network->cloneshared->NVertices,
26709371c9d4SSatish Balay                             network->cloneshared->Nsvtx));
26712bf73ac6SHong Zhang     }
26722bf73ac6SHong Zhang 
26739566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, &nsv, NULL));
26749566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushSynchronized(viewer));
2675daad07d3SAidan Hamilton     PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "  [%d] nEdges: %" PetscInt_FMT "; nVertices: %" PetscInt_FMT "; nSharedVertices: %" PetscInt_FMT "\n", rank, network->cloneshared->nEdges, network->cloneshared->nVertices, nsv));
2676caf410d2SHong Zhang 
2677caf410d2SHong Zhang     for (i = 0; i < nsubnet; i++) {
26789566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetSubnetwork(dm, i, &nv, &ne, &vtx, &edges));
2679caf410d2SHong Zhang       if (ne) {
26809566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "     Subnet %" PetscInt_FMT ": nEdges %" PetscInt_FMT ", nVertices(include shared vertices) %" PetscInt_FMT "\n", i, ne, nv));
2681caf410d2SHong Zhang         for (j = 0; j < ne; j++) {
2682caf410d2SHong Zhang           p = edges[j];
26839566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetConnectedVertices(dm, p, &cone));
26849566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetGlobalVertexIndex(dm, cone[0], &vfrom));
26859566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetGlobalVertexIndex(dm, cone[1], &vto));
26869566063dSJacob Faibussowitsch           PetscCall(DMNetworkGetGlobalEdgeIndex(dm, edges[j], &p));
26879566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "       edge %" PetscInt_FMT ": %" PetscInt_FMT " ----> %" PetscInt_FMT "\n", p, vfrom, vto));
2688caf410d2SHong Zhang         }
2689caf410d2SHong Zhang       }
2690caf410d2SHong Zhang     }
26912bf73ac6SHong Zhang 
26922bf73ac6SHong Zhang     /* Shared vertices */
26939566063dSJacob Faibussowitsch     PetscCall(DMNetworkGetSharedVertices(dm, NULL, &vtx));
26945c6496baSHong Zhang     if (nsv) {
26955c6496baSHong Zhang       PetscInt        gidx;
26962bf73ac6SHong Zhang       PetscBool       ghost;
26975c6496baSHong Zhang       const PetscInt *sv = NULL;
26985c6496baSHong Zhang 
26999566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "     SharedVertices:\n"));
27005c6496baSHong Zhang       for (i = 0; i < nsv; i++) {
27019566063dSJacob Faibussowitsch         PetscCall(DMNetworkIsGhostVertex(dm, vtx[i], &ghost));
27022bf73ac6SHong Zhang         if (ghost) continue;
27032bf73ac6SHong Zhang 
27049566063dSJacob Faibussowitsch         PetscCall(DMNetworkSharedVertexGetInfo(dm, vtx[i], &gidx, &nv, &sv));
27059566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "       svtx %" PetscInt_FMT ": global index %" PetscInt_FMT ", subnet[%" PetscInt_FMT "].%" PetscInt_FMT " ---->\n", i, gidx, sv[0], sv[1]));
270648a46eb9SPierre Jolivet         for (j = 1; j < nv; j++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "                                           ----> subnet[%" PetscInt_FMT "].%" PetscInt_FMT "\n", sv[2 * j], sv[2 * j + 1]));
2707caf410d2SHong Zhang       }
2708caf410d2SHong Zhang     }
27099566063dSJacob Faibussowitsch     PetscCall(PetscViewerFlush(viewer));
27109566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopSynchronized(viewer));
27115c6496baSHong Zhang   } else PetscCheck(iascii, PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Viewer type %s not yet supported for DMNetwork writing", ((PetscObject)viewer)->type_name);
27125f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
27135f2c45f1SShri Abhyankar }
27145f2c45f1SShri Abhyankar 
2715d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalBegin_Network(DM dm, Vec g, InsertMode mode, Vec l)
2716d71ae5a4SJacob Faibussowitsch {
27175f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27185f2c45f1SShri Abhyankar 
27195f2c45f1SShri Abhyankar   PetscFunctionBegin;
27209566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(network->plex, g, mode, l));
27215f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
27225f2c45f1SShri Abhyankar }
27235f2c45f1SShri Abhyankar 
2724d71ae5a4SJacob Faibussowitsch PetscErrorCode DMGlobalToLocalEnd_Network(DM dm, Vec g, InsertMode mode, Vec l)
2725d71ae5a4SJacob Faibussowitsch {
27265f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27275f2c45f1SShri Abhyankar 
27285f2c45f1SShri Abhyankar   PetscFunctionBegin;
27299566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(network->plex, g, mode, l));
27305f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
27315f2c45f1SShri Abhyankar }
27325f2c45f1SShri Abhyankar 
2733d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalBegin_Network(DM dm, Vec l, InsertMode mode, Vec g)
2734d71ae5a4SJacob Faibussowitsch {
27355f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27365f2c45f1SShri Abhyankar 
27375f2c45f1SShri Abhyankar   PetscFunctionBegin;
27389566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(network->plex, l, mode, g));
27395f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
27405f2c45f1SShri Abhyankar }
27415f2c45f1SShri Abhyankar 
2742d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLocalToGlobalEnd_Network(DM dm, Vec l, InsertMode mode, Vec g)
2743d71ae5a4SJacob Faibussowitsch {
27445f2c45f1SShri Abhyankar   DM_Network *network = (DM_Network *)dm->data;
27455f2c45f1SShri Abhyankar 
27465f2c45f1SShri Abhyankar   PetscFunctionBegin;
27479566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(network->plex, l, mode, g));
27485f2c45f1SShri Abhyankar   PetscFunctionReturn(0);
27495f2c45f1SShri Abhyankar }
275022bbedd7SHong Zhang 
275122bbedd7SHong Zhang /*@
275264238763SRodolfo Oliveira   DMNetworkGetVertexLocalToGlobalOrdering - Get vertex global index
275322bbedd7SHong Zhang 
275422bbedd7SHong Zhang   Not collective
275522bbedd7SHong Zhang 
27567a7aea1fSJed Brown   Input Parameters:
275722bbedd7SHong Zhang + dm - the dm object
275822bbedd7SHong Zhang - vloc - local vertex ordering, start from 0
275922bbedd7SHong Zhang 
27607a7aea1fSJed Brown   Output Parameters:
2761f0fc11ceSJed Brown .  vg  - global vertex ordering, start from 0
276222bbedd7SHong Zhang 
276397bb938eSShri Abhyankar   Level: advanced
276422bbedd7SHong Zhang 
2765db781477SPatrick Sanan .seealso: `DMNetworkSetVertexLocalToGlobalOrdering()`
276622bbedd7SHong Zhang @*/
2767d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkGetVertexLocalToGlobalOrdering(DM dm, PetscInt vloc, PetscInt *vg)
2768d71ae5a4SJacob Faibussowitsch {
276922bbedd7SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
2770daad07d3SAidan Hamilton   PetscInt   *vltog   = network->cloneshared->vltog;
277122bbedd7SHong Zhang 
277222bbedd7SHong Zhang   PetscFunctionBegin;
27735c6496baSHong Zhang   PetscCheck(vltog, PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkSetVertexLocalToGlobalOrdering() first");
277422bbedd7SHong Zhang   *vg = vltog[vloc];
277522bbedd7SHong Zhang   PetscFunctionReturn(0);
277622bbedd7SHong Zhang }
277722bbedd7SHong Zhang 
277822bbedd7SHong Zhang /*@
277964238763SRodolfo Oliveira   DMNetworkSetVertexLocalToGlobalOrdering - Create and setup vertex local to global map
278022bbedd7SHong Zhang 
278122bbedd7SHong Zhang   Collective
278222bbedd7SHong Zhang 
278322bbedd7SHong Zhang   Input Parameters:
2784f0fc11ceSJed Brown . dm - the dm object
278522bbedd7SHong Zhang 
278697bb938eSShri Abhyankar   Level: advanced
278722bbedd7SHong Zhang 
2788db781477SPatrick Sanan .seealso: `DMNetworkGetGlobalVertexIndex()`
278922bbedd7SHong Zhang @*/
2790d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkSetVertexLocalToGlobalOrdering(DM dm)
2791d71ae5a4SJacob Faibussowitsch {
279222bbedd7SHong Zhang   DM_Network        *network = (DM_Network *)dm->data;
279322bbedd7SHong Zhang   MPI_Comm           comm;
27942bf73ac6SHong Zhang   PetscMPIInt        rank, size, *displs = NULL, *recvcounts = NULL, remoterank;
279522bbedd7SHong Zhang   PetscBool          ghost;
279663029d29SHong Zhang   PetscInt          *vltog, nroots, nleaves, i, *vrange, k, N, lidx;
279722bbedd7SHong Zhang   const PetscSFNode *iremote;
279822bbedd7SHong Zhang   PetscSF            vsf;
279963029d29SHong Zhang   Vec                Vleaves, Vleaves_seq;
280063029d29SHong Zhang   VecScatter         ctx;
280163029d29SHong Zhang   PetscScalar       *varr, val;
280263029d29SHong Zhang   const PetscScalar *varr_read;
280322bbedd7SHong Zhang 
280422bbedd7SHong Zhang   PetscFunctionBegin;
28059566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
28069566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
28079566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
280822bbedd7SHong Zhang 
280922bbedd7SHong Zhang   if (size == 1) {
2810daad07d3SAidan Hamilton     nroots = network->cloneshared->vEnd - network->cloneshared->vStart;
28119566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nroots, &vltog));
281222bbedd7SHong Zhang     for (i = 0; i < nroots; i++) vltog[i] = i;
2813daad07d3SAidan Hamilton     network->cloneshared->vltog = vltog;
281422bbedd7SHong Zhang     PetscFunctionReturn(0);
281522bbedd7SHong Zhang   }
281622bbedd7SHong Zhang 
2817daad07d3SAidan Hamilton   PetscCheck(network->cloneshared->distributecalled, comm, PETSC_ERR_ARG_WRONGSTATE, "Must call DMNetworkDistribute() first");
2818daad07d3SAidan Hamilton   if (network->cloneshared->vltog) PetscCall(PetscFree(network->cloneshared->vltog));
281922bbedd7SHong Zhang 
2820daad07d3SAidan Hamilton   PetscCall(DMNetworkSetSubMap_private(network->cloneshared->vStart, network->cloneshared->vEnd, &network->vertex.mapping));
28219566063dSJacob Faibussowitsch   PetscCall(PetscSFGetSubSF(network->plex->sf, network->vertex.mapping, &network->vertex.sf));
282222bbedd7SHong Zhang   vsf = network->vertex.sf;
282322bbedd7SHong Zhang 
28249566063dSJacob Faibussowitsch   PetscCall(PetscMalloc3(size + 1, &vrange, size, &displs, size, &recvcounts));
28259566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(vsf, &nroots, &nleaves, NULL, &iremote));
282622bbedd7SHong Zhang 
28279371c9d4SSatish Balay   for (i = 0; i < size; i++) {
28289371c9d4SSatish Balay     displs[i]     = i;
28299371c9d4SSatish Balay     recvcounts[i] = 1;
28309371c9d4SSatish Balay   }
283122bbedd7SHong Zhang 
283222bbedd7SHong Zhang   i         = nroots - nleaves; /* local number of vertices, excluding ghosts */
283322bbedd7SHong Zhang   vrange[0] = 0;
28349566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allgatherv(&i, 1, MPIU_INT, vrange + 1, recvcounts, displs, MPIU_INT, comm));
2835ad540459SPierre Jolivet   for (i = 2; i < size + 1; i++) vrange[i] += vrange[i - 1];
283622bbedd7SHong Zhang 
28379566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &vltog));
2838daad07d3SAidan Hamilton   network->cloneshared->vltog = vltog;
283922bbedd7SHong Zhang 
284063029d29SHong Zhang   /* Set vltog for non-ghost vertices */
284163029d29SHong Zhang   k = 0;
284222bbedd7SHong Zhang   for (i = 0; i < nroots; i++) {
2843daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
284463029d29SHong Zhang     if (ghost) continue;
284563029d29SHong Zhang     vltog[i] = vrange[rank] + k++;
284622bbedd7SHong Zhang   }
28479566063dSJacob Faibussowitsch   PetscCall(PetscFree3(vrange, displs, recvcounts));
284863029d29SHong Zhang 
284963029d29SHong Zhang   /* Set vltog for ghost vertices */
285063029d29SHong Zhang   /* (a) create parallel Vleaves and sequential Vleaves_seq to convert local iremote[*].index to global index */
28519566063dSJacob Faibussowitsch   PetscCall(VecCreate(comm, &Vleaves));
28529566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(Vleaves, 2 * nleaves, PETSC_DETERMINE));
28539566063dSJacob Faibussowitsch   PetscCall(VecSetFromOptions(Vleaves));
28549566063dSJacob Faibussowitsch   PetscCall(VecGetArray(Vleaves, &varr));
285563029d29SHong Zhang   for (i = 0; i < nleaves; i++) {
285663029d29SHong Zhang     varr[2 * i]     = (PetscScalar)(iremote[i].rank);  /* rank of remote process */
285763029d29SHong Zhang     varr[2 * i + 1] = (PetscScalar)(iremote[i].index); /* local index in remote process */
285863029d29SHong Zhang   }
28599566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(Vleaves, &varr));
286063029d29SHong Zhang 
286163029d29SHong Zhang   /* (b) scatter local info to remote processes via VecScatter() */
28629566063dSJacob Faibussowitsch   PetscCall(VecScatterCreateToAll(Vleaves, &ctx, &Vleaves_seq));
28639566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
28649566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ctx, Vleaves, Vleaves_seq, INSERT_VALUES, SCATTER_FORWARD));
286563029d29SHong Zhang 
286663029d29SHong Zhang   /* (c) convert local indices to global indices in parallel vector Vleaves */
28679566063dSJacob Faibussowitsch   PetscCall(VecGetSize(Vleaves_seq, &N));
28689566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves_seq, &varr_read));
286963029d29SHong Zhang   for (i = 0; i < N; i += 2) {
28702e4cff2eSHong Zhang     remoterank = (PetscMPIInt)PetscRealPart(varr_read[i]);
287163029d29SHong Zhang     if (remoterank == rank) {
287263029d29SHong Zhang       k    = i + 1; /* row number */
28732e4cff2eSHong Zhang       lidx = (PetscInt)PetscRealPart(varr_read[i + 1]);
287463029d29SHong Zhang       val  = (PetscScalar)vltog[lidx]; /* global index for non-ghost vertex computed above */
28759566063dSJacob Faibussowitsch       PetscCall(VecSetValues(Vleaves, 1, &k, &val, INSERT_VALUES));
287663029d29SHong Zhang     }
287763029d29SHong Zhang   }
28789566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves_seq, &varr_read));
28799566063dSJacob Faibussowitsch   PetscCall(VecAssemblyBegin(Vleaves));
28809566063dSJacob Faibussowitsch   PetscCall(VecAssemblyEnd(Vleaves));
288163029d29SHong Zhang 
288263029d29SHong Zhang   /* (d) Set vltog for ghost vertices by copying local values of Vleaves */
28839566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(Vleaves, &varr_read));
288463029d29SHong Zhang   k = 0;
288563029d29SHong Zhang   for (i = 0; i < nroots; i++) {
2886daad07d3SAidan Hamilton     PetscCall(DMNetworkIsGhostVertex(dm, i + network->cloneshared->vStart, &ghost));
288763029d29SHong Zhang     if (!ghost) continue;
28889371c9d4SSatish Balay     vltog[i] = (PetscInt)PetscRealPart(varr_read[2 * k + 1]);
28899371c9d4SSatish Balay     k++;
289063029d29SHong Zhang   }
28919566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(Vleaves, &varr_read));
289263029d29SHong Zhang 
28939566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves));
28949566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Vleaves_seq));
28959566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&ctx));
289622bbedd7SHong Zhang   PetscFunctionReturn(0);
289722bbedd7SHong Zhang }
289842dc13f1SHong Zhang 
2899d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISAddSize_private(DM_Network *network, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *nidx)
2900d71ae5a4SJacob Faibussowitsch {
290142dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offset = 0;
290242dc13f1SHong Zhang   DMNetworkComponentHeader header;
290342dc13f1SHong Zhang 
290442dc13f1SHong Zhang   PetscFunctionBegin;
29059566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
290642dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
290742dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
290842dc13f1SHong Zhang 
290942dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
291042dc13f1SHong Zhang     key  = header->key[i];
291142dc13f1SHong Zhang     nvar = header->nvar[i];
291242dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
291342dc13f1SHong Zhang       if (key == keys[j]) {
291442dc13f1SHong Zhang         if (!blocksize || blocksize[j] == -1) {
291542dc13f1SHong Zhang           *nidx += nvar;
291642dc13f1SHong Zhang         } else {
291742dc13f1SHong Zhang           *nidx += nselectedvar[j] * nvar / blocksize[j];
291842dc13f1SHong Zhang         }
291942dc13f1SHong Zhang       }
292042dc13f1SHong Zhang     }
292142dc13f1SHong Zhang   }
292242dc13f1SHong Zhang   PetscFunctionReturn(0);
292342dc13f1SHong Zhang }
292442dc13f1SHong Zhang 
2925d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
2926d71ae5a4SJacob Faibussowitsch {
292742dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetg, k, k1, offset = 0;
292842dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
292942dc13f1SHong Zhang   DMNetworkComponentHeader header;
293042dc13f1SHong Zhang 
293142dc13f1SHong Zhang   PetscFunctionBegin;
29329566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
293342dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
293442dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
293542dc13f1SHong Zhang 
293642dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
293742dc13f1SHong Zhang     key  = header->key[i];
293842dc13f1SHong Zhang     nvar = header->nvar[i];
293942dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
294042dc13f1SHong Zhang       if (key != keys[j]) continue;
294142dc13f1SHong Zhang 
29429566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetGlobalVecOffset(dm, p, i, &offsetg));
294342dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
294442dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetg + k;
294542dc13f1SHong Zhang       } else {
294642dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
294742dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetg + k + selectedvar[j][k1];
294842dc13f1SHong Zhang         }
294942dc13f1SHong Zhang       }
295042dc13f1SHong Zhang     }
295142dc13f1SHong Zhang   }
295242dc13f1SHong Zhang   PetscFunctionReturn(0);
295342dc13f1SHong Zhang }
295442dc13f1SHong Zhang 
295542dc13f1SHong Zhang /*@
295642dc13f1SHong Zhang   DMNetworkCreateIS - Create an index set object from the global vector of the network
295742dc13f1SHong Zhang 
295842dc13f1SHong Zhang   Collective
295942dc13f1SHong Zhang 
296042dc13f1SHong Zhang   Input Parameters:
296142dc13f1SHong Zhang + dm - DMNetwork object
296242dc13f1SHong Zhang . numkeys - number of keys
296342dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
296442dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
296542dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
296642dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
296742dc13f1SHong Zhang 
296842dc13f1SHong Zhang   Output Parameters:
296942dc13f1SHong Zhang . is - the index set
297042dc13f1SHong Zhang 
297142dc13f1SHong Zhang   Level: Advanced
297242dc13f1SHong Zhang 
297342dc13f1SHong Zhang   Notes:
297442dc13f1SHong Zhang     Use blocksize[i] of -1 to indicate select all the variables of the i-th component, for which nselectvar[i] and selectedvar[i] are ignored. Use NULL, NULL, NULL to indicate for all selected components one wishes to obtain all the values of that component. For example, DMNetworkCreateIS(dm,1,&key,NULL,NULL,NULL,&is) will return an is that extracts all the variables for the 0-th component.
297542dc13f1SHong Zhang 
2976db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `ISCreateGeneral()`, `DMNetworkCreateLocalIS()`
297742dc13f1SHong Zhang @*/
2978d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
2979d71ae5a4SJacob Faibussowitsch {
298042dc13f1SHong Zhang   MPI_Comm    comm;
298142dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
298242dc13f1SHong Zhang   PetscInt    i, p, estart, eend, vstart, vend, nidx, *idx;
298342dc13f1SHong Zhang   PetscBool   ghost;
298442dc13f1SHong Zhang 
298542dc13f1SHong Zhang   PetscFunctionBegin;
29869566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
298742dc13f1SHong Zhang 
298842dc13f1SHong Zhang   /* Check input parameters */
298942dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
299042dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
299163a3b9bcSJacob 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]);
299242dc13f1SHong Zhang   }
299342dc13f1SHong Zhang 
29949566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetEdgeRange(dm, &estart, &eend));
29959566063dSJacob Faibussowitsch   PetscCall(DMNetworkGetVertexRange(dm, &vstart, &vend));
299642dc13f1SHong Zhang 
299742dc13f1SHong Zhang   /* Get local number of idx */
299842dc13f1SHong Zhang   nidx = 0;
299948a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
300042dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30019566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
300242dc13f1SHong Zhang     if (ghost) continue;
30039566063dSJacob Faibussowitsch     PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
300442dc13f1SHong Zhang   }
300542dc13f1SHong Zhang 
300642dc13f1SHong Zhang   /* Compute idx */
30079566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
300842dc13f1SHong Zhang   i = 0;
300948a46eb9SPierre Jolivet   for (p = estart; p < eend; p++) PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
301042dc13f1SHong Zhang   for (p = vstart; p < vend; p++) {
30119566063dSJacob Faibussowitsch     PetscCall(DMNetworkIsGhostVertex(dm, p, &ghost));
301242dc13f1SHong Zhang     if (ghost) continue;
30139566063dSJacob Faibussowitsch     PetscCall(DMISComputeIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
301442dc13f1SHong Zhang   }
301542dc13f1SHong Zhang 
301642dc13f1SHong Zhang   /* Create is */
30179566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(comm, nidx, idx, PETSC_COPY_VALUES, is));
30189566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
301942dc13f1SHong Zhang   PetscFunctionReturn(0);
302042dc13f1SHong Zhang }
302142dc13f1SHong Zhang 
3022d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMISComputeLocalIdx_private(DM dm, PetscInt p, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], PetscInt *ii, PetscInt *idx)
3023d71ae5a4SJacob Faibussowitsch {
302442dc13f1SHong Zhang   PetscInt                 i, j, ncomps, nvar, key, offsetl, k, k1, offset = 0;
302542dc13f1SHong Zhang   DM_Network              *network = (DM_Network *)dm->data;
302642dc13f1SHong Zhang   DMNetworkComponentHeader header;
302742dc13f1SHong Zhang 
302842dc13f1SHong Zhang   PetscFunctionBegin;
30299566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(network->DataSection, p, &offset));
303042dc13f1SHong Zhang   ncomps = ((DMNetworkComponentHeader)(network->componentdataarray + offset))->ndata;
303142dc13f1SHong Zhang   header = (DMNetworkComponentHeader)(network->componentdataarray + offset);
303242dc13f1SHong Zhang 
303342dc13f1SHong Zhang   for (i = 0; i < ncomps; i++) {
303442dc13f1SHong Zhang     key  = header->key[i];
303542dc13f1SHong Zhang     nvar = header->nvar[i];
303642dc13f1SHong Zhang     for (j = 0; j < numkeys; j++) {
303742dc13f1SHong Zhang       if (key != keys[j]) continue;
303842dc13f1SHong Zhang 
30399566063dSJacob Faibussowitsch       PetscCall(DMNetworkGetLocalVecOffset(dm, p, i, &offsetl));
304042dc13f1SHong Zhang       if (!blocksize || blocksize[j] == -1) {
304142dc13f1SHong Zhang         for (k = 0; k < nvar; k++) idx[(*ii)++] = offsetl + k;
304242dc13f1SHong Zhang       } else {
304342dc13f1SHong Zhang         for (k = 0; k < nvar; k += blocksize[j]) {
304442dc13f1SHong Zhang           for (k1 = 0; k1 < nselectedvar[j]; k1++) idx[(*ii)++] = offsetl + k + selectedvar[j][k1];
304542dc13f1SHong Zhang         }
304642dc13f1SHong Zhang       }
304742dc13f1SHong Zhang     }
304842dc13f1SHong Zhang   }
304942dc13f1SHong Zhang   PetscFunctionReturn(0);
305042dc13f1SHong Zhang }
305142dc13f1SHong Zhang 
305242dc13f1SHong Zhang /*@
305342dc13f1SHong Zhang   DMNetworkCreateLocalIS - Create an index set object from the local vector of the network
305442dc13f1SHong Zhang 
305542dc13f1SHong Zhang   Not collective
305642dc13f1SHong Zhang 
305742dc13f1SHong Zhang   Input Parameters:
305842dc13f1SHong Zhang + dm - DMNetwork object
305942dc13f1SHong Zhang . numkeys - number of keys
306042dc13f1SHong Zhang . keys - array of keys that define the components of the variables you wish to extract
306142dc13f1SHong Zhang . blocksize - block size of the variables associated to the component
306242dc13f1SHong Zhang . nselectedvar - number of variables in each block to select
306342dc13f1SHong Zhang - selectedvar - the offset into the block of each variable in each block to select
306442dc13f1SHong Zhang 
306542dc13f1SHong Zhang   Output Parameters:
306642dc13f1SHong Zhang . is - the index set
306742dc13f1SHong Zhang 
306842dc13f1SHong Zhang   Level: Advanced
306942dc13f1SHong Zhang 
307042dc13f1SHong Zhang   Notes:
307142dc13f1SHong Zhang     Use blocksize[i] of -1 to indicate select all the variables of the i-th component, for which nselectvar[i] and selectedvar[i] are ignored. Use NULL, NULL, NULL to indicate for all selected components one wishes to obtain all the values of that component. For example, DMNetworkCreateLocalIS(dm,1,&key,NULL,NULL,NULL,&is) will return an is that extracts all the variables for the 0-th component.
307242dc13f1SHong Zhang 
3073db781477SPatrick Sanan .seealso: `DMNetworkCreate()`, `DMNetworkCreateIS`, `ISCreateGeneral()`
307442dc13f1SHong Zhang @*/
3075d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkCreateLocalIS(DM dm, PetscInt numkeys, PetscInt keys[], PetscInt blocksize[], PetscInt nselectedvar[], PetscInt *selectedvar[], IS *is)
3076d71ae5a4SJacob Faibussowitsch {
307742dc13f1SHong Zhang   DM_Network *network = (DM_Network *)dm->data;
307842dc13f1SHong Zhang   PetscInt    i, p, pstart, pend, nidx, *idx;
307942dc13f1SHong Zhang 
308042dc13f1SHong Zhang   PetscFunctionBegin;
308142dc13f1SHong Zhang   /* Check input parameters */
308242dc13f1SHong Zhang   for (i = 0; i < numkeys; i++) {
308342dc13f1SHong Zhang     if (!blocksize || blocksize[i] == -1) continue;
308463a3b9bcSJacob 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]);
308542dc13f1SHong Zhang   }
308642dc13f1SHong Zhang 
3087daad07d3SAidan Hamilton   pstart = network->cloneshared->pStart;
3088daad07d3SAidan Hamilton   pend   = network->cloneshared->pEnd;
308942dc13f1SHong Zhang 
309042dc13f1SHong Zhang   /* Get local number of idx */
309142dc13f1SHong Zhang   nidx = 0;
309248a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISAddSize_private(network, p, numkeys, keys, blocksize, nselectedvar, &nidx));
309342dc13f1SHong Zhang 
309442dc13f1SHong Zhang   /* Compute local idx */
30959566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nidx, &idx));
309642dc13f1SHong Zhang   i = 0;
309748a46eb9SPierre Jolivet   for (p = pstart; p < pend; p++) PetscCall(DMISComputeLocalIdx_private(dm, p, numkeys, keys, blocksize, nselectedvar, selectedvar, &i, idx));
309842dc13f1SHong Zhang 
309942dc13f1SHong Zhang   /* Create is */
31009566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nidx, idx, PETSC_COPY_VALUES, is));
31019566063dSJacob Faibussowitsch   PetscCall(PetscFree(idx));
310242dc13f1SHong Zhang   PetscFunctionReturn(0);
310342dc13f1SHong Zhang }
3104daad07d3SAidan Hamilton /*@
3105*d5b43468SJose E. Roman   DMNetworkFinalizeComponents - Sets up internal data structures for the sections and components. It is called after registering new components and adding all components
3106daad07d3SAidan Hamilton   to the cloned network. After calling this subroutine, no new components can be added to the network.
3107daad07d3SAidan Hamilton 
3108daad07d3SAidan Hamilton   Collective
3109daad07d3SAidan Hamilton 
3110daad07d3SAidan Hamilton   Input Parameters:
3111daad07d3SAidan Hamilton . dm - the dmnetwork object
3112daad07d3SAidan Hamilton 
3113daad07d3SAidan Hamilton   Level: beginner
3114daad07d3SAidan Hamilton 
3115daad07d3SAidan Hamilton .seealso: `DMNetworkAddComponent()`, `DMNetworkRegisterComponent()`, `DMSetUp()`
3116daad07d3SAidan Hamilton @*/
3117d71ae5a4SJacob Faibussowitsch PetscErrorCode DMNetworkFinalizeComponents(DM dm)
3118d71ae5a4SJacob Faibussowitsch {
3119daad07d3SAidan Hamilton   DM_Network *network = (DM_Network *)dm->data;
3120daad07d3SAidan Hamilton 
3121daad07d3SAidan Hamilton   PetscFunctionBegin;
3122daad07d3SAidan Hamilton   if (network->componentsetup) PetscFunctionReturn(0);
3123daad07d3SAidan Hamilton   PetscCall(DMNetworkComponentSetUp(dm));
3124daad07d3SAidan Hamilton   PetscCall(DMNetworkVariablesSetUp(dm));
3125daad07d3SAidan Hamilton   PetscCall(DMSetLocalSection(network->plex, network->DofSection));
3126daad07d3SAidan Hamilton   PetscCall(DMGetGlobalSection(network->plex, &network->GlobalDofSection));
3127daad07d3SAidan Hamilton   network->componentsetup = PETSC_TRUE;
3128daad07d3SAidan Hamilton   PetscFunctionReturn(0);
3129daad07d3SAidan Hamilton }
3130