next up previous contents
Next: Registering Symmetries for Faces Up: SymBase Previous: Introduction   Contents


Registering Symmetry Conditions

Each thorn that implements a symmetry boundary condition should register itself with thorn SymBase. This has no consequences per se, but it reserves a symmetry handle for later reference. The API for registering and querying symmetry names and handles is

CCTK_INT FUNCTION
    SymmetryRegister (CCTK_STRING IN sym_name)

CCTK_INT FUNCTION
    SymmetryHandleOfName (CCTK_STRING IN sym_name)

CCTK_POINTER_TO_CONST FUNCTION
    SymmetryNameOfHandle (CCTK_INT IN sym_handle)

The routine SymmetryRegister should be called in a routine that has been scheduled in the schedule group SymmetryRegister.

Note: We have the API in the specification, we have it in the interface file, in the source code, and in a header file, and I duplicated it into grdoc headers. I refuse to write and describe and cross-check the API a sixth time in latex. At some point, we have to start using tools for that. Please read the grdoc headers or the grdoc-produced HTML files for a detailed description.