From aafde9efec26346605e035943a52062347037498 Mon Sep 17 00:00:00 2001 From: falgout Date: Fri, 4 Nov 2011 18:16:07 +0000 Subject: [PATCH] Added comments about SetPeriodic() working only for SSTRUCT and STRUCT types. --- sstruct_mv/HYPRE_sstruct_mv.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/sstruct_mv/HYPRE_sstruct_mv.h b/sstruct_mv/HYPRE_sstruct_mv.h index 71cdb2116..005ee794d 100644 --- a/sstruct_mv/HYPRE_sstruct_mv.h +++ b/sstruct_mv/HYPRE_sstruct_mv.h @@ -323,6 +323,11 @@ HYPRE_SStructGridAssemble(HYPRE_SStructGrid grid); * actual period. For example, periodicity in the first and third dimensions * for a 10x11x12 part is indicated by the array [10,0,12]. * + * NOTE: Currently, this routine will only have an effect for matrix object + * types {\tt HYPRE\_SSTRUCT} and {\tt HYPRE\_STRUCT}. For {\tt HYPRE\_PARCSR}, + * periodicity must be set up manually through other routines such as + * \Ref{HYPRE_SStructGridSetNeighborPart}. + * * NOTE: Some of the solvers in hypre have power-of-two restrictions on the size * of the periodic dimensions. **/