int HYPRE_SStructGridSetNeighborPart (HYPRE_SStructGrid grid, int part, int *ilower, int *iupper, int nbor_part, int *nbor_ilower, int *nbor_iupper, int *index_map, int *index_dir)

Describe how regions just outside of a part relate to other parts

Documentation

Describe how regions just outside of a part relate to other parts. This is done a box at a time.

Parts part and nbor_part must be different, except in the case where only cell-centered data is used.

Indexes should increase from ilower to iupper. It is not necessary that indexes increase from nbor_ilower to nbor_iupper. This is to ease the transition from the old SetNeighborBox function, and to provide some flexibility for users.

The index_map describes the mapping of indexes 0, 1, and 2 on part part to the corresponding indexes on part nbor_part. For example, triple (1, 2, 0) means that indexes 0, 1, and 2 on part part map to indexes 1, 2, and 0 on part nbor_part, respectively.

The index_dir describes the direction of the mapping in index_map. For example, triple (1, 1, -1) means that for indexes 0 and 1, increasing values map to increasing values on nbor_part, while for index 2, decreasing values map to increasing values.

NOTE: All parts related to each other via this routine must have an identical list of variables and variable types. For example, if part 0 has only two variables on it, a cell centered variable and a node centered variable, and we declare part 1 to be a neighbor of part 0, then part 1 must also have only two variables on it, and they must be of type cell and node. In addition, variables associated with FACEs or EDGEs must be grouped together and listed in X, Y, Z order. This is to enable the code to correctly associate variables on one part with variables on its neighbor part when a coordinate transformation is specified. For example, an XFACE variable on one part may correspond to a YFACE variable on a neighbor part under a particular tranformation, and the code determines this association by assuming that the variable lists are as noted here.

alphabetic index hierarchy of classes


generated by doc++