# Interface definition for thorn SymBase
# $Header$

IMPLEMENTS: SymBase



# Register a symmetry, and query the symmetry name/handle mapping:

CCTK_INT FUNCTION SymmetryRegister (CCTK_STRING IN sym_name)
PROVIDES FUNCTION SymmetryRegister \
     WITH SymBase_SymmetryRegister \
     LANGUAGE C

CCTK_INT FUNCTION SymmetryHandleOfName (CCTK_STRING IN sym_name)
PROVIDES FUNCTION SymmetryHandleOfName \
     WITH SymBase_SymmetryHandleOfName \
     LANGUAGE C

CCTK_POINTER_TO_CONST FUNCTION SymmetryNameOfHandle (CCTK_INT IN sym_handle)
PROVIDES FUNCTION SymmetryNameOfHandle \
     WITH SymBase_SymmetryNameOfHandle \
     LANGUAGE C



# Register a symmetry condition for a face:

CCTK_INT FUNCTION                                  \
    SymmetryRegisterGrid                           \
         (CCTK_POINTER IN cctkGH,                  \
          CCTK_INT IN sym_handle,                  \
          CCTK_INT IN ARRAY which_faces,           \ # array [N_FACES]
          CCTK_INT IN ARRAY symmetry_zone_width)     # array [N_FACES]
PROVIDES FUNCTION SymmetryRegisterGrid \
     WITH SymBase_SymmetryRegisterGrid \
     LANGUAGE C

CCTK_INT FUNCTION                                  \
    SymmetryRegisterGI                             \
        (CCTK_POINTER IN cctkGH,                   \
         CCTK_INT IN sym_handle,                   \
         CCTK_INT IN ARRAY which_faces,            \ # array [N_FACES]
         CCTK_INT IN ARRAY symmetry_zone_width,    \ # array [N_FACES]
         CCTK_INT IN group_index)
PROVIDES FUNCTION SymmetryRegisterGI \
     WITH SymBase_SymmetryRegisterGI \
     LANGUAGE C

CCTK_INT FUNCTION                                  \
    SymmetryRegisterGN                             \
        (CCTK_POINTER IN cctkGH,                   \
         CCTK_INT IN sym_handle,                   \
         CCTK_INT IN ARRAY which_faces,            \ # array [N_FACES]
         CCTK_INT IN ARRAY symmetry_zone_width,    \ # array [N_FACES]
         CCTK_STRING IN group_name)
PROVIDES FUNCTION SymmetryRegisterGN \
     WITH SymBase_SymmetryRegisterGN \
     LANGUAGE C



# Get the symmetry table handle for a grid or grid array:

CCTK_INT FUNCTION \
    SymmetryTableHandleForGrid (CCTK_POINTER_TO_CONST IN cctkGH)
PROVIDES FUNCTION SymmetryTableHandleForGrid \
     WITH SymBase_SymmetryTableHandleForGrid \
     LANGUAGE C

CCTK_INT FUNCTION                          \
    SymmetryTableHandleForGI               \
        (CCTK_POINTER_TO_CONST IN cctkGH,  \
         CCTK_INT IN group_index)
PROVIDES FUNCTION SymmetryTableHandleForGI \
     WITH SymBase_SymmetryTableHandleForGI \
     LANGUAGE C

CCTK_INT FUNCTION                          \
    SymmetryTableHandleForGN               \
        (CCTK_POINTER_TO_CONST IN cctkGH,  \
         CCTK_STRING IN group_name)
PROVIDES FUNCTION SymmetryTableHandleForGN \
     WITH SymBase_SymmetryTableHandleForGN \
     LANGUAGE C