Skip to content

Commit

Permalink
fix multimeshadj docs
Browse files Browse the repository at this point in the history
  • Loading branch information
markcmiller86 committed Oct 3, 2024
1 parent 6f36ff4 commit 4c5667e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/parallel.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,18 +238,18 @@ The functions described in this section of the manual include...
`name` | Name of the multi-mesh adjacency object.
`nmesh` | The number of mesh pieces in the corresponding multi-mesh object. This value must be identical in repeated calls to `DBPutMultimeshadj`.
`mesh_types` | Integer array of length `nmesh` indicating the type of each mesh in the corresponding multi-mesh object. This array must be identical to that which is passed in the `DBPutMultimesh` call and in repeated calls to `DBPutMultimeshadj`.
`nneighbors` | Integer array of length `nmesh` indicating the number of `neighbors` for each mesh piece. This array must be identical in repeated calls to `DBPutMultimeshadj`. In the argument descriptions to follow, let . That is, let be the sum of the first k entries in the `nneighbors` array.
`neighbors` | Array of integers enumerating for each mesh piece all other mesh pieces that neighbor it. Entries from index to index enumerate the `neighbors` of mesh piece k. This array must be identical in repeated calls to `DBPutMultimeshadj`.
`back` | Array of integers enumerating for each mesh piece, the local index of that mesh piece in each of its `neighbors` lists of `neighbors`. Entries from index to index enumerate the local indices of mesh piece k in each of the `neighbors` of mesh piece k. This argument may be `NULL`. In any case, this array must be identical in repeated calls to `DBPutMultimeshadj`.
`nnodes` | Array of integers indicating for each mesh piece, the number of nodes that it shares with each of its `neighbors`. Entries from index to index indicate the number of nodes that mesh piece k shares with each of its `neighbors`. This array must be identical in repeated calls to `DBPutMultimeshadj`. This argument may be `NULL`.
`nodelists` | Array of pointers to arrays of integers. Entries from index to index enumerate the nodes that mesh piece k shares with each of its `neighbors`. The contents of a specific nodelist array depend on the types of meshes that are neighboring each other (See description below). nodelists[m] may be `NULL` even if nnodes[m] is non-zero. See below for a description of repeated calls to `DBPutMultimeshadj`. This argument must be `NULL` if `nnodes` is `NULL`.
`nzones` | Array of integers indicating for each mesh piece, the number of zones that are adjacent with each of its `neighbors`. Entries from index to index indicate the number of zones that mesh piece k has adjacent to each of its `neighbors`. This array must be identical in repeated calls to `DBPutMultimeshadj`. This argument may be `NULL`.
`zonelists` | Array of pointers to arrays of integers. Entries from index to index enumerate the zones that mesh piece k has adjacent with each of its `neighbors`. The contents of a specific zonelist array depend on the types of meshes that are neighboring each other (See description below). zonelists[m] may be `NULL` even if nzones[m] is non-zero. See below for a description of repeated calls to `DBPutMultimeshadj`. This argument must be `NULL` if `nzones` is `NULL`.
`nneighbors` | Integer array of length `nmesh` indicating the number of `neighbors` for each mesh piece. This array must be identical in repeated calls to `DBPutMultimeshadj`. In the argument descriptions to follow, let $S_k = \sum_{i=1}^k nneighbors[i]$, which sums the first `k` elements from the `nneighbors` array.
`neighbors` | Array of $S_nmesh$ integers enumerating for each mesh piece all other mesh pieces that neighbor it. Entries from index $S_k$ to index $S_{k+1}-1$ enumerate the `neighbors` of mesh piece `k`. This array must be identical in repeated calls to `DBPutMultimeshadj`.
`back` | Array of $S_nmesh$ integers enumerating for each mesh piece, the local index of that mesh piece in each of its `neighbors` lists of `neighbors`. Entries from index $S_k$ to index $S_{k+1}-1$ enumerate the local indices of mesh piece `k` in each of the `neighbors` of mesh piece `k`. This argument may be `NULL`. In any case, this array must be identical in repeated calls to `DBPutMultimeshadj`.
`nnodes` | Array of $S_nmesh$ integers indicating for each mesh piece, the number of nodes that it shares with each of its `neighbors`. Entries from index $S_k$ to index $S_{k+1}-1$ indicate the number of nodes that mesh piece k shares with each of its `neighbors`. This array must be identical in repeated calls to `DBPutMultimeshadj`. This argument may be `NULL`.
`nodelists` | Array of $S_nmesh$ pointers to arrays of integers. Entries from index $S_k$ to index $S_{k+1}-1$ enumerate the nodes that mesh piece `k` shares with each of its `neighbors`. The contents of a specific nodelist array depend on the types of meshes that are neighboring each other (See description below). `nodelists[m]` may be `NULL` even if `nnodes[m]` is non-zero. See below for a description of repeated calls to `DBPutMultimeshadj`. This argument must be `NULL` if `nnodes` is `NULL`.
`nzones` | Array of $S_nmesh$ integers indicating for each mesh piece, the number of zones that are adjacent with each of its `neighbors`. Entries from index $S_k$ to index $S_{k+1}-1$ indicate the number of zones that mesh piece `k` has adjacent to each of its `neighbors`. This array must be identical in repeated calls to `DBPutMultimeshadj`. This argument may be `NULL`.
`zonelists` | Array of $S_nmesh$ pointers to arrays of integers. Entries from index $S_k$ to index $S_{k+1}-1$ enumerate the zones that mesh piece `k` has adjacent with each of its `neighbors`. The contents of a specific zonelist array depend on the types of meshes that are neighboring each other (See description below). `zonelists[m]` may be `NULL` even if `nzones[m]` is non-zero. See below for a description of repeated calls to `DBPutMultimeshadj`. This argument must be `NULL` if `nzones` is `NULL`.
`optlist` | Pointer to an option list structure containing additional information to be included in the object written into the Silo file. Use a `NULL` if there are no options.

* **Description:**

**Note: This object suffers from scalability issues above about 10{sup}`5` blocks.**
**Note: This object suffers from scalability issues above about 10{sup}5 blocks.**

**The functionality this object provides is now more efficiently and conveniently handled via Mesh Region Grouping (MRG) trees.**
Users are encouraged to use MRG trees as an alternative to `DBPutMultimeshadj()`.
Expand Down

0 comments on commit 4c5667e

Please sign in to comment.