int32_t bHYPRE_SStructGrid_SetNeighborBox ( bHYPRE_SStructGrid self, int32_t part, int32_t* ilower, int32_t* iupper, int32_t nbor_part, int32_t* nbor_ilower, int32_t* nbor_iupper, int32_t* index_map, int32_t dim, sidl_BaseInterface *_ex)

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.

The indexes ilower and iupper map directly to the indexes nbor_ilower and nbor_iupper. Although, it is required that indexes increase from ilower to iupper, indexes may increase and/or decrease from nbor_ilower to nbor_iupper.

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.

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.

alphabetic index hierarchy of classes


generated by doc++