/* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":70,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Write1D.c"},"src_code":{"kind":"string","value":"/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nOutput1D.c\nOutput2D.c\nmake.code.defn\nOutput3D.c\nWrite3D.c\nStartup.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":71,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Output1D.c"},"src_code":{"kind":"string","value":"/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput2D.c\nmake.code.defn\nOutput3D.c\nWrite3D.c\nStartup.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":72,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Output2D.c"},"src_code":{"kind":"string","value":"/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nmake.code.defn\nOutput3D.c\nWrite3D.c\nStartup.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":73,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"make.code.defn"},"src_code":{"kind":"string","value":"# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nOutput2D.c\nOutput3D.c\nWrite3D.c\nStartup.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":74,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Output3D.c"},"src_code":{"kind":"string","value":"/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nOutput2D.c\nmake.code.defn\nWrite3D.c\nStartup.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":75,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Write3D.c"},"src_code":{"kind":"string","value":"/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nOutput2D.c\nmake.code.defn\nOutput3D.c\nStartup.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":76,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Startup.c"},"src_code":{"kind":"string","value":"/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nOutput2D.c\nmake.code.defn\nOutput3D.c\nWrite3D.c\nWrite2D.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":77,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"Write2D.c"},"src_code":{"kind":"string","value":"/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nOutput2D.c\nmake.code.defn\nOutput3D.c\nWrite3D.c\nStartup.c\nChooseOutput.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nChooseOutput.c:\n```\n/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n\n```\n\n"}}},{"rowIdx":78,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOASCII"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOASCII\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOASCII\n# $Header$\n\nimplements: IOASCII\n### FIXME: need private inheritance in order to be implementation-compatible\n### with CarpetIOASCII\n#inherits: IO\n\nCCTK_INT FUNCTION \\\n Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN mapping_handle, \\\n CCTK_INT IN num_arrays, \\\n CCTK_INT ARRAY IN procs, \\\n CCTK_INT ARRAY IN vindices, \\\n CCTK_INT ARRAY IN timelevels, \\\n CCTK_INT ARRAY IN hdatatypes, \\\n CCTK_POINTER ARRAY IN hdata, \\\n CCTK_INT ARRAY OUT retvals)\n\nCCTK_INT FUNCTION \\\n Hyperslab_GlobalMappingByIndex (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN vindex, \\\n CCTK_INT IN hdim, \\\n CCTK_INT ARRAY IN direction, \\\n CCTK_INT ARRAY IN origin, \\\n CCTK_INT ARRAY IN extent, \\\n CCTK_INT ARRAY IN downsample, \\\n CCTK_INT IN table_handle, \\\n CCTK_INT CCTK_FPOINTER IN \\\n conversion_fn (CCTK_INT IN nelems, \\\n CCTK_INT IN src_stride, \\\n CCTK_INT IN dst_stride, \\\n CCTK_INT IN src_type, \\\n CCTK_INT IN dst_type, \\\n CCTK_POINTER_TO_CONST IN from, \\\n CCTK_POINTER IN to), \\\n CCTK_INT ARRAY OUT hsize)\n\nCCTK_INT FUNCTION Hyperslab_FreeMapping (CCTK_INT IN mapping_handle)\n\n\nREQUIRES FUNCTION Hyperslab_GetList\nREQUIRES FUNCTION Hyperslab_GlobalMappingByIndex\nREQUIRES FUNCTION Hyperslab_FreeMapping\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n\nCCTK_INT FUNCTION Coord_GroupSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_STRING IN groupname)\n\nUSES FUNCTION Coord_GroupSystem\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOASCII\n# $Header$\n\n\n#############################################################################\n### declare IOASCII parameters\n#############################################################################\nprivate:\n\n##########################\n# Directories to output to\n##########################\nSTRING out1D_dir \"Output directory for 1D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out2D_dir \"Output directory for 2D IOASCII files, overrides out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\nSTRING out3D_dir \"Output directory for 3D IOASCII files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n\n##########################\n# What variables to output\n##########################\nSTRING out1D_vars \"Variables to output in 1D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out2D_vars \"Variables to output in 2D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING out3D_vars \"Variables to output in 3D IOASCII file format\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n########################\n# How often to do output\n########################\nINT out1D_every \"How often to do 1D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 1D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out2D_every \"How often to do 2D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 2D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nINT out3D_every \"How often to do 3D IOASCII output, overrides IO::out_every\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable 3D IOASCII output\"\n -1: :: \"Default to IO::out_every\"\n} -1\n\n\n#################\n# output style\n#################\nKEYWORD out1D_style \"Which style for 1D lines IOASCII output\"\n{\n \"xgraph\" :: \"f over x plots suitable for xgraph\"\n \"gnuplot f(x)\" :: \"f over x plots suitable for gnuplot\"\n \"gnuplot f(t,x)\" :: \"f over t,x plots suitable for gnuplot\"\n} \"xgraph\"\n\nKEYWORD out2D_style \"Which style for 2D slices IOASCII output\"\n{\n \"gnuplot f(x,y)\" :: \"f over x,y plots suitable for gnuplot\"\n \"gnuplot f(t,x,y)\" :: \"f over t,x,y plots suitable for gnuplot\"\n} \"gnuplot f(x,y)\"\n\nKEYWORD out3D_style \"Which style for 3D volume IOASCII output\"\n{\n \"gnuplot f(x,y,z)\" :: \"f over x,y,z plots suitable for gnuplot\"\n \"gnuplot f(t,x,y,z)\" :: \"f over t,x,y,z plots suitable for gnuplot\"\n} \"gnuplot f(x,y,z)\"\n\nSTRING out_format \"Which format for IOASCII floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n############################\n# Specific to 1D output\n# Choosing what output to do\n############################\nBOOLEAN out1D_x \"Do 1D IOASCII output in the x-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_y \"Do 1D IOASCII output in the y-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_z \"Do 1D IOASCII output in the z-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\nBOOLEAN out1D_d \"Do 1D IOASCII output in the diagonal-direction\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\n################################\n# Choosing what slices to output\n################################\nREAL out1D_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xline_y\"\n} -424242\nREAL out1D_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xline_z\"\n} -424242\nREAL out1D_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yline_x\"\n} -424242\nREAL out1D_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_yline_z\"\n} -424242\nREAL out1D_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_zline_x\"\n} -424242\nREAL out1D_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_zline_y\"\n} -424242\n\nINT out1D_xline_yi \"y-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xline_yi\"\n} -1\nINT out1D_xline_zi \"z-index (from 0) for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xline_zi\"\n} -1\n\nINT out1D_yline_xi \"x-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yline_xi\"\n} -1\nINT out1D_yline_zi \"z-index (from 0) for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_yline_zi\"\n} -1\n\nINT out1D_zline_xi \"x-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_zline_xi\"\n} -1\nINT out1D_zline_yi \"y-index (from 0) for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_zline_yi\"\n} -1\n\n\n################################\n# Specific to 2D output\n# Choosing what planes to output\n################################\nREAL out2D_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n -424242: :: \"Default to IO::out_yzplane_x\"\n} -424242\nREAL out2D_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n -424242: :: \"Default to IO::out_xzplane_y\"\n} -424242\nREAL out2D_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n -424242: :: \"Default to IO::out_xyplane_z\"\n} -424242\n\nINT out2D_yzplane_xi \"x-index (from 0) for 2D planes in yz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Choose the default from IO::out_yzplane_xi\"\n} -1\nINT out2D_xzplane_yi \"y-index (from 0) for 2D planes in xz\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Choose the default from IO::out_xzplane_yi\"\n} -1\nINT out2D_xyplane_zi \"z-index (from 0) for 2D planes in xy\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Choose the default from IO::out_xyplane_zi\"\n} -1\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir\nUSES INT out_every\nUSES REAL out_xline_y\nUSES REAL out_xline_z\nUSES REAL out_yline_x\nUSES REAL out_yline_z\nUSES REAL out_zline_x\nUSES REAL out_zline_y\nUSES INT out_xline_yi\nUSES INT out_xline_zi\nUSES INT out_yline_xi\nUSES INT out_yline_zi\nUSES INT out_zline_xi\nUSES INT out_zline_yi\nUSES REAL out_yzplane_x\nUSES REAL out_xzplane_y\nUSES REAL out_xyplane_z\nUSES INT out_yzplane_xi\nUSES INT out_xzplane_yi\nUSES INT out_xyplane_zi\nUSES INT out_downsample_x\nUSES INT out_downsample_y\nUSES INT out_downsample_z\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOASCII\n# $Header$\n\n########################################################################\n### register IOASCII routines\n########################################################################\nschedule IOASCII_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nschedule IOASCII_Choose1D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 1D output lines\"\n\nschedule IOASCII_Choose2D at BASEGRID after SpatialCoordinates\n{\n LANG:C\n} \"Choose 2D output planes\"\n"},"src_filename":{"kind":"string","value":"ChooseOutput.c"},"src_code":{"kind":"string","value":"/*@@\n @file ChooseOutput.c\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Choose what 1D slices and 2D planes to output by IOASCII.\n @enddesc\n\n @version $Id$\n @@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* macro to choose origin according actual parameter settings:\n 1. Indices from IOASCII\n 2. Indices from IOUtil\n 3. Coords from IOASCII\n 4. Coords from IOUtil\n */\n#define GET_SLICE(IOASCII_param, IOUtil_param, index, coord) \\\n { \\\n index = IOASCII_param##i >= 0 ? IOASCII_param##i : IOUtil_param##i; \\\n coord = IOASCII_param != -424242 ? IOASCII_param : IOUtil_param; \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS);\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS);\n\n/*@@\n @routine IOASCII_Choose1D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 1D slices through the output data.\n @enddesc\n\n @calls IOUtil_1DLines\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n@@*/\nvoid IOASCII_Choose1D(CCTK_ARGUMENTS) {\n int i, j, maxdim;\n asciiioGH *myGH;\n int *origin_index[3];\n CCTK_REAL *origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n /* allocate arrays for origins */\n origin_phys[0] = calloc(3 * 3, sizeof(CCTK_REAL));\n origin_phys[1] = origin_phys[0] + 3;\n origin_phys[2] = origin_phys[1] + 3;\n origin_index[0] = calloc(3 * 3, sizeof(int));\n origin_index[1] = origin_index[0] + 3;\n origin_index[2] = origin_index[1] + 3;\n\n /* get slice points */\n GET_SLICE(out1D_xline_y, out_xline_y, origin_index[0][1], origin_phys[0][1]);\n GET_SLICE(out1D_xline_z, out_xline_z, origin_index[0][2], origin_phys[0][2]);\n GET_SLICE(out1D_yline_x, out_yline_x, origin_index[1][0], origin_phys[1][0]);\n GET_SLICE(out1D_yline_z, out_yline_z, origin_index[1][2], origin_phys[1][2]);\n GET_SLICE(out1D_zline_x, out_zline_x, origin_index[2][0], origin_phys[2][0]);\n GET_SLICE(out1D_zline_y, out_zline_y, origin_index[2][1], origin_phys[2][1]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->spxyz = malloc(maxdim * sizeof(int **));\n\n for (i = 0; i < maxdim; i++) {\n myGH->spxyz[i] = malloc((i + 1) * sizeof(int *));\n\n for (j = 0; j <= i; j++) {\n myGH->spxyz[i][j] = calloc(i + 1, sizeof(int));\n }\n\n if (i < 3) {\n IOUtil_1DLines(cctkGH, i + 1, origin_index, origin_phys, myGH->spxyz[i]);\n }\n }\n\n /* free allocated resources */\n free(origin_phys[0]);\n free(origin_index[0]);\n}\n\n/*@@\n @routine IOASCII_Choose2D\n @author Gabrielle Allen\n @date July 6 2000\n @desc\n Use parameters to choose the 2D slices through the output data.\n @enddesc\n\n @calls IOUtil_2DPlanes\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @@*/\nvoid IOASCII_Choose2D(CCTK_ARGUMENTS) {\n int i, maxdim;\n asciiioGH *myGH;\n int origin_index[3];\n CCTK_REAL origin_phys[3];\n DECLARE_CCTK_PARAMETERS\n\n GET_SLICE(out2D_xyplane_z, out_xyplane_z, origin_index[0], origin_phys[0]);\n GET_SLICE(out2D_xzplane_y, out_xzplane_y, origin_index[1], origin_phys[1]);\n GET_SLICE(out2D_yzplane_x, out_yzplane_x, origin_index[2], origin_phys[2]);\n\n maxdim = CCTK_MaxDim();\n myGH = CCTK_GHExtension(cctkGH, \"IOASCII\");\n myGH->sp2xyz = malloc(maxdim * sizeof(int *));\n\n for (i = 0; i < maxdim; i++) {\n myGH->sp2xyz[i] = calloc(i + 1, sizeof(int));\n\n if (i == 2) {\n IOUtil_2DPlanes(cctkGH, i + 1, origin_index, origin_phys,\n myGH->sp2xyz[i]);\n }\n }\n}\n"},"context_filenames":{"kind":"string","value":"ioASCIIGH.h\nWrite1D.c\nOutput1D.c\nOutput2D.c\nmake.code.defn\nOutput3D.c\nWrite3D.c\nStartup.c\nWrite2D.c\n"},"context":{"kind":"string","value":"ioASCIIGH.h:\n```\n/*@@\n @header ioASCIIGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOASCII.\n @version $Header$\n@@*/\n\n#ifndef _IOASCII_IOASCIIGH_H_\n#define _IOASCII_IOASCIIGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\ntypedef struct IOASCIIGH {\n /* default number of times to output */\n int out1D_every_default, out2D_every_default, out3D_every_default;\n\n /* number of times to output every variable */\n CCTK_INT *out1D_every, *out2D_every, *out3D_every;\n\n /* lists of variables to output */\n char *out1D_vars, *out2D_vars, *out3D_vars;\n\n /* directories in which to output */\n char *out1D_dir, *out2D_dir, *out3D_dir;\n\n /* the last iteration output for var [i] */\n int *out1D_last, *out2D_last, *out3D_last;\n\n /* database for names of output files that were already created */\n pNamedData *filenameList1D, *fileList_2D, *fileList_3D;\n\n /* for 1D lines, we define the index where to start the line:\n spxyz[maxdim][XYZdirection][xyzstart_index] */\n int ***spxyz;\n\n /* for 2D planes, we define the index where to locate the plane\n sp2xyz[maxdim][perpendicular direction] */\n int **sp2xyz;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} asciiioGH;\n\n/* prototypes of functions to be registered as I/O methods */\nint IOASCII_Output1DGH(const cGH *GH);\nint IOASCII_TriggerOutput1D(const cGH *GH, int);\nint IOASCII_TimeFor1D(const cGH *GH, int);\nint IOASCII_Output1DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output2DGH(const cGH *GH);\nint IOASCII_TriggerOutput2D(const cGH *GH, int);\nint IOASCII_TimeFor2D(const cGH *GH, int);\nint IOASCII_Output2DVarAs(const cGH *GH, const char *var, const char *alias);\nint IOASCII_Output3DGH(const cGH *GH);\nint IOASCII_TriggerOutput3D(const cGH *GH, int);\nint IOASCII_TimeFor3D(const cGH *GH, int);\nint IOASCII_Output3DVarAs(const cGH *GH, const char *var, const char *alias);\n\n/* other function prototypes */\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias);\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias);\n\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH);\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif /* _IOASCII_IOASCIIGH_H_ */\n\n```\n\nWrite1D.c:\n```\n/*@@\n @file Write1D.c\n @date March 1997\n @author Paul Walker\n @desc\n Output one-dimensional lines in ASCII xgraph/gnuplot format.\n @enddesc\n\n @history\n @hauthor Thomas Radke\n @hdate 30 May 2000\n @hdesc\n Get rid of all the PUGH stuff by using thorn Hyperslab.\n @endhdesc\n @hendhistory\n @version $Id$\n@@*/\n\n#include <math.h> /* sqrt(3) */\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write1D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 1D line (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hstride, hsize, format[2] */\n#define WRITE_DATA(hstart, cctk_type, c_type, is_complex, fmt, file) \\\n { \\\n int _h; \\\n int _offset = is_complex ? 2 : 1; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord = hdata[1]; \\\n \\\n _hdata += hstart; \\\n for (_h = 0; _h < hsize; _h++) { \\\n if (_coord) { \\\n fprintf(file, fmt, (double)_coord[_h], (c_type)_hdata[_h * _offset]); \\\n } else { \\\n fprintf(file, fmt, _h, (c_type)_hdata[_h * _offset]); \\\n } \\\n \\\n if (is_complex && hstride == 1) { \\\n fprintf(file, format[2], (c_type)_hdata[_h * _offset + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files, FILE *file[]);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]);\n\n/*@@\n @routine IOASCII_Write1D\n @date March 1999\n @author Gabrielle Allen\n @desc\n This routine does 1D line output along the orthogonals\n and the diagonal (in case of a cubed grid).\n <p>\n It writes to ASCII files suitable for gnuplot and xgraph.\n A header telling the physical time prefixes the output data.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc global index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name (used for creating the output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOASCII_Write1D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int do_dir[4];\n CCTK_INT coord_index[4];\n int i, dir, myproc, gindex, have_coords, mapping;\n int hstride, num_files, num_requested_hslabs, num_returned_hslabs;\n int *extent_int;\n cGroup gdata;\n char *fullname, *groupname;\n char header[40], buffer[30];\n CCTK_INT coord_system_handle, coord_handles[3];\n char format[3][64];\n FILE *file[8];\n CCTK_REAL offset;\n CCTK_REAL coord_lower[3];\n CCTK_INT downsample[4];\n CCTK_INT *origin, *direction;\n CCTK_INT hsize, extent;\n CCTK_INT vindices[2];\n void *hdata[2];\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable's group index and its full name */\n gindex = CCTK_GroupIndexFromVarI(vindex);\n fullname = CCTK_FullName(vindex);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D output for '%s' (no storage)\",\n fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the variable's group information */\n CCTK_GroupData(gindex, &gdata);\n\n /* see what slices should be output */\n do_dir[0] = out1D_x && gdata.dim >= 1;\n do_dir[1] = out1D_y && gdata.dim >= 2;\n do_dir[2] = out1D_z && gdata.dim >= 3;\n /* diagonal slice is done only if variable is 3D */\n do_dir[3] = out1D_d && gdata.dim == 3;\n if (out1D_d && !do_dir[3] && myGH->out1D_last[vindex] < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: No IOASCII_1D diagonal output for '%s' \"\n \"(only implemented for non-staggered 3D variables)\",\n fullname);\n }\n\n /* return if nothing to do */\n if (!(do_dir[0] || do_dir[1] || do_dir[2] || do_dir[3])) {\n free(fullname);\n return (0);\n }\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n\n /* set header format string */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n sprintf(buffer, \"\\n\\n\\\"Time = %%%s\\n\", out_format);\n } else {\n sprintf(buffer, \"\\n#Time = %%%s\\n\", out_format);\n }\n sprintf(header, buffer, (double)GH->cctk_time);\n\n /* check whether to include physical time as separate column in the output */\n i = 0;\n if (CCTK_Equals(out1D_style, \"gnuplot f(t,x)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%d\", out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\", out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* get the stride into the data and the (maximum) number of files to write */\n hstride = gdata.vartype == CCTK_VARIABLE_COMPLEX &&\n CCTK_Equals(out1D_style, \"xgraph\")\n ? 2\n : 1;\n num_files = hstride * 4;\n\n /* processor 0 opens the files with the appropriate name */\n myproc = CCTK_MyProc(GH);\n memset(file, 0, sizeof(file));\n if (myproc == 0) {\n OpenFile(GH, fullname, alias, &gdata, do_dir,\n have_coords ? coord_lower : NULL, num_files, file);\n }\n\n origin = calloc(2 * gdata.dim, sizeof(CCTK_INT));\n direction = origin + gdata.dim;\n extent_int = malloc((gdata.dim + 1) * sizeof(int));\n\n /* set downsampling vector from I/O parameters */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n downsample[3] = 1;\n\n /* get the variable's extents, compute the extent for 3D-diagonals as the\n minimum of grid points in each direction */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n if (gdata.dim == 3) {\n extent_int[3] =\n extent_int[0] < extent_int[1] ? extent_int[0] : extent_int[1];\n if (extent_int[2] < extent_int[3]) {\n extent_int[3] = extent_int[2];\n }\n }\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize = 1; dir < gdata.dim; dir++) {\n hsize *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < 4; dir++) {\n if (hsize <= 0) {\n continue;\n }\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* get the number of hyperslabs to extract\n (ie. whether to get a coordinate hyperslab too or not) */\n num_requested_hslabs = have_coords && dir < 3 ? 2 : 1;\n\n /* set the direction vector */\n for (i = 0; i < gdata.dim; i++) {\n direction[i] = (dir == i || dir == 3) ? 1 : 0;\n }\n\n /* set the extent */\n extent = extent_int[dir];\n\n /* set the origin of the line */\n if (gdata.grouptype == CCTK_GF && dir < 3) {\n for (i = 0; i < gdata.dim; i++) {\n origin[i] = myGH->spxyz[gdata.dim - 1][dir][i];\n }\n extent -= origin[dir];\n } else /* origin for CCTK_ARRAYS is always (0, 0, 0) */\n {\n memset(origin, 0, gdata.dim * sizeof(CCTK_INT));\n }\n\n mapping = Hyperslab_GlobalMappingByIndex(GH, vindex, 1, direction, origin,\n &extent, &downsample[dir],\n -1, /* table handle */\n NULL /* conversion fn */, &hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n if (hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n /* allocate hyperslab buffers on I/O processor */\n hdata[0] = hdata[1] = NULL;\n if (myproc == 0) {\n hdata[0] = malloc(hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(hsize * sizeof(CCTK_REAL)) : NULL;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* And dump the data to file */\n if (file[dir] != NULL) {\n if (num_returned_hslabs != num_requested_hslabs) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n } else {\n if (have_coords) {\n if (dir < 3) {\n /* do nothing */\n } else {\n /* calculate the diagonal coordinates */\n offset = GH->cctk_delta_space[0] * sqrt(3);\n for (i = 0; i < hsize; i++) {\n ((CCTK_REAL *)hdata[1])[i] =\n coord_lower[0] * sqrt(3) + i * offset;\n }\n }\n }\n\n WriteData(gdata.vartype, header, format, hsize, hstride, hdata,\n file + dir);\n }\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of loop through all directions */\n\n /* close the output file(s) */\n for (dir = 0; dir < 8; dir++) {\n if (file[dir]) {\n fclose(file[dir]);\n }\n }\n\n /* free allocated resources */\n free(origin);\n free(fullname);\n free(extent_int);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n @@*/\nstatic void OpenFile(const cGH *GH, const char *fullname, const char *alias,\n const cGroup *gdata, const int *do_dir,\n const CCTK_REAL *coord_lower, int num_files,\n FILE *file[]) {\n int i, dir, upper, lower, first_time_through;\n asciiioGH *myGH;\n char comment_char;\n char *filename, *type_extension;\n const char *file_extension;\n char slicename[20], buffer[128];\n char ylabel1_fmt_string[13], ylabel2_fmt_string[13];\n ioAdvertisedFileDesc advertised_file;\n const char *extensions[] = {\"xl\", \"yl\", \"zl\", \"dl\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* set comment character and file extension */\n if (CCTK_Equals(out1D_style, \"xgraph\")) {\n comment_char = '\"';\n file_extension = \".xg\";\n } else {\n comment_char = '#';\n file_extension = \".asc\";\n }\n\n sprintf(ylabel1_fmt_string, \" (%%c = %%%s\", out_format);\n sprintf(ylabel2_fmt_string, \", %%c = %%%s\", out_format);\n\n /* 20 extra characters should be enough for '/',\n the type extension, the file extension, and the trailing '\\0' */\n filename =\n malloc(strlen(myGH->out1D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n for (i = 0; i < num_files; i++) {\n dir = i % 4;\n\n /* skip empty slices */\n if (!do_dir[dir]) {\n continue;\n }\n\n /* add suffix for complex type variables in xgraph output */\n if (gdata->vartype == CCTK_VARIABLE_COMPLEX && num_files == 8) {\n if (new_filename_scheme) {\n type_extension = i < 4 ? \"re_\" : \"im_\";\n } else {\n type_extension = i < 4 ? \"_re\" : \"_im\";\n }\n } else {\n type_extension = \"\";\n }\n\n /* get the indices into spxyz[] */\n lower = (dir + 1) % 3;\n upper = (dir + 2) % 3;\n if (upper < lower) {\n upper = lower;\n lower = 0;\n }\n\n /* FIXME: this can go after the old filename scheme has gone */\n if (new_filename_scheme) {\n if ((i + 1) % 4) {\n if (gdata->dim == 1) {\n sprintf(slicename, \"%s1D\", type_extension);\n } else if (gdata->dim == 2) {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s%c_[%d][%d]\", type_extension, 'x' + dir,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n } else {\n sprintf(slicename, \"%s%dD_diagonal\", type_extension, gdata->dim);\n }\n\n sprintf(filename, \"%s%s_%s%s\", myGH->out1D_dir, alias, slicename,\n file_extension);\n } else {\n sprintf(filename, \"%s%s%s.%s\", myGH->out1D_dir, alias, type_extension,\n extensions[dir]);\n }\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameList1D, filename) == NULL;\n file[i] = fopen(\n filename, IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file[i]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write1D: Cannot open 1D output file '%s'\", filename);\n } else if (first_time_through) {\n /* advertise new files for downloading and add file info */\n /* FIXME: this can go after the old filename scheme has gone */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"One-dimensional line plots\";\n advertised_file.mimetype =\n comment_char == '#' ? \"application/gnuplot\" : \"application/x-graph\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* mark a restart point with an empty line in the output file,\n so that gnuplot/xgraph don't try to connect the last output\n before the abort and the first output after the restart */\n if (!IO_TruncateOutputFiles(GH)) {\n fputc('\\n', file[i]);\n }\n\n /* add some file information to the output file */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file[i], \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file[i], \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file[i], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n if (dir < 3) {\n fprintf(file[i], \"%cx-label %c\\n\", comment_char, 'x' + dir);\n } else {\n fprintf(file[i], \"%cx-label diagonal\\n\", comment_char);\n }\n fprintf(file[i], \"%cy-label %s\", comment_char, fullname);\n if (dir < 3 && gdata->dim > 1) {\n /* output the physical coordinates of the 1D line */\n if (coord_lower) {\n fprintf(file[i], ylabel1_fmt_string, 'x' + lower,\n coord_lower[lower] +\n GH->cctk_delta_space[lower] *\n myGH->spxyz[gdata->dim - 1][dir][lower]);\n if (gdata->dim > 2) {\n fprintf(file[i], ylabel2_fmt_string, 'x' + upper,\n coord_lower[upper] +\n GH->cctk_delta_space[upper] *\n myGH->spxyz[gdata->dim - 1][dir][upper]);\n }\n fputs(\"),\", file[i]);\n }\n /* output the index coordinates of the 1D line */\n fprintf(file[i], \" (%ci = %d\", 'x' + lower,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][lower]\n : 0);\n if (gdata->dim > 2) {\n fprintf(file[i], \", %ci = %d\", 'x' + upper,\n gdata->grouptype == CCTK_GF\n ? myGH->spxyz[gdata->dim - 1][dir][upper]\n : 0);\n }\n fputs(\")\", file[i]);\n }\n fputc('\\n', file[i]);\n }\n\n StoreNamedData(&myGH->filenameList1D, filename, file[i]);\n }\n }\n\n free(filename);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n int hsize, int hstride, void *const *const hdata,\n FILE *const file[]) {\n /* print out header */\n fputs(header, file[0]);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(0, CCTK_BYTE, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(0, CCTK_INT, int, 0, format[0], file[0]);\n } else if (vtype == CCTK_VARIABLE_REAL) {\n WRITE_DATA(0, CCTK_REAL, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(0, CCTK_REAL, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL, double, 1, format[1], file[4]);\n }\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(0, CCTK_INT1, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(0, CCTK_INT2, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(0, CCTK_INT4, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(0, CCTK_INT8, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(0, CCTK_INT16, int, 0, format[0], file[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4) {\n WRITE_DATA(0, CCTK_REAL4, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(0, CCTK_REAL4, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL4, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8) {\n WRITE_DATA(0, CCTK_REAL8, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(0, CCTK_REAL8, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL8, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16) {\n WRITE_DATA(0, CCTK_REAL16, double, 0, format[1], file[0]);\n } else if (vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(0, CCTK_REAL16, double, 1, format[1], file[0]);\n if (hstride == 2) {\n /* print out header */\n fputs(header, file[0 + 4]);\n WRITE_DATA(1, CCTK_REAL16, double, 1, format[1], file[0 + 4]);\n }\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n}\n\n```\n\nOutput1D.c:\n```\n/*@@\n @file IO_Output1D.c\n @date Tue Jan 9 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with 1D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output1D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output1DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor1D\n IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output1DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor1D(GH, vindex) &&\n IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 1D output this iteration */\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output1DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII output method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D, or<BR>\n -1 if variable cannot be output by IOASCII_1D\n @endreturndesc\n@@*/\nint IOASCII_Output1DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 1D output.\",\n fullname);\n } else if (CheckOutputVar(vindex)) {\n retval = IOASCII_Write1D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IO 1D output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor1D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters1D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out1D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out1D_every[vindex] == 0;\n if (retval) {\n /* check if this variable wasn't already output this iteration */\n if (myGH->out1D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 1D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput1D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output a variable\n using the IOASCII output method method\n @enddesc\n @calls IOASCII_Write1D\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write1D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput1D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n retval = IOASCII_Write1D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 1D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out1D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters1D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 1D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters1D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out1D_every_default;\n myGH->out1D_every_default = out1D_every >= 0 ? out1D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out1D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out1D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 1D output every %d \"\n \"iterations\",\n myGH->out1D_every_default);\n } else {\n CCTK_INFO(\"Periodic 1D output turned off\");\n }\n }\n\n /* re-parse the 'out1D_vars' parameter if it was changed */\n if (strcmp(out1D_vars, myGH->out1D_vars) || myGH->out1D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out1D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out1D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out1D_vars'\");\n }\n\n if (myGH->out1D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out1D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 1D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out1D_vars' parameter */\n free(myGH->out1D_vars);\n myGH->out1D_vars = strdup(out1D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int retval;\n int grouptype;\n char *fullname;\n\n /* check the variable type */\n grouptype = CCTK_GroupTypeFromVarI(vindex);\n retval = grouptype == CCTK_GF || grouptype == CCTK_ARRAY;\n if (!retval) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 1D output for '%s': not a grid function or an \"\n \"array\",\n fullname);\n free(fullname);\n }\n\n return (retval);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex)) {\n myGH->out1D_every[vindex] = myGH->out1D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"1D IOASCII\", \"IOASCII::out1D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out1D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nOutput2D.c:\n```\n/*@@\n @file Output2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Functions to deal with 2D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output2D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output2DGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor2D\n IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output2DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor2D(GH, vindex) &&\n IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 2D output this iteration */\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output2DVarAs\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Unconditional output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D, or<BR>\n -1 if variable cannot be output by IOASCII_2D\n @endreturndesc\n@@*/\nint IOASCII_Output2DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 2D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write2D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable\n using the IOASCII 2D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor2D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters2D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out2D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out2D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out2D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 2D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput2D\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable\n using the IOASCII 2D output method\n @enddesc\n @calls IOASCII_Write2D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write2D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput2D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 2D output */\n retval = IOASCII_Write2D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variable as having 2D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out2D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters2D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 2D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters2D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out2D_every_default;\n myGH->out2D_every_default = out2D_every >= 0 ? out2D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out2D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out2D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 2D output every %d \"\n \"iterations\",\n myGH->out2D_every_default);\n } else {\n CCTK_INFO(\"Periodic 2D output turned off\");\n }\n }\n\n /* re-parse the 'out2D_vars' parameter if it was changed */\n if (strcmp(out2D_vars, myGH->out2D_vars) || myGH->out2D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out2D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out2D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out2D_vars'\");\n }\n\n if (myGH->out2D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out2D_every[i]) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 2D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out2D_vars' parameter */\n free(myGH->out2D_vars);\n myGH->out2D_vars = strdup(out2D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n errormsg = NULL;\n if (groupinfo.dim < 2 || groupinfo.dim > 3) {\n errormsg = \"dim != [2,3]\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out2D_every[vindex] = myGH->out2D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"2D IOASCII\", \"IOASCII::out2D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out2D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOASCII\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \\\n Output3D.c Write3D.c\n\n```\n\nOutput3D.c:\n```\n/*@@\n @file Output3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Functions to deal with 3D ASCII output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int CheckOutputVar(int vindex);\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOASCII_Output3DGH\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOASCII_TimeFor3D\n IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOASCII_Output3DGH(const cGH *GH) {\n int vindex, retval;\n const asciiioGH *myGH;\n\n retval = 0;\n myGH = (const asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOASCII_TimeFor3D(GH, vindex) &&\n IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having 3D output this iteration */\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_Output3DVarAs\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Unconditional output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n (used to generate output filename)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D, or<BR>\n -1 if variable cannot be output by IOASCII_3D\n @endreturndesc\n@@*/\nint IOASCII_Output3DVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, retval;\n\n retval = -1;\n vindex = CCTK_VarIndex(fullname);\n if (vindex < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"There is no such variable %s. Ignoring IOASCII 3D output.\",\n fullname);\n } else if (CheckOutputVar(vindex) == 0) {\n retval = IOASCII_Write3D(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TimeFor3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Decides if it is time to output a variable\n using the IOASCII 3D output method\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOASCII_TimeFor3D(const cGH *GH, int vindex) {\n int retval;\n char *fullname;\n asciiioGH *myGH;\n\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n IOASCII_CheckSteerableParameters3D(myGH);\n\n /* check if this variable should be output */\n retval = myGH->out3D_every[vindex] > 0 &&\n GH->cctk_iteration % myGH->out3D_every[vindex] == 0;\n if (retval) {\n /* check if variable wasn't already output this iteration */\n if (myGH->out3D_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done IOASCII 3D output for '%s' in current \"\n \"iteration (probably via triggers)\",\n fullname);\n free(fullname);\n retval = 0;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_TriggerOutput3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Triggers the output of a variable\n using the IOASCII 3D output method\n @enddesc\n @calls IOASCII_Write3D\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOASCII_Write3D\n @endreturndesc\n@@*/\nint IOASCII_TriggerOutput3D(const cGH *GH, int vindex) {\n int retval;\n asciiioGH *myGH;\n\n /* do the 3D output */\n retval = IOASCII_Write3D(GH, vindex, CCTK_VarName(vindex));\n if (retval == 0) {\n /* register variables as having 3D output this iteration */\n myGH = (asciiioGH *)CCTK_GHExtension(GH, \"IOASCII\");\n myGH->out3D_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOASCII_CheckSteerableParameters3D\n @date Tue 8 June 2004\n @author Thomas Radke\n @desc\n Check if steerable IOASCII 3D parameters have changed\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOASCII GH\n @vtype asciiioGH *\n @vio inout\n @endvar\n@@*/\nvoid IOASCII_CheckSteerableParameters3D(asciiioGH *myGH) {\n int i, num_vars;\n char *fullname, *msg;\n DECLARE_CCTK_PARAMETERS\n\n /* how often to output */\n i = myGH->out3D_every_default;\n myGH->out3D_every_default = out3D_every >= 0 ? out3D_every : out_every;\n\n /* report if frequency changed */\n if (myGH->out3D_every_default != i && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->out3D_every_default > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic 3D output every %d \"\n \"iterations\",\n myGH->out3D_every_default);\n } else {\n CCTK_INFO(\"Periodic 3D output turned off\");\n }\n }\n\n /* re-parse the 'out3D_vars' parameter if it was changed */\n if (strcmp(out3D_vars, myGH->out3D_vars) || myGH->out3D_every_default != i) {\n num_vars = CCTK_NumVars();\n memset(myGH->out3D_every, 0, num_vars * sizeof(CCTK_INT));\n if (CCTK_TraverseString(out3D_vars, SetOutputFlag, myGH,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOASCII::out3D_vars'\");\n }\n\n if (myGH->out3D_every_default == i || !CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (i = 0; i < num_vars; i++) {\n if (myGH->out3D_every[i] > 0) {\n fullname = CCTK_FullName(i);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic 3D output requested for \"\n \"'%s'\",\n fullname);\n } else {\n char *tmp = msg;\n Util_asprintf(&msg, \"%s, '%s'\", msg, fullname);\n free(tmp);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n\n /* save the last setting of 'out3D_vars' parameter */\n free(myGH->out3D_vars);\n myGH->out3D_vars = strdup(out3D_vars);\n }\n}\n\n/**************************** local functions ******************************/\n/* check if this variable can be output (static conditions) */\nstatic int CheckOutputVar(int vindex) {\n int groupindex;\n cGroup groupinfo;\n char *fullname;\n const char *errormsg;\n\n /* get the variable group information */\n groupindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(groupindex, &groupinfo);\n\n /* check if variable is grid array type with 3 dimensions */\n errormsg = NULL;\n if (groupinfo.dim != 3) {\n errormsg = \"dim != 3\";\n } else if (groupinfo.grouptype != CCTK_GF &&\n groupinfo.grouptype != CCTK_ARRAY) {\n errormsg = \"not a grid function or array\";\n }\n\n if (errormsg) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s': %s\", fullname, errormsg);\n free(fullname);\n }\n\n return (errormsg != NULL);\n}\n\n/* callback for CCTK_TraverseString() to set the output flag\n for the given variable */\nstatic void SetOutputFlag(int vindex, const char *optstring, void *arg) {\n const asciiioGH *myGH = (const asciiioGH *)arg;\n\n if (CheckOutputVar(vindex) == 0) {\n myGH->out3D_every[vindex] = myGH->out3D_every_default;\n\n if (optstring) {\n IOUtil_ParseOutputFrequency(\"3D IOASCII\", \"IOASCII::out3D_vars\",\n myGH->stop_on_parse_errors, vindex, optstring,\n &myGH->out3D_every[vindex], NULL);\n }\n }\n}\n\n```\n\nWrite3D.c:\n```\n/*@@\n @file Write3D.c\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Three-dimensional output of variables in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write3D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 3D array (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j, _k; \\\n const cctk_type *_hdata = (const cctk_type *)hdata[0]; \\\n const CCTK_REAL *_coord[3]; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n _coord[2] = (const CCTK_REAL *)hdata[3]; \\\n for (_k = 0; _k < hsize[2]; _k++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)*_coord[0]++, (double)*_coord[1]++, \\\n (double)*_coord[2]++, (c_type)*_hdata++); \\\n } else { \\\n fprintf(file, fmt, _i, _j, _k, (c_type)*_hdata++); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], (c_type)*_hdata++); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write3D\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the 3D volume of a variable into a gnuplot ASCII file.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write3D(const cGH *GH, int vindex, const char *alias) {\n int i, total_hsize;\n int myproc, gindex, have_coords;\n int num_requested_hslabs, num_returned_hslabs;\n char header[40], buffer[30];\n char format[3][64];\n FILE *file;\n cGroup gdata;\n CCTK_INT coord_system_handle, coord_handles[3];\n char *fullname, *groupname;\n void *hdata[4];\n int extent_int[3];\n int mapping;\n CCTK_INT vindices[4], extent[3], downsample[3], hsize[3];\n const CCTK_INT origin[] = {0, 0, 0},\n direction[] = {1, 0, 0, 0, 1, 0, 0, 0, 1};\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 3D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n vindices[0] = vindex;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, 3, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 1; i <= 3; i++) {\n vindices[i] = -1;\n Util_TableGetInt(coord_handles[i - 1], &vindices[i], \"GAINDEX\");\n have_coords &= vindices[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 4 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, (double)GH->cctk_time);\n i = 0;\n if (CCTK_Equals(out3D_style, \"gnuplot f(t,x,y,z)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n i = (int)strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + i, \"%%%s\\t\\t%%%s\\t\\t%%d\\t\\t%%d\", out_format,\n out_format);\n sprintf(format[1] + i, \"%%%s\\t\\t%%%s\\t\\t%%%s\\t\\t%%%s\", out_format,\n out_format, out_format, out_format);\n } else {\n sprintf(format[0] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + i, \"%%d\\t\\t%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* What processor are we on? */\n myproc = CCTK_MyProc(GH);\n\n /* Open the file on processor 0 */\n file = myproc == 0 ? OpenFile(GH, fullname, alias) : NULL;\n\n /* get the total number of grid points to check for zero-sized variables */\n /* set the extent vector (copy from 'int' to 'CCTK_INT' */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n for (i = 0, total_hsize = 1; i < 3; i++) {\n total_hsize *= extent_int[i];\n extent[i] = extent_int[i];\n }\n if (total_hsize <= 0) {\n free(fullname);\n return (0);\n }\n\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n downsample[2] = out_downsample_z;\n\n /* get the hyperslab mapping */\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 3, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n free(fullname);\n return (-1);\n }\n total_hsize = hsize[0] * hsize[1] * hsize[2];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: selected hyperslab has zero size for \"\n \"variable '%s'\",\n fullname);\n Hyperslab_FreeMapping(mapping);\n free(fullname);\n return (-1);\n }\n\n hdata[0] = hdata[1] = hdata[2] = hdata[3];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] = have_coords ? malloc(3 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + 1 * total_hsize;\n hdata[3] = (CCTK_REAL *)hdata[1] + 2 * total_hsize;\n }\n\n /* get the hyperslabs */\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices, NULL,\n NULL, hdata, NULL);\n\n /* And dump the data to file */\n if (myproc == 0) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write3D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n } /* end of outputting the data by processor 0 */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens an ASCII file for a given alias name.\n If this is the first time through, it will create the file,\n write some header information, and advertise it to IOUtil.\n @enddesc\n\n @returntype FILE *\n @returndesc\n the file descriptor, or NULL if the file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE *OpenFile(const cGH *GH, const char *fullname, const char *alias) {\n FILE **file;\n char *filename;\n char buffer[128];\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n file = GetNamedData(myGH->fileList_3D, alias);\n if (file) {\n return (*file);\n }\n\n file = malloc(sizeof(FILE *));\n filename = malloc(strlen(myGH->out3D_dir) + strlen(alias) + 9);\n\n /* open/create the file */\n sprintf(filename, \"%s%s_3D.asc\", myGH->out3D_dir, alias);\n\n /* if restart from recovery, try to open an existing file ... */\n *file = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!*file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 3D IOASCII output file '%s'\", filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Full-dimensional variable contents\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(*file, \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(*file, \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(*file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"#z-label %s\\n\", advertised_file.varname);\n }\n if (CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(*file, \"\\n\\n\");\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_3D, alias, file);\n\n free(filename);\n\n return (*file);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslab data into a file.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[3], void *const *const hdata,\n FILE *file) {\n int is_complex;\n\n if (file == NULL) {\n return;\n }\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOASCII.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_IOMethods.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Startup_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n#define CREATE_OUTDIR(dim, dir) \\\n { \\\n const char *_dir = dir; \\\n \\\n /* check whether \"dir\" was set; if not default to \"IO::out_dir\" */ \\\n if (*_dir == 0) { \\\n _dir = out_dir; \\\n } \\\n \\\n /* omit the directory name if it's the current working dir */ \\\n if (strcmp(_dir, \".\") == 0) { \\\n myGH->dir = strdup(\"\"); \\\n } else { \\\n myGH->dir = malloc(strlen(_dir) + 2); \\\n sprintf(myGH->dir, \"%s/\", _dir); \\\n } \\\n \\\n /* create the directory */ \\\n i = IOUtil_CreateDirectory(GH, myGH->dir, 0, 0); \\\n if (i < 0) { \\\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING, \\\n \"IOASCII_SetupGH: Problem creating directory '%s' \" \\\n \"for %dD output\", \\\n myGH->dir, dim); \\\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) { \\\n CCTK_VInfo(CCTK_THORNSTRING, \"%dD output to directory '%s'\", dim, \\\n myGH->dir); \\\n } \\\n }\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOASCII_Startup(void);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOASCII_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOASCII.\n Registers the GH extensions needed for IOASCII\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOASCII_Startup(void) {\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOASCII\"),\n IOASCII_SetupGH);\n return 0;\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine IOASCII_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOASCII's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOASCII_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i, maxdim, numvars;\n asciiioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused variables */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(asciiioGH));\n if (!myGH) {\n CCTK_WARN(0, \"IOASCII_SetupGH: Unable to allocate memory for GH\");\n }\n\n /* register the IOASCII routines as output methods */\n i = CCTK_RegisterIOMethod(\"IOASCII_1D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output1DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output1DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor1D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput1D);\n\n /* only register N-D IOASCII I/O methods\n if at least N-dimensional grid variables are defined by thorns */\n maxdim = CCTK_MaxDim();\n if (maxdim >= 2) {\n i = CCTK_RegisterIOMethod(\"IOASCII_2D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output2DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output2DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor2D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput2D);\n }\n\n if (maxdim >= 3) {\n i = CCTK_RegisterIOMethod(\"IOASCII_3D\");\n CCTK_RegisterIOMethodOutputGH(i, IOASCII_Output3DGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOASCII_Output3DVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOASCII_TimeFor3D);\n CCTK_RegisterIOMethodTriggerOutput(i, IOASCII_TriggerOutput3D);\n }\n\n numvars = CCTK_NumVars();\n myGH->out1D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out2D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out3D_every = malloc(numvars * sizeof(CCTK_INT));\n myGH->out1D_last = malloc(numvars * sizeof(int));\n myGH->out2D_last = malloc(numvars * sizeof(int));\n myGH->out3D_last = malloc(numvars * sizeof(int));\n\n for (i = 0; i < numvars; i++) {\n myGH->out1D_last[i] = -1;\n myGH->out2D_last[i] = -1;\n myGH->out3D_last[i] = -1;\n }\n\n myGH->out1D_vars = strdup(\"\");\n myGH->out2D_vars = strdup(\"\");\n myGH->out3D_vars = strdup(\"\");\n myGH->out1D_every_default = out1D_every - 1;\n myGH->out2D_every_default = out2D_every - 1;\n myGH->out3D_every_default = out3D_every - 1;\n\n myGH->filenameList1D = NULL;\n myGH->fileList_2D = NULL;\n myGH->fileList_3D = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_1D' registered: output of 1D lines of grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters1D(myGH);\n if (maxdim >= 2) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_2D' registered: output of 2D planes of \"\n \"grid functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters2D(myGH);\n }\n if (maxdim >= 3) {\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'IOASCII_3D' registered: output of 3D grid \"\n \"functions/arrays to ASCII files\");\n }\n IOASCII_CheckSteerableParameters3D(myGH);\n }\n myGH->stop_on_parse_errors = 0;\n\n /* make sure all output directories exist */\n CREATE_OUTDIR(1, out1D_dir);\n CREATE_OUTDIR(2, out2D_dir);\n CREATE_OUTDIR(3, out3D_dir);\n\n return (myGH);\n}\n\n```\n\nWrite2D.c:\n```\n/*@@\n @file Write2D.c\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Output two-dimensional slices in ASCII gnuplot format.\n @enddesc\n @version $Id$\n @@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"ioASCIIGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Id$\";\nCCTK_FILEVERSION(CactusBase_IOASCII_Write2D_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* Macro to output a 2D slice (with coordinates if available) as typed data\n For readability, the macro definition implicitely uses the following\n variables (which are defined in the calling routine):\n hdata, hsize, is_complex, format[2], file */\n#define WRITE_DATA(cctk_type, c_type, fmt) \\\n { \\\n int _i, _j; \\\n const cctk_type *_hdata = hdata[0]; \\\n const CCTK_REAL *_coord[2]; \\\n const int _di = is_complex ? 2 : 1; \\\n \\\n _coord[0] = (const CCTK_REAL *)hdata[1]; \\\n _coord[1] = (const CCTK_REAL *)hdata[2]; \\\n for (_i = 0; _i < hsize[0]; _i++) { \\\n for (_j = 0; _j < hsize[1]; _j++) { \\\n if (_coord[0]) { \\\n fprintf(file, fmt, (double)_coord[0][_i + hsize[0] * _j], \\\n (double)_coord[1][_i + hsize[0] * _j], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } else { \\\n fprintf(file, fmt, _i, _j, \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j)]); \\\n } \\\n \\\n if (is_complex) { \\\n fprintf(file, format[2], \\\n (c_type)_hdata[_di * (_i + hsize[0] * _j) + 1]); \\\n } \\\n fputc('\\n', file); \\\n } \\\n fputc('\\n', file); \\\n } \\\n _coord[0] += hsize[0] * _j; \\\n _coord[1] += hsize[0] * _j; \\\n _hdata += _di * hsize[0] * _j; \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir);\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file);\n\n/*@@\n @routine IOASCII_Write2D\n @date Thu May 11 2000\n @author Thomas Radke\n @desc\n Writes the 2D slices of a variable into separate ASCII files.\n @enddesc\n @calls Hyperslab_GlobalMappingByIndex\n Hyperslab_FreeMapping\n Hyperslab_GetList\n OpenFile\n WriteData\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name of variable to output\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned<BR>\n -2 if output file couldn't be opened<BR>\n -3 if hyperslab for coordinates and/or variable couldn't be\n extracted\n @endreturndesc\n@@*/\nint IOASCII_Write2D(const cGH *GH, int vindex, const char *alias) {\n asciiioGH *myGH;\n int i, total_hsize, num_requested_hslabs, num_returned_hslabs;\n int dir, dir_i, dir_j, maxdir, myproc, gindex, have_coords;\n int mapping;\n cGroup gdata;\n CCTK_INT coord_index[3];\n CCTK_INT coord_system_handle, coord_handles[3];\n CCTK_REAL coord_lower[3];\n char format[3][64];\n char header[40], buffer[30];\n char *fullname, *groupname;\n int extent_int[3];\n CCTK_INT vindices[3], origin[3], extent[2], direction[6], downsample[2],\n hsize[2];\n void *hdata[3];\n FILE **fileset;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable name and group information */\n fullname = CCTK_FullName(vindex);\n gindex = CCTK_GroupIndexFromVarI(vindex);\n CCTK_GroupData(gindex, &gdata);\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, gindex)) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No IOASCII 2D output for '%s' (no storage)\", fullname);\n free(fullname);\n return (-1);\n }\n\n /* get the handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* get the number of slices to output */\n /* in general: maxdir = gdata.dim * (gdata.dim - 1) / 2; */\n maxdir = gdata.dim == 2 ? 1 : 3;\n\n dir = gdata.dim < 3 ? gdata.dim : 3;\n\n have_coords = CCTK_IsFunctionAliased(\"Coord_GroupSystem\");\n if (have_coords) {\n /* get the coordinate system associated with this grid variable */\n groupname = CCTK_GroupName(gindex);\n coord_system_handle = Coord_GroupSystem(GH, groupname);\n free(groupname);\n\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, dir, coord_handles,\n \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n /* get the coordinate functions and coordinate physical minimum */\n for (i = 0; i < dir; i++) {\n coord_index[i] = -1;\n coord_lower[i] = 0;\n Util_TableGetInt(coord_handles[i], &coord_index[i], \"GAINDEX\");\n Util_TableGetReal(coord_handles[i], &coord_lower[i], \"COMPMIN\");\n have_coords &= coord_index[i] >= 0;\n }\n }\n num_requested_hslabs = have_coords ? 3 : 1;\n\n /* set header and data format strings */\n sprintf(buffer, \"\\n\\n#Time = %%%s\\n\", out_format);\n sprintf(header, buffer, GH->cctk_time);\n dir = 0;\n if (CCTK_Equals(out2D_style, \"gnuplot f(t,x,y)\")) {\n sprintf(buffer, \"%%%s\\t\\t\", out_format);\n sprintf(format[0], buffer, (double)GH->cctk_time);\n sprintf(format[1], buffer, (double)GH->cctk_time);\n dir = strlen(format[0]);\n }\n if (have_coords) {\n sprintf(format[0] + dir, \"%%%s\\t\\t%%%s\\t\\t%%d\", out_format, out_format);\n sprintf(format[1] + dir, \"%%%s\\t\\t%%%s\\t\\t%%%s\", out_format, out_format,\n out_format);\n } else {\n sprintf(format[0] + dir, \"%%d\\t\\t%%d\\t\\t%%d\");\n sprintf(format[1] + dir, \"%%d\\t\\t%%d\\t\\t%%%s\", out_format);\n }\n sprintf(format[2], \"\\t\\t%%%s\", out_format);\n\n /* processor 0 opens the files on the first trip through */\n fileset = NULL;\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n fileset = OpenFile(GH, fullname, alias, gdata.dim,\n have_coords ? coord_lower : NULL, maxdir);\n }\n\n /* get the extents of the variable */\n if (gdata.grouptype == CCTK_GF || gdata.disttype != CCTK_DISTRIB_CONSTANT)\n CCTK_GroupgshVI(GH, gdata.dim, extent_int, vindex);\n else\n CCTK_GrouplshVI(GH, gdata.dim, extent_int, vindex);\n\n /* get the total number of grid points to check for zero-sized variables */\n for (dir = 0, hsize[0] = 1; dir < gdata.dim; dir++) {\n hsize[0] *= extent_int[dir];\n }\n\n /* now do the actual I/O looping over all directions */\n for (dir = 0; dir < maxdir; dir++) {\n if (hsize[0] <= 0) {\n continue;\n }\n\n /* get the directions to span the hyperslab */\n if (dir == 0) {\n dir_i = 0;\n dir_j = 1; /* xy */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_y;\n } else if (dir == 1) {\n dir_i = 0;\n dir_j = 2; /* xz */\n downsample[0] = out_downsample_x;\n downsample[1] = out_downsample_z;\n } else {\n dir_i = 1;\n dir_j = 2; /* yz */\n downsample[0] = out_downsample_y;\n downsample[1] = out_downsample_z;\n }\n\n /* set the extent vector */\n extent[0] = extent_int[dir_i];\n extent[1] = extent_int[dir_j];\n\n /* set the origin using the slice center from IOUtil */\n memset(origin, 0, sizeof(origin));\n if (have_coords) {\n origin[maxdir - dir - 1] = myGH->sp2xyz[gdata.dim - 1][dir];\n }\n\n /* set the direction vector */\n memset(direction, 0, sizeof(direction));\n direction[dir_i] = direction[gdata.dim + dir_j] = 1;\n\n mapping =\n Hyperslab_GlobalMappingByIndex(GH, vindex, 2, direction, origin, extent,\n downsample, -1, /* table handle */\n NULL /* conversion fn */, hsize);\n if (mapping < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to define hyperslab mapping for \"\n \"variable '%s'\",\n fullname);\n continue;\n }\n total_hsize = hsize[0] * hsize[1];\n if (total_hsize <= 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: selected hyperslab has zero size for \"\n \"variable '%s' direction %d\",\n fullname, dir);\n Hyperslab_FreeMapping(mapping);\n continue;\n }\n\n hdata[0] = hdata[1] = hdata[2];\n if (myproc == 0) {\n /* allocate hyperslab buffers */\n hdata[0] = malloc(total_hsize * CCTK_VarTypeSize(gdata.vartype));\n hdata[1] =\n have_coords ? malloc(2 * total_hsize * sizeof(CCTK_REAL)) : NULL;\n hdata[2] = (CCTK_REAL *)hdata[1] + total_hsize;\n }\n\n /* get the hyperslabs */\n vindices[0] = vindex;\n vindices[1] = coord_index[dir_i];\n vindices[2] = coord_index[dir_j];\n num_returned_hslabs =\n Hyperslab_GetList(GH, mapping, num_requested_hslabs, NULL, vindices,\n NULL, NULL, hdata, NULL);\n\n /* release the mapping structure */\n Hyperslab_FreeMapping(mapping);\n\n /* and dump the data to file */\n if (fileset) {\n if (num_returned_hslabs == num_requested_hslabs) {\n WriteData(gdata.vartype, header, format, hsize, hdata, fileset[dir]);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOASCII_Write2D: Failed to extract hyperslab for \"\n \"variable '%s'\",\n fullname);\n }\n\n /* clean up */\n free(hdata[0]);\n free(hdata[1]);\n\n } /* end of outputting the data by processor 0 */\n\n } /* end of looping through xyz directions */\n\n free(fullname);\n\n return (0);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine OpenFile\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Opens a set of ASCII files for a given alias name.\n If this is the first time through, it will create the files,\n write some header information, and advertise them to IOUtil.\n @enddesc\n\n @returntype FILE **\n @returndesc\n the set of open file descriptors,<BR>\n or NULL if a file couldn't be created\n @endreturndesc\n @@*/\nstatic FILE **OpenFile(const cGH *GH, const char *fullname, const char *alias,\n int dim, const CCTK_REAL *coord_lower, int maxdir) {\n int dir;\n FILE **fileset;\n char *filename;\n asciiioGH *myGH;\n ioAdvertisedFileDesc advertised_file;\n char slicename[30], zlabel_fmt_string[30], buffer[128];\n const char *extensions[] = {\"xy\", \"xz\", \"yz\"};\n DECLARE_CCTK_PARAMETERS\n\n /* get handle for IOASCII extension */\n myGH = CCTK_GHExtension(GH, \"IOASCII\");\n\n /* see if we are the first time through */\n fileset = (FILE **)GetNamedData(myGH->fileList_2D, alias);\n if (fileset) {\n return (fileset);\n }\n\n sprintf(zlabel_fmt_string, \" (%%c = %%%s),\", out_format);\n fileset = malloc(3 * sizeof(FILE *));\n filename =\n malloc(strlen(myGH->out2D_dir) + strlen(alias) + sizeof(slicename) + 20);\n\n /* open/create files for each slice */\n for (dir = 0; dir < maxdir; dir++) {\n if (new_filename_scheme) {\n if (dim == 2) {\n strcpy(slicename, \"2D\");\n } else {\n /* give the slice origin as range [1 .. n] */\n sprintf(slicename, \"%s_[%d]\", extensions[dir],\n myGH->sp2xyz[dim - 1][dir]);\n }\n\n sprintf(filename, \"%s%s_%s.asc\", myGH->out2D_dir, alias, slicename);\n } else {\n if (dim == 2) {\n sprintf(filename, \"%s%s_2D.gnuplot\", myGH->out2D_dir, alias);\n } else {\n sprintf(filename, \"%s%s_2d_%s.gnuplot\", myGH->out2D_dir, alias,\n extensions[dir]);\n }\n }\n\n /* if restart from recovery, try to open an existing file ... */\n fileset[dir] = fopen(filename, IO_TruncateOutputFiles(GH) ? \"w\" : \"a\");\n if (!fileset[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Cannot open 2D output file '%s'\", filename);\n free(fileset);\n free(filename);\n return (NULL);\n }\n\n /* advertise the file for downloading and write file info */\n advertised_file.slice = new_filename_scheme ? slicename : extensions[dir];\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = \"Two-dimensional slice plots\";\n advertised_file.mimetype = \"application/gnuplot\";\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Parameter file %s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"#Created %s \", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(fileset[dir], \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(fileset[dir], \"#x-label %c\\n\", extensions[dir][0]);\n fprintf(fileset[dir], \"#y-label %c\\n\", extensions[dir][1]);\n fprintf(fileset[dir], \"#z-label %s\", advertised_file.varname);\n if (dim != 2) {\n if (coord_lower) {\n fprintf(fileset[dir], zlabel_fmt_string, 'x' + (maxdir - dir - 1),\n coord_lower[maxdir - dir - 1] +\n GH->cctk_delta_space[maxdir - dir - 1] *\n myGH->sp2xyz[dim - 1][dir]);\n }\n fprintf(fileset[dir], \" (%ci = %d)\", 'x' + (maxdir - dir - 1),\n myGH->sp2xyz[dim - 1][dir]);\n }\n }\n }\n\n /* store file desriptors in database */\n StoreNamedData(&myGH->fileList_2D, alias, fileset);\n\n free(filename);\n\n return (fileset);\n}\n\n/*@@\n @routine WriteData\n @date Wed 12 Dec 2001\n @author Thomas Radke\n @desc\n Writes the given hyperslabs into the appropriate output files.\n @enddesc\n @@*/\nstatic void WriteData(int vtype, const char *header, char format[3][64],\n const CCTK_INT hsize[2], void *const *const hdata,\n FILE *file) {\n int is_complex;\n char complex_fmt_string[30];\n DECLARE_CCTK_PARAMETERS\n\n is_complex = !strncmp(CCTK_VarTypeName(vtype), \"CCTK_VARIABLE_COMPLEX\", 21);\n sprintf(complex_fmt_string, \"\\t\\t%%%s\", out_format);\n\n /* print out header */\n fputs(header, file);\n\n if (vtype == CCTK_VARIABLE_BYTE) {\n WRITE_DATA(CCTK_BYTE, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_INT) {\n WRITE_DATA(CCTK_INT, int, format[0]);\n } else if (vtype == CCTK_VARIABLE_REAL || vtype == CCTK_VARIABLE_COMPLEX) {\n WRITE_DATA(CCTK_REAL, double, format[1]);\n }\n#ifdef HAVE_CCTK_INT1\n else if (vtype == CCTK_VARIABLE_INT1) {\n WRITE_DATA(CCTK_INT1, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT2\n else if (vtype == CCTK_VARIABLE_INT2) {\n WRITE_DATA(CCTK_INT2, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT4\n else if (vtype == CCTK_VARIABLE_INT4) {\n WRITE_DATA(CCTK_INT4, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT8\n else if (vtype == CCTK_VARIABLE_INT8) {\n WRITE_DATA(CCTK_INT8, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_INT16\n else if (vtype == CCTK_VARIABLE_INT16) {\n WRITE_DATA(CCTK_INT16, int, format[0]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL4\n else if (vtype == CCTK_VARIABLE_REAL4 || vtype == CCTK_VARIABLE_COMPLEX8) {\n WRITE_DATA(CCTK_REAL4, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL8\n else if (vtype == CCTK_VARIABLE_REAL8 || vtype == CCTK_VARIABLE_COMPLEX16) {\n WRITE_DATA(CCTK_REAL8, double, format[1]);\n }\n#endif\n\n#ifdef HAVE_CCTK_REAL16\n else if (vtype == CCTK_VARIABLE_REAL16 || vtype == CCTK_VARIABLE_COMPLEX32) {\n WRITE_DATA(CCTK_REAL16, double, format[1]);\n }\n#endif\n\n else {\n CCTK_WARN(1, \"Unsupported variable type\");\n }\n\n /* keep the file open but flush it */\n fflush(file);\n}\n\n```\n\n"}}},{"rowIdx":79,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"WriteScalar.c"},"src_code":{"kind":"string","value":"/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n"},"context_filenames":{"kind":"string","value":"iobasicGH.h\nOutputInfo.c\nOutputScalar.c\nmake.code.defn\nWriteInfo.c\nStartup.c\n"},"context":{"kind":"string","value":"iobasicGH.h:\n```\n/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n\n```\n\nOutputInfo.c:\n```\n/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n\n```\n\nOutputScalar.c:\n```\n/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n\n```\n\nWriteInfo.c:\n```\n/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n\n```\n\n"}}},{"rowIdx":80,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"iobasicGH.h"},"src_code":{"kind":"string","value":"/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n"},"context_filenames":{"kind":"string","value":"WriteScalar.c\nOutputInfo.c\nOutputScalar.c\nmake.code.defn\nWriteInfo.c\nStartup.c\n"},"context":{"kind":"string","value":"WriteScalar.c:\n```\n/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n\n```\n\nOutputInfo.c:\n```\n/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n\n```\n\nOutputScalar.c:\n```\n/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n\n```\n\nWriteInfo.c:\n```\n/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n\n```\n\n"}}},{"rowIdx":81,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"OutputInfo.c"},"src_code":{"kind":"string","value":"/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n"},"context_filenames":{"kind":"string","value":"WriteScalar.c\niobasicGH.h\nOutputScalar.c\nmake.code.defn\nWriteInfo.c\nStartup.c\n"},"context":{"kind":"string","value":"WriteScalar.c:\n```\n/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n\n```\n\niobasicGH.h:\n```\n/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n\n```\n\nOutputScalar.c:\n```\n/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n\n```\n\nWriteInfo.c:\n```\n/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n\n```\n\n"}}},{"rowIdx":82,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"OutputScalar.c"},"src_code":{"kind":"string","value":"/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n"},"context_filenames":{"kind":"string","value":"WriteScalar.c\niobasicGH.h\nOutputInfo.c\nmake.code.defn\nWriteInfo.c\nStartup.c\n"},"context":{"kind":"string","value":"WriteScalar.c:\n```\n/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n\n```\n\niobasicGH.h:\n```\n/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n\n```\n\nOutputInfo.c:\n```\n/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n\n```\n\nWriteInfo.c:\n```\n/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n\n```\n\n"}}},{"rowIdx":83,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"make.code.defn"},"src_code":{"kind":"string","value":"# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n"},"context_filenames":{"kind":"string","value":"WriteScalar.c\niobasicGH.h\nOutputInfo.c\nOutputScalar.c\nWriteInfo.c\nStartup.c\n"},"context":{"kind":"string","value":"WriteScalar.c:\n```\n/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n\n```\n\niobasicGH.h:\n```\n/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n\n```\n\nOutputInfo.c:\n```\n/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n\n```\n\nOutputScalar.c:\n```\n/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n\n```\n\nWriteInfo.c:\n```\n/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n\n```\n\n"}}},{"rowIdx":84,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"WriteInfo.c"},"src_code":{"kind":"string","value":"/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n"},"context_filenames":{"kind":"string","value":"WriteScalar.c\niobasicGH.h\nOutputInfo.c\nOutputScalar.c\nmake.code.defn\nStartup.c\n"},"context":{"kind":"string","value":"WriteScalar.c:\n```\n/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n\n```\n\niobasicGH.h:\n```\n/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n\n```\n\nOutputInfo.c:\n```\n/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n\n```\n\nOutputScalar.c:\n```\n/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n\n```\n\n"}}},{"rowIdx":85,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOBasic"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definition for thorn IOBasic\n# $Header$\n\nREQUIRES IOUtil\n\nREQUIRES THORNS: IOUtil\n"},"interface":{"kind":"string","value":"# Interface definition for thorn IOBasic\n# $Header$\n\nimplements: IOBasic\ninherits: IO\n\nreal next_info_output_time type=scalar\nreal next_scalar_output_time type=scalar\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nREQUIRES FUNCTION IO_TruncateOutputFiles\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn IOBasic\n# $Header$\n\n\n#############################################################################\n### declare IOBasic parameters\n#############################################################################\nprivate:\n\n##########################\n# Directory to output to\n##########################\nSTRING out_dir \"Output directory for IOBasic's scalar files, overrides IO::out_dir\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n \"^$\" :: \"An empty string to choose the default from IO::out_dir\"\n} \"\"\n\n##########################\n# What variables to output\n##########################\nSTRING outInfo_vars \"Variables to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\nSTRING outScalar_vars \"Variables to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string to output nothing\"\n} \"\"\n\n\n##########################\n# What reductions to output\n##########################\nSTRING outInfo_reductions \"List of reductions to output as Info to screen\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum\"\nSTRING outScalar_reductions \"List of reductions to output into files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"Space-separated list of reduction operators\"\n} \"minimum maximum norm1 norm2\"\n\n\n########################\n# How often to do output\n########################\nKEYWORD outInfo_criterion \"Criterion to select Info output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outInfo_every \"How often to do Info output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Info output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outInfo_dt \"How often to do Info output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\nKEYWORD outScalar_criterion \"Criterion to select Scalar output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT outScalar_every \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable Scalar output\"\n -1: :: \"Default to IO::out_every\"\n} -1\nREAL outScalar_dt \"How often to do Scalar output\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Default to IO::out_dt\"\n} -2\n\n\n#####################\n# Scalar output style\n#####################\nKEYWORD outScalar_style \"Which style for Scalar output\" STEERABLE = RECOVER\n{\n \"gnuplot\" :: \"1D output readable by gnuplot\"\n \"xgraph\" :: \"1D output readable by xgraph\"\n} \"xgraph\"\n\nSTRING out_format \"Which format for Scalar floating-point number output\" STEERABLE = ALWAYS\n{\n \"^(\\.[1]?[0-9])?[EGefg]$\" :: \"output with given precision in exponential / floating point notation\"\n} \".13f\"\n\n\n#############################################################################\n### import IOUtil parameters\n#############################################################################\nshares: IO\n\nUSES STRING out_dir AS io_out_dir\nUSES KEYWORD out_criterion\nUSES INT out_every\nUSES REAL out_dt\nUSES KEYWORD verbose\nUSES KEYWORD out_fileinfo\nUSES BOOLEAN new_filename_scheme\nUSES BOOLEAN strict_io_parameter_check\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOBasic\n# $Header$\n\n########################################################################\n### register IOBasic routines\n########################################################################\nschedule IOBasic_Startup at STARTUP after IOUtil_Startup\n{\n LANG:C\n} \"Startup routine\"\n\n\n########################################################################\n### register IOBasic routines\n########################################################################\nstorage: next_info_output_time next_scalar_output_time\nschedule IOBasic_Init at INITIAL\n{\n LANG:C\n} \"Initialisation routine\"\n"},"src_filename":{"kind":"string","value":"Startup.c"},"src_code":{"kind":"string","value":"/*@@\n @file Startup.c\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOBasic.\n @enddesc\n @version $Id$\n@@*/\n\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <ctype.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Table.h\"\n#include \"CactusBase/IOUtil/src/ioutil_Utils.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_Startup_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nint IOBasic_Startup(void);\nvoid IOBasic_Init(CCTK_ARGUMENTS);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH);\n\n/*@@\n @routine IOBasic_Startup\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOBasic.\n Registers the GH extensions needed for IOBasic\n along with its setup routine.\n @enddesc\n @calls CCTK_RegisterGHExtensionSetupGH\n@@*/\nint IOBasic_Startup(void) {\n if (CCTK_GHExtensionHandle(\"IO\") < 0) {\n CCTK_WARN(1, \"Thorn IOUtil was not activated. \"\n \"No IOBasic I/O methods will be enabled.\");\n return 0;\n }\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IOBasic\"),\n IOBasic_SetupGH);\n\n return 0;\n}\n\n/*@@\n @routine IOBasic_Init\n @date Tue 30 Dec 2003\n @author Erik Schnetter\n @desc\n Initialise the next_*_output_time variables.\n @enddesc\n@@*/\nvoid IOBasic_Init(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n *next_info_output_time = cctk_time;\n *next_scalar_output_time = cctk_time;\n}\n\n/****************************************************************************/\n/* local routines */\n/****************************************************************************/\n/*@@\n @routine IOBasic_SetupGH\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Allocates and sets up IOBasic's GH extension structure\n @enddesc\n\n @calls CCTK_RegisterIOMethod\n CCTK_RegisterIOMethodOutputGH\n CCTK_RegisterIOMethodOutputVarAs\n CCTK_RegisterIOMethodTimeToOutput\n CCTK_RegisterIOMethodTriggerOutput\n\n @var config\n @vdesc the CCTK configuration as provided by the flesh\n @vtype tFleshConfig *\n @vio unused\n @endvar\n @var conv_level\n @vdesc the convergence level\n @vtype int\n @vio unused\n @endvar\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc\n pointer to the allocated GH extension structure\n @endreturndesc\n@@*/\nstatic void *IOBasic_SetupGH(tFleshConfig *config, int conv_level, cGH *GH) {\n int i;\n iobasicGH *myGH;\n const char *my_out_dir;\n DECLARE_CCTK_PARAMETERS\n\n /* suppress compiler warnings about unused parameters */\n (void)(config + 0);\n (void)(conv_level + 0);\n (void)(GH + 0);\n\n /* allocate the GH extension and its components */\n myGH = malloc(sizeof(iobasicGH));\n if (!myGH) {\n return (NULL);\n }\n\n /* Register the IOBasic routines as output methods */\n i = CCTK_RegisterIOMethod(\"Scalar\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_ScalarOutputGH);\n CCTK_RegisterIOMethodOutputVarAs(i, IOBasic_OutputVarAs);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForScalarOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerScalarOutput);\n\n i = CCTK_RegisterIOMethod(\"Info\");\n CCTK_RegisterIOMethodOutputGH(i, IOBasic_InfoOutputGH);\n CCTK_RegisterIOMethodTimeToOutput(i, IOBasic_TimeForInfoOutput);\n CCTK_RegisterIOMethodTriggerOutput(i, IOBasic_TriggerInfoOutput);\n\n i = CCTK_NumVars();\n\n myGH->info_reductions = calloc(2 * i, sizeof(iobasic_reductionlist_t));\n myGH->scalar_reductions = myGH->info_reductions + i;\n myGH->outInfo_last = malloc(2 * i * sizeof(int));\n myGH->outScalar_last = myGH->outInfo_last + i;\n\n /* initialize counters for how often to do output with a value different\n to the current parameter values\n this forces info output about periodic output */\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n memset(myGH->outInfo_last, -1, 2 * i * sizeof(int));\n\n myGH->filenameListScalar = NULL;\n\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Scalar' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to ASCII files\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_INFO(\"I/O Method 'Info' registered: output of scalar quantities \"\n \"(grid scalars, reductions) to screen\");\n }\n IOBasic_CheckSteerableInfoParameters(myGH);\n myGH->stop_on_parse_errors = 0;\n\n /* get the name of IOBasic's output directory */\n my_out_dir = out_dir;\n if (*my_out_dir == 0) {\n my_out_dir = io_out_dir;\n }\n\n /* skip the directory pathname if output goes into current directory */\n if (strcmp(my_out_dir, \".\")) {\n i = strlen(my_out_dir);\n myGH->out_dir = malloc(i + 2);\n strcpy(myGH->out_dir, my_out_dir);\n myGH->out_dir[i] = '/';\n myGH->out_dir[i + 1] = 0;\n } else {\n myGH->out_dir = strdup(\"\");\n }\n\n /* create the output dir */\n if (*myGH->out_dir && CCTK_MyProc(GH) == 0) {\n i = IOUtil_CreateDirectory(GH, myGH->out_dir, 0, 0);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_SetupGH: Couldn't create Scalar output directory \"\n \"'%s'\",\n myGH->out_dir);\n } else if (i >= 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Scalar: Output to directory '%s'\",\n myGH->out_dir);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine IOBasic_AssignReductionList\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Callback routine called by CCTK_TraverseString() to set the\n reduction list for a given variable.\n For CCTK_GF and CCTK_ARRAY variables, it builds a chained list\n of reduction operators according to the settings of 'optstring'\n or the 'IOBasic::out{Info|Scalar}_reductions' parameter.\n @enddesc\n @calls CCTK_GroupTypeFromVarI\n CCTK_LocalArrayReductionHandle\n\n @var vindex\n @vdesc index of the variable to set info output\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string for this variable\n @vtype const char *\n @vio in\n @endvar\n @var arg\n @vdesc user-supplied argument to callback routine\n @vtype void *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg) {\n int table, iterator, reduction_handle;\n char key[128];\n CCTK_INT type, nelems;\n const char *string_start, *string_end;\n char *fullname, *reduction_op, *reduction_op_list;\n iobasic_reductionlist_t *list;\n iobasic_reduction_t **new_reduction;\n const iobasic_parseinfo_t *info;\n\n info = (const iobasic_parseinfo_t *)arg;\n list = info->reduction_list + vindex;\n\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n if (optstring) {\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"option list '%s' for variable '%s' ignored\", optstring,\n CCTK_VarName(vindex));\n }\n\n list->reductions = malloc(sizeof(iobasic_reduction_t));\n if (strncmp(CCTK_VarTypeName(CCTK_VarTypeI(vindex)),\n \"CCTK_VARIABLE_COMPLEX\", 21)) {\n list->num_reductions = 1;\n list->reductions->name = strdup(\"scalar value\");\n list->reductions->next = NULL;\n } else {\n list->num_reductions = 2;\n list->reductions->name = strdup(\"real part\");\n list->reductions->next = malloc(sizeof(iobasic_reduction_t));\n list->reductions->next->name = strdup(\"imag part\");\n list->reductions->next->next = NULL;\n }\n\n return;\n }\n\n /* initialize to empty list */\n list->num_reductions = 0;\n list->reductions = NULL;\n\n if (optstring) {\n reduction_op_list = NULL;\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n if (type == CCTK_VARIABLE_CHAR && nelems > 0) {\n reduction_op_list = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, reduction_op_list,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Key 'reductions' in option string '%s' for variable \"\n \"'%s' must have a non-empty string value\",\n optstring, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option with key '%s' in option string '%s' for variable \"\n \"'%s' not recognized\",\n key, optstring, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string '%s' for variable '%s' couldn't be parsed\",\n optstring, fullname);\n }\n free(fullname);\n\n if (!reduction_op_list) {\n reduction_op_list = strdup(info->reductions_string);\n }\n } else {\n reduction_op_list = strdup(info->reductions_string);\n }\n\n /* now loop over all reduction operators */\n string_start = reduction_op_list;\n reduction_op = malloc(strlen(string_start) + 1);\n while (string_start && *string_start) {\n /* skip leading spaces */\n while (isspace((int)*string_start)) {\n string_start++;\n }\n if (!*string_start) {\n break;\n }\n\n /* advance to end of the operator string */\n string_end = string_start + 1;\n while (*string_end && !isspace((int)*string_end)) {\n string_end++;\n }\n\n /* copy the operator string */\n strncpy(reduction_op, string_start, string_end - string_start);\n reduction_op[string_end - string_start] = 0;\n string_start = string_end;\n\n /* get the reduction handle from the reduction operator */\n reduction_handle = CCTK_LocalArrayReductionHandle(reduction_op);\n if (reduction_handle < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Unknown reduction operator '%s'. Maybe you forgot to \"\n \"activate thorn LocalReduce?\",\n reduction_op);\n continue;\n }\n\n /* add new reduction to end of list */\n new_reduction = &list->reductions;\n while (*new_reduction) {\n if (strcmp((*new_reduction)->name, reduction_op) == 0) {\n new_reduction = NULL;\n break;\n }\n new_reduction = &((*new_reduction)->next);\n }\n if (new_reduction == NULL) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_AssignReductionList: Duplicate reduction operator \"\n \"'%s' will be ignored\",\n reduction_op);\n continue;\n }\n\n *new_reduction = malloc(sizeof(**new_reduction));\n (*new_reduction)->handle = reduction_handle;\n (*new_reduction)->name = strdup(reduction_op);\n (*new_reduction)->next = NULL;\n list->num_reductions++;\n }\n\n free(reduction_op_list);\n free(reduction_op);\n}\n"},"context_filenames":{"kind":"string","value":"WriteScalar.c\niobasicGH.h\nOutputInfo.c\nOutputScalar.c\nmake.code.defn\nWriteInfo.c\n"},"context":{"kind":"string","value":"WriteScalar.c:\n```\n/*@@\n @routine WriteScalar.c\n @date 18th September 1999\n @author Gabrielle Allen\n @desc\n Dumps data for IOBasic's \"Scalar\" I/O method to output files\n @enddesc\n @version $Id$\n@@*/\n\n#include <ctype.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h> /* strlen(3) */\n#include <sys/types.h>\n#include <sys/stat.h> /* stat(2) */\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"CactusBase/IOUtil/src/ioutil_AdvertisedFiles.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteScalar_c);\n\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias);\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias);\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname);\n\n/*@@\n @routine IOBasic_WriteScalar\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Write a scalar value of a CCTK variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n This routine just calls the appropriate output routine\n according to the variable type.\n @enddesc\n\n @calls CCTK_QueryGroupStorageI\n CCTK_GroupIndexFromVarI\n CCTK_GroupTypeFromVarI\n IOBasic_WriteScalarGS\n IOBasic_WriteScalarGA\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of either @seeroutine IOBasic_WriteScalarGS or\n @seeroutine IOBasic_WriteScalarGA, or\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias) {\n int retval;\n char *fullname;\n\n /* check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: No scalar output for '%s' (no storage)\",\n fullname);\n free(fullname);\n retval = -1;\n } else if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n retval = IOBasic_WriteScalarGS(GH, vindex, alias);\n } else {\n retval = IOBasic_WriteScalarGA(GH, vindex, alias);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGA\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Apply the given reduction operators on the CCTK_ARRAY or\n CCTK_GF variable and output the result into a text file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_ReduceGridArrays\n CCTK_ReductionHandle\n IOUtil_RestartFromRecovery\n IOUtil_AdvertiseFile\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGA(const cGH *GH, int vindex, const char *alias) {\n iobasicGH *myGH;\n FILE *file;\n char *filename;\n char format_str[15];\n const char *file_extension;\n iobasic_reduction_t *reduction;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n /* set output format */\n sprintf(format_str, \"%%%s\\t%%%s\\n\", out_format, out_format);\n\n /* set the output file extension and the output style */\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->scalar_reductions[vindex].reductions;\n\n /* now loop over all reduction operators */\n while (reduction) {\n /* do the reduction (all processors) */\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, 0, reduction->handle, -1, 1, input_array, 1,\n output_array_type_codes, reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalar: Internal error in reduction '%s'\",\n reduction->name);\n } else if (CCTK_MyProc(GH) == 0) {\n /* dump the reduction value to file by processor 0 */\n if (new_filename_scheme) {\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(reduction->name) + strlen(file_extension) + 2);\n sprintf(filename, \"%s%s_%s%s\", myGH->out_dir, alias, reduction->name,\n file_extension);\n } else {\n /* FIXME: this check can go if we switch to the new filename scheme */\n if (strcmp(reduction->name, \"minimum\") == 0) {\n file_extension = \"min\";\n } else if (strcmp(reduction->name, \"maximum\") == 0) {\n file_extension = \"max\";\n } else if (strcmp(reduction->name, \"norm1\") == 0) {\n file_extension = \"nm1\";\n } else if (strcmp(reduction->name, \"norm2\") == 0) {\n file_extension = \"nm2\";\n } else {\n file_extension = reduction->name;\n }\n\n /* allocate filename string buffer and build the filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 5);\n sprintf(filename, \"%s%s_%s.tl\", myGH->out_dir, alias, file_extension);\n }\n\n file = OpenScalarFile(GH, vindex, filename, reduction->name,\n \"Reduction on Grid Arrays\", alias);\n if (file) {\n /* write the data and close the file */\n fprintf(file, format_str, GH->cctk_time, reduction->value);\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGA: Could not open output file '%s'\",\n filename);\n }\n free(filename);\n }\n\n reduction = reduction->next;\n }\n\n return (0);\n}\n\n/*@@\n @routine IOBasic_WriteScalarGS\n @date Mon Jun 19 2000\n @author Thomas Radke\n @desc\n Output the value of a CCTK_SCALAR variable into an ASCII file\n suitable for postprocessing by either gnuplot or xgraph.\n @enddesc\n\n @calls CCTK_MyProc\n CCTK_GHExtension\n CCTK_Equals\n OpenScalarFile\n CCTK_VarDataPtrI\n CCTK_VarTypeI\n CCTK_WARN\n CCTK_VWarn\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n @endreturndesc\n@@*/\nstatic int IOBasic_WriteScalarGS(const cGH *GH, int vindex, const char *alias) {\n FILE *file;\n void *data;\n iobasicGH *myGH;\n char *filename;\n const char *file_extension;\n char format_str_real[15], format_str_int[15];\n DECLARE_CCTK_PARAMETERS\n\n /* output is done by processor 0 only */\n if (CCTK_MyProc(GH) != 0) {\n return (0);\n }\n\n /* set the output format string for the desired notation */\n sprintf(format_str_real, \"%%%s\\t%%%s\\n\", out_format, out_format);\n sprintf(format_str_int, \"%%%s\\t%%d\\n\", out_format);\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* set the output file extension according to the output style */\n if (new_filename_scheme) {\n file_extension = CCTK_Equals(outScalar_style, \"gnuplot\") ? \".asc\" : \".xg\";\n } else {\n file_extension = \".tl\";\n }\n\n /* build the output filename */\n filename = malloc(strlen(myGH->out_dir) + strlen(alias) +\n strlen(file_extension) + 1);\n sprintf(filename, \"%s%s%s\", myGH->out_dir, alias, file_extension);\n\n /* create/reopen the file */\n file = OpenScalarFile(GH, vindex, filename, \"tl\", \"Scalar value\", alias);\n if (file) {\n /* get the data pointer */\n data = CCTK_VarDataPtrI(GH, 0, vindex);\n\n switch (CCTK_VarTypeI(vindex)) {\n case CCTK_VARIABLE_REAL:\n fprintf(file, format_str_real, GH->cctk_time, (double)*(CCTK_REAL *)data);\n break;\n case CCTK_VARIABLE_INT:\n fprintf(file, format_str_int, GH->cctk_time, (int)*(CCTK_INT *)data);\n break;\n default:\n CCTK_WARN(3, \"Unsupported data type\");\n break;\n }\n\n /* close the output file */\n fclose(file);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteScalarGS: Could not open output file '%s'\",\n filename);\n }\n\n /* clean up */\n free(filename);\n\n return (0);\n}\n\nstatic FILE *OpenScalarFile(const cGH *GH, int vindex, const char *filename,\n const char *slicename, const char *description,\n const char *aliasname) {\n int first_time_through;\n FILE *file;\n iobasicGH *myGH;\n char *fullname;\n char comment_char, buffer[128];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n /* get the GH extension handle for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* get the variable's full name */\n fullname = CCTK_FullName(vindex);\n\n /* create the output file the first time through\n If restart from recovery, existing files are opened in append mode. */\n first_time_through = GetNamedData(myGH->filenameListScalar, filename) == NULL;\n file = fopen(filename,\n IO_TruncateOutputFiles(GH) && first_time_through ? \"w\" : \"a\");\n if (!file) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"OpenScalarFile: Cannot open output file '%s'\", filename);\n } else if (first_time_through) {\n if (CCTK_Equals(outScalar_style, \"gnuplot\")) {\n comment_char = '#';\n advertised_file.mimetype = \"application/gnuplot\";\n } else {\n comment_char = '\"'; /* this is for xgraph */\n advertised_file.mimetype = \"application/x-graph\";\n }\n\n /* just store a non-NULL pointer in database */\n StoreNamedData(&myGH->filenameListScalar, filename, (void *)1);\n\n /* advertise the file for downloading */\n advertised_file.slice = slicename;\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = fullname;\n advertised_file.description = description;\n\n IOUtil_AdvertiseFile(GH, filename, &advertised_file);\n\n /* write the file info and the header */\n if (CCTK_Equals(out_fileinfo, \"parameter filename\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n fprintf(file, \"%cParameter file %s\\n\", comment_char, buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"creation date\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n buffer[0] = 0;\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(file, \"%cCreated %s \", comment_char, buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(file, \"%s\\n\", buffer);\n }\n if (CCTK_Equals(out_fileinfo, \"axis labels\") ||\n CCTK_Equals(out_fileinfo, \"all\")) {\n fprintf(file, \"%cx-label time\\n\", comment_char);\n fprintf(file, \"%cy-label %s\\n\", comment_char, advertised_file.varname);\n }\n fprintf(file, \"%c%s v time\\n\", comment_char, aliasname);\n }\n\n free(fullname);\n\n return (file);\n}\n\n```\n\niobasicGH.h:\n```\n/*@@\n @header iobasicGH.h\n @date Friday 18th September 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOBasic.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOBASIC_IOBASICGH_H_\n#define _IOBASIC_IOBASICGH_H_ 1\n\n#include \"StoreNamedData.h\"\n\ntypedef struct IOBASIC_REDUCTION {\n int handle;\n char *name;\n char is_valid;\n CCTK_REAL value;\n struct IOBASIC_REDUCTION *next;\n} iobasic_reduction_t;\n\ntypedef struct IOBASIC_REDUCTIONLIST {\n unsigned int num_reductions;\n iobasic_reduction_t *reductions;\n} iobasic_reductionlist_t;\n\ntypedef struct IOBASIC_PARSEINFO {\n const char *reductions_string;\n iobasic_reductionlist_t *reduction_list;\n} iobasic_parseinfo_t;\n\ntypedef struct IOBASIC_GH {\n /* how often to output */\n int outScalar_every, outInfo_every;\n CCTK_REAL outScalar_dt, outInfo_dt;\n char info_reductions_changed;\n\n /* directory in which to place scalar output */\n char *out_dir;\n\n /* The last iteration output */\n int *outInfo_last, *outScalar_last;\n\n /* The reduction lists for info and scalar output for all variables */\n iobasic_reductionlist_t *info_reductions, *scalar_reductions;\n\n /* database for names of output files that were already created */\n pNamedData *filenameListScalar;\n\n /* stop on I/O parameter parsing errors ? */\n int stop_on_parse_errors;\n\n} iobasicGH;\n\n/* prototypes of functions to be registered */\nint IOBasic_InfoOutputGH(const cGH *GH);\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname, const char *alias);\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex);\nint IOBasic_ScalarOutputGH(const cGH *GH);\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex);\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex);\n\n/* other function prototypes */\nvoid IOBasic_AssignReductionList(int vindex, const char *optstring, void *arg);\nint IOBasic_WriteInfo(const cGH *GH, int vindex);\nint IOBasic_WriteScalar(const cGH *GH, int vindex, const char *alias);\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH);\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH);\n\n#endif /* _IOBASIC_IOBASICGH_H_ */\n\n```\n\nOutputInfo.c:\n```\n/*@@\n @file OutputInfo.c\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Functions to deal with info output of variables\n @enddesc\n @version $Id$\n@@*/\n\n#include <math.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputInfo_c)\n\n/********************************************************************\n ******************** Macro Definitions ***********************\n ********************************************************************/\n/* uncomment the following to get some debugging output */\n/* #define IOBASIC_DEBUG 1 */\n\n/* the number at which to switch from decimal to exponential notation */\n#define DECIMAL_SMALLEST 1.0e-8\n#define DECIMAL_TOOBIG 1.0e+3\n#define USE_DECIMAL_NOTATION(x) \\\n ((x) == 0.0 || \\\n (fabs((double)x) >= DECIMAL_SMALLEST && fabs((double)x) < DECIMAL_TOOBIG))\n#define PRINT_FORMATTED_REDUCTION_VALUE(reduction) \\\n if (reduction->is_valid) { \\\n if (USE_DECIMAL_NOTATION(reduction->value)) { \\\n printf(\"% 13.8f |\", reduction->value); \\\n } else { \\\n printf(\"% 11.6e |\", reduction->value); \\\n } \\\n } else { \\\n printf(\" ------------ |\"); \\\n }\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars);\nstatic int TimeForOutput(const cGH *cctkGH);\n\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n if (myGH->outInfo_every <= 0 || cctk_iteration % myGH->outInfo_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n if (myGH->outInfo_dt < 0) {\n return 0;\n }\n if (myGH->outInfo_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_info_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_info_output_time += myGH->outInfo_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_InfoOutputGH\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and prints output if requested\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n PrintHeader\n IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_InfoOutputGH(const cGH *GH) {\n int vindex, num_vars, retval;\n iobasic_reduction_t *reduction;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* print header if neccessary */\n num_vars = CCTK_NumVars();\n if (myGH->info_reductions_changed) {\n PrintHeader(myGH, num_vars);\n }\n\n /* print the iteration/timestep information for all variables */\n if (USE_DECIMAL_NOTATION(GH->cctk_time)) {\n printf(\"%6d |%9.3f |\", GH->cctk_iteration, GH->cctk_time);\n } else {\n printf(\"%6d |%7.3e |\", GH->cctk_iteration, GH->cctk_time);\n }\n\n /* loop over all variables */\n for (vindex = 0; vindex < num_vars; vindex++) {\n /* check this variable should be output */\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n continue;\n }\n\n /* check variable not already output this iteration */\n if (myGH->outInfo_last[vindex] != GH->cctk_iteration) {\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO OutputInfoGH\\n----------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n printf(\" Last output iteration was = %d\\n\", myGH->outInfo_last[vindex]);\n#endif\n\n /* get the data to output */\n if (IOBasic_WriteInfo (GH, vindex) == 0)\n {\n /* register variable as having info output this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n /* finally print the stuff to screen */\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n PRINT_FORMATTED_REDUCTION_VALUE(reduction);\n reduction = reduction->next;\n }\n } /* end of loop over all variables */\n\n /* add the new line */\n putchar('\\n');\n fflush(stdout);\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to output a variable using info output\n @enddesc\n @calls IOBasic_CheckSteerableInfoParameters\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to check for output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n true/false (1 or 0) if this variable should be output or not\n @endreturndesc\n@@*/\nint IOBasic_TimeForInfoOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableInfoParameters(myGH);\n\n if (myGH->info_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH))\n return 0;\n\n /* check if variable was not already output this iteration */\n if (myGH->outInfo_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done Info output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerInfoOutput\n @date June 31 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's info output\n @enddesc\n @calls IOBasic_WriteInfo\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteInfo\n @endreturndesc\n@@*/\nint IOBasic_TriggerInfoOutput(const cGH *GH, int vindex) {\n int retval;\n iobasicGH *myGH;\n\n /* get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IO TriggerOutputInfo\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf (\" Variable = -%s-\\n\", CCTK_VarName (vindex);\n#endif\n\n /* get the data values to output */\n retval = IOBasic_WriteInfo (GH, vindex);\n\n if (retval == 0)\n {\n /* register variable as having Info output at this iteration */\n myGH->outInfo_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableInfoParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outInfo_every' and/or 'IO::out_every'\n resp. to set myGH->outInfo_every to the frequency of info output.\n Re-evaluates 'IOBasic::outInfo_vars' and\n 'IOBasic::outInfo_reductions' and sets\n myGH->info_reductions_changed to true if one of them was changed.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableInfoParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outInfo_vars_lastset = -1;\n static int outInfo_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outInfo_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outInfo_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outInfo_every;\n myGH->outInfo_every = outInfo_every >= 0 ? outInfo_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outInfo_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output every %d iterations\",\n myGH->outInfo_every);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outInfo_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outInfo_dt;\n myGH->outInfo_dt = outInfo_dt >= 0 ? outInfo_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outInfo_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outInfo_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic info output dt %g\",\n (double)myGH->outInfo_dt);\n } else {\n CCTK_INFO(\"Periodic info output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outInfo_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outInfo_criterion out of bounds\");\n }\n\n /* check if the 'outInfo_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outInfo_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outInfo_reductions_lastset;\n outInfo_reductions_lastset = times_set;\n\n /* check if the 'outInfo_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outInfo_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outInfo_vars_lastset;\n outInfo_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old info output lists ... */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n myGH->info_reductions[vindex].num_reductions = 0;\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->info_reductions;\n info.reductions_string = outInfo_reductions;\n if (CCTK_TraverseString(outInfo_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outInfo_vars'\");\n }\n\n myGH->info_reductions_changed = 1;\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/*@@\n @routine PrintHeader\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n It re-evaluates the info reduction lists of all CCTK variables\n and prints the header for the info output table.\n @enddesc\n @calls CCTK_TraverseString\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n @var num_vars\n @vdesc total number of CCTK variables\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic void PrintHeader(iobasicGH *myGH, int num_vars) {\n DECLARE_CCTK_PARAMETERS\n int i, num_columns, vindex;\n char *fullname, *msg, *oldmsg;\n iobasic_reduction_t *reduction;\n\n /* count number of info values to output */\n num_columns = 0;\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n num_columns += myGH->info_reductions[vindex].num_reductions;\n\n if (myGH->info_reductions[vindex].num_reductions > 0 &&\n !CCTK_Equals(verbose, \"none\")) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic info output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n\n /* draw a horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n\n /* the first header line displays the iteration number (first column)\n and the full names of the variables to output (third column ff.) */\n printf(\" it | |\");\n if (num_columns > 0) {\n for (vindex = 0; vindex < num_vars; vindex++) {\n i = myGH->info_reductions[vindex].num_reductions;\n if (i > 0) {\n fullname = CCTK_FullName(vindex);\n if (strlen(fullname) > (unsigned int)15 * i - 3) {\n printf(\" *%s |\", fullname + strlen(fullname) - (15 * i - 4));\n } else {\n printf(\" %-*s |\", 15 * i - 3, fullname);\n }\n free(fullname);\n }\n }\n }\n putchar('\\n');\n\n /* the second header line displays the physical time (second column)\n and the names of the reduction operators to apply (third column ff.) */\n printf(\" | t \");\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->info_reductions[vindex].num_reductions > 0) {\n reduction = myGH->info_reductions[vindex].reductions;\n while (reduction) {\n printf(\"| %-12s \", reduction->name);\n reduction = reduction->next;\n }\n }\n }\n printf(\"|\\n\");\n\n /* finally draw another horizontal delimiter line */\n printf(\"-------------------\");\n for (i = 0; i < num_columns; i++) {\n printf(\"---------------\");\n }\n putchar('\\n');\n fflush(stdout);\n\n myGH->info_reductions_changed = 0;\n}\n\n```\n\nOutputScalar.c:\n```\n/*@@\n @file Output.c\n @date Mon 21 September\n @author Gabrielle Allen\n @desc\n Functions to deal with scalar output of grid variables\n @enddesc\n@@*/\n\n/* #define IOBASIC_DEBUG 1 */\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"iobasicGH.h\"\n\nstatic const char *rcsid = \"$Header$\";\n\nCCTK_FILEVERSION(CactusBase_IOBasic_OutputScalar_c)\n\n/********************************************************************\n ******************** Static Variables ************************\n ********************************************************************/\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH);\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\n/*@@\n @routine IOBasic_ScalarOutputGH\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Loops over all variables and outputs them if necessary\n @enddesc\n @calls IOBasic_TimeForScalarOutput\n IOBasic_WriteScalar\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n the number of variables which were output at this iteration\n (or 0 if it wasn't time to output yet)\n @endreturndesc\n@@*/\nint IOBasic_ScalarOutputGH(const cGH *GH) {\n int vindex, retval;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (!TimeForOutput(GH))\n return 0;\n\n retval = 0;\n\n /* loop over all variables */\n for (vindex = CCTK_NumVars() - 1; vindex >= 0; vindex--) {\n if (IOBasic_TimeForScalarOutput(GH, vindex) &&\n IOBasic_WriteScalar(GH, vindex, CCTK_VarName(vindex)) == 0) {\n /* register variable as having output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n retval++;\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_OutputVarAs\n @date Sun 8 Mar 2003\n @author Thomas Radke\n @desc\n Unconditional output of a variable using the \"Scalar\" I/O method\n @enddesc\n @calls IOBasic_WriteScalar\n\n @var GH\n @vdesc pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var fullname\n @vdesc complete name of variable to output, maybe appended by an\n options string\n @vtype const char *\n @vio in\n @endvar\n @var alias\n @vdesc variable's alias name used to build the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar, or<BR>\n -1 if variable cannot be output by \"Scalar\"\n @endreturndesc\n@@*/\nint IOBasic_OutputVarAs(const cGH *GH, const char *fullname,\n const char *alias) {\n int vindex, old_num_reductions, retval;\n char *varname, *tmp;\n iobasic_parseinfo_t info;\n iobasic_reduction_t *reduction, *old_reductions, *next;\n iobasicGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* get the variable index from 'fullname' */\n varname = strdup(fullname);\n tmp = strchr(fullname, '[');\n if (tmp) {\n varname[tmp - fullname] = 0;\n }\n\n vindex = CCTK_VarIndex(varname);\n free(varname);\n if (vindex < -1) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: invalid variable name in 'fullname' \"\n \"argument '%s'\",\n fullname);\n return (-1);\n }\n\n /* save the old scalar_reductions[vindex] info ... */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n old_num_reductions = myGH->scalar_reductions[vindex].num_reductions;\n old_reductions = myGH->scalar_reductions[vindex].reductions;\n\n /* ... and create a temporary one from 'fullname' */\n retval = 0;\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(fullname, IOBasic_AssignReductionList, &info,\n CCTK_VAR) < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_OutputVarAs: failed to parse 'fullname' argument '%s'\",\n fullname);\n retval = -1;\n } else if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n /* do the actual output */\n retval = IOBasic_WriteScalar(GH, vindex, alias);\n\n /* free temporary scalar_reductions[vindex] info and restore the old one */\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n myGH->scalar_reductions[vindex].num_reductions = old_num_reductions;\n myGH->scalar_reductions[vindex].reductions = old_reductions;\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_TimeForScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Decides if it is time to do Scalar output.\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 1 if output should take place at this iteration, or<BR>\n 0 if not\n @endreturndesc\n@@*/\nint IOBasic_TimeForScalarOutput(const cGH *GH, int vindex) {\n char *fullname;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n if (myGH->scalar_reductions[vindex].num_reductions == 0) {\n return 0;\n }\n\n if (!TimeForOutput(GH)) {\n return 0;\n }\n\n /* Check if variable wasn't already output this iteration */\n if (myGH->outScalar_last[vindex] == GH->cctk_iteration) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(5, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Already done scalar output for '%s' in current iteration \"\n \"(probably via triggers)\",\n fullname);\n free(fullname);\n return 0;\n }\n\n return 1;\n}\n\n/*@@\n @routine IOBasic_TriggerScalarOutput\n @date Sat March 6 1999\n @author Gabrielle Allen\n @desc\n Triggers the output of a variable using IOBasic's Scalar\n output method\n @enddesc\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc index of variable to output\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n return code of @seeroutine IOBasic_WriteScalar\n @endreturndesc\n@@*/\nint IOBasic_TriggerScalarOutput(const cGH *GH, int vindex) {\n int retval;\n const char *name;\n iobasicGH *myGH;\n\n /* Get the GH extension for IOBasic */\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n\n name = CCTK_VarName(vindex);\n\n#ifdef IOBASIC_DEBUG\n printf(\"\\nIn IOBasic_TriggerScalarOutput\\n---------------------\\n\");\n printf(\" Index = %d\\n\", vindex);\n printf(\" Variable = -%s-\\n\", name);\n#endif\n\n /* do the Scalar output */\n retval = IOBasic_WriteScalar(GH, vindex, name);\n if (retval == 0) {\n /* register variable as having Scalar output this iteration */\n myGH->outScalar_last[vindex] = GH->cctk_iteration;\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOBasic_CheckSteerableScalarParameters\n @date Tue 31 Jul 2001\n @author Thomas Radke\n @desc\n Re-evaluates 'IOBasic::outScalar_every' and/or 'IO::out_every'\n resp. to set myGH->outScalar_every to the frequency of scalar\n output. Re-evaluates 'IOBasic::outScalar_vars' and\n 'IOBasic::outScalar_reductions'.\n @enddesc\n @calls CCTK_ParameterQueryTimesSet\n\n @var myGH\n @vdesc Pointer to IOBasic's GH extension\n @vtype iobasicGH *\n @vio in\n @endvar\n@@*/\nvoid IOBasic_CheckSteerableScalarParameters(iobasicGH *myGH) {\n int vindex, out_old, times_set, update_reductions_list, num_vars;\n CCTK_REAL outdt_old;\n iobasic_reduction_t *reduction, *next;\n static int outScalar_vars_lastset = -1;\n static int outScalar_reductions_lastset = -1;\n iobasic_parseinfo_t info;\n char *msg, *oldmsg, *fullname;\n DECLARE_CCTK_PARAMETERS\n\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n /* how often to output */\n out_old = myGH->outScalar_every;\n myGH->outScalar_every = outScalar_every >= 0 ? outScalar_every : out_every;\n\n /* report if frequency changed */\n if (myGH->outScalar_every != out_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_every > 0) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Periodic scalar output every %d iterations\",\n myGH->outScalar_every);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_every <= 0) {\n return;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n /* how often to output */\n outdt_old = myGH->outScalar_dt;\n myGH->outScalar_dt = outScalar_dt >= 0 ? outScalar_dt : out_dt;\n\n /* report if frequency changed */\n if (myGH->outScalar_dt != outdt_old && !CCTK_Equals(verbose, \"none\")) {\n if (myGH->outScalar_dt >= 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Periodic scalar output dt %g\",\n (double)myGH->outScalar_dt);\n } else {\n CCTK_INFO(\"Periodic scalar output turned off\");\n }\n }\n\n /* return if there's nothing to do */\n if (myGH->outScalar_dt < 0) {\n return;\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n /* check if the 'outScalar_reductions' parameter if it was changed */\n times_set =\n CCTK_ParameterQueryTimesSet(\"outScalar_reductions\", CCTK_THORNSTRING);\n update_reductions_list = times_set != outScalar_reductions_lastset;\n outScalar_reductions_lastset = times_set;\n\n /* check if the 'outScalar_vars' parameter if it was changed */\n times_set = CCTK_ParameterQueryTimesSet(\"outScalar_vars\", CCTK_THORNSTRING);\n update_reductions_list |= times_set != outScalar_vars_lastset;\n outScalar_vars_lastset = times_set;\n\n if (update_reductions_list) {\n /* free old reduction lists ... */\n num_vars = CCTK_NumVars();\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions > 0) {\n myGH->scalar_reductions[vindex].num_reductions = 0;\n reduction = myGH->scalar_reductions[vindex].reductions;\n while (reduction) {\n next = reduction->next;\n free(reduction->name);\n free(reduction);\n reduction = next;\n }\n }\n }\n\n /* ... and create new ones */\n info.reduction_list = myGH->scalar_reductions;\n info.reductions_string = outScalar_reductions;\n if (CCTK_TraverseString(outScalar_vars, IOBasic_AssignReductionList, &info,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IOBasic::outScalar_vars'\");\n } else if (!CCTK_Equals(verbose, \"none\")) {\n msg = NULL;\n for (vindex = 0; vindex < num_vars; vindex++) {\n if (myGH->scalar_reductions[vindex].num_reductions) {\n fullname = CCTK_FullName(vindex);\n if (!msg) {\n Util_asprintf(&msg, \"Periodic scalar output requested for '%s'\",\n fullname);\n } else {\n oldmsg = msg;\n Util_asprintf(&msg, \"%s, '%s'\", oldmsg, fullname);\n free(oldmsg);\n }\n free(fullname);\n }\n }\n if (msg) {\n CCTK_INFO(msg);\n free(msg);\n }\n }\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic int TimeForOutput(const cGH *cctkGH) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n iobasicGH *myGH;\n\n /* get the GH extensions for IOBasic */\n myGH = CCTK_GHExtension(cctkGH, \"IOBasic\");\n\n /* check if steerable parameters changed */\n IOBasic_CheckSteerableScalarParameters(myGH);\n\n /* how to decide when to output? */\n /* (return if no output is required) */\n if (CCTK_EQUALS(outScalar_criterion, \"never\")) {\n return 0;\n } else if (CCTK_EQUALS(outScalar_criterion, \"iteration\")) {\n if (myGH->outScalar_every <= 0 || cctk_iteration % myGH->outScalar_every) {\n return 0;\n }\n } else if (CCTK_EQUALS(outScalar_criterion, \"time\")) {\n if (myGH->outScalar_dt < 0) {\n return 0;\n }\n if (myGH->outScalar_dt > 0) {\n static int output_iteration = -1;\n static int output_this_iteration;\n if (!(cctk_iteration >= output_iteration))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"cctk_iteration out of bounds\");\n if (cctk_iteration > output_iteration) {\n output_iteration = cctk_iteration;\n output_this_iteration =\n cctk_time >= *next_scalar_output_time - 1.0e-12 * cctk_delta_time;\n if (output_this_iteration) {\n *next_scalar_output_time += myGH->outScalar_dt;\n }\n }\n if (!output_this_iteration) {\n return 0;\n }\n }\n } else {\n if (!(0))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOBasic\",\n \"outScalar_criterion out of bounds\");\n }\n\n return 1;\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOBasic\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c \\\n OutputScalar.c \\\n OutputInfo.c \\\n WriteScalar.c \\\n WriteInfo.c \n\n```\n\nWriteInfo.c:\n```\n/*@@\n @file WriteInfo.c\n @date June 31 1999\n @author Gabrielle Allen, Paul Walker, Thomas Radke\n @desc\n Gets the data for IOBasic's info output.\n @enddesc\n @version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"iobasicGH.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOBasic_WriteInfo_c)\n\n/*@@\n @routine IOBasic_WriteInfo\n @date Tue 31 July 2001\n @author Thomas Radke\n @desc\n Gets the data values to output for a given CCTK variable.\n For CCTK_SCALAR variables, their value is taken,\n for CCTK_GF and CCTK_ARRAY variables the appropriate\n reduction operations are performed and their results taken.\n @enddesc\n\n @calls CCTK_VarDataPtrI\n CCTK_ReduceGridArrays\n\n @var GH\n @vdesc Pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var vindex\n @vdesc CCTK index of the variable to output\n @vtype int\n @vio in\n @endvar\n @var alias\n @vdesc alias name to use for building the output filename\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if variable has no storage assigned\n @endreturndesc\n@@*/\nint IOBasic_WriteInfo(const cGH *GH, int vindex) {\n int vtype;\n char *fullname;\n iobasicGH *myGH;\n void *ptr;\n iobasic_reduction_t *reduction;\n\n CCTK_INT input_array[1];\n CCTK_INT output_array_type_codes[1];\n CCTK_REAL output_value;\n void *reduction_value[1];\n\n input_array[0] = vindex;\n output_array_type_codes[0] = CCTK_VARIABLE_REAL;\n reduction_value[0] = &output_value;\n\n myGH = CCTK_GHExtension(GH, \"IOBasic\");\n reduction = myGH->info_reductions[vindex].reductions;\n\n /* first, check if variable has storage assigned */\n if (!CCTK_QueryGroupStorageI(GH, CCTK_GroupIndexFromVarI(vindex))) {\n fullname = CCTK_FullName(vindex);\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: No info output for '%s' (no storage)\",\n fullname);\n free(fullname);\n\n /* invalidate data buffer for this variable */\n while (reduction) {\n reduction->is_valid = 0;\n reduction = reduction->next;\n }\n return (-1);\n }\n\n /* CCTK scalars are printed by their value, cast into a C double */\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_SCALAR) {\n reduction->is_valid = 1;\n\n /* get the variable's data type and data pointer */\n ptr = CCTK_VarDataPtrI(GH, 0, vindex);\n vtype = CCTK_VarTypeI(vindex);\n switch (vtype) {\n case CCTK_VARIABLE_BYTE:\n reduction->value = (double)*(CCTK_BYTE *)ptr;\n break;\n case CCTK_VARIABLE_INT:\n reduction->value = (double)*(CCTK_INT *)ptr;\n break;\n case CCTK_VARIABLE_REAL:\n reduction->value = (double)*(CCTK_REAL *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX:\n reduction->value = (double)((CCTK_REAL *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#ifdef HAVE_CCTK_INT1\n case CCTK_VARIABLE_INT1:\n reduction->value = (double)*(CCTK_INT1 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT2\n case CCTK_VARIABLE_INT2:\n reduction->value = (double)*(CCTK_INT2 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT4\n case CCTK_VARIABLE_INT4:\n reduction->value = (double)*(CCTK_INT4 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT8\n case CCTK_VARIABLE_INT8:\n reduction->value = (double)*(CCTK_INT8 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_INT16\n case CCTK_VARIABLE_INT16:\n reduction->value = (double)*(CCTK_INT16 *)ptr;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL4\n case CCTK_VARIABLE_REAL4:\n reduction->value = (double)*(CCTK_REAL4 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX8:\n reduction->value = (double)((CCTK_REAL4 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL4 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL8\n case CCTK_VARIABLE_REAL8:\n reduction->value = (double)*(CCTK_REAL8 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX16:\n reduction->value = (double)((CCTK_REAL8 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL8 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n#ifdef HAVE_CCTK_REAL16\n case CCTK_VARIABLE_REAL16:\n reduction->value = (double)*(CCTK_REAL16 *)ptr;\n break;\n case CCTK_VARIABLE_COMPLEX32:\n reduction->value = (double)((CCTK_REAL16 *)ptr)[0];\n reduction->next->value = (double)((CCTK_REAL16 *)ptr)[1];\n reduction->next->is_valid = 1;\n break;\n#endif\n default:\n CCTK_WARN(3, \"IOBasic_WriteInfo: Unsupported data type\");\n reduction->is_valid = 0;\n break;\n }\n } else {\n /* for CCTK_GF and CCTK_ARRAY variables: loop over all reductions */\n while (reduction) {\n reduction->is_valid =\n CCTK_ReduceGridArrays(GH, -1, reduction->handle, -1, 1, input_array,\n 1, output_array_type_codes,\n reduction_value) == 0;\n reduction->value = output_value;\n\n if (!reduction->is_valid) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOBasic_WriteInfo: Internal error in reduction '%s'\",\n reduction->name);\n }\n\n reduction = reduction->next;\n }\n }\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":86,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"ioutil_CheckpointRecovery.h"},"src_code":{"kind":"string","value":"/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n"},"context_filenames":{"kind":"string","value":"Utils.c\nmake.code.defn\nioutil_AdvertisedFiles.h\nioGH.h\nioutil_Utils.h\nAdvertisedFiles.c\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"Utils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":87,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"Utils.c"},"src_code":{"kind":"string","value":"/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nmake.code.defn\nioutil_AdvertisedFiles.h\nioGH.h\nioutil_Utils.h\nAdvertisedFiles.c\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":88,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"make.code.defn"},"src_code":{"kind":"string","value":"# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nioutil_AdvertisedFiles.h\nioGH.h\nioutil_Utils.h\nAdvertisedFiles.c\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":89,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"ioutil_AdvertisedFiles.h"},"src_code":{"kind":"string","value":"/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nmake.code.defn\nioGH.h\nioutil_Utils.h\nAdvertisedFiles.c\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":90,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"ioGH.h"},"src_code":{"kind":"string","value":"/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nmake.code.defn\nioutil_AdvertisedFiles.h\nioutil_Utils.h\nAdvertisedFiles.c\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":91,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"ioutil_Utils.h"},"src_code":{"kind":"string","value":"/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nmake.code.defn\nioutil_AdvertisedFiles.h\nioGH.h\nAdvertisedFiles.c\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":92,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"AdvertisedFiles.c"},"src_code":{"kind":"string","value":"/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nmake.code.defn\nioutil_AdvertisedFiles.h\nioGH.h\nioutil_Utils.h\nCheckpointRecovery.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":93,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"CheckpointRecovery.c"},"src_code":{"kind":"string","value":"/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nmake.code.defn\nioutil_AdvertisedFiles.h\nioGH.h\nioutil_Utils.h\nAdvertisedFiles.c\nStartup.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n\n```\n\n"}}},{"rowIdx":94,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/IOUtil"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":"# Configuration definitions for thorn IOUTIL\n# $Header$\n\n# In future we can hopefully use function aliasing instead.\n\nPROVIDES IOUTIL\n{\n SCRIPT\n LANG\n}\n"},"interface":{"kind":"string","value":"# Interface definitions for thorn IOUtil\n# $Header$\n\nimplements: IO\n\n\n# aliased functions required from Coordinate base thorn\n\nCCTK_INT FUNCTION Coord_GetDefaultSystem \\\n (CCTK_POINTER_TO_CONST IN GH, \\\n CCTK_INT IN systemdim)\n\nUSES FUNCTION Coord_GetDefaultSystem\n\n\nCCTK_INT FUNCTION IO_TruncateOutputFiles \\\n (CCTK_POINTER_TO_CONST IN GH)\n\nPROVIDES FUNCTION IO_TruncateOutputFiles \\\n WITH IOUtil_TruncateOutputFiles \\\n LANGUAGE C\n"},"param":{"kind":"string","value":"# Parameter definitione for thorn IOUtil\n# $Header$\n\n#############################################################################\n### declare IOUtil parameters\n### These are declared protected so that they can be seen by other I/O thorns.\n#############################################################################\nrestricted:\n\n####################\n# Output directories\n####################\nSTRING out_dir \"Default output directory\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\n\n########################\n# How often to do output\n########################\nKEYWORD out_criterion \"Criterion to select output intervals\"\n{\n \"never\" :: \"Never output\"\n \"iteration\" :: \"Output every so many iterations\"\n \"time\" :: \"Output every that much coordinate time\"\n} \"iteration\"\nINT out_every \"How often to do output by default\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable output\"\n} -1\nREAL out_dt \"How often to do output by default\" STEERABLE = ALWAYS\n{\n (0:* :: \"In intervals of that much coordinate time\"\n 0 :: \"As often as possible\"\n -1 :: \"Disable output\"\n -2 :: \"Disable output\"\n} -2\n\n################\n# various things\n################\nKEYWORD verbose \"Level of screen output for I/O\" STEERABLE = ALWAYS\n{\n \"none\" :: \"No output\"\n \"standard\" :: \"Initial description for each I/O method\"\n \"full\" :: \"Maximal output\"\n} \"standard\"\nBOOLEAN print_timing_info \"Print timing information on I/O operations.\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN new_filename_scheme \"Use the new filename scheme for output files ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN require_empty_output_directory \"Require that IO::out_dir is empty at startup ?\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN strict_io_parameter_check \"Stop on errors while parsing I/O parameters from parameter file ?\" STEERABLE = RECOVER\n{\n} \"yes\"\nBOOLEAN abort_on_io_errors \"Abort on I/O errors (rather than just print a warning) ?\" STEERABLE = ALWAYS\n{\n} \"no\"\nKEYWORD out_fileinfo \"Add some useful file information to output files ?\" STEERABLE = RECOVER\n{\n \"none\" :: \"no file information\"\n \"creation date\" :: \"add creation date\"\n \"parameter filename\" :: \"add parameter filename\"\n \"axis labels\" :: \"add axis labels information to output files\"\n \"all\" :: \"add all available file information\"\n} \"all\"\nSTRING out_group_separator \"String to separate group name from variable name in file name\" STEERABLE = ALWAYS\n{\n \"\" :: \"Note: The old default was'::'\"\n} \"-\"\n\n#######################\n# Specific to 3D output\n#######################\nKEYWORD out_mode \"Which mode to use for output\" STEERABLE = RECOVER\n{\n \"proc\" :: \"Every processor writes its share of data into a separate file\"\n \"np\" :: \"Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every\"\n \"onefile\" :: \"All output is written into a single file by processor 0\"\n} \"proc\"\n\nINT out_proc_every \"Do output on every N processors\" STEERABLE = RECOVER\n{\n 1:* :: \"A number between [1, nprocs)\"\n} 8\nINT out_timesteps_per_file \"How many timesteps to write to a single file\" STEERABLE = RECOVER\n{\n# 1:* :: \"Number of timesteps per file\"\n 1:1 :: \"Number of timesteps per file (can only be 1 so far)\"\n -1: :: \"All timesteps in a single file\"\n} -1\nBOOLEAN out3D_septimefiles \"Write one file per time slice, as opposed to all data in one file\" STEERABLE = RECOVER\n{\n} \"no\"\nBOOLEAN out_unchunked \"Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode.\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD out_save_parameters \"Save current parameter settings in output files ?\" STEERABLE = RECOVER\n{\n \"all\" :: \"Save all parameter settings\"\n \"only set\" :: \"Only save parameters which have been set before\"\n \"no\" :: \"Don't save parameter settings\"\n} \"only set\"\n\n\n##############################################\n# Downsampling parameters (only for 3D output)\n##############################################\nINT out_downsample_x \"Factor by which to downsample output in x direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_y \"Factor by which to downsample output in y direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nINT out_downsample_z \"Factor by which to downsample output in z direction. Point (0,0,0) is always included.\" STEERABLE = ALWAYS\n{\n 1:* :: \"A positive integer\"\n} 1\nBOOLEAN out_single_precision \"Output data in single precision ?\" STEERABLE = ALWAYS\n{\n} \"no\"\n\n\n###################################\n# Checkpointing/recovery parameters\n###################################\nBOOLEAN checkpoint_ID \"Checkpoint initial data ?\" STEERABLE = RECOVER\n{\n} \"no\"\nKEYWORD recover \"Recover from a checkpoint file ?\" STEERABLE = RECOVER\n{\n \"no\" :: \"Don't recover\"\n \"manual\" :: \"Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file\"\n \"auto\" :: \"Automatically recover from the latest checkpoint file found in <recover_dir>\"\n \"autoprobe\" :: \"Probe for checkpoint files and automatically recover, continue as usual if nothing was found\"\n} \"no\"\nINT checkpoint_every \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n -1:0 :: \"Disable periodic checkpointing\"\n} -1\nREAL checkpoint_every_walltime_hours \"How often to checkpoint\" STEERABLE = ALWAYS\n{\n (0:* :: \"After so much walltime has passed\"\n -1 :: \"Disable periodic walltime checkpointing\"\n} -1\nBOOLEAN checkpoint_on_terminate \"Checkpoint after last iteration\" STEERABLE = ALWAYS\n{\n} \"no\"\nINT checkpoint_keep \"How many checkpoint files to keep\" STEERABLE = ALWAYS\n{\n 1:* :: \"1 overwrites the latest checkpoint file\"\n -1: :: \"Keep all checkpoint files\"\n} 1\nSTRING checkpoint_file \"File name for regular checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_ID_file \"File name for initial data checkpoint\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING recover_file \"Basename of recovery file\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid filename\"\n} \"checkpoint.chkpt\"\nSTRING checkpoint_dir \"Output directory for checkpoint files\" STEERABLE = ALWAYS\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING recover_dir \"Directory to look for recovery files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_dir \"Directory to look for input files\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid directory name\"\n} \".\"\nSTRING filereader_ID_files \"List of basenames of files to read in as initial data (e.g. omit the filename extention here)\" STEERABLE = RECOVER\n{\n \".+\" :: \"Space-separated list of initial data filenames (basenames, e.g. excluding the file name extention)\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"\"\nSTRING filereader_ID_vars \"List of variables to read in from the given initial data files\" STEERABLE = RECOVER\n{\n \"all\" :: \"Read all variables contained in the initial data files\"\n \".+\" :: \"Space-separated list of fully qualified variable/group names\"\n \"^$\" :: \"An empty string for not recovering initial data\"\n} \"all\"\nBOOLEAN recover_and_remove \"Remove checkpoint file after successful recovery ?\" STEERABLE = RECOVER\n{\n} \"no\"\n\n\n###################################\n# Parameter file writing parameters\n###################################\nKEYWORD parfile_write \"Write a parameter file to 'IO::out_dir'\" STEERABLE = RECOVER\n{\n \"no\" :: \"Do not write a parameter file\"\n \"copy\" :: \"Copy the original parameter file\"\n \"generate\" :: \"Generate a parameter file from the current settings\"\n# \"verbose generate\" :: \"Like \\\"generate\\\" but describe all parameters in detail\"\n} \"copy\"\nSTRING parfile_name \"Filename for the parameter file to be written\" STEERABLE = RECOVER\n{\n \".+\" :: \"A valid filename\"\n \"^$\" :: \"An empty string to choose the original parameter filename\"\n} \"\"\nINT parfile_update_every \"How often to update the parameter file for steered parameters\" STEERABLE = ALWAYS\n{\n 1:* :: \"Every so many iterations\"\n 0: :: \"Disable updating\"\n} 0\n\n\n#######################################\n# 1D line slice center setup parameters\n#######################################\nREAL out_xline_y \"y-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xline_z \"z-coord for 1D lines in x-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_yline_x \"x-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_yline_z \"z-coord for 1D lines in y-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\nREAL out_zline_x \"x-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_zline_y \"y-coord for 1D lines in z-direction\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\n\nINT out_xline_yi \"y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xline_zi \"z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_yline_xi \"x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_yline_zi \"z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\nINT out_zline_xi \"x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_zline_yi \"y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\n\n\n##################################\n# 2D plane center setup parameters\n##################################\nREAL out_yzplane_x \"x-coord for 2D planes in yz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [xmin, xmax]\"\n} 0.0\nREAL out_xzplane_y \"y-coord for 2D planes in xz\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [ymin, ymax]\"\n} 0.0\nREAL out_xyplane_z \"z-coord for 2D planes in xy\" STEERABLE = RECOVER\n{\n *:* :: \"A value between [zmin, zmax]\"\n} 0.0\n\nINT out_yzplane_xi \"x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nx)\"\n -1: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box\"\n} -2\nINT out_xzplane_yi \"y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, ny)\"\n -1: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box\"\n} -2\nINT out_xyplane_zi \"z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z\" STEERABLE = RECOVER\n{\n 0:* :: \"An index between [0, nz)\"\n -1: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0\"\n -2: :: \"Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box\"\n} -2\n\n\nprivate:\n\nBOOLEAN truncate_files \"Truncate existing output files from previous runs (except when recovering) ?\" STEERABLE = ALWAYS\n{\n} \"yes\"\n\nBOOLEAN truncate_files_after_recovering \"Truncate existing output files after recovering ?\" STEERABLE = RECOVER\n{\n} \"no\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn IOUtil\n# $Header$\n\nschedule IOUtil_Startup at STARTUP after Driver_Startup\n{\n LANG:C\n} \"Startup routine\"\n\nif (! CCTK_Equals (recover, \"no\"))\n{\n schedule IOUtil_RecoverGH at RECOVER_VARIABLES\n {\n LANG:C\n OPTIONS: level\n } \"Checkpoint recovery routine\"\n}\n\nif (*filereader_ID_files && *filereader_ID_vars)\n{\n schedule IOUtil_RecoverIDFromDatafiles at INITIAL\n {\n LANG:C\n OPTIONS: level\n } \"Initial data recovery routine\"\n}\n\nif (! CCTK_Equals (parfile_write, \"no\") && parfile_update_every)\n{\n schedule IOUtil_UpdateParFile at POSTSTEP\n {\n LANG:C\n OPTIONS: meta\n } \"Append steered parameters to parameter file\"\n}\n"},"src_filename":{"kind":"string","value":"Startup.c"},"src_code":{"kind":"string","value":"/*@@\n @file Startup.c\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n Startup routines for IOUtil.\n @enddesc\n @version $Id$\n@@*/\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n#include \"cctk_Misc.h\"\n#include \"cctk_Version.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_Network.h\"\n\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <fcntl.h>\n#include <errno.h>\n#ifdef HAVE_SYS_STAT_H\n#include <sys/stat.h>\n#endif\n#ifdef HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\n/* the rcs ID and its dummy funtion to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Startup_c)\n\n/********************************************************************\n ********************* External Routines **********************\n ********************************************************************/\nint IOUtil_Startup(void);\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS);\n\n/********************************************************************\n ********************* Internal Typedefs **********************\n ********************************************************************/\n/* structure defining a single-linked list of parameters\n (stores the name of the parameter, its stringified value, and its type) */\ntypedef struct t_param_list {\n char *name;\n char *value;\n const char *format_string;\n struct t_param_list *next;\n} t_param_list;\n\n/********************************************************************\n ********************** Static Routines *********************\n ********************************************************************/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH);\nstatic int CopyParFile(int recovered);\nstatic int GenerateParFile(int recovered);\nstatic int DumpParameters(FILE *outfile);\n\n/*@@\n @routine IOUtil_Startup\n @date Sat Feb 6 1999\n @author Gabrielle Allen\n @desc\n The startup registration routine for IOUtil.<BR>\n It registers the GH extension \"IO\" for IOUtil, along with its\n setup routine.\n It also advertises the original parameter file.\n @enddesc\n @calls CCTK_RegisterGHExtension\n CCTK_RegisterGHExtensionSetupGH\n CCTK_ParameterFilename\n IOUtil_AdvertiseFile\n@@*/\nint IOUtil_Startup(void) {\n char parfile[1024];\n ioAdvertisedFileDesc advertised_file;\n DECLARE_CCTK_PARAMETERS\n\n CCTK_RegisterGHExtensionSetupGH(CCTK_RegisterGHExtension(\"IO\"), SetupGH);\n\n /* advertise the parameter file */\n parfile[0] = 0;\n\n /* TODO: check the returned size; the function silently truncates\n * the filename if it doesn't fit in the buffer; I can't think of a\n * situation where this is useful. Even better, modify\n * CCTK_ParameterFilename to allocate memory for the string, like\n * many other Cactus functions do. */\n\n CCTK_ParameterFilename(sizeof(parfile), parfile);\n advertised_file.slice = \"\";\n advertised_file.thorn = CCTK_THORNSTRING;\n advertised_file.varname = \"\";\n advertised_file.description = \"Parameter File\";\n advertised_file.mimetype = \"text/plain\";\n IOUtil_AdvertiseFile(NULL, parfile, &advertised_file);\n\n return 0;\n}\n\n/*@@\n @routine IOUtil_UpdateParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Updates the parameter file for all parameters which got steered\n during its last invocation.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype int\n @returndesc 0 for success\n @endreturndesc\n@@*/\nvoid IOUtil_UpdateParFile(CCTK_ARGUMENTS) {\n DECLARE_CCTK_PARAMETERS;\n const cGH *GH = cctkGH;\n\n /* check if it's time to update */\n if (CCTK_MyProc(GH) > 0 || GH->cctk_iteration % parfile_update_every) {\n return;\n }\n\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Not yet implemented: updating parameter file for steered \"\n \"parameters up to iteration %d\",\n GH->cctk_iteration);\n}\n\n/*@@\n @routine IOUtil_TruncateOutputFiles\n @date Wed 17 November 2004\n @author Thomas Radke\n @desc\n Aliased function 'IO_TruncateOutputFiles' which can be called\n by I/O methods to check whether to truncate existing output\n files or not.\n @enddesc\n\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n\n @returntype CCTK_INT\n @returndesc 1 or 0 for truncate or not\n @endreturndesc\n@@*/\nCCTK_INT IOUtil_TruncateOutputFiles(const CCTK_POINTER_TO_CONST GH) {\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (!myGH) {\n CCTK_WARN(CCTK_WARN_ABORT, \"IOUtil_TruncateOutputFiles called before being \"\n \"fully initialized. Please make sure to only \"\n \"call me after the STARTUP bin has finished and \"\n \"the driver called CCTKi_InitGHExtensions.\");\n }\n\n return (myGH->recovered ? truncate_files_after_recovering : truncate_files);\n}\n\n/********************************************************************\n *********************** Local Functions ***********************\n ********************************************************************/\n/*@@\n @routine SetupGH\n @date Tue May 09 2000\n @author Thomas Radke\n @desc\n The GH allocation and initialization routine for IOUtil.<BR>\n Necessary output dirs are created, checkpoint/recovery timers\n are created if timing information is wanted, and a parameter\n file is written to 'IO::out_dir' if requested.\n @enddesc\n @calls IOUtil_CreateDirectory\n CopyParFile\n GenerateParFile\n\n @var config\n @vdesc flesh configuration structure (unused)\n @vtype tFleshConfig *\n @vio in\n @endvar\n @var convergence_level\n @vdesc convergence level (unused)\n @vtype int\n @vio in\n @endvar\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n\n @returntype void *\n @returndesc the pointer to IOUtil's GH extension structure, or<BR>\n NULL if memory allocation failed\n @endreturndesc\n@@*/\nstatic void *SetupGH(tFleshConfig *config, int convergence_level, cGH *GH) {\n int i, maxdim, myproc;\n ioGH *myGH;\n#ifdef HAVE_DIRENT_H\n DIR *dir;\n struct dirent *file;\n#endif\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warnings about unused parameters */\n convergence_level = convergence_level;\n\n myproc = CCTK_MyProc(GH);\n myGH = calloc(1, sizeof(ioGH));\n if (!myGH) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't allocate GH extension structure for IOUtil\");\n return (NULL);\n }\n\n if (CCTK_Equals(out_mode, \"proc\")) {\n myGH->ioproc = myproc;\n myGH->nioprocs = CCTK_nProcs(GH);\n myGH->ioproc_every = 1;\n } else if (CCTK_Equals(out_mode, \"np\")) {\n myGH->ioproc_every = out_proc_every;\n if (out_proc_every > CCTK_nProcs(GH)) {\n myGH->ioproc_every = CCTK_nProcs(GH);\n CCTK_VInfo(CCTK_THORNSTRING, \"Reducing 'IO::out_proc_every' to %d\",\n myGH->ioproc_every);\n }\n\n myGH->nioprocs = CCTK_nProcs(GH) / myGH->ioproc_every +\n (CCTK_nProcs(GH) % myGH->ioproc_every ? 1 : 0);\n myGH->ioproc = myproc - (myproc % myGH->ioproc_every);\n } else /* IO::out_mode = \"onefile\" */\n {\n myGH->ioproc = 0;\n myGH->nioprocs = 1;\n myGH->ioproc_every = CCTK_nProcs(GH);\n }\n\n /* For now we can only have unchunked for a single output file */\n myGH->unchunked = 0;\n if (out_unchunked || CCTK_nProcs(GH) == 1) {\n if (myGH->ioproc_every >= CCTK_nProcs(GH)) {\n myGH->unchunked = 1;\n } else {\n CCTK_INFO(\"Unchunked output not supported for multiple \"\n \"output files. Output will be chunked.\");\n }\n }\n\n myGH->stop_on_parse_errors = 0;\n\n /* create the default output and checkpoint directories */\n i = IOUtil_CreateDirectory(GH, out_dir, !CCTK_Equals(out_mode, \"onefile\"),\n myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating default output directory '%s'\", out_dir);\n } else if (i > 0) {\n if (CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"default output directory '%s' already exists\", out_dir);\n }\n if (require_empty_output_directory) {\n#ifdef HAVE_DIRENT_H\n i = 0;\n dir = opendir(out_dir);\n while ((file = readdir(dir)) != NULL) {\n if (strcmp(file->d_name, \".\") == 0 || strcmp(file->d_name, \"..\") == 0) {\n continue;\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found file '%s' in already existing output directory '%s'\",\n file->d_name, out_dir);\n i++;\n }\n closedir(dir);\n if (i) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"You have set IO::out_dir = '%s' and \"\n \"IO::require_empty_output_directory = 'yes'. \"\n \"This output directory already exists and is non-empty.\",\n out_dir);\n }\n#else\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::require_empty_output_directory = \"\n \"\\\"yes\\\"' on this architecture because it doesn't provide \"\n \"opendir(3) to browse the IO::out_dir directory.\\n\"\n \"Please use 'IO::require_empty_output_directories = \"\n \"\\\"no\\\"' instead !\");\n#endif\n }\n }\n i = IOUtil_CreateDirectory(GH, checkpoint_dir,\n !CCTK_Equals(out_mode, \"onefile\"), myGH->ioproc);\n if (i < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Problem creating checkpoint directory '%s'\", checkpoint_dir);\n } else if (i > 0 && CCTK_Equals(verbose, \"full\")) {\n CCTK_VInfo(CCTK_THORNSTRING, \"checkpoint directory '%s' already exists\",\n checkpoint_dir);\n }\n\n /* save downsampling parameters in ioUtilGH because they are temporarily\n reset during checkpointing */\n /* for now we have only parameters for the first 3 dimensions\n the rest is constantly initialized to 1 */\n maxdim = CCTK_MaxDim();\n myGH->downsample = malloc(maxdim * sizeof(int));\n\n switch (maxdim > 3 ? 3 : maxdim) {\n case 3:\n myGH->downsample[2] = out_downsample_z;\n case 2:\n myGH->downsample[1] = out_downsample_y;\n case 1:\n myGH->downsample[0] = out_downsample_x;\n }\n\n for (i = 3; i < maxdim; i++) {\n myGH->downsample[i] = 1;\n }\n\n/* evaluate the 'IO::out_single_precision' parameter only\n if Cactus was compiled with double precision */\n#ifdef SINGLE_PRECISION\n myGH->out_single = 0;\n#else\n myGH->out_single = out_single_precision;\n#endif\n\n /* copy the 'recovered' flag to this GH extension */\n myGH->recovered = config->recovered;\n\n /* reset the flags array for the file reader */\n myGH->do_inVars = NULL;\n\n /* write the parameter file if requested */\n if (myproc == 0) {\n if (CCTK_Equals(parfile_write, \"copy\")) {\n CopyParFile(myGH->recovered);\n } else if (CCTK_Equals(parfile_write, \"generate\")) {\n GenerateParFile(myGH->recovered);\n }\n }\n\n return (myGH);\n}\n\n/*@@\n @routine CopyParFile\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Copies the original parameter file to a new one in 'IO::out_dir'.\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be opened for reading,<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int CopyParFile(int recovered) {\n int in_parfile, out_parfile, bytes, bytes_written, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and open it for reading */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n in_parfile = open(buffer, O_RDONLY);\n if (in_parfile < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't open original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n /* use the file mode of the original parfile to create the new one */\n if (fstat(in_parfile, &in_stat_buf)) {\n in_stat_buf.st_mode = 0644;\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be copied.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n /* binary-copy the input parfile to the output parfile */\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n while ((bytes = read(in_parfile, buffer, sizeof(buffer))) > 0) {\n bytes_written = write(out_parfile, buffer, bytes);\n if (bytes_written != bytes) {\n if (bytes_written < 0) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s' (%s)\",\n out_parfilename, strerror(errno));\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Error while writing parameter file '%s'\",\n out_parfilename);\n }\n }\n }\n close(out_parfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n }\n\n /* clean up */\n close(in_parfile);\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Tue 18 Dec 2001\n @author Thomas Radke\n @desc\n Generates a new parameter file in 'IO::out_dir' with an\n ActiveThorns list and a sorted list of all active parameters\n which have been set in the original parameter file.<BR>\n Note that the new parameter file will usually overwrite an\n existing file unless\n - the new parameter file is identical with the original one\n - this is a recovery run\n @enddesc\n @calls CCTK_ParameterFilename\n\n @var recovered\n @vdesc flag indicating whether this is a recovery run\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if original parameter file couldn't be stat(2),<BR>\n -2 if new parameter file couldn't be opened for writing<BR>\n @endreturndesc\n@@*/\nstatic int GenerateParFile(int recovered) {\n FILE *outfile;\n int out_parfile, flags;\n char *out_parfilename, buffer[1024];\n const char *my_parfile_name;\n struct stat in_stat_buf, out_stat_buf;\n DECLARE_CCTK_PARAMETERS\n\n /* get the name of the original parfile and stat(2) it */\n CCTK_ParameterFilename(sizeof(buffer), buffer);\n if (stat(buffer, &in_stat_buf)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't stat(2) original parameter file '%s' (%s)\", buffer,\n strerror(errno));\n return (-1);\n }\n\n /* build the name of the output parfile */\n my_parfile_name = parfile_name;\n if (!*my_parfile_name) {\n /* cut off any path names */\n my_parfile_name = strrchr(buffer, '/');\n if (my_parfile_name) {\n my_parfile_name++;\n } else {\n my_parfile_name = buffer;\n }\n }\n out_parfilename = malloc(strlen(out_dir) + strlen(my_parfile_name) + 2);\n sprintf(out_parfilename, \"%s/%s\", out_dir, my_parfile_name);\n\n /* check whether input and output files are identical */\n if (!stat(out_parfilename, &out_stat_buf) &&\n in_stat_buf.st_ino == out_stat_buf.st_ino) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Parameter file '%s' to be written into directory '%s' is \"\n \"identical with original parameter file. Parameter file will \"\n \"not be generated.\",\n my_parfile_name, out_dir);\n out_parfile = 0;\n } else {\n flags = O_CREAT | O_TRUNC | O_WRONLY;\n if (recovered) {\n flags |= O_EXCL;\n }\n\n out_parfile = open(out_parfilename, flags, in_stat_buf.st_mode);\n if (out_parfile >= 0) {\n outfile = fdopen(out_parfile, \"w\");\n }\n if (out_parfile >= 0 && outfile) {\n fprintf(outfile, \"# '%s' automatically generated by Cactus version %s\\n\",\n out_parfilename, CCTK_FullVersion());\n fprintf(outfile, \"# Original parameter file was '%s'\\n\", buffer);\n Util_CurrentTime(sizeof(buffer), buffer);\n fprintf(outfile, \"# Run time/date was %s \", buffer);\n Util_CurrentDate(sizeof(buffer), buffer);\n fprintf(outfile, \"%s \", buffer);\n Util_GetHostName(buffer, sizeof(buffer));\n fprintf(outfile, \"on host '%s' with %d processor(s)\\n\\n\", buffer,\n CCTK_nProcs(NULL));\n DumpParameters(outfile);\n fclose(outfile);\n } else {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't write parameter file '%s' (%s)\", out_parfilename,\n strerror(errno));\n }\n if (out_parfile >= 0) {\n close(out_parfile);\n }\n }\n\n /* clean up */\n free(out_parfilename);\n\n return (out_parfile >= 0 ? 0 : -2);\n}\n\n/*@@\n @routine DumpParameters\n @date Thu Oct 25 2001\n @author Thomas Radke\n @desc\n Dumps parameter settings of all active thorns into a file.\n @enddesc\n @calls CCTK_NumCompiledThorns\n CCTK_CompiledThorn\n CCTK_IsThornActive\n CCTK_ParameterWalk\n CCTK_ParameterValString\n\n @var parfile\n @vdesc open file descriptor for the output file\n @vtype FILE *\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 if file descriptor is invalid\n @endreturndesc\n@@*/\nstatic int DumpParameters(FILE *outfile) {\n int thorn, first, num_thorns;\n int len, maxname_len;\n const char *thornname;\n char *param;\n const cParamData *pdata;\n t_param_list *list, *last, *new;\n const char *quoted_format = \"%s::%-*s = \\\"%s\\\"\\n\",\n *non_quoted_format = \"%s::%-*s = %s\\n\";\n\n /* check passed file descriptor */\n if (outfile == NULL) {\n return (-1);\n }\n\n num_thorns = CCTK_NumCompiledThorns();\n\n /* loop over all thorns to print the 'ActiveThorns' list */\n first = 1;\n fputs(\"ActiveThorns = \\\"\", outfile);\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns and \"Cactus\" */\n if (strcmp(\"Cactus\", thornname) && CCTK_IsThornActive(thornname)) {\n if (!first) {\n putc(' ', outfile);\n }\n fputs(thornname, outfile);\n first = 0;\n }\n }\n fputs(\"\\\"\\n\", outfile);\n\n /* loop over all thorns */\n for (thorn = 0; thorn < num_thorns; thorn++) {\n thornname = CCTK_CompiledThorn(thorn);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thornname)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n maxname_len = 0;\n list = last = NULL;\n first = 1;\n while (CCTK_ParameterWalk(first, thornname, ¶m, &pdata) == 0) {\n first = 0;\n\n /* skip the parameters which weren't explicitely set */\n if (pdata->n_set > 0) {\n new = malloc(sizeof(t_param_list));\n if (new) {\n new->value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (new->value) {\n new->format_string =\n pdata->type == PARAMETER_INT || pdata->type == PARAMETER_REAL\n ? non_quoted_format\n : quoted_format;\n new->name = pdata->name;\n len = strlen(new->name);\n if (len > maxname_len) {\n maxname_len = len;\n }\n if (last) {\n last->next = new;\n last = new;\n } else {\n list = last = new;\n }\n last->next = NULL;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n free(new);\n }\n } else {\n CCTK_WARN(1, \"Couldn't allocate list element\");\n }\n }\n free(param);\n } /* end of loop walking over all parameters of given thorn */\n\n /* finally dump out the list for this thorn */\n if (list) {\n fprintf(outfile, \"\\n# Parameters of thorn %s (implementing %s)\\n\",\n thornname, CCTK_ThornImplementation(thornname));\n }\n while (list) {\n fprintf(outfile, list->format_string, thornname, maxname_len, list->name,\n list->value);\n free(list->value);\n last = list->next;\n free(list);\n list = last;\n }\n } /* end of looping over all thorns */\n\n return (0);\n}\n"},"context_filenames":{"kind":"string","value":"ioutil_CheckpointRecovery.h\nUtils.c\nmake.code.defn\nioutil_AdvertisedFiles.h\nioGH.h\nioutil_Utils.h\nAdvertisedFiles.c\nCheckpointRecovery.c\n"},"context":{"kind":"string","value":"ioutil_CheckpointRecovery.h:\n```\n/*@@\n @header ioutil_CheckpointRecovery.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Typedefs and function prototypes for checkpointing and recovery.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_\n#define _IOUTIL_CHECKPOINTRECOVERY_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* enums for checkpointing/recovery and filereader functions */\nenum {\n CP_INITIAL_DATA,\n CP_EVOLUTION_DATA,\n CP_RECOVER_PARAMETERS,\n CP_RECOVER_DATA,\n FILEREADER_DATA\n};\n\n/************************************************************************\n *\n * Function prototypes\n *\n ************************************************************************/\n\n/* create a checkpoint filename */\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked);\n\n/* register a new recovery method */\nint IOUtil_RegisterRecover(const char *name,\n int (*func)(cGH *, const char *, int));\n\n/* recover variables from a list of data files */\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars);\n\n/* generic recovery routine called by other IO thorns */\nint IOUtil_RecoverParameters(int (*recoverFn)(cGH *GH, const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType);\n\n/* return the parameter database as one single string */\nchar *IOUtil_GetAllParameters(const cGH *GH, int all);\n\n/* set all parameters contained in the given string */\nvoid IOUtil_SetAllParameters(const char *parameters);\n\n/* print the checkpoint/recovery timings to stdout */\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_CHECKPOINTRECOVERY_H_ */\n\n```\n\nUtils.c:\n```\n/*@@\n @file Utils.c\n @date Tue 4th July 2000\n @author Gabrielle Allen\n @desc\n Utility routines which may be called by other I/O thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include <math.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"util_String.h\"\n#include \"util_Table.h\"\n#include \"ioGH.h\"\n#include \"ioutil_Utils.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_Utils_c)\n\n/********************************************************************\n ******************** Macro Definitions ************************\n ********************************************************************/\n/* uncomment this if you want some debugging output */\n/* #define DEBUG_IOUTIL 1 */\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n const cGH *GH;\n ioRequest **request_list;\n const char *method_name;\n const char *parameter_name;\n int out_every_default;\n CCTK_REAL out_dt_default;\n} info_t;\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg);\n\n/*@@\n @routine IOUtil_ParseVarsForOutput\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Parses the given 'out_vars' string as a list of variable and/or\n groupnames. If an option string is appended to a name this will\n be parsed for I/O request options.\n @enddesc\n\n @calls CCTK_TraverseString\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether stop with a level-0 warning message\n on parsing errors\n @vtype int\n @vio in\n @endvar\n @var out_vars\n @vdesc string with list of variables and/or group names to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_default\n @vdesc default output frequency to set the I/O request to\n @vtype int\n @vio in\n @endvar\n @var out_dt_default\n @vdesc default output frequency to set the I/O request to\n @vtype CCTK_REAL\n @vio in\n @endvar\n @var request_list\n @vdesc list of I/O requests to fill out\n @vtype ioRequest *[]\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]) {\n int i;\n info_t info;\n\n /* free current list of I/O requests */\n for (i = CCTK_NumVars() - 1; i >= 0; i--) {\n if (request_list[i]) {\n IOUtil_FreeIORequest(&request_list[i]);\n }\n }\n\n /* generate new list of I/O requests */\n info.GH = GH;\n info.request_list = request_list;\n info.method_name = method_name;\n info.parameter_name = parameter_name;\n info.out_every_default = out_every_default;\n info.out_dt_default = out_dt_default;\n if (CCTK_TraverseString(out_vars, SetOutputVar, &info, CCTK_GROUP_OR_VAR) <\n 0) {\n CCTK_VWarn(stop_on_parse_errors ? 0 : 1, __LINE__, __FILE__,\n CCTK_THORNSTRING, \"error while parsing parameter '%s'\",\n parameter_name);\n }\n}\n\n/*@@\n @routine IOUtil_FreeIORequest\n @date Fri 26 April 2002\n @author Thomas Radke\n @desc\n Frees an I/O request description.\n @enddesc\n\n @var request\n @vdesc pointer to the I/O request structure\n @vtype ioRequest **\n @vio inout\n @endvar\n@@*/\nvoid IOUtil_FreeIORequest(ioRequest **request) {\n free((*request)->reductions);\n free((*request)->vectors);\n free(*request);\n *request = NULL;\n}\n\n/*@@\n @routine IOUtil_ParseOutputFrequency\n @date Mon 27 May 2002\n @author Thomas Radke\n @desc\n Parses the option string for a given variable for the\n 'out_every' and 'out_dt' options and sets its output\n frequency.\n @enddesc\n\n @calls Util_TableCreateFromString\n\n @var method_name\n @vdesc name of the originating I/O method\n @vtype const char *\n @vio in\n @endvar\n @var parameter_name\n @vdesc name of the originating I/O parameter to parse\n @vtype const char *\n @vio in\n @endvar\n @var stop_on_parse_errors\n @vdesc flag indicating whether to stop with level-0 warning message\n on a parsing error\n @vtype int\n @vio in\n @endvar\n @var vindex\n @vdesc index of the variable to set the output frequency\n @vtype int\n @vio in\n @endvar\n @var optstring\n @vdesc option string to parse\n @vtype const char *\n @vio in\n @endvar\n @var out_every_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype int *\n @vio out\n @endvar\n @var out_dt_ptr\n @vdesc pointer to the variable's output frequency flag\n @vtype CCTK_REAL *\n @vio out\n @endvar\n@@*/\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every_ptr,\n CCTK_REAL *out_dt_ptr) {\n int table, iterator, warnlevel;\n char key[128];\n char *fullname;\n CCTK_INT type, nelems;\n DECLARE_CCTK_PARAMETERS\n\n warnlevel = stop_on_parse_errors ? 0 : 1;\n fullname = CCTK_FullName(vindex);\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, out_every_ptr, \"out_every\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, out_dt_ptr, \"out_dt\");\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* warn about other options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n parameter_name);\n CCTK_VWarn(warnlevel, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n method_name, fullname);\n }\n free(fullname);\n}\n\n/*@@\n @routine IOUtil_1DLines\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 1D lines\n for output on a multidimensional regular Cartesian unigrid.\n The first slot of the array specifies the 1D line direction,\n the second slot fixes the indices of the starting point\n of that line on the grid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 1D lines given by grid point indices\n @vtype const int [num_dims][num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 1D lines given by physical coordinates\n @vtype const CCTK_REAL [num_dims][num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 1D line slice center\n @vtype int [num_dims][num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *slice_center) {\n int dim, dir, coord_system_handle = -1, have_coords, have_origin_index, len;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n for (dim = 0; dim < num_dims && have_origin_index; dim++) {\n have_origin_index = origin_index[dir][dim] >= 0;\n }\n }\n\n /* if no coordinate info is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 1D lines from %dD variables\",\n num_dims, num_dims);\n for (dir = 0; dir < num_dims; dir++) {\n memset(slice_center[dir], 0, num_dims * sizeof(int));\n }\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (!have_origin_index) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: Could not get ranges for %c-direction \"\n \"of associated default coordinate system '%s'\",\n 'x' + dir, coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n for (dim = 0; dim < num_dims; dim++) {\n if (dim == dir) {\n /* line always starts at the first point */\n slice_center[dir][dim] = 0;\n } else if (origin_index[dir][dim] >= 0) {\n /* FIXME: check upper index bounds also ?? */\n slice_center[dir][dim] = origin_index[dir][dim];\n } else if (lower[dim] > origin_phys[dir][dim] ||\n upper[dim] < origin_phys[dir][dim]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: %c-coordinate (%f) for slice center of \"\n \"1D lines in %c-direction for %dD variables is out of \"\n \"grid coordinates range (%f, %f)\",\n 'x' + dim, (double)origin_phys[dir][dim], 'x' + dir,\n num_dims, (double)lower[dim], (double)upper[dim]);\n\n slice_center[dir][dim] =\n origin_index[dir][dim] == -1\n ? 0\n : ceil((upper[dim] - lower[dim]) / (2 * delta[dim]) - 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_1DLines: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir][dim]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir][dim] =\n ceil((origin_phys[dir][dim] - lower[dim]) / delta[dim] - 1e-6);\n\n#ifdef DEBUG_IOUTIL\n printf(\"spxyz for %c-coord of lines in %c-direction is %d\\n\", 'x' + dim,\n 'x' + dir, slice_center[dir][dim]);\n#endif\n }\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_2DPlanes\n @date July 4 2000\n @author Gabrielle Allen, Gerd Lanfermann, Thomas Radke\n @desc\n Fills out an array determining where to position 2D planes\n for output on a multidimensional regular Cartesian unigrid.\n @enddesc\n\n @calls Coord_GetDefaultSystem\n\n @var GH\n @vdesc Pointer to CCTK GH\n @vtype const cGH *\n @vio in\n @endvar\n @var num_dims\n @vdesc number of dimensions of underlying grid\n @vtype int\n @vio in\n @endvar\n @var origin_index\n @vdesc origin for 2D planes given by grid point indices\n @vtype const int [num_dims]\n @vio in\n @endvar\n @var origin_phys\n @vdesc origin for 2D planes given by physical coordinates\n @vtype const CCTK_REAL [num_dims]\n @vio in\n @endvar\n @var slice_center\n @vdesc resulting 2D plane slice center\n @vtype int [num_dims]\n @vio out\n @endvar\n\n @returntype int\n @returndesc\n 0 for success\n -1 no coordinate system of given dimensions found\n @endreturndesc\n @@*/\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center) {\n int have_coords, have_origin_index, len, coord_system_handle = -1, dir;\n char *coord_system_name;\n CCTK_INT *coord_handles = NULL;\n CCTK_REAL *lower, *upper, *delta;\n\n /* get the default coordinate system associated with this grid dimension */\n coord_system_name = NULL;\n have_coords = CCTK_IsFunctionAliased(\"Coord_GetDefaultSystem\");\n if (have_coords) {\n coord_system_handle = Coord_GetDefaultSystem(GH, num_dims);\n coord_handles = malloc(num_dims * sizeof(CCTK_INT));\n have_coords = coord_system_handle >= 0 &&\n Util_TableGetIntArray(coord_system_handle, num_dims,\n coord_handles, \"COORDINATES\") >= 0;\n }\n if (have_coords) {\n len = Util_TableGetString(coord_system_handle, 0, NULL, \"NAME\");\n have_coords = len > 0;\n if (have_coords) {\n coord_system_name = malloc(len);\n Util_TableGetString(coord_system_handle, len, coord_system_name, \"NAME\");\n have_coords = Util_StrCmpi(coord_system_name, \"cart\");\n }\n }\n\n /* check that origin_index[] is valid */\n have_origin_index = origin_index != NULL;\n for (dir = 0; dir < num_dims && have_origin_index; dir++) {\n have_origin_index = origin_index[dir] >= 0;\n }\n\n /* if no coordinate system is available then origin_index[] must be given */\n if (!have_coords && !have_origin_index) {\n CCTK_VWarn(3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Found no default Cartesian coordinate system \"\n \"associated with grid variables of dimension %d, and no slice \"\n \"center index coordinates were given either - slice center \"\n \"will not be set up for output of 2D planes from %dD variables\",\n num_dims, num_dims);\n\n free(coord_handles);\n free(coord_system_name);\n\n return (-1);\n }\n\n /* get the ranges in every direction */\n lower = calloc(3 * num_dims, sizeof(CCTK_REAL));\n upper = lower + 1 * num_dims;\n delta = lower + 2 * num_dims;\n if (have_coords) {\n for (dir = 0; dir < num_dims; dir++) {\n if (Util_TableGetReal(coord_handles[dir], &lower[dir], \"COMPMIN\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &upper[dir], \"COMPMAX\") < 0 ||\n Util_TableGetReal(coord_handles[dir], &delta[dir], \"DELTA\") < 0) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: Could not get ranges/deltas for \"\n \"%c-direction of associated coordinate system '%s'\",\n 'x' + (num_dims - dir - 1), coord_system_name);\n }\n }\n }\n\n /* now set the slice center for each line\n according to origin_index[] or origin_phys[] */\n for (dir = 0; dir < num_dims; dir++) {\n if (origin_index && origin_index[dir] >= 0) {\n slice_center[dir] = origin_index[dir];\n } else if (lower[num_dims - 1 - dir] > origin_phys[dir] ||\n upper[num_dims - 1 - dir] < origin_phys[dir]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: %c-coordinate for slice center of 2D \"\n \"planes (%f) is out of grid coordinates range (%f, %f)\",\n 'x' + (num_dims - dir - 1), (double)origin_phys[dir],\n (double)lower[num_dims - 1 - dir],\n (double)upper[num_dims - 1 - dir]);\n\n slice_center[dir] =\n origin_index[dir] == -1\n ? 0\n : ceil((upper[num_dims - 1 - dir] - lower[num_dims - 1 - dir]) /\n (2 * delta[num_dims - 1 - dir]) -\n 1e-6);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_2DPlanes: slice center will default to %c-index %d\",\n 'x' + dir, slice_center[dir]);\n } else {\n /* Find index for first point above the chosen coordinate */\n slice_center[dir] = ceil((origin_phys[dir] - lower[num_dims - 1 - dir]) /\n delta[num_dims - 1 - dir] -\n 1e-6);\n#ifdef DEBUG_IOUTIL\n printf(\"sp2xyz for planes perpendicular to %d-direction is %d\\n\", dir,\n slice_center[dir]);\n#endif\n }\n }\n\n free(lower);\n free(coord_handles);\n free(coord_system_name);\n\n return (0);\n}\n\n/*@@\n @routine IOUtil_PrintTimings\n @date Wed Jun 28 2000\n @author Thomas Radke\n @desc\n Gets the timing information for the given timers and prints it\n as INFO messages to screen.\n @enddesc\n @history\n @endhistory\n @var description\n @vdesc description of the timers\n @vtype const char *\n @vio in\n @endvar\n @var ntimers\n @vdesc number of timers passed in\n @vtype int\n @vio in\n @endvar\n @var timers\n @vdesc array of timers\n @vtype const int [ntimers]\n @vio in\n @endvar\n @var timer_descriptions\n @vdesc array of timer descriptions\n @vtype const char *const [ntimers]\n @vio in\n @endvar\n@@*/\n\nvoid IOUtil_PrintTimings(const char *description, int ntimers,\n const int *timers,\n const char *const *const timer_descriptions) {\n int i, j;\n cTimerData *info;\n\n info = CCTK_TimerCreateData();\n if (info) {\n CCTK_INFO(description);\n\n for (i = 0; i < info->n_vals; i++) {\n for (j = 0; j < ntimers; j++) {\n CCTK_TimerI(timers[j], info);\n if (j == 0) {\n CCTK_VInfo(CCTK_THORNSTRING, \" %s:\", info->vals[i].heading);\n }\n switch (info->vals[i].type) {\n case val_int:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n info->vals[i].val.i, info->vals[i].units);\n break;\n\n case val_long:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5d %s\", timer_descriptions[j],\n (int)info->vals[i].val.l, info->vals[i].units);\n break;\n\n case val_double:\n CCTK_VInfo(CCTK_THORNSTRING, \" %s %5.1f %s\", timer_descriptions[j],\n info->vals[i].val.d, info->vals[i].units);\n break;\n\n default:\n CCTK_WARN(1, \"Unknown data type for timer info\");\n break;\n }\n }\n }\n CCTK_INFO(\"-----------------------------------------\");\n CCTK_TimerDestroyData(info);\n } else {\n CCTK_WARN(1, \"Couldn't create timer info structure ! \"\n \"No timing output available.\");\n }\n}\n\n/*@@\n @routine IOUtil_CreateDirectory\n @date Fri 10 Aug 2001\n @author Thomas Radke\n @desc\n Creates an output directory path and makes sure it is visible\n on all I/O processors.\n It is assumed that processor 0 is always an I/O processor.\n If there are other I/O processors, they will also try and\n create the directory themselfs. This guarantees the directory\n be created on all nodes in case the I/O processors don't share\n a common filesystem.\n @enddesc\n @calls CCTK_MyProc\n CCTK_CreateDirectory\n CCTK_Barrier\n\n @var GH\n @vdesc pointer to the GH extensions\n @vtype const cGH *\n @vio in\n @endvar\n @var dirname\n @vdesc the directory to create\n @vtype const char *\n @vio in\n @endvar\n @var multiple_io_procs\n @vdesc flag indicating that there will be I/O from multiple I/O procs\n @vtype int\n @vio in\n @endvar\n @var ioproc\n @vdesc I/O processor associated with this processor\n @vtype int\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for non-I/O processors, or\n return code of @seeroutine CCTK_CreateDirectory\n @endreturndesc\n@@*/\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc) {\n int myproc, retval;\n\n /* default return value for non-I/O processors */\n retval = 0;\n\n /* first, processor 0 creates the directory */\n myproc = CCTK_MyProc(GH);\n if (myproc == 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n\n if (multiple_io_procs) {\n /* now the other I/O processors create the directory\n after syncing with processor 0 */\n CCTK_Barrier(GH);\n if (myproc == ioproc || ioproc != 0) {\n retval = CCTK_CreateDirectory(0755, dirname);\n }\n }\n\n return (retval);\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic void SetOutputVar(int vindex, const char *optstring, void *arg) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n CCTK_INT *refinement_levels;\n char *fullname;\n const info_t *info = arg;\n ioRequest *request;\n DECLARE_CCTK_PARAMETERS\n\n /* allocate a new I/O request structure and initialize it with defaults */\n request = IOUtil_DefaultIORequest(info->GH, vindex, info->out_every_default,\n info->out_dt_default);\n\n if (!optstring) {\n info->request_list[vindex] = request;\n return;\n }\n\n fullname = CCTK_FullName(vindex);\n\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n /* check for option 'out_every' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_every\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->out_every, \"out_every\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_every' in option string \"\n \"'%s' in parameter '%s' (must be an integer)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_every' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_every\");\n }\n\n /* check for option 'out_dt' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_dt\") > 0) {\n if (type == CCTK_VARIABLE_REAL && nelems == 1) {\n Util_TableGetReal(table, &request->out_dt, \"out_dt\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_dt' in option string \"\n \"'%s' in parameter '%s' (must be real)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_dt' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_dt\");\n }\n\n /* check for boolean option 'out_unchunked' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"out_unchunked\") > 0) {\n int unchunked = -1;\n if (type == CCTK_VARIABLE_CHAR && nelems >= (int)sizeof(\"no\") - 1 &&\n nelems <= (int)sizeof(\"false\") - 1) {\n char value[sizeof(\"false\")];\n Util_TableGetString(table, sizeof(value), value, \"out_unchunked\");\n if (CCTK_Equals(value, \"yes\") || CCTK_Equals(value, \"true\")) {\n unchunked = 1;\n } else if (CCTK_Equals(value, \"no\") || CCTK_Equals(value, \"false\")) {\n unchunked = 0;\n }\n }\n if (unchunked >= 0) {\n request->out_unchunked = unchunked;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'out_unchunked' in option string \"\n \"'%s' in parameter '%s' (must be a boolean)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'out_unchunked' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"out_unchunked\");\n }\n\n /* check for hyperslab option 'direction' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"direction\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems > 0 &&\n nelems <= request->vdim * request->vdim &&\n nelems % request->vdim == 0) {\n request->hdim = nelems / request->vdim;\n Util_TableGetIntArray(table, nelems, request->direction, \"direction\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'direction' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d x hdim elements, 1 <= hdim <= %d)\",\n optstring, info->parameter_name, (int)request->vdim,\n (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'direction' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"direction\");\n }\n\n /* check for hyperslab option 'origin' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"origin\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->vdim) {\n Util_TableGetIntArray(table, nelems, request->origin, \"origin\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'origin' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->vdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'origin' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"origin\");\n }\n\n /* check for hyperslab option 'extent' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"extent\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->extent, \"extent\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'extent' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'extent' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"extent\");\n }\n\n /* check for hyperslab option 'downsample' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"downsample\") > 0) {\n if (type == CCTK_VARIABLE_INT && nelems == request->hdim) {\n Util_TableGetIntArray(table, nelems, request->downsample, \"downsample\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'downsample' in option string \"\n \"'%s' in parameter '%s' (must be an integer array with \"\n \"%d elements)\",\n optstring, info->parameter_name, (int)request->hdim);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'downsample' will be ignored for %s output of \"\n \"variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"downsample\");\n }\n\n /* check for option 'refinement_levels' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"refinement_levels\") >\n 0) {\n request->refinement_levels = 0;\n if (type == CCTK_VARIABLE_INT && nelems > 0) {\n refinement_levels = malloc(nelems * sizeof(int));\n Util_TableGetIntArray(table, nelems, refinement_levels,\n \"refinement_levels\");\n while (--nelems >= 0) {\n if (refinement_levels[nelems] < 0) {\n request->refinement_levels = 0;\n break;\n }\n request->refinement_levels |= 1 << refinement_levels[nelems];\n }\n free(refinement_levels);\n }\n if (request->refinement_levels == 0) {\n if (CCTK_GroupTypeFromVarI(vindex) == CCTK_GF) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (must be an array of \"\n \"positive integers)\",\n optstring, info->parameter_name);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Meaningless option 'refinement_levels' in option \"\n \"string '%s' in parameter '%s' (only makes sense for \"\n \"grid functions)\",\n optstring, info->parameter_name);\n }\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'refinement_levels' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n request->refinement_levels = -1;\n }\n Util_TableDeleteKey(table, \"refinement_levels\");\n }\n\n /* check for option 'compression_level' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"compression_level\") >\n 0) {\n request->compression_level = -1;\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &request->compression_level,\n \"compression_level\");\n if (request->compression_level < 0 || request->compression_level > 9) {\n type = -1;\n request->compression_level = -1;\n }\n }\n if (!(type == CCTK_VARIABLE_INT && nelems == 1)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'compression_level' in option \"\n \"string '%s' in parameter '%s' (must be an integer in the \"\n \"range [0-9])\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'compression_level' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"compression_level\");\n }\n\n /* check for option 'reductions' */\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"reductions\") > 0) {\n request->reductions = NULL;\n if (type == CCTK_VARIABLE_CHAR && nelems >= 0) {\n request->reductions = malloc(nelems + 1);\n Util_TableGetString(table, nelems + 1, request->reductions,\n \"reductions\");\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'reductions' in option \"\n \"string '%s' in parameter '%s' (must be a string)\",\n optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option 'reductions' will be ignored for %s output \"\n \"of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableDeleteKey(table, \"reductions\");\n }\n\n /* warn about unrecognized options */\n iterator = Util_TableItCreate(table);\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s' in parameter '%s'\",\n key, optstring, info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s' in parameter '%s'\", optstring,\n info->parameter_name);\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Option string will be ignored for %s output of variable '%s'\",\n info->method_name, fullname);\n }\n\n /* assign the new I/O request */\n info->request_list[vindex] = request;\n\n /* clean up */\n free(fullname);\n}\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default) {\n int vdim;\n int *extent_int;\n ioRequest *request;\n const ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n /* check for valid variable index */\n vdim = CCTK_GroupDimFromVarI(vindex);\n if (vdim < 0) {\n return (NULL);\n }\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n\n /* allocate a new I/O request structure */\n request = malloc(sizeof(ioRequest));\n\n /* fill out the basics */\n request->vindex = vindex;\n request->timelevel = 0;\n request->check_exist = myGH->recovered;\n request->out_every = out_every_default;\n request->out_dt = out_dt_default;\n request->out_unchunked = out_unchunked;\n request->reductions = NULL;\n request->with_ghostzones = 0;\n request->refinement_levels = -1;\n request->compression_level = -1;\n\n /* get the I/O request datatype (will be single-precision if requested) */\n request->hdatatype = CCTK_VarTypeI(vindex);\n if (myGH->out_single && CCTK_GroupTypeFromVarI(vindex) != CCTK_SCALAR) {\n if (request->hdatatype == CCTK_VARIABLE_REAL) {\n request->hdatatype = CCTK_VARIABLE_REAL4;\n } else if (request->hdatatype == CCTK_VARIABLE_COMPLEX) {\n request->hdatatype = CCTK_VARIABLE_COMPLEX8;\n }\n#ifdef CCTK_INT2\n else if (request->hdatatype == CCTK_VARIABLE_INT) {\n request->hdatatype = CCTK_VARIABLE_INT2;\n }\n#endif\n }\n\n /* get the variable's dimension and extents */\n request->vdim = vdim;\n extent_int = NULL;\n if (request->vdim > 0) {\n extent_int = malloc(request->vdim * sizeof(int));\n CCTK_GroupgshVI(GH, request->vdim, extent_int, vindex);\n }\n\n /* allocate the arrays all in one go\n only initialize those which are mandatory for the Hyperslab API */\n request->vectors =\n calloc((request->vdim + 6) * request->vdim + 1, sizeof(CCTK_INT));\n request->hoffset = request->vectors + 0 * request->vdim;\n request->hsize = request->vectors + 1 * request->vdim;\n request->hsize_chunk = request->vectors + 2 * request->vdim;\n request->origin = request->vectors + 3 * request->vdim + 1;\n request->extent = request->vectors + 4 * request->vdim + 1;\n request->downsample = request->vectors + 5 * request->vdim + 1;\n request->direction = request->vectors + 6 * request->vdim + 1;\n\n for (request->hdim = 0; request->hdim < request->vdim; request->hdim++) {\n request->extent[request->hdim] = extent_int[request->hdim];\n request->direction[request->hdim * (request->vdim + 1)] = 1;\n\n /* take the downsampling parameters from IOUtil */\n if (request->hdim == 0) {\n request->downsample[request->hdim] = out_downsample_x;\n } else if (request->hdim == 1) {\n request->downsample[request->hdim] = out_downsample_y;\n } else if (request->hdim == 2) {\n request->downsample[request->hdim] = out_downsample_z;\n } else {\n request->downsample[request->hdim] = 1;\n }\n }\n\n /* clean up */\n if (extent_int) {\n free(extent_int);\n }\n\n return (request);\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn IOUtil\n# $Header$\n\n# Source files in this directory\nSRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c\n\n```\n\nioutil_AdvertisedFiles.h:\n```\n/*@@\n @header ioutil_AdvertisedFiles.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Structures and function prototypes for advertising files.\n @history\n @endhistory\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_ADVERTISED_FILES_H_\n#define _IOUTIL_ADVERTISED_FILES_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an advertised file\n It contains pointer to strings holding\n - the thorn which created the file\n - the variable name the file contents data belongs to\n - the MIME type for the file format used\n - a short slice string indication the dimensionality of the data\n - an arbitrary additional description of the file contents */\ntypedef struct {\n const char *thorn;\n const char *varname;\n const char *mimetype;\n const char *slice;\n const char *description;\n} ioAdvertisedFileDesc;\n\n/* structure containing function pointers for handling with advertised files\n For the moment it contains only a registration routine for new files to\n be advertised. In the future we might also want something like\n unadvertising, or notification when the contents of the file changed. */\ntypedef struct {\n int (*advertise)(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description);\n} ioAdvertisedFileListenerCallbacks;\n\n/* register a new listener with its own callbacks for file advertising */\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks);\n\n/* advertise a file */\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *desc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_ADVERTISED_FILES_H_ */\n\n```\n\nioGH.h:\n```\n/*@@\n @header ioGH.h\n @date Tue 9th Jan 1999\n @author Gabrielle Allen\n @desc\n The extensions to the GH structure from IOUtil.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOGH_H_\n#define _IOUTIL_IOGH_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* advertise that this is the new version of this API, which has 'alias'\n * members in the grid extension */\n#define IOUTIL_IOGH_HAS_ALIAS 1\n\n/* IOUtil's GH extension structure */\ntypedef struct {\n /* for full-dimensional parallel output */\n int ioproc; /* the I/O processor each proc belongs to */\n int nioprocs; /* total number of I/O processors */\n int ioproc_every; /* output by every N'th processor */\n int unchunked; /* if true generate unchunked output file */\n int *downsample; /* downsampling parameters array of size cctk_maxdim */\n int out_single; /* if true output 3D data in single precision */\n\n /* for recovery */\n int recovered; /* flag indicating restart after successful recovery */\n int stop_on_parse_errors; /* stop on I/O parameter parsing errors ? */\n\n /* for data file reader */\n CCTK_INT *do_inVars; /* flags indicating to read in variable i with\n iteration number do_inVars[i] (or -1 to read\n the last iteration */\n const char **alias; /* name under which a variable appears in data files.\n If NULL, use CCTK_FullName() */\n} ioGH;\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOGH_H_ */\n\n```\n\nioutil_Utils.h:\n```\n/*@@\n @header ioutil_Utils.h\n @date Tue 19 Sep 2000\n @author Thomas Radke\n @desc\n Function prototypes for setting up slice centers.\n @enddesc\n @version $Header$\n@@*/\n\n#ifndef _IOUTIL_IOUTIL_UTILS_H_\n#define _IOUTIL_IOUTIL_UTILS_H_ 1\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/* structure describing an I/O request (including hyperslab parameters) */\ntypedef struct {\n /* output frequency */\n CCTK_INT out_every;\n CCTK_REAL out_dt;\n\n /* index and timelevel of the variable */\n int vindex, timelevel;\n\n /* dimensionality of the variable and the hyperslab */\n CCTK_INT vdim, hdim;\n\n /* CCTK datatype for the hyperslab */\n int hdatatype;\n\n /* flag indicating whether an object to be written already exists\n (and remove it in that case) */\n int check_exist;\n\n /* flag indicating whether to include ghostzones in the hyperslab mapping */\n int with_ghostzones;\n\n /* flag indicating whether to output in chunked or unchunked format */\n int out_unchunked;\n\n /* compression level */\n CCTK_INT compression_level;\n\n /* pointer to allocated buffers */\n CCTK_INT *vectors;\n\n /* hyperslab mapping parameters */\n CCTK_INT *origin, *direction, *extent, *downsample;\n\n /* offset and sizes of hyperslab into the variable's dataspace */\n CCTK_INT *hoffset, *hsize, *hsize_chunk;\n\n /* bitmask for refinement levels to output */\n CCTK_INT refinement_levels;\n\n /* list of reductions to output */\n char *reductions;\n\n} ioRequest;\n\n/* Advertise that this is the new version of this API, which has\n 'out_dt' arguments in the IOUtil_* functions below */\n#define IOUTIL_PARSER_HAS_OUT_DT 1\n\n/* parse a given 'out_vars' parameter string */\nvoid IOUtil_ParseVarsForOutput(const cGH *GH, const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, const char *out_vars,\n int out_every_default, CCTK_REAL out_dt_default,\n ioRequest *request_list[]);\n\n/* parse a given I/O parameter option string for the 'out_every' and\n 'out_dt' options */\nvoid IOUtil_ParseOutputFrequency(const char *method_name,\n const char *parameter_name,\n int stop_on_parse_errors, int vindex,\n const char *optstring, CCTK_INT *out_every,\n CCTK_REAL *out_dt);\n\n/* return the default I/O request description structure for a variable */\nioRequest *IOUtil_DefaultIORequest(const cGH *GH, int vindex,\n int out_every_default,\n CCTK_REAL out_dt_default);\n\n/* free an I/O request description */\nvoid IOUtil_FreeIORequest(ioRequest **request);\n\n/* set the slice center for 1D lines */\nint IOUtil_1DLines(const cGH *GH, int num_dims, int *const *const origin_index,\n CCTK_REAL *const *const origin_phys,\n int *const *const slice_center);\n\n/* set the slice center for 2D planes */\nint IOUtil_2DPlanes(const cGH *GH, int num_dims, const int *origin_index,\n const CCTK_REAL *origin_phys, int *slice_center);\n\n/* create an output directory on all I/O processors */\nint IOUtil_CreateDirectory(const cGH *GH, const char *dirname,\n int multiple_io_procs, int ioproc);\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* _IOUTIL_IOUTIL_UTILS_H_ */\n\n```\n\nAdvertisedFiles.c:\n```\n/*@@\n @file AdvertisedFiles.c\n @date Mon 18 Sep 2000\n @author Thomas Radke\n @desc\n IOUtil file advertising stuff.\n @enddesc\n @history\n @endhistory\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"StoreNamedData.h\"\n#include \"ioGH.h\"\n#include \"ioutil_AdvertisedFiles.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_AdvertisedFiles_c)\n\n/********************************************************************\n ********************* Local Data *****************************\n ********************************************************************/\n\n/* database holding all registered listeners for file advertising */\nstatic pNamedData *listener_DB = NULL;\n\n/*@@\n @routine IOUtil_RegisterAdvertisedFileListener\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Registers a listener with its callbacks for\n advertised file handling\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var listener\n @vdesc identification of the listener to be registered\n @vtype const char *\n @vio in\n @endvar\n @var callbacks\n @vdesc structure containing the listener's callback routines\n @vtype const ioAdvertisedFileListenerCallbacks *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns\n 0 on success\n -1 if memory allocation failed or NULL pointers were passed\n @endreturndesc\n@@*/\n\nint IOUtil_RegisterAdvertisedFileListener(\n const cGH *GH, const char *listener,\n const ioAdvertisedFileListenerCallbacks *callbacks) {\n int retval = -1;\n ioAdvertisedFileListenerCallbacks *new_callbacks;\n\n /* prevent compiler warning about unused parameter */\n GH = GH;\n\n if (listener && callbacks) {\n new_callbacks = (ioAdvertisedFileListenerCallbacks *)malloc(\n sizeof(ioAdvertisedFileListenerCallbacks));\n if (new_callbacks) {\n *new_callbacks = *callbacks;\n retval = StoreNamedData(&listener_DB, listener, new_callbacks);\n if (retval)\n free(new_callbacks);\n }\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AdvertiseFile\n @date Wed May 17 2000\n @author Thomas Radke\n @desc\n Adds a filename to the list of advertised files for downloading.\n The routine calls all listeners which are currently registered\n for advertised file handling.\n @enddesc\n @history\n @endhistory\n @var GH\n @vdesc pointer to grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var filename\n @vdesc name of the file to advertise\n @vtype const char *\n @vio in\n @endvar\n @var description\n @vdesc structure which describes the file\n @vtype const ioAdvertisedFileDesc *\n @vio in\n @endvar\n @returntype int\n @returndesc This routine returns the logically OR'ed return values\n of all listeners' advertise callbacks called.\n @endreturndesc\n@@*/\n\nint IOUtil_AdvertiseFile(const cGH *GH, const char *filename,\n const ioAdvertisedFileDesc *description) {\n int retval = 0;\n pNamedData *listener;\n ioAdvertisedFileListenerCallbacks *callbacks;\n\n /* get the listener database from IOUtil's GH extension */\n listener = listener_DB;\n\n /* loop through all listeners' advertise() callbacks */\n while (listener) {\n callbacks = (ioAdvertisedFileListenerCallbacks *)listener->data;\n if (callbacks && callbacks->advertise)\n retval |= (callbacks->advertise)(GH, filename, description);\n listener = listener->next;\n }\n\n return (retval);\n}\n\n```\n\nCheckpointRecovery.c:\n```\n/*@@\n @file CheckpointRecovery.c\n @date Jun 04 1999\n @author Thomas Radke\n @desc\n Utility routines for checkpointing/recovery and the filereader\n The actual work is done by the IO thorns.\n @enddesc\n @version $Id$\n @@*/\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n#include \"cctk_FortranString.h\"\n#include \"util_Table.h\"\n\n#include \"ioGH.h\"\n#include \"ioutil_CheckpointRecovery.h\"\n\n#include <ctype.h>\n#include <stdio.h>\n#include <string.h>\n#include <stdlib.h>\n#include <stdbool.h>\n#ifdef HAVE_DIRENT_H\n#include <dirent.h>\n#endif\n\n#include \"util_String.h\"\n\nstatic const char *rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_IOUtil_CheckpointRecovery_c)\n\n/********************************************************************\n ******************** External Routines ************************\n ********************************************************************/\nvoid IOUtil_RecoverGH(cGH *GH);\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH);\nvoid CCTK_FCALL CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result,\n cGH **GH,\n TWO_FORTSTRING_ARG);\n\n/********************************************************************\n ******************** Static Variables *************************\n ********************************************************************/\n/* table to store registered recovery functions */\nstatic int recover_fn_table = -1;\nstatic int checkpoint_file_exists = 0;\n\n/********************************************************************\n ******************** Internal Typedefs ************************\n ********************************************************************/\ntypedef struct {\n char *basename;\n int iteration;\n} filelist_t;\n\ntypedef int (*recover_fn_t)(cGH *GH, const char *basefilename, int called_from);\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\nstatic char *EncodeString(const char *string);\nstatic char *DecodeString(const char *string);\nstatic int OctalDigitToInt(const char digit);\nstatic void SetInputFlag(int vindex, const char *optstring, void *arg);\n#ifdef HAVE_DIRENT_H\nstatic int CompareFiles(const void *a, const void *b);\n#endif\n\n/************************************************************************\n *\n * Registration functions for Restoring from IO Files\n *\n ************************************************************************/\n\n/*@@\n @routine IOUtil_RegisterRecover\n @date Monday 21 June 1999\n @author Gabrielle Allen\n @desc\n Registers a new recovery method\n @enddesc\n @calls Util_GetHandle\n Util_NewHandle\n\n @var name\n @vdesc The name of the function for recovery\n @vtype const char *\n @vio in\n @endvar\n @var recover_fn\n @vdesc the recovery function to register\n @vtype recover_fn_t\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 for success, or<BR>\n -1 method with this name already registered\n @endreturndesc\n@@*/\nint IOUtil_RegisterRecover(const char *name, recover_fn_t recover_fn) {\n int retval;\n\n /* create the function pointer table on the first time through */\n if (recover_fn_table < 0) {\n recover_fn_table = Util_TableCreate(UTIL_TABLE_FLAGS_DEFAULT);\n }\n\n /* check that the method hasn't already been registered */\n retval =\n Util_TableQueryValueInfo(recover_fn_table, NULL, NULL, name) ? -1 : 0;\n if (!retval) {\n Util_TableSetFnPointer(recover_fn_table, (CCTK_FPOINTER)recover_fn, name);\n }\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_AssembleFilename\n @date 30 June 2004\n @author Thomas Radke\n @desc\n This routine assembles the full basename for checkpoint/recovery\n and filereader files, paying attention to the different types:\n\n * it returns the full filename (directory+filename)\n * for cp files it prepends the iteration number as \"it_%d\"\n * for chunked files it prepends the file number as \"file_%d\"\n\n This routine replaces the old routine IOUtil_PrepareFilename()\n which should not be used anymore.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basename of the file\n @vtype const char *\n @vio in\n @endvar\n @var postfix\n @vdesc optional postfix to append to the basename\n (eg. \".tmp\" for temporary files, or \"\" for no postfix)\n @vtype const char *\n @vio in\n @var extension\n @vdesc file extension to append to the basefilename\n (should be given with the dot, eg. as \".h5\")\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n @var file_ioproc\n @vdesc the IO processor number (for chunked files)\n @vtype int\n @vio in\n @endvar\n @var file_unchunked\n @vdesc flag to indicate whether file mode is unchunked or not\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc\n the filename (must be freed after use)\n @endreturndesc\n@@*/\nchar *IOUtil_AssembleFilename(const cGH *GH, const char *basefilename,\n const char *postfix, const char *extension,\n int called_from, int file_ioproc,\n int file_unchunked) {\n DECLARE_CCTK_PARAMETERS\n size_t filenamelen;\n char *filename;\n const char *dir, *basename;\n char iteration_postfix[32], filenumber_postfix[32];\n\n /* get the right parameters */\n dir = basename = NULL;\n switch (called_from) {\n case CP_INITIAL_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_ID_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_EVOLUTION_DATA:\n dir = checkpoint_dir;\n basename = checkpoint_file;\n if (CCTK_CreateDirectory(0755, checkpoint_dir) < 0)\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Checkpoint directory %s could not be created\",\n checkpoint_dir);\n break;\n\n case CP_RECOVER_DATA:\n case CP_RECOVER_PARAMETERS:\n dir = recover_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n case FILEREADER_DATA:\n dir = filereader_ID_dir;\n basename = basefilename ? basefilename : recover_file;\n break;\n\n default:\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"IOUtil_AssembleFilename: unknown calling mode %d\", called_from);\n break;\n }\n\n /* if checkpoint filename, merge in the iteration number\n and for chunked files also the file number */\n iteration_postfix[0] = 0;\n if (called_from == CP_INITIAL_DATA || called_from == CP_EVOLUTION_DATA) {\n Util_snprintf(iteration_postfix, sizeof(iteration_postfix), \".it_%d\",\n (int)GH->cctk_iteration);\n }\n\n /* If not one unchunked file give a file number */\n filenumber_postfix[0] = 0;\n if (!file_unchunked) {\n Util_snprintf(filenumber_postfix, sizeof(filenumber_postfix), \".file_%d\",\n file_ioproc);\n }\n\n if (!(dir && basename && postfix && extension))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\",\n \"Directory, basename, postfix or extension error\");\n filenamelen = strlen(dir) + strlen(basename) + strlen(postfix) +\n strlen(iteration_postfix) + strlen(filenumber_postfix) +\n strlen(extension) + 2;\n filename = malloc(filenamelen);\n if (!(filename))\n CCTK_VWarn(0, __LINE__, __FILE__, \"IOUtil\", \"File name error\");\n Util_snprintf(filename, filenamelen, \"%s/%s%s%s%s%s\", dir, basename, postfix,\n iteration_postfix, filenumber_postfix, extension);\n\n return (filename);\n}\n\n/*@@\n @routine IOUtil_RecoverFromFile\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n Recover from a given file.\n This routine loops through all XXX_RecoverGH routines\n registered by IO thorns.\n @enddesc\n @calls Util_GetHandledData\n <registered RecoverGH routines>\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var basefilename\n @vdesc basefilename of the file(s) to recover from\n @vtype const char *\n @vio in\n @endvar\n @var called_from\n @vdesc indicates the caller function:\n * either Filereader (FILEREADER_DATA)\n * or IOUtil_RecoverGH() (CP_RECOVER_DATA)\n @vtype int\n @vio in\n @endvar\n@@*/\nstatic int IOUtil_RecoverFromFile(cGH *GH, const char *basefilename,\n int called_from) {\n int keylen, ihandle, retval;\n char *key;\n CCTK_FPOINTER func;\n recover_fn_t recover_fn;\n\n if (Util_TableQueryNKeys(recover_fn_table) <= 0) {\n CCTK_WARN(1, \"IOUtil_RecoverFromFile: No recovery routines \"\n \"were registered\");\n return (-1);\n }\n\n keylen = Util_TableQueryMaxKeyLength(recover_fn_table) + 1;\n key = malloc(keylen);\n\n for (ihandle = Util_TableItCreate(recover_fn_table), retval = -1;\n Util_TableItQueryIsNonNull(ihandle) > 0 && retval < 0;\n Util_TableItAdvance(ihandle)) {\n Util_TableItQueryKeyValueInfo(ihandle, keylen, key, NULL, NULL);\n Util_TableGetFnPointer(recover_fn_table, &func, key);\n if (func) {\n recover_fn = (recover_fn_t)func;\n retval = recover_fn(GH, basefilename, called_from);\n }\n }\n free(key);\n Util_TableItDestroy(ihandle);\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_RecoverGH\n @date Jun 14 1999\n @author Thomas Radke\n @desc\n The rfr-registered recovery routine.\n Just calls IOUtil_RecoverFromFile()\n with called_from == CP_RECOVER_DATA.\n @enddesc\n @calls IOUtil_RecoverFromFile\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverGH(cGH *GH) {\n if (checkpoint_file_exists) {\n /* stop if recovery failed */\n if (IOUtil_RecoverFromFile(GH, NULL, CP_RECOVER_DATA) < 0) {\n CCTK_WARN(0, \"Failed to restart from recovery !\");\n }\n }\n}\n\n/*@@\n @routine IOUtil_RecoverVarsFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n IOUtil's function interface to recover variables from data files.\n Any thorn can call this routine with a list of datafile names\n and a list of variables to read in from these files. <BR>\n\n It just calls IOUtil_RecoverFromFile() with\n called_from == FILEREADER_DATA for each data file\n from the given file list.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n @var in_files\n @vdesc list of filenames to process (separated by spaces)\n @vtype const char *\n @vio in\n @endvar\n @var in_vars\n @vdesc list of variable fullnames to read in from the files\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n total number of recovered variables\n @endreturndesc\n@@*/\nint IOUtil_RecoverVarsFromDatafiles(cGH *GH, const char *in_files,\n const char *in_vars) {\n int retval, num_recovered_vars;\n ioGH *myGH;\n char *basefilename, *delim, delim_char;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n if (myGH == NULL) {\n CCTK_WARN(0, \"invalid cctkGH pointer passed into \"\n \"IOUtil_RecoverVarsFromDatafiles()\");\n }\n\n if (CCTK_NumVars() > 0) {\n void *calldata[2];\n myGH->do_inVars = calloc(CCTK_NumVars(), sizeof(CCTK_INT));\n myGH->alias = calloc(CCTK_NumVars(), sizeof(char *));\n calldata[0] = myGH->do_inVars;\n calldata[1] = myGH->alias;\n if (CCTK_TraverseString(in_vars, SetInputFlag, calldata,\n CCTK_GROUP_OR_VAR) < 0) {\n CCTK_WARN(myGH->stop_on_parse_errors ? 0 : 1,\n \"error while parsing parameter 'IO::filereader_ID_vars'\");\n }\n } else {\n myGH->do_inVars = NULL;\n myGH->alias = NULL;\n }\n\n num_recovered_vars = 0;\n\n /* duplicate the filename list and parse it */\n basefilename = strdup(in_files);\n while (basefilename && *basefilename) {\n /* skip leading spaces */\n while (isspace((int)*basefilename)) {\n basefilename++;\n }\n if (!*basefilename) {\n break;\n }\n\n /* find delimiter for current filename and cut there */\n for (delim = basefilename + 1; !isspace((int)*delim) && *delim; delim++)\n ;\n delim_char = *delim;\n *delim = 0;\n\n if (!CCTK_Equals(verbose, \"none\")) {\n CCTK_VInfo(CCTK_THORNSTRING,\n \"Reading variables from file with base name '%s'\",\n basefilename);\n }\n\n retval = IOUtil_RecoverFromFile(GH, basefilename, FILEREADER_DATA);\n if (retval >= 0) {\n num_recovered_vars += retval;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to read variables from data file with base name '%s'\",\n basefilename);\n }\n\n *delim = delim_char;\n basefilename = delim;\n }\n\n if (basefilename) {\n free(basefilename - strlen(in_files));\n }\n\n if (myGH->do_inVars) {\n free(myGH->do_inVars);\n myGH->do_inVars = NULL;\n }\n\n if (myGH->alias) {\n const int numVars = CCTK_NumVars();\n for (int i = 0; i < numVars; i++) {\n if (myGH->alias[i])\n free((void *)myGH->alias[i]);\n }\n free(myGH->alias);\n myGH->alias = NULL;\n }\n\n return (num_recovered_vars);\n}\n\nvoid CCTK_FCALL\n CCTK_FNAME(IOUtil_RecoverVarsFromDatafiles)(int *result, cGH **GH,\n TWO_FORTSTRING_ARG) {\n TWO_FORTSTRING_CREATE(in_files, in_vars)\n *result = IOUtil_RecoverVarsFromDatafiles(*GH, in_files, in_vars);\n free(in_files);\n free(in_vars);\n}\n\n/*@@\n @routine IOUtil_RecoverIDFromDatafiles\n @date Wed Apr 19 2000\n @author Thomas Radke\n @desc\n The rfr-registered initial data recovery routine.\n Just calls IOUtil's generic routine\n IOUtil_RecoverVarsFromDatafiles() with the filereader_ID_XXX\n parameters.\n @enddesc\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype cGH *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_RecoverIDFromDatafiles(cGH *GH) {\n ioGH *myGH;\n DECLARE_CCTK_PARAMETERS\n\n myGH = CCTK_GHExtension(GH, \"IO\");\n myGH->stop_on_parse_errors = strict_io_parameter_check;\n IOUtil_RecoverVarsFromDatafiles(GH, filereader_ID_files, filereader_ID_vars);\n myGH->stop_on_parse_errors = 0;\n}\n\n/*@@\n @routine IOUtil_RecoverParameters\n @date Apr 22 2000\n @author Thomas Radke\n @desc\n The generic parameter recovery routine.\n It is called by the IO thorns' parameter recovery routines\n scheduled at CCTK_RECOVER_PARAMETERS, and simply calls\n the given callback routine with its arguments\n plus a checkpoint filename.\n @enddesc\n\n @var recover_fn\n @vdesc callback function for recovery of parameters\n from a given checkpoint file\n @vtype int (*) (cGH *, const char *, int)\n @vio in\n @endvar\n @var fileExtension\n @vdesc extension of valid checkpoint files for given callback\n @vtype const char *\n @vio in\n @endvar\n @var fileType\n @vdesc string to describe the type of checkpoint file\n (used for warning/info messages)\n @vtype const char *\n @vio in\n @endvar\n\n @returntype int\n @returndesc\n 0 if in \"autoprobe\" mode and no cp files were found, or<BR>\n +1 if parameter recovery was successful for some cp file,<BR>\n -1 if in \"auto\" mode and no checkpoint files were found,\n or if parameter recovery failed for some cp file,<BR>\n -2 if in \"auto*\" mode and recovery dir doesn't exist\n @endreturndesc\n@@*/\nint IOUtil_RecoverParameters(int (*recover_fn)(cGH *GH,\n const char *basefilename,\n int called_from),\n const char *fileExtension, const char *fileType) {\n int retval;\n#ifdef HAVE_DIRENT_H\n int len, recover_file_len;\n unsigned int num_files;\n const char *p, *q;\n DIR *dir;\n struct dirent *file;\n filelist_t *filelist, *tmp;\n#endif\n DECLARE_CCTK_PARAMETERS\n#ifdef HAVE_DIRENT_H\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n#endif\n\n if (CCTK_Equals(recover, \"auto\") || CCTK_Equals(recover, \"autoprobe\")) {\n#ifdef HAVE_DIRENT_H\n if (verbose_full) {\n CCTK_VInfo(CCTK_THORNSTRING, \"Searching for %s checkpoint files \"\n \"with basefilename '%s' in directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n dir = opendir(recover_dir);\n if (!dir) {\n /* The recovery directory does not exist */\n if (CCTK_Equals(recover, \"autoprobe\")) {\n /* This is harmless when \"autoprobe\" is used */\n CCTK_VInfo(CCTK_THORNSTRING, \"Recovery directory '%s' doesn't exist\",\n recover_dir);\n return 0;\n } else {\n /* This is an error when \"auto\" is used */\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Recovery directory '%s' doesn't exist\", recover_dir);\n return -2;\n }\n }\n\n /* get the list of potential recovery files */\n recover_file_len = strlen(recover_file);\n num_files = 0;\n filelist = NULL;\n\n while ((file = readdir(dir)) != NULL) {\n /* first check the file prefix */\n if (strncmp(file->d_name, recover_file, recover_file_len) ||\n strncmp(file->d_name + recover_file_len, \".it_\", 4)) {\n continue;\n }\n\n /* now check if there is an iteration number following the file prefix */\n for (p = file->d_name + recover_file_len + 4; *p && *p != '.'; p++) {\n if (!isdigit((int)*p)) {\n break;\n }\n }\n\n /* check for a '.file_<processor>' suffix for chunked output */\n q = p;\n if (!strncmp(q, \".file_\", 6)) {\n /* read past the <processor> number */\n for (q = q + 6; *q && *q != '.'; q++) {\n if (!isdigit((int)*q)) {\n break;\n }\n }\n }\n\n /* finally check the file extension suffix */\n if (*q != '.' || strcmp(q, fileExtension)) {\n continue;\n }\n\n /* found a recovery file by that basename */\n if (num_files == 0) {\n tmp = malloc(sizeof(filelist_t));\n } else {\n tmp = realloc(filelist, (num_files + 1) * sizeof(filelist_t));\n }\n if (tmp == NULL) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate memory for file list\");\n continue;\n }\n filelist = tmp;\n filelist[num_files].basename = strdup(file->d_name);\n /* cut the filename after the iteration number field */\n len = p - file->d_name;\n filelist[num_files].basename[len] = 0;\n filelist[num_files].iteration = atoi(file->d_name + recover_file_len + 4);\n\n num_files++;\n }\n closedir(dir);\n\n retval = CCTK_Equals(recover, \"auto\") ? -1 : 0;\n if (num_files) {\n /* sort the list according to their iteration numbers */\n qsort(filelist, num_files, sizeof(filelist_t), CompareFiles);\n\n /* loop over all recovery files found and call the callback routine;\n skip all following files after the first successful recovery (when\n recover_fn() returned a positive value) */\n while (num_files--) {\n if (retval <= 0) {\n retval = recover_fn(NULL, filelist[num_files].basename,\n CP_RECOVER_PARAMETERS);\n }\n free(filelist[num_files].basename);\n }\n free(filelist);\n } else {\n CCTK_VWarn(retval ? 1 : 3, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"No %s checkpoint files with basefilename '%s' found in \"\n \"recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n#else\n fileExtension = fileExtension;\n\n /* No opendir(3) ??? It's probably a Windows box, so just give up ! */\n CCTK_WARN(0, \"You cannot use 'IO::recover = \\\"auto*\\\"' on \"\n \"this architecture because it doesn't provide opendir(3) to \"\n \"automatically look for checkpoint files.\\n\"\n \"Please use 'IO::recover = \\\"manual\\\"' instead !\");\n retval = -1;\n#endif\n } else {\n /* just call the recovery routine */\n retval = (*recover_fn)(NULL, recover_file, CP_RECOVER_PARAMETERS);\n }\n\n if (retval < 0) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not recover parameters from %s checkpoint file(s) \"\n \"with basefilename '%s' in recovery directory '%s'\",\n fileType, recover_file, recover_dir);\n }\n\n /* remember parameter recovery status for later evaluation in\n IOUtil_RecoverGH() */\n checkpoint_file_exists = retval > 0;\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_GetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Collect all parameters of active implementations\n into a single string which can then be dumped as an attribute.\n\n Each \"<parameter> = <value>\" pair in the resulting string\n is separated by a newline character from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character.\n @enddesc\n\n @var GH\n @vdesc pointer to CCTK grid hierarchy\n @vtype const cGH *\n @vio in\n @endvar\n @var all\n @vdesc flag indicating whether to save all parameters or just the ones\n which have been set before\n @vtype int\n @vio in\n @endvar\n\n @returntype char *\n @returndesc the allocated string or NULL\n @endreturndesc\n@@*/\nchar *IOUtil_GetAllParameters(const cGH *GH, int all) {\n int i, first, add_len, current_len, max_len;\n char *param, *value, *encoded_value, *tmp, *retval;\n const char *thorn;\n const cParamData *pdata;\n DECLARE_CCTK_PARAMETERS\n\n /* avoid compiler warning about unused parameter */\n GH = GH;\n\n /* preallocate buffer for parameters, to prevent too many subsequent reallocs\n (causing unnecessary memory fragmentation) */\n max_len = 1024 * 1024;\n retval = malloc(max_len);\n if (!retval) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n current_len = 0;\n\n /* loop over all thorns */\n for (i = CCTK_NumCompiledThorns() - 1; i >= 0; i--) {\n thorn = CCTK_CompiledThorn(i);\n\n /* skip all inactive thorns */\n if (!CCTK_IsThornActive(thorn)) {\n continue;\n }\n\n /* now walk through all parameters of given thorn */\n first = 1;\n while (CCTK_ParameterWalk(first, thorn, ¶m, &pdata) == 0) {\n first = 0;\n\n /* if 'all' is false get only parameters which have been set */\n if (all || pdata->n_set > 0) {\n value = CCTK_ParameterValString(pdata->name, pdata->thorn);\n if (value == NULL) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't get value for parameter '%s'\", param);\n } else {\n encoded_value = EncodeString(value);\n add_len = strlen(param) + strlen(encoded_value) + 5;\n if (current_len + add_len >= max_len) {\n /* double new buffer length until buffer is large enough */\n while (current_len + add_len >= max_len) {\n max_len *= 2;\n }\n tmp = realloc(retval, max_len);\n if (!tmp) {\n CCTK_VWarn(0, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Failed to allocate buffer of %d bytes\", max_len);\n }\n retval = tmp;\n }\n\n sprintf(retval + current_len, \"%s = %s\\n\", param, encoded_value);\n current_len += add_len - 1;\n\n free(encoded_value);\n free(value);\n }\n }\n\n free(param);\n\n } /* end of loop walking over all parameters of given thorn */\n } /* end of looping over all thorns */\n\n return (retval);\n}\n\n/*@@\n @routine IOUtil_SetAllParameters\n @date Mon Apr 10 2000\n @author Thomas Radke\n @desc\n Parse the given string for parameters\n and call CCTK_SetParameter() for each.\n\n The input string is expected to follow the format of\n IOUtil_GetAllParameters() (see above) where each\n \"<parameter> = <value>\" pair is separated by a newline character\n from the next pair.\n The \"<value>\" substring is encoded such that non-printable\n characters are contained as escape sequences, and a single\n '\\' character is escaped by another '\\' character. This\n encoding is undone before setting the a value of a parameter.\n @enddesc\n\n @var parameters\n @vdesc the parameter string\n @vtype const char *\n @vio in\n @endvar\n@@*/\nvoid IOUtil_SetAllParameters(const char *parameters) {\n char *tmp, *nextparam, *avalue, *decoded_value, *param;\n char oldchar;\n char *name, *thorn_impl, *parameter_string, *free_me;\n const char *thorn;\n const cParamData *paramdata;\n int ierr, steered_non_steerable;\n DECLARE_CCTK_PARAMETERS\n bool verbose_full = CCTK_Equals(verbose, \"full\");\n\n parameter_string = free_me = strdup(parameters);\n steered_non_steerable = 0;\n while (*parameter_string) {\n /* find the end of the current \"<parameter> = <value>\" pair substring */\n nextparam = parameter_string;\n while (*nextparam != '\\n' && *nextparam) {\n nextparam++;\n }\n oldchar = *nextparam;\n *nextparam = 0;\n\n /* find the end of \"<parameter>\" */\n tmp = parameter_string;\n while (*tmp != ' ') {\n tmp++;\n }\n *tmp = 0;\n\n param = parameter_string;\n /* skip the \" = \" delimiter to get to \"<value>\" */\n avalue = tmp + 3;\n\n name = thorn_impl = NULL;\n if (Util_SplitString(þ_impl, &name, param, \"::\") == 0) {\n /* find out the implementing thorn of the parameter given */\n thorn = CCTK_ActivatingThorn(thorn_impl);\n if (!thorn) {\n thorn = thorn_impl;\n }\n\n /* set parameter only if it belongs to an active implementation\n and is not an accumulator parameter */\n if (CCTK_IsThornActive(thorn)) {\n paramdata = CCTK_ParameterData(name, thorn);\n if (paramdata && !paramdata->accumulator_expression) {\n decoded_value = DecodeString(avalue);\n ierr = CCTK_ParameterSet(name, thorn, decoded_value);\n if (ierr == -10) {\n steered_non_steerable = 1;\n } else if (ierr < 0) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't set parameter '%s' to '%s'\", param,\n decoded_value);\n }\n free(decoded_value);\n }\n } else if (verbose_full) {\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Ignoring inactive parameter '%s' for recovery\", param);\n }\n\n if (name) {\n free(name);\n }\n if (thorn_impl) {\n free(thorn_impl);\n }\n }\n\n *nextparam = oldchar;\n parameter_string = nextparam;\n if (*parameter_string == '\\n') {\n parameter_string++;\n }\n }\n\n free(free_me);\n\n if (steered_non_steerable) {\n CCTK_ERROR(\"Attempted to steer non steerable parameters.\");\n }\n}\n\n/********************************************************************\n ******************** Internal Routines ************************\n ********************************************************************/\n/* encodes a C string with all the non-printable characters converted\n into a 4-char-long escape sequence representation \"\\xxx\" and\n the single '\\' character converted into \"\\\\\" */\nstatic char *EncodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n\n p = retval = malloc(4 * len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (!isprint(string[i])) {\n sprintf(p, \"\\\\%.03o\", (unsigned char)string[i]);\n p += 4;\n } else {\n *p++ = string[i];\n if (string[i] == '\\\\') {\n *p++ = string[i];\n }\n }\n }\n *p = 0;\n\n return (retval);\n}\n\n/* decodes a string encoded by EncodeString() back into a C string */\nstatic char *DecodeString(const char *string) {\n size_t i, len = strlen(string);\n char *p, *retval;\n int o1, o2, o3;\n\n p = retval = malloc(len + 1);\n if (!retval) {\n CCTK_WARN(0, \"Out of memory !\");\n }\n\n for (i = 0; i < len; i++) {\n if (string[i] != '\\\\') {\n *p++ = string[i];\n } else {\n if (i + 1 >= len)\n goto bail_out;\n if (string[i + 1] == '\\\\') {\n *p++ = '\\\\';\n i++;\n } else {\n if (i + 3 >= len)\n goto bail_out;\n o1 = OctalDigitToInt(string[i + 1]);\n o2 = OctalDigitToInt(string[i + 2]);\n o3 = OctalDigitToInt(string[i + 3]);\n if (o1 < 0 || o2 < 0 || o3 < 0)\n goto bail_out;\n *p++ = (char)(8 * 8 * o1 + 8 * o2 + o3);\n i += 3;\n }\n }\n }\n *p = 0;\n\n return (retval);\n\nbail_out:\n free(retval);\n CCTK_WARN(1, \"Malformed string\");\n return NULL;\n}\n\n/* callback for CCTK_TraverseString() to set the input flag\n for the given variable */\nstatic void SetInputFlag(int vindex, const char *optstring, void *calldata) {\n int table, iterator;\n char key[128];\n CCTK_INT type, nelems;\n void **flags = (void **)calldata;\n CCTK_INT *do_inVars = (CCTK_INT *)flags[0];\n const char **alias = (const char **)flags[1];\n\n /* default -1 is to read the last iteration number from the file */\n do_inVars[vindex] = -1;\n\n /* default is NULL to use CCTK_FullName() */\n alias[vindex] = NULL;\n\n if (optstring) {\n table = Util_TableCreateFromString(optstring);\n if (table >= 0) {\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"cctk_iteration\") >\n 0) {\n if (type == CCTK_VARIABLE_INT && nelems == 1) {\n Util_TableGetInt(table, &do_inVars[vindex], \"cctk_iteration\");\n\n /* if a specific iteration number was given then increment it\n to keep 0 as disabling value */\n if (do_inVars[vindex] >= 0) {\n do_inVars[vindex]++;\n }\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'cctk_iteration' in option \"\n \"string '%s' (must be an integer)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"cctk_iteration\");\n }\n\n if (Util_TableQueryValueInfo(table, &type, &nelems, \"alias\") > 0) {\n if (type == CCTK_VARIABLE_CHAR) {\n char *buf = malloc(nelems + 1);\n if (!(buf)) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Could not allocate %d bytes\", (int)nelems + 1);\n }\n int len = Util_TableGetString(table, nelems + 1, buf, \"alias\");\n if (len != nelems) {\n CCTK_VError(__LINE__, __FILE__, \"IOUtil\",\n \"Unexpected length %d of 'alias' option value in '%s'. \"\n \"Expected length %d.\",\n len, optstring, (int)nelems);\n }\n\n alias[vindex] = buf;\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Invalid value for option 'alias' in option \"\n \"string '%s' (must be a string)\",\n optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableDeleteKey(table, \"alias\");\n }\n\n /* warn about other options */\n for (iterator = Util_TableItCreate(table);\n Util_TableItQueryIsNonNull(iterator) > 0 &&\n Util_TableItQueryKeyValueInfo(iterator, sizeof(key), key, 0, 0) >\n 0;\n Util_TableItAdvance(iterator)) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Found option with unrecognized key '%s' in option string \"\n \"'%s'\",\n key, optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n Util_TableItDestroy(iterator);\n\n Util_TableDestroy(table);\n } else {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Couldn't parse option string '%s'\", optstring);\n CCTK_WARN(1, \"Option will be ignored by file reader routines\");\n }\n }\n}\n\n/* Convert an octal digit to an integer. Return -1 if this is not an\n octal digit. Note that this routine does not assume ASCII encoding\n (and thus cannot calculate digit-'0'), and does not use\n non-standard library function such as isoctal. */\nstatic int OctalDigitToInt(const char digit) {\n switch (digit) {\n case '0':\n return 0;\n case '1':\n return 1;\n case '2':\n return 2;\n case '3':\n return 3;\n case '4':\n return 4;\n case '5':\n return 5;\n case '6':\n return 6;\n case '7':\n return 7;\n }\n return -1;\n}\n\n#ifdef HAVE_DIRENT_H\n/* callback for qsort() to sort the list of recovery files found */\nstatic int CompareFiles(const void *a, const void *b) {\n return (((const filelist_t *)a)->iteration -\n ((const filelist_t *)b)->iteration);\n}\n#endif\n\n```\n\n"}}},{"rowIdx":95,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/SymBase"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":""},"interface":{"kind":"string","value":"# Interface definition for thorn SymBase\n# $Header$\n\nIMPLEMENTS: SymBase\n\n\n\n# Register a symmetry, and query the symmetry name/handle mapping:\n\nCCTK_INT FUNCTION SymmetryRegister (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryRegister \\\n WITH SymBase_SymmetryRegister \\\n LANGUAGE C\n\nCCTK_INT FUNCTION SymmetryHandleOfName (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryHandleOfName \\\n WITH SymBase_SymmetryHandleOfName \\\n LANGUAGE C\n\nCCTK_POINTER_TO_CONST FUNCTION SymmetryNameOfHandle (CCTK_INT IN sym_handle)\nPROVIDES FUNCTION SymmetryNameOfHandle \\\n WITH SymBase_SymmetryNameOfHandle \\\n LANGUAGE C\n\n\n\n# Register a symmetry condition for a face:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGrid \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width) \nPROVIDES FUNCTION SymmetryRegisterGrid \\\n WITH SymBase_SymmetryRegisterGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGI \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryRegisterGI \\\n WITH SymBase_SymmetryRegisterGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGN \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryRegisterGN \\\n WITH SymBase_SymmetryRegisterGN \\\n LANGUAGE C\n\n\n\n# Register a symmetry interpolator:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGridInterpolator \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT CCTK_FPOINTER IN symmetry_interpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces))\nPROVIDES FUNCTION SymmetryRegisterGridInterpolator \\\n WITH SymBase_SymmetryRegisterGridInterpolator \\\n LANGUAGE C\n\n\n\n# Get the symmetry table handle for a grid or grid array:\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGrid (CCTK_POINTER_TO_CONST IN cctkGH)\nPROVIDES FUNCTION SymmetryTableHandleForGrid \\\n WITH SymBase_SymmetryTableHandleForGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGI \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryTableHandleForGI \\\n WITH SymBase_SymmetryTableHandleForGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGN \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryTableHandleForGN \\\n WITH SymBase_SymmetryTableHandleForGN \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n GetSymmetryBoundaries \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN size, \\\n CCTK_INT OUT ARRAY symbnd)\nPROVIDES FUNCTION GetSymmetryBoundaries \\\n WITH SymBase_GetSymmetryBoundaries \\\n LANGUAGE C\n\n\n\n# Interpolation\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nPROVIDES FUNCTION SymmetryInterpolate \\\n WITH SymBase_SymmetryInterpolate \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolateFaces \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces)\nPROVIDES FUNCTION SymmetryInterpolateFaces \\\n WITH SymBase_SymmetryInterpolateFaces \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n DriverInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nUSES FUNCTION DriverInterpolate\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn SymBase\n# $Header$\n\nBOOLEAN verbose \"Output symmetry boundary face descriptions after registration\"\n{\n} \"yes\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn SymBase\n# $Header$\n\nSCHEDULE SymBase_Startup AT CCTK_STARTUP\n{\n LANG: C\n} \"Register GH Extension for SymBase\"\n\nSCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH\n{\n} \"Wrapper group for SymBase\"\n\nSCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper\n{\n} \"Register your symmetries here\"\n\nSCHEDULE SymBase_Statistics IN SymBase_Wrapper AFTER SymmetryRegister\n{\n LANG: C\n} \"Print symmetry boundary face descriptions\"\n\nSCHEDULE SymBase_Check AT CCTK_BASEGRID\n{\n LANG: C\n} \"Check whether the driver set up the grid consistently\"\n"},"src_filename":{"kind":"string","value":"SymBase.h"},"src_code":{"kind":"string","value":"/*@@\n @file SymBase.h\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Declarations for thorn SymBase\n @version $Header$\n @enddesc\n@@*/\n\n#ifndef SYMBASE_H\n#define SYMBASE_H\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n/* SymBase's GH extension */\nstruct SymBase {\n /* The table handles below identify tables that have the following\n entries:\n\n CCTK_INT symmetry_handle[2*dim]\n CCTK_INT symmetry_zone_width[2*dim]\n CCTK_FPOINTER symmetry_interpolate[2*dim]\n\n dim is here the dimension of the group containing the variable,\n i.e. there is one entry per face. The true type of the\n symmetry_interpolate entries is SymmetryInterpolateFPointer.\n\n (Given that user code is not allowed to modify these tables, and\n that this structure is defined here in this header file, there is\n no real need to use tables for this. It would be possible to put\n these data directly into this structure, thereby simplifying user\n code and not make anything less flexible.)\n */\n\n /* Grid symmetry table handle */\n int sym_table;\n\n /* Grid array symmetry table handles, one handle per grid\n variable */\n int *array_sym_tables;\n};\n\ntypedef CCTK_INT (*SymmetryInterpolateFPointer)(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Number of registered symmetries */\nextern int SymBase_num_symmetries;\n\n/* The names of these symmetries */\nextern const char **SymBase_symmetry_names;\n\n/* Startup.c */\nint SymBase_Startup(void);\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH);\n\n/* Handles.c */\nCCTK_INT SymBase_SymmetryRegister(CCTK_STRING const sym_name);\nCCTK_INT SymBase_SymmetryHandleOfName(CCTK_STRING const sym_name);\nCCTK_POINTER_TO_CONST SymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle);\n\n/* Faces.c */\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name);\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\n\n/* Table.c */\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_);\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name);\n\n/* Interpolate.c */\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]);\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Statistics.c */\nvoid SymBase_Statistics(CCTK_ARGUMENTS);\n\n/* Check.c */\nvoid SymBase_Check(CCTK_ARGUMENTS);\n\n#endif /* ! defined SYMBASE_H */\n"},"context_filenames":{"kind":"string","value":"Table.c\nFaces.c\nStatistics.c\nCheck.c\nHandles.c\nmake.code.defn\nInterpolation.c\nStartup.c\n"},"context":{"kind":"string","value":"Table.c:\n```\n/*@@\n @file Table.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Get the symmetry table handle for a grid or grid array\n @version $Header$\n @enddesc\n@@*/\n\n#include \"cctk.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Table_c);\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n return symdata->sym_table;\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n -6 if group_index has an illegal value\n -7 if the group type has an illegal value\n -8 if there was an internal error\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return symdata->array_sym_tables[group_index];\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGN\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryTableHandleForGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryTableHandleForGI(cctkGH_, group_index);\n}\n\n/*@@\n @routine SymBase_GetSymmetryBoundaries\n @author Erik Schnetter\n @date 2006-05-16\n @desc\n Determine which boundaries are symmetry boundaries\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var size\n @vtype CCTK_INT\n @vdesc Array size\n @vio in\n @endvar\n @var symbnd\n @vtype CCTK_INT [size]\n @vdesc 0 for outer boundary, 1 for symmetry boundary\n @vio out\n @endvar\n @returntype CCTK_INT\n @returndesc\n 0 Success\n -10 Wrong array size; must be 2*cctk_dim\n -11 Symmetry table handle does not exist\n -12 Wrong number of symmetry table entries (internal error)\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_GetSymmetryBoundaries(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const size,\n CCTK_INT *restrict const symbnd) {\n cGH const *const cctkGH = cctkGH_;\n CCTK_INT symtable;\n CCTK_INT symmetry_handle[6];\n CCTK_INT iret;\n int d;\n\n /* Check the arguments */\n if (size != 2 * cctkGH->cctk_dim) {\n return -10;\n }\n\n /* Get the symmetry table */\n symtable = SymmetryTableHandleForGrid(cctkGH);\n if (symtable < 0) {\n return -11;\n }\n\n /* Get the symmetry handles for each face */\n iret = Util_TableGetIntArray(symtable, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (iret != 2 * cctkGH->cctk_dim) {\n return -12;\n }\n\n /* A face has a symmetry boundary if there is a valid (non-negative)\n handle registered for that face */\n for (d = 0; d < 2 * cctkGH->cctk_dim; ++d) {\n symbnd[d] = symmetry_handle[d] >= 0;\n }\n\n /* Success */\n return 0;\n}\n\n```\n\nFaces.c:\n```\n/*@@\n @file Faces.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry condition for a face\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Faces_c);\n\n/*@@\n @routine SymBase_SymmetryRegisterFaces\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -3 if which_faces has an illegal value\n -4 if symmetry_zone_width has an illegal value\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!which_faces) {\n return -3; /* illegal argument */\n }\n if (!new_symmetry_zone_width) {\n return -4; /* illegal argument */\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (which_faces[face]) {\n if (symmetry_handle[face] != -1) {\n return -5; /* The face is already taken */\n }\n symmetry_handle[face] = sym_handle;\n if (new_symmetry_zone_width[face] > 100) {\n CCTK_WARN(0, \"Tried to register a symmetry face with a symmetry zone \"\n \"width >100 -- this looks like an error. This can be \"\n \"caused by using a symmetry thorn (or the old built-in \"\n \"CartGrid3D symmetries) which does not use CoordBase with \"\n \"new versions of the Carpet driver. Please use a \"\n \"separate symmetry thorn (e.g. ReflectionSymmetry) \"\n \"instead.\");\n }\n symmetry_zone_width[face] = new_symmetry_zone_width[face];\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterFaces(symdata->sym_table, cctkGH->cctk_dim,\n sym_handle, which_faces,\n new_symmetry_zone_width);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -6 if group_index has an illegal value\n -7 if the group has an illegal type\n -8 internal error\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return SymBase_SymmetryRegisterFaces(\n symdata->array_sym_tables[group_index], CCTK_GroupDimI(group_index),\n sym_handle, which_faces, new_symmetry_zone_width);\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryRegisterGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryRegisterGI(cctkGH_, sym_handle, which_faces,\n new_symmetry_zone_width, group_index);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterInterpolatorFaces\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n (may be NULL)\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -10 symmetry_interpolate is NULL\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!new_symmetry_interpolate) {\n return -10;\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (symmetry_handle[face] == sym_handle) {\n symmetry_interpolate[face] = (CCTK_FPOINTER)new_symmetry_interpolate;\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGridInterpolator\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator\n for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterInterpolatorFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterInterpolatorFaces(symdata->sym_table,\n cctkGH->cctk_dim, sym_handle,\n new_symmetry_interpolate);\n}\n\n```\n\nStatistics.c:\n```\n/*@@\n @file Statistics.c\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Provide information about the registered symmetry conditions\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Statistics_c);\n\n/*@@\n @routine SymBase_Statistics\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n If verbose, print the symmetry boundary conditions for each\n face.\n Warn if symmetries do not have interpolation operators\n associated with them.\n @enddesc\n@@*/\n\nvoid SymBase_Statistics(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n char const *symmetry_name;\n int face;\n int ierr;\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Print information about the registered symmetry faces, if desired */\n\n if (verbose) {\n\n /* Loop over all faces */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VInfo(CCTK_THORNSTRING, \"Symmetry on %s %c-face: %s\",\n face % 2 == 0 ? \"lower\" : \"upper\", \"xyz\"[face / 2],\n symmetry_name);\n }\n }\n }\n\n /* Warn about symmetries without interpolators */\n\n /* Loop over all registered symmetries */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n if (symmetry_interpolate[face] == NULL) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"The symmetry \\\"%s\\\" on the %s %c-face has not registered a \"\n \"symmetry interpolator\",\n symmetry_name, face % 2 == 0 ? \"lower\" : \"upper\",\n \"xyz\"[face / 2]);\n }\n }\n }\n}\n\n```\n\nCheck.c:\n```\n/*@@\n @file Check.c\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @version $Header$\n @enddesc\n@@*/\n\n#include \"util_Table.h\"\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Check_c);\n\n/*@@\n @routine SymBase_Check\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @enddesc\n @var CCTK_ARGUMENTS\n @endvar\n@@*/\n\nvoid SymBase_Check(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n\n struct SymBase const *symdata;\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int ierr;\n int d;\n\n /* Get table entries */\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n sym_table = symdata->sym_table;\n\n if (2 * cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ierr = 0;\n\n for (d = 0; d < cctk_dim; ++d) {\n\n /* Check lower boundary */\n if (symmetry_handle[2 * d] >= 0) {\n if (cctk_bbox[2 * d]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] < symmetry_zone_width[2 * d]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the lower boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n\n /* Check upper boundary */\n if (symmetry_handle[2 * d + 1] >= 0) {\n if (cctk_bbox[2 * d + 1]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] <\n symmetry_zone_width[2 * d + 1]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the upper boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n }\n\n if (ierr) {\n CCTK_WARN(0, \"The grid setup is inconsistent with the boundary sizes. One \"\n \"or more processors' domains are too small. The grid setup \"\n \"is decided by the driver. Try to make the driver lay out \"\n \"the grids differently.\");\n }\n}\n\n```\n\nHandles.c:\n```\n/*@@\n @file Handles.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry, and query the symmetry name/handle mapping\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Handles_c);\n\n/* Number of registered symmetries */\nint SymBase_num_symmetries;\n\n/* The names of these symmetries */\nconst char **SymBase_symmetry_names;\n\n/*@@\n @routine SymBase_SymmetryRegister\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if a symmetry with the same name has already been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegister(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return -2; /* symmetry exists already */\n }\n }\n\n SymBase_symmetry_names =\n realloc(SymBase_symmetry_names,\n (SymBase_num_symmetries + 1) * sizeof *SymBase_symmetry_names);\n if (!SymBase_symmetry_names) {\n CCTK_WARN(0, \"internal error\");\n }\n\n SymBase_symmetry_names[SymBase_num_symmetries] = strdup(sym_name);\n if (!SymBase_symmetry_names[SymBase_num_symmetries]) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ++SymBase_num_symmetries;\n\n return SymBase_num_symmetries - 1;\n}\n\n/*@@\n @routine SymBase_SymmetryHandleOfName\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry name to a symmetry handle\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if no symmetry with that name has been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryHandleOfName(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return n; /* found */\n }\n }\n\n return -2; /* not found */\n}\n\n/*@@\n @routine SymBase_SymmetryNameOfHandle\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry handle to a symmetry name\n @enddesc\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry name\n @vio in\n @endvar\n @returntype CCTK_POINTER_TO_CONST\n @returndesc\n char const * containing the symmetry name\n NULL if no symmetry with that handle has been registered\n @endreturndesc\n@@*/\n\nCCTK_POINTER_TO_CONST\nSymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle) {\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return NULL; /* illegal argument */\n }\n\n return SymBase_symmetry_names[sym_handle];\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn SymBase\n# $Header$\n\n# Source files in this directory\nSRCS = Check.c Faces.c Handles.c Interpolation.c Startup.c Statistics.c Table.c\n\n# Subdirectories containing source files\nSUBDIRS = \n\n```\n\nInterpolation.c:\n```\n/*@@\n @file Interpolation.c\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Apply symmetry conditions during interpolation\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n#include \"util_ErrorCodes.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Interpolation_c);\n\n/*@@\n @routine SymBase_SymmetryInterpolate\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components.\n All arguments are equivalent to the CCTK_InterpGridArrays\n function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 Input array has illegal group type\n -94 Mixing grid functions and grid arrays\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n CCTK_INT faces;\n int has_grid_arrays, has_only_grid_arrays;\n int n;\n int f;\n int ierr;\n\n /* Check arguments */\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n /* If this interpolates grid arrays, then do not apply symmetries --\n there are no symmetries registered for grid arrays (yet). */\n has_grid_arrays = 0;\n has_only_grid_arrays = 1;\n for (n = 0; n < N_input_arrays; ++n) {\n if (input_array_indices[n] != -1) {\n const int grouptype = CCTK_GroupTypeFromVarI(input_array_indices[n]);\n switch (grouptype) {\n case CCTK_GF:\n has_only_grid_arrays = 0;\n break;\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n has_grid_arrays = 1;\n break;\n default: {\n char *groupname = CCTK_GroupName(input_array_indices[n]);\n CCTK_VWarn(CCTK_WARN_ALERT, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not determine group type of input arrays for group \"\n \"'%s' (%ld), received %d\",\n groupname, (long)input_array_indices[n], grouptype);\n free(groupname);\n }\n return -93;\n }\n }\n }\n if (has_grid_arrays && !has_only_grid_arrays) {\n CCTK_WARN(1, \"The input arrays contain both grid function and grid arrays; \"\n \"this is not possible\");\n return -94;\n }\n if (has_grid_arrays) {\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n return DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n }\n\n /* Check arguments */\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find all faces that need symmetries applied */\n faces = 0;\n for (f = 0; f < 2 * cctkGH->cctk_dim; ++f) {\n if (symmetry_interpolate[f]) {\n faces |= (1 << f);\n }\n }\n\n /* Forward the call */\n return SymBase_SymmetryInterpolateFaces(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays, output_array_types,\n output_arrays, faces);\n}\n\n/*@@\n @routine SymBase_SymmetryInterpolateFaces\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components,\n but only for the selected faces.\n When no faces are selected, forward the call to the\n driver's interpolator throug the aliased function\n \"DriverInterpolate\".\n All arguments except \"faces\" are equivalent to the\n CCTK_InterpGridArrays function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var faces\n @vtype CCTK_INT\n @vdesc Bit mask selecting which faces' symmetries should be treated.\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 faces is NULL\n or the return value from DriverInterpolate\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find a face that needs a symmetry applied */\n for (face = 0; face < 2 * N_dims; ++face) {\n if (faces & (1 << face)) {\n break;\n }\n }\n\n if (face == 2 * N_dims) {\n /* All faces are done */\n\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n ierr = DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n\n } else {\n /* Treat the face */\n\n /* Recursive call to a symmetry condition */\n if (!symmetry_interpolate[face]) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = ((SymmetryInterpolateFPointer)symmetry_interpolate[face])(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays, faces);\n }\n\n return ierr;\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Thorn startup\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Startup_c);\n\n/*@@\n @routine SymBase_Startup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a GH extension and initialise the global variables\n @enddesc\n @returntype int\n @returndesc\n status code\n 0 for success\n @endreturndesc\n@@*/\n\nint SymBase_Startup(void) {\n int handle;\n int ierr;\n\n handle = CCTK_RegisterGHExtension(\"SymBase\");\n if (handle < 0) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create GH extension for symmetry data\");\n }\n\n ierr = CCTK_RegisterGHExtensionSetupGH(handle, SymBase_Setup);\n if (ierr != 1) { /* strange error code convention */\n CCTK_WARN(0,\n \"Internal Error: Could not register GH Extension setup routine\");\n }\n\n SymBase_num_symmetries = 0;\n SymBase_symmetry_names = NULL;\n\n return 0; /* no error */\n}\n\n/*@@\n @routine SymBase_Setup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Initialise the GH extension\n @enddesc\n @var config\n @vtype tFleshConfig *\n @vdesc Internal flesh information, unused\n @vio in\n @endvar\n @var convlev\n @vtype int\n @vdesc Convergence level, unused\n @vio in\n @endvar\n @var cctkGH\n @vtype cGH *\n @vdesc Grid hierarchy\n @vio in\n @endvar\n@@*/\n\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH) {\n struct SymBase *symdata;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int group;\n int face;\n int ierr;\n const void *dummy;\n\n /* avoid compiler warnings about unused parameters */\n dummy = &config;\n dummy = &convlev;\n dummy = &cctkGH;\n dummy = &dummy;\n\n /* Create GH extension */\n symdata = malloc(sizeof *symdata);\n if (!symdata) {\n CCTK_WARN(0, \"Failed to allocate memory for symmetry data\");\n }\n\n /* Initialise handle and zone width arrays */\n for (face = 0; face < 100; ++face) {\n symmetry_handle[face] = -1;\n symmetry_zone_width[face] = 0;\n symmetry_interpolate[face] = NULL;\n }\n\n /* Create grid symmetry table */\n symdata->sym_table = Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n\n if (symdata->sym_table < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table.\");\n }\n\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"Internal Error: Can currently only handle a hundred faces.\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_handle, \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr =\n Util_TableSetFPointerArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n\n /* Create grid array symmetry tables */\n symdata->array_sym_tables =\n malloc(CCTK_NumGroups() * sizeof *symdata->array_sym_tables);\n if (!symdata->array_sym_tables) {\n CCTK_WARN(\n 0,\n \"Internal Error: Failed to create array for symmetry tables for GAs\");\n }\n\n for (group = 0; group < CCTK_NumGroups(); ++group) {\n switch (CCTK_GroupTypeI(group)) {\n case CCTK_GF:\n\n /* No table */\n symdata->array_sym_tables[group] = -1;\n break;\n\n case CCTK_SCALAR:\n /* FALL_THROUGH */\n\n case CCTK_ARRAY:\n\n /* Create array symmetry table */\n symdata->array_sym_tables[group] =\n Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n if (symdata->array_sym_tables[group] < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table for GA\");\n }\n\n if (2 * CCTK_GroupDimI(group) > 100) {\n CCTK_WARN(0, \"Internal Error: Can only handle 100 faces\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group), symmetry_handle,\n \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group),\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0,\n \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr = Util_TableSetFPointerArray(\n symdata->array_sym_tables[group], 2 * CCTK_GroupDimI(group),\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n break;\n\n default:\n CCTK_WARN(0, \"Internal Error: Unknown GV type\");\n }\n }\n\n return symdata;\n}\n\n```\n\n"}}},{"rowIdx":96,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/SymBase"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":""},"interface":{"kind":"string","value":"# Interface definition for thorn SymBase\n# $Header$\n\nIMPLEMENTS: SymBase\n\n\n\n# Register a symmetry, and query the symmetry name/handle mapping:\n\nCCTK_INT FUNCTION SymmetryRegister (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryRegister \\\n WITH SymBase_SymmetryRegister \\\n LANGUAGE C\n\nCCTK_INT FUNCTION SymmetryHandleOfName (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryHandleOfName \\\n WITH SymBase_SymmetryHandleOfName \\\n LANGUAGE C\n\nCCTK_POINTER_TO_CONST FUNCTION SymmetryNameOfHandle (CCTK_INT IN sym_handle)\nPROVIDES FUNCTION SymmetryNameOfHandle \\\n WITH SymBase_SymmetryNameOfHandle \\\n LANGUAGE C\n\n\n\n# Register a symmetry condition for a face:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGrid \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width) \nPROVIDES FUNCTION SymmetryRegisterGrid \\\n WITH SymBase_SymmetryRegisterGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGI \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryRegisterGI \\\n WITH SymBase_SymmetryRegisterGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGN \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryRegisterGN \\\n WITH SymBase_SymmetryRegisterGN \\\n LANGUAGE C\n\n\n\n# Register a symmetry interpolator:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGridInterpolator \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT CCTK_FPOINTER IN symmetry_interpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces))\nPROVIDES FUNCTION SymmetryRegisterGridInterpolator \\\n WITH SymBase_SymmetryRegisterGridInterpolator \\\n LANGUAGE C\n\n\n\n# Get the symmetry table handle for a grid or grid array:\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGrid (CCTK_POINTER_TO_CONST IN cctkGH)\nPROVIDES FUNCTION SymmetryTableHandleForGrid \\\n WITH SymBase_SymmetryTableHandleForGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGI \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryTableHandleForGI \\\n WITH SymBase_SymmetryTableHandleForGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGN \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryTableHandleForGN \\\n WITH SymBase_SymmetryTableHandleForGN \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n GetSymmetryBoundaries \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN size, \\\n CCTK_INT OUT ARRAY symbnd)\nPROVIDES FUNCTION GetSymmetryBoundaries \\\n WITH SymBase_GetSymmetryBoundaries \\\n LANGUAGE C\n\n\n\n# Interpolation\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nPROVIDES FUNCTION SymmetryInterpolate \\\n WITH SymBase_SymmetryInterpolate \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolateFaces \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces)\nPROVIDES FUNCTION SymmetryInterpolateFaces \\\n WITH SymBase_SymmetryInterpolateFaces \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n DriverInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nUSES FUNCTION DriverInterpolate\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn SymBase\n# $Header$\n\nBOOLEAN verbose \"Output symmetry boundary face descriptions after registration\"\n{\n} \"yes\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn SymBase\n# $Header$\n\nSCHEDULE SymBase_Startup AT CCTK_STARTUP\n{\n LANG: C\n} \"Register GH Extension for SymBase\"\n\nSCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH\n{\n} \"Wrapper group for SymBase\"\n\nSCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper\n{\n} \"Register your symmetries here\"\n\nSCHEDULE SymBase_Statistics IN SymBase_Wrapper AFTER SymmetryRegister\n{\n LANG: C\n} \"Print symmetry boundary face descriptions\"\n\nSCHEDULE SymBase_Check AT CCTK_BASEGRID\n{\n LANG: C\n} \"Check whether the driver set up the grid consistently\"\n"},"src_filename":{"kind":"string","value":"Table.c"},"src_code":{"kind":"string","value":"/*@@\n @file Table.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Get the symmetry table handle for a grid or grid array\n @version $Header$\n @enddesc\n@@*/\n\n#include \"cctk.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Table_c);\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n return symdata->sym_table;\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n -6 if group_index has an illegal value\n -7 if the group type has an illegal value\n -8 if there was an internal error\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return symdata->array_sym_tables[group_index];\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGN\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryTableHandleForGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryTableHandleForGI(cctkGH_, group_index);\n}\n\n/*@@\n @routine SymBase_GetSymmetryBoundaries\n @author Erik Schnetter\n @date 2006-05-16\n @desc\n Determine which boundaries are symmetry boundaries\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var size\n @vtype CCTK_INT\n @vdesc Array size\n @vio in\n @endvar\n @var symbnd\n @vtype CCTK_INT [size]\n @vdesc 0 for outer boundary, 1 for symmetry boundary\n @vio out\n @endvar\n @returntype CCTK_INT\n @returndesc\n 0 Success\n -10 Wrong array size; must be 2*cctk_dim\n -11 Symmetry table handle does not exist\n -12 Wrong number of symmetry table entries (internal error)\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_GetSymmetryBoundaries(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const size,\n CCTK_INT *restrict const symbnd) {\n cGH const *const cctkGH = cctkGH_;\n CCTK_INT symtable;\n CCTK_INT symmetry_handle[6];\n CCTK_INT iret;\n int d;\n\n /* Check the arguments */\n if (size != 2 * cctkGH->cctk_dim) {\n return -10;\n }\n\n /* Get the symmetry table */\n symtable = SymmetryTableHandleForGrid(cctkGH);\n if (symtable < 0) {\n return -11;\n }\n\n /* Get the symmetry handles for each face */\n iret = Util_TableGetIntArray(symtable, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (iret != 2 * cctkGH->cctk_dim) {\n return -12;\n }\n\n /* A face has a symmetry boundary if there is a valid (non-negative)\n handle registered for that face */\n for (d = 0; d < 2 * cctkGH->cctk_dim; ++d) {\n symbnd[d] = symmetry_handle[d] >= 0;\n }\n\n /* Success */\n return 0;\n}\n"},"context_filenames":{"kind":"string","value":"SymBase.h\nFaces.c\nStatistics.c\nCheck.c\nHandles.c\nmake.code.defn\nInterpolation.c\nStartup.c\n"},"context":{"kind":"string","value":"SymBase.h:\n```\n/*@@\n @file SymBase.h\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Declarations for thorn SymBase\n @version $Header$\n @enddesc\n@@*/\n\n#ifndef SYMBASE_H\n#define SYMBASE_H\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n/* SymBase's GH extension */\nstruct SymBase {\n /* The table handles below identify tables that have the following\n entries:\n\n CCTK_INT symmetry_handle[2*dim]\n CCTK_INT symmetry_zone_width[2*dim]\n CCTK_FPOINTER symmetry_interpolate[2*dim]\n\n dim is here the dimension of the group containing the variable,\n i.e. there is one entry per face. The true type of the\n symmetry_interpolate entries is SymmetryInterpolateFPointer.\n\n (Given that user code is not allowed to modify these tables, and\n that this structure is defined here in this header file, there is\n no real need to use tables for this. It would be possible to put\n these data directly into this structure, thereby simplifying user\n code and not make anything less flexible.)\n */\n\n /* Grid symmetry table handle */\n int sym_table;\n\n /* Grid array symmetry table handles, one handle per grid\n variable */\n int *array_sym_tables;\n};\n\ntypedef CCTK_INT (*SymmetryInterpolateFPointer)(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Number of registered symmetries */\nextern int SymBase_num_symmetries;\n\n/* The names of these symmetries */\nextern const char **SymBase_symmetry_names;\n\n/* Startup.c */\nint SymBase_Startup(void);\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH);\n\n/* Handles.c */\nCCTK_INT SymBase_SymmetryRegister(CCTK_STRING const sym_name);\nCCTK_INT SymBase_SymmetryHandleOfName(CCTK_STRING const sym_name);\nCCTK_POINTER_TO_CONST SymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle);\n\n/* Faces.c */\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name);\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\n\n/* Table.c */\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_);\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name);\n\n/* Interpolate.c */\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]);\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Statistics.c */\nvoid SymBase_Statistics(CCTK_ARGUMENTS);\n\n/* Check.c */\nvoid SymBase_Check(CCTK_ARGUMENTS);\n\n#endif /* ! defined SYMBASE_H */\n\n```\n\nFaces.c:\n```\n/*@@\n @file Faces.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry condition for a face\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Faces_c);\n\n/*@@\n @routine SymBase_SymmetryRegisterFaces\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -3 if which_faces has an illegal value\n -4 if symmetry_zone_width has an illegal value\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!which_faces) {\n return -3; /* illegal argument */\n }\n if (!new_symmetry_zone_width) {\n return -4; /* illegal argument */\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (which_faces[face]) {\n if (symmetry_handle[face] != -1) {\n return -5; /* The face is already taken */\n }\n symmetry_handle[face] = sym_handle;\n if (new_symmetry_zone_width[face] > 100) {\n CCTK_WARN(0, \"Tried to register a symmetry face with a symmetry zone \"\n \"width >100 -- this looks like an error. This can be \"\n \"caused by using a symmetry thorn (or the old built-in \"\n \"CartGrid3D symmetries) which does not use CoordBase with \"\n \"new versions of the Carpet driver. Please use a \"\n \"separate symmetry thorn (e.g. ReflectionSymmetry) \"\n \"instead.\");\n }\n symmetry_zone_width[face] = new_symmetry_zone_width[face];\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterFaces(symdata->sym_table, cctkGH->cctk_dim,\n sym_handle, which_faces,\n new_symmetry_zone_width);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -6 if group_index has an illegal value\n -7 if the group has an illegal type\n -8 internal error\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return SymBase_SymmetryRegisterFaces(\n symdata->array_sym_tables[group_index], CCTK_GroupDimI(group_index),\n sym_handle, which_faces, new_symmetry_zone_width);\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryRegisterGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryRegisterGI(cctkGH_, sym_handle, which_faces,\n new_symmetry_zone_width, group_index);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterInterpolatorFaces\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n (may be NULL)\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -10 symmetry_interpolate is NULL\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!new_symmetry_interpolate) {\n return -10;\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (symmetry_handle[face] == sym_handle) {\n symmetry_interpolate[face] = (CCTK_FPOINTER)new_symmetry_interpolate;\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGridInterpolator\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator\n for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterInterpolatorFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterInterpolatorFaces(symdata->sym_table,\n cctkGH->cctk_dim, sym_handle,\n new_symmetry_interpolate);\n}\n\n```\n\nStatistics.c:\n```\n/*@@\n @file Statistics.c\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Provide information about the registered symmetry conditions\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Statistics_c);\n\n/*@@\n @routine SymBase_Statistics\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n If verbose, print the symmetry boundary conditions for each\n face.\n Warn if symmetries do not have interpolation operators\n associated with them.\n @enddesc\n@@*/\n\nvoid SymBase_Statistics(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n char const *symmetry_name;\n int face;\n int ierr;\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Print information about the registered symmetry faces, if desired */\n\n if (verbose) {\n\n /* Loop over all faces */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VInfo(CCTK_THORNSTRING, \"Symmetry on %s %c-face: %s\",\n face % 2 == 0 ? \"lower\" : \"upper\", \"xyz\"[face / 2],\n symmetry_name);\n }\n }\n }\n\n /* Warn about symmetries without interpolators */\n\n /* Loop over all registered symmetries */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n if (symmetry_interpolate[face] == NULL) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"The symmetry \\\"%s\\\" on the %s %c-face has not registered a \"\n \"symmetry interpolator\",\n symmetry_name, face % 2 == 0 ? \"lower\" : \"upper\",\n \"xyz\"[face / 2]);\n }\n }\n }\n}\n\n```\n\nCheck.c:\n```\n/*@@\n @file Check.c\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @version $Header$\n @enddesc\n@@*/\n\n#include \"util_Table.h\"\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Check_c);\n\n/*@@\n @routine SymBase_Check\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @enddesc\n @var CCTK_ARGUMENTS\n @endvar\n@@*/\n\nvoid SymBase_Check(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n\n struct SymBase const *symdata;\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int ierr;\n int d;\n\n /* Get table entries */\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n sym_table = symdata->sym_table;\n\n if (2 * cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ierr = 0;\n\n for (d = 0; d < cctk_dim; ++d) {\n\n /* Check lower boundary */\n if (symmetry_handle[2 * d] >= 0) {\n if (cctk_bbox[2 * d]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] < symmetry_zone_width[2 * d]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the lower boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n\n /* Check upper boundary */\n if (symmetry_handle[2 * d + 1] >= 0) {\n if (cctk_bbox[2 * d + 1]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] <\n symmetry_zone_width[2 * d + 1]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the upper boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n }\n\n if (ierr) {\n CCTK_WARN(0, \"The grid setup is inconsistent with the boundary sizes. One \"\n \"or more processors' domains are too small. The grid setup \"\n \"is decided by the driver. Try to make the driver lay out \"\n \"the grids differently.\");\n }\n}\n\n```\n\nHandles.c:\n```\n/*@@\n @file Handles.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry, and query the symmetry name/handle mapping\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Handles_c);\n\n/* Number of registered symmetries */\nint SymBase_num_symmetries;\n\n/* The names of these symmetries */\nconst char **SymBase_symmetry_names;\n\n/*@@\n @routine SymBase_SymmetryRegister\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if a symmetry with the same name has already been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegister(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return -2; /* symmetry exists already */\n }\n }\n\n SymBase_symmetry_names =\n realloc(SymBase_symmetry_names,\n (SymBase_num_symmetries + 1) * sizeof *SymBase_symmetry_names);\n if (!SymBase_symmetry_names) {\n CCTK_WARN(0, \"internal error\");\n }\n\n SymBase_symmetry_names[SymBase_num_symmetries] = strdup(sym_name);\n if (!SymBase_symmetry_names[SymBase_num_symmetries]) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ++SymBase_num_symmetries;\n\n return SymBase_num_symmetries - 1;\n}\n\n/*@@\n @routine SymBase_SymmetryHandleOfName\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry name to a symmetry handle\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if no symmetry with that name has been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryHandleOfName(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return n; /* found */\n }\n }\n\n return -2; /* not found */\n}\n\n/*@@\n @routine SymBase_SymmetryNameOfHandle\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry handle to a symmetry name\n @enddesc\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry name\n @vio in\n @endvar\n @returntype CCTK_POINTER_TO_CONST\n @returndesc\n char const * containing the symmetry name\n NULL if no symmetry with that handle has been registered\n @endreturndesc\n@@*/\n\nCCTK_POINTER_TO_CONST\nSymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle) {\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return NULL; /* illegal argument */\n }\n\n return SymBase_symmetry_names[sym_handle];\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn SymBase\n# $Header$\n\n# Source files in this directory\nSRCS = Check.c Faces.c Handles.c Interpolation.c Startup.c Statistics.c Table.c\n\n# Subdirectories containing source files\nSUBDIRS = \n\n```\n\nInterpolation.c:\n```\n/*@@\n @file Interpolation.c\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Apply symmetry conditions during interpolation\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n#include \"util_ErrorCodes.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Interpolation_c);\n\n/*@@\n @routine SymBase_SymmetryInterpolate\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components.\n All arguments are equivalent to the CCTK_InterpGridArrays\n function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 Input array has illegal group type\n -94 Mixing grid functions and grid arrays\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n CCTK_INT faces;\n int has_grid_arrays, has_only_grid_arrays;\n int n;\n int f;\n int ierr;\n\n /* Check arguments */\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n /* If this interpolates grid arrays, then do not apply symmetries --\n there are no symmetries registered for grid arrays (yet). */\n has_grid_arrays = 0;\n has_only_grid_arrays = 1;\n for (n = 0; n < N_input_arrays; ++n) {\n if (input_array_indices[n] != -1) {\n const int grouptype = CCTK_GroupTypeFromVarI(input_array_indices[n]);\n switch (grouptype) {\n case CCTK_GF:\n has_only_grid_arrays = 0;\n break;\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n has_grid_arrays = 1;\n break;\n default: {\n char *groupname = CCTK_GroupName(input_array_indices[n]);\n CCTK_VWarn(CCTK_WARN_ALERT, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not determine group type of input arrays for group \"\n \"'%s' (%ld), received %d\",\n groupname, (long)input_array_indices[n], grouptype);\n free(groupname);\n }\n return -93;\n }\n }\n }\n if (has_grid_arrays && !has_only_grid_arrays) {\n CCTK_WARN(1, \"The input arrays contain both grid function and grid arrays; \"\n \"this is not possible\");\n return -94;\n }\n if (has_grid_arrays) {\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n return DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n }\n\n /* Check arguments */\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find all faces that need symmetries applied */\n faces = 0;\n for (f = 0; f < 2 * cctkGH->cctk_dim; ++f) {\n if (symmetry_interpolate[f]) {\n faces |= (1 << f);\n }\n }\n\n /* Forward the call */\n return SymBase_SymmetryInterpolateFaces(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays, output_array_types,\n output_arrays, faces);\n}\n\n/*@@\n @routine SymBase_SymmetryInterpolateFaces\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components,\n but only for the selected faces.\n When no faces are selected, forward the call to the\n driver's interpolator throug the aliased function\n \"DriverInterpolate\".\n All arguments except \"faces\" are equivalent to the\n CCTK_InterpGridArrays function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var faces\n @vtype CCTK_INT\n @vdesc Bit mask selecting which faces' symmetries should be treated.\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 faces is NULL\n or the return value from DriverInterpolate\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find a face that needs a symmetry applied */\n for (face = 0; face < 2 * N_dims; ++face) {\n if (faces & (1 << face)) {\n break;\n }\n }\n\n if (face == 2 * N_dims) {\n /* All faces are done */\n\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n ierr = DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n\n } else {\n /* Treat the face */\n\n /* Recursive call to a symmetry condition */\n if (!symmetry_interpolate[face]) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = ((SymmetryInterpolateFPointer)symmetry_interpolate[face])(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays, faces);\n }\n\n return ierr;\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Thorn startup\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Startup_c);\n\n/*@@\n @routine SymBase_Startup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a GH extension and initialise the global variables\n @enddesc\n @returntype int\n @returndesc\n status code\n 0 for success\n @endreturndesc\n@@*/\n\nint SymBase_Startup(void) {\n int handle;\n int ierr;\n\n handle = CCTK_RegisterGHExtension(\"SymBase\");\n if (handle < 0) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create GH extension for symmetry data\");\n }\n\n ierr = CCTK_RegisterGHExtensionSetupGH(handle, SymBase_Setup);\n if (ierr != 1) { /* strange error code convention */\n CCTK_WARN(0,\n \"Internal Error: Could not register GH Extension setup routine\");\n }\n\n SymBase_num_symmetries = 0;\n SymBase_symmetry_names = NULL;\n\n return 0; /* no error */\n}\n\n/*@@\n @routine SymBase_Setup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Initialise the GH extension\n @enddesc\n @var config\n @vtype tFleshConfig *\n @vdesc Internal flesh information, unused\n @vio in\n @endvar\n @var convlev\n @vtype int\n @vdesc Convergence level, unused\n @vio in\n @endvar\n @var cctkGH\n @vtype cGH *\n @vdesc Grid hierarchy\n @vio in\n @endvar\n@@*/\n\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH) {\n struct SymBase *symdata;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int group;\n int face;\n int ierr;\n const void *dummy;\n\n /* avoid compiler warnings about unused parameters */\n dummy = &config;\n dummy = &convlev;\n dummy = &cctkGH;\n dummy = &dummy;\n\n /* Create GH extension */\n symdata = malloc(sizeof *symdata);\n if (!symdata) {\n CCTK_WARN(0, \"Failed to allocate memory for symmetry data\");\n }\n\n /* Initialise handle and zone width arrays */\n for (face = 0; face < 100; ++face) {\n symmetry_handle[face] = -1;\n symmetry_zone_width[face] = 0;\n symmetry_interpolate[face] = NULL;\n }\n\n /* Create grid symmetry table */\n symdata->sym_table = Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n\n if (symdata->sym_table < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table.\");\n }\n\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"Internal Error: Can currently only handle a hundred faces.\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_handle, \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr =\n Util_TableSetFPointerArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n\n /* Create grid array symmetry tables */\n symdata->array_sym_tables =\n malloc(CCTK_NumGroups() * sizeof *symdata->array_sym_tables);\n if (!symdata->array_sym_tables) {\n CCTK_WARN(\n 0,\n \"Internal Error: Failed to create array for symmetry tables for GAs\");\n }\n\n for (group = 0; group < CCTK_NumGroups(); ++group) {\n switch (CCTK_GroupTypeI(group)) {\n case CCTK_GF:\n\n /* No table */\n symdata->array_sym_tables[group] = -1;\n break;\n\n case CCTK_SCALAR:\n /* FALL_THROUGH */\n\n case CCTK_ARRAY:\n\n /* Create array symmetry table */\n symdata->array_sym_tables[group] =\n Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n if (symdata->array_sym_tables[group] < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table for GA\");\n }\n\n if (2 * CCTK_GroupDimI(group) > 100) {\n CCTK_WARN(0, \"Internal Error: Can only handle 100 faces\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group), symmetry_handle,\n \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group),\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0,\n \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr = Util_TableSetFPointerArray(\n symdata->array_sym_tables[group], 2 * CCTK_GroupDimI(group),\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n break;\n\n default:\n CCTK_WARN(0, \"Internal Error: Unknown GV type\");\n }\n }\n\n return symdata;\n}\n\n```\n\n"}}},{"rowIdx":97,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/SymBase"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":""},"interface":{"kind":"string","value":"# Interface definition for thorn SymBase\n# $Header$\n\nIMPLEMENTS: SymBase\n\n\n\n# Register a symmetry, and query the symmetry name/handle mapping:\n\nCCTK_INT FUNCTION SymmetryRegister (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryRegister \\\n WITH SymBase_SymmetryRegister \\\n LANGUAGE C\n\nCCTK_INT FUNCTION SymmetryHandleOfName (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryHandleOfName \\\n WITH SymBase_SymmetryHandleOfName \\\n LANGUAGE C\n\nCCTK_POINTER_TO_CONST FUNCTION SymmetryNameOfHandle (CCTK_INT IN sym_handle)\nPROVIDES FUNCTION SymmetryNameOfHandle \\\n WITH SymBase_SymmetryNameOfHandle \\\n LANGUAGE C\n\n\n\n# Register a symmetry condition for a face:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGrid \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width) \nPROVIDES FUNCTION SymmetryRegisterGrid \\\n WITH SymBase_SymmetryRegisterGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGI \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryRegisterGI \\\n WITH SymBase_SymmetryRegisterGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGN \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryRegisterGN \\\n WITH SymBase_SymmetryRegisterGN \\\n LANGUAGE C\n\n\n\n# Register a symmetry interpolator:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGridInterpolator \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT CCTK_FPOINTER IN symmetry_interpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces))\nPROVIDES FUNCTION SymmetryRegisterGridInterpolator \\\n WITH SymBase_SymmetryRegisterGridInterpolator \\\n LANGUAGE C\n\n\n\n# Get the symmetry table handle for a grid or grid array:\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGrid (CCTK_POINTER_TO_CONST IN cctkGH)\nPROVIDES FUNCTION SymmetryTableHandleForGrid \\\n WITH SymBase_SymmetryTableHandleForGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGI \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryTableHandleForGI \\\n WITH SymBase_SymmetryTableHandleForGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGN \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryTableHandleForGN \\\n WITH SymBase_SymmetryTableHandleForGN \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n GetSymmetryBoundaries \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN size, \\\n CCTK_INT OUT ARRAY symbnd)\nPROVIDES FUNCTION GetSymmetryBoundaries \\\n WITH SymBase_GetSymmetryBoundaries \\\n LANGUAGE C\n\n\n\n# Interpolation\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nPROVIDES FUNCTION SymmetryInterpolate \\\n WITH SymBase_SymmetryInterpolate \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolateFaces \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces)\nPROVIDES FUNCTION SymmetryInterpolateFaces \\\n WITH SymBase_SymmetryInterpolateFaces \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n DriverInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nUSES FUNCTION DriverInterpolate\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn SymBase\n# $Header$\n\nBOOLEAN verbose \"Output symmetry boundary face descriptions after registration\"\n{\n} \"yes\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn SymBase\n# $Header$\n\nSCHEDULE SymBase_Startup AT CCTK_STARTUP\n{\n LANG: C\n} \"Register GH Extension for SymBase\"\n\nSCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH\n{\n} \"Wrapper group for SymBase\"\n\nSCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper\n{\n} \"Register your symmetries here\"\n\nSCHEDULE SymBase_Statistics IN SymBase_Wrapper AFTER SymmetryRegister\n{\n LANG: C\n} \"Print symmetry boundary face descriptions\"\n\nSCHEDULE SymBase_Check AT CCTK_BASEGRID\n{\n LANG: C\n} \"Check whether the driver set up the grid consistently\"\n"},"src_filename":{"kind":"string","value":"Faces.c"},"src_code":{"kind":"string","value":"/*@@\n @file Faces.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry condition for a face\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Faces_c);\n\n/*@@\n @routine SymBase_SymmetryRegisterFaces\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -3 if which_faces has an illegal value\n -4 if symmetry_zone_width has an illegal value\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!which_faces) {\n return -3; /* illegal argument */\n }\n if (!new_symmetry_zone_width) {\n return -4; /* illegal argument */\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (which_faces[face]) {\n if (symmetry_handle[face] != -1) {\n return -5; /* The face is already taken */\n }\n symmetry_handle[face] = sym_handle;\n if (new_symmetry_zone_width[face] > 100) {\n CCTK_WARN(0, \"Tried to register a symmetry face with a symmetry zone \"\n \"width >100 -- this looks like an error. This can be \"\n \"caused by using a symmetry thorn (or the old built-in \"\n \"CartGrid3D symmetries) which does not use CoordBase with \"\n \"new versions of the Carpet driver. Please use a \"\n \"separate symmetry thorn (e.g. ReflectionSymmetry) \"\n \"instead.\");\n }\n symmetry_zone_width[face] = new_symmetry_zone_width[face];\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterFaces(symdata->sym_table, cctkGH->cctk_dim,\n sym_handle, which_faces,\n new_symmetry_zone_width);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -6 if group_index has an illegal value\n -7 if the group has an illegal type\n -8 internal error\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return SymBase_SymmetryRegisterFaces(\n symdata->array_sym_tables[group_index], CCTK_GroupDimI(group_index),\n sym_handle, which_faces, new_symmetry_zone_width);\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryRegisterGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryRegisterGI(cctkGH_, sym_handle, which_faces,\n new_symmetry_zone_width, group_index);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterInterpolatorFaces\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n (may be NULL)\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -10 symmetry_interpolate is NULL\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!new_symmetry_interpolate) {\n return -10;\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (symmetry_handle[face] == sym_handle) {\n symmetry_interpolate[face] = (CCTK_FPOINTER)new_symmetry_interpolate;\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGridInterpolator\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator\n for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterInterpolatorFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterInterpolatorFaces(symdata->sym_table,\n cctkGH->cctk_dim, sym_handle,\n new_symmetry_interpolate);\n}\n"},"context_filenames":{"kind":"string","value":"SymBase.h\nTable.c\nStatistics.c\nCheck.c\nHandles.c\nmake.code.defn\nInterpolation.c\nStartup.c\n"},"context":{"kind":"string","value":"SymBase.h:\n```\n/*@@\n @file SymBase.h\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Declarations for thorn SymBase\n @version $Header$\n @enddesc\n@@*/\n\n#ifndef SYMBASE_H\n#define SYMBASE_H\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n/* SymBase's GH extension */\nstruct SymBase {\n /* The table handles below identify tables that have the following\n entries:\n\n CCTK_INT symmetry_handle[2*dim]\n CCTK_INT symmetry_zone_width[2*dim]\n CCTK_FPOINTER symmetry_interpolate[2*dim]\n\n dim is here the dimension of the group containing the variable,\n i.e. there is one entry per face. The true type of the\n symmetry_interpolate entries is SymmetryInterpolateFPointer.\n\n (Given that user code is not allowed to modify these tables, and\n that this structure is defined here in this header file, there is\n no real need to use tables for this. It would be possible to put\n these data directly into this structure, thereby simplifying user\n code and not make anything less flexible.)\n */\n\n /* Grid symmetry table handle */\n int sym_table;\n\n /* Grid array symmetry table handles, one handle per grid\n variable */\n int *array_sym_tables;\n};\n\ntypedef CCTK_INT (*SymmetryInterpolateFPointer)(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Number of registered symmetries */\nextern int SymBase_num_symmetries;\n\n/* The names of these symmetries */\nextern const char **SymBase_symmetry_names;\n\n/* Startup.c */\nint SymBase_Startup(void);\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH);\n\n/* Handles.c */\nCCTK_INT SymBase_SymmetryRegister(CCTK_STRING const sym_name);\nCCTK_INT SymBase_SymmetryHandleOfName(CCTK_STRING const sym_name);\nCCTK_POINTER_TO_CONST SymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle);\n\n/* Faces.c */\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name);\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\n\n/* Table.c */\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_);\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name);\n\n/* Interpolate.c */\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]);\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Statistics.c */\nvoid SymBase_Statistics(CCTK_ARGUMENTS);\n\n/* Check.c */\nvoid SymBase_Check(CCTK_ARGUMENTS);\n\n#endif /* ! defined SYMBASE_H */\n\n```\n\nTable.c:\n```\n/*@@\n @file Table.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Get the symmetry table handle for a grid or grid array\n @version $Header$\n @enddesc\n@@*/\n\n#include \"cctk.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Table_c);\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n return symdata->sym_table;\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n -6 if group_index has an illegal value\n -7 if the group type has an illegal value\n -8 if there was an internal error\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return symdata->array_sym_tables[group_index];\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGN\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryTableHandleForGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryTableHandleForGI(cctkGH_, group_index);\n}\n\n/*@@\n @routine SymBase_GetSymmetryBoundaries\n @author Erik Schnetter\n @date 2006-05-16\n @desc\n Determine which boundaries are symmetry boundaries\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var size\n @vtype CCTK_INT\n @vdesc Array size\n @vio in\n @endvar\n @var symbnd\n @vtype CCTK_INT [size]\n @vdesc 0 for outer boundary, 1 for symmetry boundary\n @vio out\n @endvar\n @returntype CCTK_INT\n @returndesc\n 0 Success\n -10 Wrong array size; must be 2*cctk_dim\n -11 Symmetry table handle does not exist\n -12 Wrong number of symmetry table entries (internal error)\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_GetSymmetryBoundaries(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const size,\n CCTK_INT *restrict const symbnd) {\n cGH const *const cctkGH = cctkGH_;\n CCTK_INT symtable;\n CCTK_INT symmetry_handle[6];\n CCTK_INT iret;\n int d;\n\n /* Check the arguments */\n if (size != 2 * cctkGH->cctk_dim) {\n return -10;\n }\n\n /* Get the symmetry table */\n symtable = SymmetryTableHandleForGrid(cctkGH);\n if (symtable < 0) {\n return -11;\n }\n\n /* Get the symmetry handles for each face */\n iret = Util_TableGetIntArray(symtable, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (iret != 2 * cctkGH->cctk_dim) {\n return -12;\n }\n\n /* A face has a symmetry boundary if there is a valid (non-negative)\n handle registered for that face */\n for (d = 0; d < 2 * cctkGH->cctk_dim; ++d) {\n symbnd[d] = symmetry_handle[d] >= 0;\n }\n\n /* Success */\n return 0;\n}\n\n```\n\nStatistics.c:\n```\n/*@@\n @file Statistics.c\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Provide information about the registered symmetry conditions\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Statistics_c);\n\n/*@@\n @routine SymBase_Statistics\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n If verbose, print the symmetry boundary conditions for each\n face.\n Warn if symmetries do not have interpolation operators\n associated with them.\n @enddesc\n@@*/\n\nvoid SymBase_Statistics(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n char const *symmetry_name;\n int face;\n int ierr;\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Print information about the registered symmetry faces, if desired */\n\n if (verbose) {\n\n /* Loop over all faces */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VInfo(CCTK_THORNSTRING, \"Symmetry on %s %c-face: %s\",\n face % 2 == 0 ? \"lower\" : \"upper\", \"xyz\"[face / 2],\n symmetry_name);\n }\n }\n }\n\n /* Warn about symmetries without interpolators */\n\n /* Loop over all registered symmetries */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n if (symmetry_interpolate[face] == NULL) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"The symmetry \\\"%s\\\" on the %s %c-face has not registered a \"\n \"symmetry interpolator\",\n symmetry_name, face % 2 == 0 ? \"lower\" : \"upper\",\n \"xyz\"[face / 2]);\n }\n }\n }\n}\n\n```\n\nCheck.c:\n```\n/*@@\n @file Check.c\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @version $Header$\n @enddesc\n@@*/\n\n#include \"util_Table.h\"\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Check_c);\n\n/*@@\n @routine SymBase_Check\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @enddesc\n @var CCTK_ARGUMENTS\n @endvar\n@@*/\n\nvoid SymBase_Check(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n\n struct SymBase const *symdata;\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int ierr;\n int d;\n\n /* Get table entries */\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n sym_table = symdata->sym_table;\n\n if (2 * cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ierr = 0;\n\n for (d = 0; d < cctk_dim; ++d) {\n\n /* Check lower boundary */\n if (symmetry_handle[2 * d] >= 0) {\n if (cctk_bbox[2 * d]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] < symmetry_zone_width[2 * d]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the lower boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n\n /* Check upper boundary */\n if (symmetry_handle[2 * d + 1] >= 0) {\n if (cctk_bbox[2 * d + 1]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] <\n symmetry_zone_width[2 * d + 1]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the upper boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n }\n\n if (ierr) {\n CCTK_WARN(0, \"The grid setup is inconsistent with the boundary sizes. One \"\n \"or more processors' domains are too small. The grid setup \"\n \"is decided by the driver. Try to make the driver lay out \"\n \"the grids differently.\");\n }\n}\n\n```\n\nHandles.c:\n```\n/*@@\n @file Handles.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry, and query the symmetry name/handle mapping\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Handles_c);\n\n/* Number of registered symmetries */\nint SymBase_num_symmetries;\n\n/* The names of these symmetries */\nconst char **SymBase_symmetry_names;\n\n/*@@\n @routine SymBase_SymmetryRegister\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if a symmetry with the same name has already been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegister(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return -2; /* symmetry exists already */\n }\n }\n\n SymBase_symmetry_names =\n realloc(SymBase_symmetry_names,\n (SymBase_num_symmetries + 1) * sizeof *SymBase_symmetry_names);\n if (!SymBase_symmetry_names) {\n CCTK_WARN(0, \"internal error\");\n }\n\n SymBase_symmetry_names[SymBase_num_symmetries] = strdup(sym_name);\n if (!SymBase_symmetry_names[SymBase_num_symmetries]) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ++SymBase_num_symmetries;\n\n return SymBase_num_symmetries - 1;\n}\n\n/*@@\n @routine SymBase_SymmetryHandleOfName\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry name to a symmetry handle\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if no symmetry with that name has been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryHandleOfName(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return n; /* found */\n }\n }\n\n return -2; /* not found */\n}\n\n/*@@\n @routine SymBase_SymmetryNameOfHandle\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry handle to a symmetry name\n @enddesc\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry name\n @vio in\n @endvar\n @returntype CCTK_POINTER_TO_CONST\n @returndesc\n char const * containing the symmetry name\n NULL if no symmetry with that handle has been registered\n @endreturndesc\n@@*/\n\nCCTK_POINTER_TO_CONST\nSymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle) {\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return NULL; /* illegal argument */\n }\n\n return SymBase_symmetry_names[sym_handle];\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn SymBase\n# $Header$\n\n# Source files in this directory\nSRCS = Check.c Faces.c Handles.c Interpolation.c Startup.c Statistics.c Table.c\n\n# Subdirectories containing source files\nSUBDIRS = \n\n```\n\nInterpolation.c:\n```\n/*@@\n @file Interpolation.c\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Apply symmetry conditions during interpolation\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n#include \"util_ErrorCodes.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Interpolation_c);\n\n/*@@\n @routine SymBase_SymmetryInterpolate\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components.\n All arguments are equivalent to the CCTK_InterpGridArrays\n function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 Input array has illegal group type\n -94 Mixing grid functions and grid arrays\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n CCTK_INT faces;\n int has_grid_arrays, has_only_grid_arrays;\n int n;\n int f;\n int ierr;\n\n /* Check arguments */\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n /* If this interpolates grid arrays, then do not apply symmetries --\n there are no symmetries registered for grid arrays (yet). */\n has_grid_arrays = 0;\n has_only_grid_arrays = 1;\n for (n = 0; n < N_input_arrays; ++n) {\n if (input_array_indices[n] != -1) {\n const int grouptype = CCTK_GroupTypeFromVarI(input_array_indices[n]);\n switch (grouptype) {\n case CCTK_GF:\n has_only_grid_arrays = 0;\n break;\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n has_grid_arrays = 1;\n break;\n default: {\n char *groupname = CCTK_GroupName(input_array_indices[n]);\n CCTK_VWarn(CCTK_WARN_ALERT, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not determine group type of input arrays for group \"\n \"'%s' (%ld), received %d\",\n groupname, (long)input_array_indices[n], grouptype);\n free(groupname);\n }\n return -93;\n }\n }\n }\n if (has_grid_arrays && !has_only_grid_arrays) {\n CCTK_WARN(1, \"The input arrays contain both grid function and grid arrays; \"\n \"this is not possible\");\n return -94;\n }\n if (has_grid_arrays) {\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n return DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n }\n\n /* Check arguments */\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find all faces that need symmetries applied */\n faces = 0;\n for (f = 0; f < 2 * cctkGH->cctk_dim; ++f) {\n if (symmetry_interpolate[f]) {\n faces |= (1 << f);\n }\n }\n\n /* Forward the call */\n return SymBase_SymmetryInterpolateFaces(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays, output_array_types,\n output_arrays, faces);\n}\n\n/*@@\n @routine SymBase_SymmetryInterpolateFaces\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components,\n but only for the selected faces.\n When no faces are selected, forward the call to the\n driver's interpolator throug the aliased function\n \"DriverInterpolate\".\n All arguments except \"faces\" are equivalent to the\n CCTK_InterpGridArrays function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var faces\n @vtype CCTK_INT\n @vdesc Bit mask selecting which faces' symmetries should be treated.\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 faces is NULL\n or the return value from DriverInterpolate\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find a face that needs a symmetry applied */\n for (face = 0; face < 2 * N_dims; ++face) {\n if (faces & (1 << face)) {\n break;\n }\n }\n\n if (face == 2 * N_dims) {\n /* All faces are done */\n\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n ierr = DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n\n } else {\n /* Treat the face */\n\n /* Recursive call to a symmetry condition */\n if (!symmetry_interpolate[face]) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = ((SymmetryInterpolateFPointer)symmetry_interpolate[face])(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays, faces);\n }\n\n return ierr;\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Thorn startup\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Startup_c);\n\n/*@@\n @routine SymBase_Startup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a GH extension and initialise the global variables\n @enddesc\n @returntype int\n @returndesc\n status code\n 0 for success\n @endreturndesc\n@@*/\n\nint SymBase_Startup(void) {\n int handle;\n int ierr;\n\n handle = CCTK_RegisterGHExtension(\"SymBase\");\n if (handle < 0) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create GH extension for symmetry data\");\n }\n\n ierr = CCTK_RegisterGHExtensionSetupGH(handle, SymBase_Setup);\n if (ierr != 1) { /* strange error code convention */\n CCTK_WARN(0,\n \"Internal Error: Could not register GH Extension setup routine\");\n }\n\n SymBase_num_symmetries = 0;\n SymBase_symmetry_names = NULL;\n\n return 0; /* no error */\n}\n\n/*@@\n @routine SymBase_Setup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Initialise the GH extension\n @enddesc\n @var config\n @vtype tFleshConfig *\n @vdesc Internal flesh information, unused\n @vio in\n @endvar\n @var convlev\n @vtype int\n @vdesc Convergence level, unused\n @vio in\n @endvar\n @var cctkGH\n @vtype cGH *\n @vdesc Grid hierarchy\n @vio in\n @endvar\n@@*/\n\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH) {\n struct SymBase *symdata;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int group;\n int face;\n int ierr;\n const void *dummy;\n\n /* avoid compiler warnings about unused parameters */\n dummy = &config;\n dummy = &convlev;\n dummy = &cctkGH;\n dummy = &dummy;\n\n /* Create GH extension */\n symdata = malloc(sizeof *symdata);\n if (!symdata) {\n CCTK_WARN(0, \"Failed to allocate memory for symmetry data\");\n }\n\n /* Initialise handle and zone width arrays */\n for (face = 0; face < 100; ++face) {\n symmetry_handle[face] = -1;\n symmetry_zone_width[face] = 0;\n symmetry_interpolate[face] = NULL;\n }\n\n /* Create grid symmetry table */\n symdata->sym_table = Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n\n if (symdata->sym_table < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table.\");\n }\n\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"Internal Error: Can currently only handle a hundred faces.\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_handle, \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr =\n Util_TableSetFPointerArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n\n /* Create grid array symmetry tables */\n symdata->array_sym_tables =\n malloc(CCTK_NumGroups() * sizeof *symdata->array_sym_tables);\n if (!symdata->array_sym_tables) {\n CCTK_WARN(\n 0,\n \"Internal Error: Failed to create array for symmetry tables for GAs\");\n }\n\n for (group = 0; group < CCTK_NumGroups(); ++group) {\n switch (CCTK_GroupTypeI(group)) {\n case CCTK_GF:\n\n /* No table */\n symdata->array_sym_tables[group] = -1;\n break;\n\n case CCTK_SCALAR:\n /* FALL_THROUGH */\n\n case CCTK_ARRAY:\n\n /* Create array symmetry table */\n symdata->array_sym_tables[group] =\n Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n if (symdata->array_sym_tables[group] < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table for GA\");\n }\n\n if (2 * CCTK_GroupDimI(group) > 100) {\n CCTK_WARN(0, \"Internal Error: Can only handle 100 faces\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group), symmetry_handle,\n \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group),\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0,\n \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr = Util_TableSetFPointerArray(\n symdata->array_sym_tables[group], 2 * CCTK_GroupDimI(group),\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n break;\n\n default:\n CCTK_WARN(0, \"Internal Error: Unknown GV type\");\n }\n }\n\n return symdata;\n}\n\n```\n\n"}}},{"rowIdx":98,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/SymBase"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":""},"interface":{"kind":"string","value":"# Interface definition for thorn SymBase\n# $Header$\n\nIMPLEMENTS: SymBase\n\n\n\n# Register a symmetry, and query the symmetry name/handle mapping:\n\nCCTK_INT FUNCTION SymmetryRegister (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryRegister \\\n WITH SymBase_SymmetryRegister \\\n LANGUAGE C\n\nCCTK_INT FUNCTION SymmetryHandleOfName (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryHandleOfName \\\n WITH SymBase_SymmetryHandleOfName \\\n LANGUAGE C\n\nCCTK_POINTER_TO_CONST FUNCTION SymmetryNameOfHandle (CCTK_INT IN sym_handle)\nPROVIDES FUNCTION SymmetryNameOfHandle \\\n WITH SymBase_SymmetryNameOfHandle \\\n LANGUAGE C\n\n\n\n# Register a symmetry condition for a face:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGrid \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width) \nPROVIDES FUNCTION SymmetryRegisterGrid \\\n WITH SymBase_SymmetryRegisterGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGI \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryRegisterGI \\\n WITH SymBase_SymmetryRegisterGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGN \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryRegisterGN \\\n WITH SymBase_SymmetryRegisterGN \\\n LANGUAGE C\n\n\n\n# Register a symmetry interpolator:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGridInterpolator \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT CCTK_FPOINTER IN symmetry_interpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces))\nPROVIDES FUNCTION SymmetryRegisterGridInterpolator \\\n WITH SymBase_SymmetryRegisterGridInterpolator \\\n LANGUAGE C\n\n\n\n# Get the symmetry table handle for a grid or grid array:\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGrid (CCTK_POINTER_TO_CONST IN cctkGH)\nPROVIDES FUNCTION SymmetryTableHandleForGrid \\\n WITH SymBase_SymmetryTableHandleForGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGI \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryTableHandleForGI \\\n WITH SymBase_SymmetryTableHandleForGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGN \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryTableHandleForGN \\\n WITH SymBase_SymmetryTableHandleForGN \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n GetSymmetryBoundaries \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN size, \\\n CCTK_INT OUT ARRAY symbnd)\nPROVIDES FUNCTION GetSymmetryBoundaries \\\n WITH SymBase_GetSymmetryBoundaries \\\n LANGUAGE C\n\n\n\n# Interpolation\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nPROVIDES FUNCTION SymmetryInterpolate \\\n WITH SymBase_SymmetryInterpolate \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolateFaces \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces)\nPROVIDES FUNCTION SymmetryInterpolateFaces \\\n WITH SymBase_SymmetryInterpolateFaces \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n DriverInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nUSES FUNCTION DriverInterpolate\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn SymBase\n# $Header$\n\nBOOLEAN verbose \"Output symmetry boundary face descriptions after registration\"\n{\n} \"yes\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn SymBase\n# $Header$\n\nSCHEDULE SymBase_Startup AT CCTK_STARTUP\n{\n LANG: C\n} \"Register GH Extension for SymBase\"\n\nSCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH\n{\n} \"Wrapper group for SymBase\"\n\nSCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper\n{\n} \"Register your symmetries here\"\n\nSCHEDULE SymBase_Statistics IN SymBase_Wrapper AFTER SymmetryRegister\n{\n LANG: C\n} \"Print symmetry boundary face descriptions\"\n\nSCHEDULE SymBase_Check AT CCTK_BASEGRID\n{\n LANG: C\n} \"Check whether the driver set up the grid consistently\"\n"},"src_filename":{"kind":"string","value":"Statistics.c"},"src_code":{"kind":"string","value":"/*@@\n @file Statistics.c\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Provide information about the registered symmetry conditions\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Statistics_c);\n\n/*@@\n @routine SymBase_Statistics\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n If verbose, print the symmetry boundary conditions for each\n face.\n Warn if symmetries do not have interpolation operators\n associated with them.\n @enddesc\n@@*/\n\nvoid SymBase_Statistics(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n char const *symmetry_name;\n int face;\n int ierr;\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Print information about the registered symmetry faces, if desired */\n\n if (verbose) {\n\n /* Loop over all faces */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VInfo(CCTK_THORNSTRING, \"Symmetry on %s %c-face: %s\",\n face % 2 == 0 ? \"lower\" : \"upper\", \"xyz\"[face / 2],\n symmetry_name);\n }\n }\n }\n\n /* Warn about symmetries without interpolators */\n\n /* Loop over all registered symmetries */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n if (symmetry_interpolate[face] == NULL) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"The symmetry \\\"%s\\\" on the %s %c-face has not registered a \"\n \"symmetry interpolator\",\n symmetry_name, face % 2 == 0 ? \"lower\" : \"upper\",\n \"xyz\"[face / 2]);\n }\n }\n }\n}\n"},"context_filenames":{"kind":"string","value":"SymBase.h\nTable.c\nFaces.c\nCheck.c\nHandles.c\nmake.code.defn\nInterpolation.c\nStartup.c\n"},"context":{"kind":"string","value":"SymBase.h:\n```\n/*@@\n @file SymBase.h\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Declarations for thorn SymBase\n @version $Header$\n @enddesc\n@@*/\n\n#ifndef SYMBASE_H\n#define SYMBASE_H\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n/* SymBase's GH extension */\nstruct SymBase {\n /* The table handles below identify tables that have the following\n entries:\n\n CCTK_INT symmetry_handle[2*dim]\n CCTK_INT symmetry_zone_width[2*dim]\n CCTK_FPOINTER symmetry_interpolate[2*dim]\n\n dim is here the dimension of the group containing the variable,\n i.e. there is one entry per face. The true type of the\n symmetry_interpolate entries is SymmetryInterpolateFPointer.\n\n (Given that user code is not allowed to modify these tables, and\n that this structure is defined here in this header file, there is\n no real need to use tables for this. It would be possible to put\n these data directly into this structure, thereby simplifying user\n code and not make anything less flexible.)\n */\n\n /* Grid symmetry table handle */\n int sym_table;\n\n /* Grid array symmetry table handles, one handle per grid\n variable */\n int *array_sym_tables;\n};\n\ntypedef CCTK_INT (*SymmetryInterpolateFPointer)(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Number of registered symmetries */\nextern int SymBase_num_symmetries;\n\n/* The names of these symmetries */\nextern const char **SymBase_symmetry_names;\n\n/* Startup.c */\nint SymBase_Startup(void);\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH);\n\n/* Handles.c */\nCCTK_INT SymBase_SymmetryRegister(CCTK_STRING const sym_name);\nCCTK_INT SymBase_SymmetryHandleOfName(CCTK_STRING const sym_name);\nCCTK_POINTER_TO_CONST SymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle);\n\n/* Faces.c */\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name);\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\n\n/* Table.c */\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_);\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name);\n\n/* Interpolate.c */\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]);\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Statistics.c */\nvoid SymBase_Statistics(CCTK_ARGUMENTS);\n\n/* Check.c */\nvoid SymBase_Check(CCTK_ARGUMENTS);\n\n#endif /* ! defined SYMBASE_H */\n\n```\n\nTable.c:\n```\n/*@@\n @file Table.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Get the symmetry table handle for a grid or grid array\n @version $Header$\n @enddesc\n@@*/\n\n#include \"cctk.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Table_c);\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n return symdata->sym_table;\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n -6 if group_index has an illegal value\n -7 if the group type has an illegal value\n -8 if there was an internal error\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return symdata->array_sym_tables[group_index];\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGN\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryTableHandleForGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryTableHandleForGI(cctkGH_, group_index);\n}\n\n/*@@\n @routine SymBase_GetSymmetryBoundaries\n @author Erik Schnetter\n @date 2006-05-16\n @desc\n Determine which boundaries are symmetry boundaries\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var size\n @vtype CCTK_INT\n @vdesc Array size\n @vio in\n @endvar\n @var symbnd\n @vtype CCTK_INT [size]\n @vdesc 0 for outer boundary, 1 for symmetry boundary\n @vio out\n @endvar\n @returntype CCTK_INT\n @returndesc\n 0 Success\n -10 Wrong array size; must be 2*cctk_dim\n -11 Symmetry table handle does not exist\n -12 Wrong number of symmetry table entries (internal error)\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_GetSymmetryBoundaries(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const size,\n CCTK_INT *restrict const symbnd) {\n cGH const *const cctkGH = cctkGH_;\n CCTK_INT symtable;\n CCTK_INT symmetry_handle[6];\n CCTK_INT iret;\n int d;\n\n /* Check the arguments */\n if (size != 2 * cctkGH->cctk_dim) {\n return -10;\n }\n\n /* Get the symmetry table */\n symtable = SymmetryTableHandleForGrid(cctkGH);\n if (symtable < 0) {\n return -11;\n }\n\n /* Get the symmetry handles for each face */\n iret = Util_TableGetIntArray(symtable, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (iret != 2 * cctkGH->cctk_dim) {\n return -12;\n }\n\n /* A face has a symmetry boundary if there is a valid (non-negative)\n handle registered for that face */\n for (d = 0; d < 2 * cctkGH->cctk_dim; ++d) {\n symbnd[d] = symmetry_handle[d] >= 0;\n }\n\n /* Success */\n return 0;\n}\n\n```\n\nFaces.c:\n```\n/*@@\n @file Faces.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry condition for a face\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Faces_c);\n\n/*@@\n @routine SymBase_SymmetryRegisterFaces\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -3 if which_faces has an illegal value\n -4 if symmetry_zone_width has an illegal value\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!which_faces) {\n return -3; /* illegal argument */\n }\n if (!new_symmetry_zone_width) {\n return -4; /* illegal argument */\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (which_faces[face]) {\n if (symmetry_handle[face] != -1) {\n return -5; /* The face is already taken */\n }\n symmetry_handle[face] = sym_handle;\n if (new_symmetry_zone_width[face] > 100) {\n CCTK_WARN(0, \"Tried to register a symmetry face with a symmetry zone \"\n \"width >100 -- this looks like an error. This can be \"\n \"caused by using a symmetry thorn (or the old built-in \"\n \"CartGrid3D symmetries) which does not use CoordBase with \"\n \"new versions of the Carpet driver. Please use a \"\n \"separate symmetry thorn (e.g. ReflectionSymmetry) \"\n \"instead.\");\n }\n symmetry_zone_width[face] = new_symmetry_zone_width[face];\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterFaces(symdata->sym_table, cctkGH->cctk_dim,\n sym_handle, which_faces,\n new_symmetry_zone_width);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -6 if group_index has an illegal value\n -7 if the group has an illegal type\n -8 internal error\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return SymBase_SymmetryRegisterFaces(\n symdata->array_sym_tables[group_index], CCTK_GroupDimI(group_index),\n sym_handle, which_faces, new_symmetry_zone_width);\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryRegisterGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryRegisterGI(cctkGH_, sym_handle, which_faces,\n new_symmetry_zone_width, group_index);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterInterpolatorFaces\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n (may be NULL)\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -10 symmetry_interpolate is NULL\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!new_symmetry_interpolate) {\n return -10;\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (symmetry_handle[face] == sym_handle) {\n symmetry_interpolate[face] = (CCTK_FPOINTER)new_symmetry_interpolate;\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGridInterpolator\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator\n for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterInterpolatorFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterInterpolatorFaces(symdata->sym_table,\n cctkGH->cctk_dim, sym_handle,\n new_symmetry_interpolate);\n}\n\n```\n\nCheck.c:\n```\n/*@@\n @file Check.c\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @version $Header$\n @enddesc\n@@*/\n\n#include \"util_Table.h\"\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Check_c);\n\n/*@@\n @routine SymBase_Check\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @enddesc\n @var CCTK_ARGUMENTS\n @endvar\n@@*/\n\nvoid SymBase_Check(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n\n struct SymBase const *symdata;\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int ierr;\n int d;\n\n /* Get table entries */\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n sym_table = symdata->sym_table;\n\n if (2 * cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ierr = 0;\n\n for (d = 0; d < cctk_dim; ++d) {\n\n /* Check lower boundary */\n if (symmetry_handle[2 * d] >= 0) {\n if (cctk_bbox[2 * d]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] < symmetry_zone_width[2 * d]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the lower boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n\n /* Check upper boundary */\n if (symmetry_handle[2 * d + 1] >= 0) {\n if (cctk_bbox[2 * d + 1]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] <\n symmetry_zone_width[2 * d + 1]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the upper boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n }\n\n if (ierr) {\n CCTK_WARN(0, \"The grid setup is inconsistent with the boundary sizes. One \"\n \"or more processors' domains are too small. The grid setup \"\n \"is decided by the driver. Try to make the driver lay out \"\n \"the grids differently.\");\n }\n}\n\n```\n\nHandles.c:\n```\n/*@@\n @file Handles.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry, and query the symmetry name/handle mapping\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Handles_c);\n\n/* Number of registered symmetries */\nint SymBase_num_symmetries;\n\n/* The names of these symmetries */\nconst char **SymBase_symmetry_names;\n\n/*@@\n @routine SymBase_SymmetryRegister\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if a symmetry with the same name has already been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegister(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return -2; /* symmetry exists already */\n }\n }\n\n SymBase_symmetry_names =\n realloc(SymBase_symmetry_names,\n (SymBase_num_symmetries + 1) * sizeof *SymBase_symmetry_names);\n if (!SymBase_symmetry_names) {\n CCTK_WARN(0, \"internal error\");\n }\n\n SymBase_symmetry_names[SymBase_num_symmetries] = strdup(sym_name);\n if (!SymBase_symmetry_names[SymBase_num_symmetries]) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ++SymBase_num_symmetries;\n\n return SymBase_num_symmetries - 1;\n}\n\n/*@@\n @routine SymBase_SymmetryHandleOfName\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry name to a symmetry handle\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if no symmetry with that name has been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryHandleOfName(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return n; /* found */\n }\n }\n\n return -2; /* not found */\n}\n\n/*@@\n @routine SymBase_SymmetryNameOfHandle\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry handle to a symmetry name\n @enddesc\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry name\n @vio in\n @endvar\n @returntype CCTK_POINTER_TO_CONST\n @returndesc\n char const * containing the symmetry name\n NULL if no symmetry with that handle has been registered\n @endreturndesc\n@@*/\n\nCCTK_POINTER_TO_CONST\nSymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle) {\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return NULL; /* illegal argument */\n }\n\n return SymBase_symmetry_names[sym_handle];\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn SymBase\n# $Header$\n\n# Source files in this directory\nSRCS = Check.c Faces.c Handles.c Interpolation.c Startup.c Statistics.c Table.c\n\n# Subdirectories containing source files\nSUBDIRS = \n\n```\n\nInterpolation.c:\n```\n/*@@\n @file Interpolation.c\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Apply symmetry conditions during interpolation\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n#include \"util_ErrorCodes.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Interpolation_c);\n\n/*@@\n @routine SymBase_SymmetryInterpolate\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components.\n All arguments are equivalent to the CCTK_InterpGridArrays\n function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 Input array has illegal group type\n -94 Mixing grid functions and grid arrays\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n CCTK_INT faces;\n int has_grid_arrays, has_only_grid_arrays;\n int n;\n int f;\n int ierr;\n\n /* Check arguments */\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n /* If this interpolates grid arrays, then do not apply symmetries --\n there are no symmetries registered for grid arrays (yet). */\n has_grid_arrays = 0;\n has_only_grid_arrays = 1;\n for (n = 0; n < N_input_arrays; ++n) {\n if (input_array_indices[n] != -1) {\n const int grouptype = CCTK_GroupTypeFromVarI(input_array_indices[n]);\n switch (grouptype) {\n case CCTK_GF:\n has_only_grid_arrays = 0;\n break;\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n has_grid_arrays = 1;\n break;\n default: {\n char *groupname = CCTK_GroupName(input_array_indices[n]);\n CCTK_VWarn(CCTK_WARN_ALERT, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not determine group type of input arrays for group \"\n \"'%s' (%ld), received %d\",\n groupname, (long)input_array_indices[n], grouptype);\n free(groupname);\n }\n return -93;\n }\n }\n }\n if (has_grid_arrays && !has_only_grid_arrays) {\n CCTK_WARN(1, \"The input arrays contain both grid function and grid arrays; \"\n \"this is not possible\");\n return -94;\n }\n if (has_grid_arrays) {\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n return DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n }\n\n /* Check arguments */\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find all faces that need symmetries applied */\n faces = 0;\n for (f = 0; f < 2 * cctkGH->cctk_dim; ++f) {\n if (symmetry_interpolate[f]) {\n faces |= (1 << f);\n }\n }\n\n /* Forward the call */\n return SymBase_SymmetryInterpolateFaces(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays, output_array_types,\n output_arrays, faces);\n}\n\n/*@@\n @routine SymBase_SymmetryInterpolateFaces\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components,\n but only for the selected faces.\n When no faces are selected, forward the call to the\n driver's interpolator throug the aliased function\n \"DriverInterpolate\".\n All arguments except \"faces\" are equivalent to the\n CCTK_InterpGridArrays function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var faces\n @vtype CCTK_INT\n @vdesc Bit mask selecting which faces' symmetries should be treated.\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 faces is NULL\n or the return value from DriverInterpolate\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find a face that needs a symmetry applied */\n for (face = 0; face < 2 * N_dims; ++face) {\n if (faces & (1 << face)) {\n break;\n }\n }\n\n if (face == 2 * N_dims) {\n /* All faces are done */\n\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n ierr = DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n\n } else {\n /* Treat the face */\n\n /* Recursive call to a symmetry condition */\n if (!symmetry_interpolate[face]) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = ((SymmetryInterpolateFPointer)symmetry_interpolate[face])(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays, faces);\n }\n\n return ierr;\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Thorn startup\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Startup_c);\n\n/*@@\n @routine SymBase_Startup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a GH extension and initialise the global variables\n @enddesc\n @returntype int\n @returndesc\n status code\n 0 for success\n @endreturndesc\n@@*/\n\nint SymBase_Startup(void) {\n int handle;\n int ierr;\n\n handle = CCTK_RegisterGHExtension(\"SymBase\");\n if (handle < 0) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create GH extension for symmetry data\");\n }\n\n ierr = CCTK_RegisterGHExtensionSetupGH(handle, SymBase_Setup);\n if (ierr != 1) { /* strange error code convention */\n CCTK_WARN(0,\n \"Internal Error: Could not register GH Extension setup routine\");\n }\n\n SymBase_num_symmetries = 0;\n SymBase_symmetry_names = NULL;\n\n return 0; /* no error */\n}\n\n/*@@\n @routine SymBase_Setup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Initialise the GH extension\n @enddesc\n @var config\n @vtype tFleshConfig *\n @vdesc Internal flesh information, unused\n @vio in\n @endvar\n @var convlev\n @vtype int\n @vdesc Convergence level, unused\n @vio in\n @endvar\n @var cctkGH\n @vtype cGH *\n @vdesc Grid hierarchy\n @vio in\n @endvar\n@@*/\n\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH) {\n struct SymBase *symdata;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int group;\n int face;\n int ierr;\n const void *dummy;\n\n /* avoid compiler warnings about unused parameters */\n dummy = &config;\n dummy = &convlev;\n dummy = &cctkGH;\n dummy = &dummy;\n\n /* Create GH extension */\n symdata = malloc(sizeof *symdata);\n if (!symdata) {\n CCTK_WARN(0, \"Failed to allocate memory for symmetry data\");\n }\n\n /* Initialise handle and zone width arrays */\n for (face = 0; face < 100; ++face) {\n symmetry_handle[face] = -1;\n symmetry_zone_width[face] = 0;\n symmetry_interpolate[face] = NULL;\n }\n\n /* Create grid symmetry table */\n symdata->sym_table = Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n\n if (symdata->sym_table < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table.\");\n }\n\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"Internal Error: Can currently only handle a hundred faces.\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_handle, \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr =\n Util_TableSetFPointerArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n\n /* Create grid array symmetry tables */\n symdata->array_sym_tables =\n malloc(CCTK_NumGroups() * sizeof *symdata->array_sym_tables);\n if (!symdata->array_sym_tables) {\n CCTK_WARN(\n 0,\n \"Internal Error: Failed to create array for symmetry tables for GAs\");\n }\n\n for (group = 0; group < CCTK_NumGroups(); ++group) {\n switch (CCTK_GroupTypeI(group)) {\n case CCTK_GF:\n\n /* No table */\n symdata->array_sym_tables[group] = -1;\n break;\n\n case CCTK_SCALAR:\n /* FALL_THROUGH */\n\n case CCTK_ARRAY:\n\n /* Create array symmetry table */\n symdata->array_sym_tables[group] =\n Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n if (symdata->array_sym_tables[group] < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table for GA\");\n }\n\n if (2 * CCTK_GroupDimI(group) > 100) {\n CCTK_WARN(0, \"Internal Error: Can only handle 100 faces\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group), symmetry_handle,\n \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group),\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0,\n \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr = Util_TableSetFPointerArray(\n symdata->array_sym_tables[group], 2 * CCTK_GroupDimI(group),\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n break;\n\n default:\n CCTK_WARN(0, \"Internal Error: Unknown GV type\");\n }\n }\n\n return symdata;\n}\n\n```\n\n"}}},{"rowIdx":99,"cells":{"thorn_name":{"kind":"string","value":"CactusBase/SymBase"},"url":{"kind":"string","value":"https://bitbucket.org/cactuscode/cactusbase.git"},"configuration":{"kind":"string","value":""},"interface":{"kind":"string","value":"# Interface definition for thorn SymBase\n# $Header$\n\nIMPLEMENTS: SymBase\n\n\n\n# Register a symmetry, and query the symmetry name/handle mapping:\n\nCCTK_INT FUNCTION SymmetryRegister (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryRegister \\\n WITH SymBase_SymmetryRegister \\\n LANGUAGE C\n\nCCTK_INT FUNCTION SymmetryHandleOfName (CCTK_STRING IN sym_name)\nPROVIDES FUNCTION SymmetryHandleOfName \\\n WITH SymBase_SymmetryHandleOfName \\\n LANGUAGE C\n\nCCTK_POINTER_TO_CONST FUNCTION SymmetryNameOfHandle (CCTK_INT IN sym_handle)\nPROVIDES FUNCTION SymmetryNameOfHandle \\\n WITH SymBase_SymmetryNameOfHandle \\\n LANGUAGE C\n\n\n\n# Register a symmetry condition for a face:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGrid \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width) \nPROVIDES FUNCTION SymmetryRegisterGrid \\\n WITH SymBase_SymmetryRegisterGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGI \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryRegisterGI \\\n WITH SymBase_SymmetryRegisterGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGN \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT IN ARRAY which_faces, \\\n CCTK_INT IN ARRAY symmetry_zone_width, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryRegisterGN \\\n WITH SymBase_SymmetryRegisterGN \\\n LANGUAGE C\n\n\n\n# Register a symmetry interpolator:\n\nCCTK_INT FUNCTION \\\n SymmetryRegisterGridInterpolator \\\n (CCTK_POINTER IN cctkGH, \\\n CCTK_INT IN sym_handle, \\\n CCTK_INT CCTK_FPOINTER IN symmetry_interpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces))\nPROVIDES FUNCTION SymmetryRegisterGridInterpolator \\\n WITH SymBase_SymmetryRegisterGridInterpolator \\\n LANGUAGE C\n\n\n\n# Get the symmetry table handle for a grid or grid array:\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGrid (CCTK_POINTER_TO_CONST IN cctkGH)\nPROVIDES FUNCTION SymmetryTableHandleForGrid \\\n WITH SymBase_SymmetryTableHandleForGrid \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGI \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN group_index)\nPROVIDES FUNCTION SymmetryTableHandleForGI \\\n WITH SymBase_SymmetryTableHandleForGI \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryTableHandleForGN \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_STRING IN group_name)\nPROVIDES FUNCTION SymmetryTableHandleForGN \\\n WITH SymBase_SymmetryTableHandleForGN \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n GetSymmetryBoundaries \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN size, \\\n CCTK_INT OUT ARRAY symbnd)\nPROVIDES FUNCTION GetSymmetryBoundaries \\\n WITH SymBase_GetSymmetryBoundaries \\\n LANGUAGE C\n\n\n\n# Interpolation\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nPROVIDES FUNCTION SymmetryInterpolate \\\n WITH SymBase_SymmetryInterpolate \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n SymmetryInterpolateFaces \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays, \\\n CCTK_INT IN faces)\nPROVIDES FUNCTION SymmetryInterpolateFaces \\\n WITH SymBase_SymmetryInterpolateFaces \\\n LANGUAGE C\n\nCCTK_INT FUNCTION \\\n DriverInterpolate \\\n (CCTK_POINTER_TO_CONST IN cctkGH, \\\n CCTK_INT IN N_dims, \\\n CCTK_INT IN local_interp_handle, \\\n CCTK_INT IN param_table_handle, \\\n CCTK_INT IN coord_system_handle, \\\n CCTK_INT IN N_interp_points, \\\n CCTK_INT IN interp_coords_type, \\\n CCTK_POINTER_TO_CONST ARRAY IN interp_coords, \\\n CCTK_INT IN N_input_arrays, \\\n CCTK_INT ARRAY IN input_array_indices, \\\n CCTK_INT IN N_output_arrays, \\\n CCTK_INT ARRAY IN output_array_types, \\\n CCTK_POINTER ARRAY IN output_arrays)\nUSES FUNCTION DriverInterpolate\n"},"param":{"kind":"string","value":"# Parameter definitions for thorn SymBase\n# $Header$\n\nBOOLEAN verbose \"Output symmetry boundary face descriptions after registration\"\n{\n} \"yes\"\n"},"schedule":{"kind":"string","value":"# Schedule definitions for thorn SymBase\n# $Header$\n\nSCHEDULE SymBase_Startup AT CCTK_STARTUP\n{\n LANG: C\n} \"Register GH Extension for SymBase\"\n\nSCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH\n{\n} \"Wrapper group for SymBase\"\n\nSCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper\n{\n} \"Register your symmetries here\"\n\nSCHEDULE SymBase_Statistics IN SymBase_Wrapper AFTER SymmetryRegister\n{\n LANG: C\n} \"Print symmetry boundary face descriptions\"\n\nSCHEDULE SymBase_Check AT CCTK_BASEGRID\n{\n LANG: C\n} \"Check whether the driver set up the grid consistently\"\n"},"src_filename":{"kind":"string","value":"Check.c"},"src_code":{"kind":"string","value":"/*@@\n @file Check.c\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @version $Header$\n @enddesc\n@@*/\n\n#include \"util_Table.h\"\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Check_c);\n\n/*@@\n @routine SymBase_Check\n @author Erik Schnetter\n @date 2004-06-19\n @desc\n Check whether the driver set up the grid consistently.\n @enddesc\n @var CCTK_ARGUMENTS\n @endvar\n@@*/\n\nvoid SymBase_Check(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n\n struct SymBase const *symdata;\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int ierr;\n int d;\n\n /* Get table entries */\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n sym_table = symdata->sym_table;\n\n if (2 * cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctk_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ierr = 0;\n\n for (d = 0; d < cctk_dim; ++d) {\n\n /* Check lower boundary */\n if (symmetry_handle[2 * d] >= 0) {\n if (cctk_bbox[2 * d]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] < symmetry_zone_width[2 * d]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the lower boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n\n /* Check upper boundary */\n if (symmetry_handle[2 * d + 1] >= 0) {\n if (cctk_bbox[2 * d + 1]) {\n if (cctk_lsh[d] - cctk_nghostzones[d] <\n symmetry_zone_width[2 * d + 1]) {\n CCTK_VWarn(1, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"This processor's domain is too small for the boundary \"\n \"condition at the upper boundary in direction %d\",\n d);\n ierr = 1;\n }\n }\n }\n }\n\n if (ierr) {\n CCTK_WARN(0, \"The grid setup is inconsistent with the boundary sizes. One \"\n \"or more processors' domains are too small. The grid setup \"\n \"is decided by the driver. Try to make the driver lay out \"\n \"the grids differently.\");\n }\n}\n"},"context_filenames":{"kind":"string","value":"SymBase.h\nTable.c\nFaces.c\nStatistics.c\nHandles.c\nmake.code.defn\nInterpolation.c\nStartup.c\n"},"context":{"kind":"string","value":"SymBase.h:\n```\n/*@@\n @file SymBase.h\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Declarations for thorn SymBase\n @version $Header$\n @enddesc\n@@*/\n\n#ifndef SYMBASE_H\n#define SYMBASE_H\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n/* SymBase's GH extension */\nstruct SymBase {\n /* The table handles below identify tables that have the following\n entries:\n\n CCTK_INT symmetry_handle[2*dim]\n CCTK_INT symmetry_zone_width[2*dim]\n CCTK_FPOINTER symmetry_interpolate[2*dim]\n\n dim is here the dimension of the group containing the variable,\n i.e. there is one entry per face. The true type of the\n symmetry_interpolate entries is SymmetryInterpolateFPointer.\n\n (Given that user code is not allowed to modify these tables, and\n that this structure is defined here in this header file, there is\n no real need to use tables for this. It would be possible to put\n these data directly into this structure, thereby simplifying user\n code and not make anything less flexible.)\n */\n\n /* Grid symmetry table handle */\n int sym_table;\n\n /* Grid array symmetry table handles, one handle per grid\n variable */\n int *array_sym_tables;\n};\n\ntypedef CCTK_INT (*SymmetryInterpolateFPointer)(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Number of registered symmetries */\nextern int SymBase_num_symmetries;\n\n/* The names of these symmetries */\nextern const char **SymBase_symmetry_names;\n\n/* Startup.c */\nint SymBase_Startup(void);\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH);\n\n/* Handles.c */\nCCTK_INT SymBase_SymmetryRegister(CCTK_STRING const sym_name);\nCCTK_INT SymBase_SymmetryHandleOfName(CCTK_STRING const sym_name);\nCCTK_POINTER_TO_CONST SymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle);\n\n/* Faces.c */\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width);\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name);\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate);\n\n/* Table.c */\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_);\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index);\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name);\n\n/* Interpolate.c */\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]);\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces);\n\n/* Statistics.c */\nvoid SymBase_Statistics(CCTK_ARGUMENTS);\n\n/* Check.c */\nvoid SymBase_Check(CCTK_ARGUMENTS);\n\n#endif /* ! defined SYMBASE_H */\n\n```\n\nTable.c:\n```\n/*@@\n @file Table.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Get the symmetry table handle for a grid or grid array\n @version $Header$\n @enddesc\n@@*/\n\n#include \"cctk.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Table_c);\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGrid(CCTK_POINTER_TO_CONST const cctkGH_) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n return symdata->sym_table;\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n -6 if group_index has an illegal value\n -7 if the group type has an illegal value\n -8 if there was an internal error\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGI(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error: cctkGH does not exist\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error: SymBase GH extension does not exist\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return symdata->array_sym_tables[group_index];\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryTableHandleForGN\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Return the symmetry table handle for a grid array\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry table handle\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryTableHandleForGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryTableHandleForGN(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryTableHandleForGI(cctkGH_, group_index);\n}\n\n/*@@\n @routine SymBase_GetSymmetryBoundaries\n @author Erik Schnetter\n @date 2006-05-16\n @desc\n Determine which boundaries are symmetry boundaries\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var size\n @vtype CCTK_INT\n @vdesc Array size\n @vio in\n @endvar\n @var symbnd\n @vtype CCTK_INT [size]\n @vdesc 0 for outer boundary, 1 for symmetry boundary\n @vio out\n @endvar\n @returntype CCTK_INT\n @returndesc\n 0 Success\n -10 Wrong array size; must be 2*cctk_dim\n -11 Symmetry table handle does not exist\n -12 Wrong number of symmetry table entries (internal error)\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_GetSymmetryBoundaries(CCTK_POINTER_TO_CONST const cctkGH_,\n CCTK_INT const size,\n CCTK_INT *restrict const symbnd) {\n cGH const *const cctkGH = cctkGH_;\n CCTK_INT symtable;\n CCTK_INT symmetry_handle[6];\n CCTK_INT iret;\n int d;\n\n /* Check the arguments */\n if (size != 2 * cctkGH->cctk_dim) {\n return -10;\n }\n\n /* Get the symmetry table */\n symtable = SymmetryTableHandleForGrid(cctkGH);\n if (symtable < 0) {\n return -11;\n }\n\n /* Get the symmetry handles for each face */\n iret = Util_TableGetIntArray(symtable, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (iret != 2 * cctkGH->cctk_dim) {\n return -12;\n }\n\n /* A face has a symmetry boundary if there is a valid (non-negative)\n handle registered for that face */\n for (d = 0; d < 2 * cctkGH->cctk_dim; ++d) {\n symbnd[d] = symmetry_handle[d] >= 0;\n }\n\n /* Success */\n return 0;\n}\n\n```\n\nFaces.c:\n```\n/*@@\n @file Faces.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry condition for a face\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Faces_c);\n\n/*@@\n @routine SymBase_SymmetryRegisterFaces\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -3 if which_faces has an illegal value\n -4 if symmetry_zone_width has an illegal value\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterFaces(CCTK_INT const sym_table,\n CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!which_faces) {\n return -3; /* illegal argument */\n }\n if (!new_symmetry_zone_width) {\n return -4; /* illegal argument */\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (which_faces[face]) {\n if (symmetry_handle[face] != -1) {\n return -5; /* The face is already taken */\n }\n symmetry_handle[face] = sym_handle;\n if (new_symmetry_zone_width[face] > 100) {\n CCTK_WARN(0, \"Tried to register a symmetry face with a symmetry zone \"\n \"width >100 -- this looks like an error. This can be \"\n \"caused by using a symmetry thorn (or the old built-in \"\n \"CartGrid3D symmetries) which does not use CoordBase with \"\n \"new versions of the Carpet driver. Please use a \"\n \"separate symmetry thorn (e.g. ReflectionSymmetry) \"\n \"instead.\");\n }\n symmetry_zone_width[face] = new_symmetry_zone_width[face];\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableSetIntArray(sym_table, 2 * group_dim, symmetry_zone_width,\n \"symmetry_zone_width\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGrid\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGrid(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterFaces(symdata->sym_table, cctkGH->cctk_dim,\n sym_handle, which_faces,\n new_symmetry_zone_width);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_index\n @vtype CCTK_INT\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -6 if group_index has an illegal value\n -7 if the group has an illegal type\n -8 internal error\n Error codes of SymBase_SymmetryRegisterFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGI(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_INT const group_index) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n if (group_index < 0 || group_index >= CCTK_NumGroups()) {\n return -6; /* illegal argument */\n }\n\n switch (CCTK_GroupTypeI(group_index)) {\n case CCTK_GF:\n return -7; /* illegal group type */\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n return SymBase_SymmetryRegisterFaces(\n symdata->array_sym_tables[group_index], CCTK_GroupDimI(group_index),\n sym_handle, which_faces, new_symmetry_zone_width);\n default:\n CCTK_WARN(0, \"internal error\");\n }\n\n return -8; /* internal error */\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGI\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry for certain faces of grid arrays\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var which_faces\n @vtype CCTK_INT[2*group_dim]\n @vdesc The set of faces\n @vio in\n @endvar\n @var symmetry_zone_width\n @vtype CCTK_INT[2*group_dim]\n @vdesc Symmetry boundary width\n @vio in\n @endvar\n @var group_name\n @vtype CCTK_STRING\n @vdesc Grid array group\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of CCTK_GroupIndex\n Error codes of SymBase_SymmetryRegisterGI\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGN(CCTK_POINTER const cctkGH_,\n CCTK_INT const sym_handle,\n CCTK_INT const *const which_faces,\n CCTK_INT const *const new_symmetry_zone_width,\n CCTK_STRING const group_name) {\n int group_index;\n\n group_index = CCTK_GroupIndex(group_name);\n if (group_index < 0) {\n return group_index; /* illegal argument */\n }\n\n return SymBase_SymmetryRegisterGI(cctkGH_, sym_handle, which_faces,\n new_symmetry_zone_width, group_index);\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterInterpolatorFaces\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator for certain faces\n @enddesc\n @var sym_table\n @vtype CCTK_INT\n @vdesc Table which describes the grid or grid array\n @vio in\n @endvar\n @var group_dim\n @vtype CCTK_INT\n @vdesc Dimension of the grid or grid array\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n (may be NULL)\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -1 if sym_table has an illegal value\n -9 if group_dim has an illegal value\n -2 if sym_handle has an illegal value\n -10 symmetry_interpolate is NULL\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterInterpolatorFaces(\n CCTK_INT const sym_table, CCTK_INT const group_dim,\n CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n if (sym_table < 0) {\n return -1; /* illegal argument */\n }\n if (group_dim < 0) {\n return -9; /* illegal argument */\n }\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return -2; /* illegal argument */\n }\n if (!new_symmetry_interpolate) {\n return -10;\n }\n\n /* Get table entries */\n if (2 * group_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * group_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * group_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Update table entries */\n for (face = 0; face < 2 * group_dim; ++face) {\n if (symmetry_handle[face] == sym_handle) {\n symmetry_interpolate[face] = (CCTK_FPOINTER)new_symmetry_interpolate;\n }\n }\n\n /* Set table entries */\n ierr = Util_TableSetFPointerArray(\n sym_table, 2 * group_dim, symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 1) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return 0;\n}\n\n/*@@\n @routine SymBase_SymmetryRegisterGridInterpolator\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Register a symmetry interpolator\n for certain faces of the grid hierarchy\n @enddesc\n @var cctkGH\n @vtype cGH *\n @vdesc The grid hierarchy\n @vio in\n @endvar\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry handle\n @vio in\n @endvar\n @var symmetry_interpolate\n @vtype CCTK_FPOINTER\n @vdesc Routine that applies symmetries to the interpolation points\n and then calls back\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n Error codes of SymBase_SymmetryRegisterInterpolatorFaces\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegisterGridInterpolator(\n CCTK_POINTER const cctkGH_, CCTK_INT const sym_handle,\n SymmetryInterpolateFPointer const new_symmetry_interpolate) {\n cGH const *const cctkGH = cctkGH_;\n struct SymBase const *symdata;\n\n if (!cctkGH) {\n CCTK_WARN(0, \"internal error\");\n }\n\n symdata = CCTK_GHExtension(cctkGH, \"SymBase\");\n if (!symdata) {\n CCTK_WARN(0, \"internal error\");\n }\n\n return SymBase_SymmetryRegisterInterpolatorFaces(symdata->sym_table,\n cctkGH->cctk_dim, sym_handle,\n new_symmetry_interpolate);\n}\n\n```\n\nStatistics.c:\n```\n/*@@\n @file Statistics.c\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n Provide information about the registered symmetry conditions\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Parameters.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Statistics_c);\n\n/*@@\n @routine SymBase_Statistics\n @author Erik Schnetter\n @date 2004-05-25\n @desc\n If verbose, print the symmetry boundary conditions for each\n face.\n Warn if symmetries do not have interpolation operators\n associated with them.\n @enddesc\n@@*/\n\nvoid SymBase_Statistics(CCTK_ARGUMENTS) {\n DECLARE_CCTK_ARGUMENTS;\n DECLARE_CCTK_PARAMETERS;\n\n CCTK_INT sym_table;\n CCTK_INT symmetry_handle[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n char const *symmetry_name;\n int face;\n int ierr;\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = Util_TableGetIntArray(sym_table, 2 * cctkGH->cctk_dim, symmetry_handle,\n \"symmetry_handle\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Print information about the registered symmetry faces, if desired */\n\n if (verbose) {\n\n /* Loop over all faces */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VInfo(CCTK_THORNSTRING, \"Symmetry on %s %c-face: %s\",\n face % 2 == 0 ? \"lower\" : \"upper\", \"xyz\"[face / 2],\n symmetry_name);\n }\n }\n }\n\n /* Warn about symmetries without interpolators */\n\n /* Loop over all registered symmetries */\n for (face = 0; face < 2 * cctkGH->cctk_dim; ++face) {\n if (symmetry_handle[face] >= 0) {\n if (symmetry_interpolate[face] == NULL) {\n symmetry_name = SymBase_SymmetryNameOfHandle(symmetry_handle[face]);\n if (!symmetry_name) {\n CCTK_WARN(0, \"internal error\");\n }\n if (face >= 6) {\n CCTK_WARN(0, \"only 3 dimensions are supported so far\");\n }\n CCTK_VWarn(2, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"The symmetry \\\"%s\\\" on the %s %c-face has not registered a \"\n \"symmetry interpolator\",\n symmetry_name, face % 2 == 0 ? \"lower\" : \"upper\",\n \"xyz\"[face / 2]);\n }\n }\n }\n}\n\n```\n\nHandles.c:\n```\n/*@@\n @file Handles.c\n @author Erik Schnetter\n @date 2004/03/07 09:48:53\n @desc\n Register a symmetry, and query the symmetry name/handle mapping\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n#include <string.h>\n\n#include \"cctk.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Handles_c);\n\n/* Number of registered symmetries */\nint SymBase_num_symmetries;\n\n/* The names of these symmetries */\nconst char **SymBase_symmetry_names;\n\n/*@@\n @routine SymBase_SymmetryRegister\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a symmetry\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if a symmetry with the same name has already been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryRegister(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return -2; /* symmetry exists already */\n }\n }\n\n SymBase_symmetry_names =\n realloc(SymBase_symmetry_names,\n (SymBase_num_symmetries + 1) * sizeof *SymBase_symmetry_names);\n if (!SymBase_symmetry_names) {\n CCTK_WARN(0, \"internal error\");\n }\n\n SymBase_symmetry_names[SymBase_num_symmetries] = strdup(sym_name);\n if (!SymBase_symmetry_names[SymBase_num_symmetries]) {\n CCTK_WARN(0, \"internal error\");\n }\n\n ++SymBase_num_symmetries;\n\n return SymBase_num_symmetries - 1;\n}\n\n/*@@\n @routine SymBase_SymmetryHandleOfName\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry name to a symmetry handle\n @enddesc\n @var sym_name\n @vtype CCTK_STRING\n @vdesc Name of the symmetry\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n >=0 symmetry handle\n -1 if sym_name has an illegal value\n -2 if no symmetry with that name has been registered\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryHandleOfName(CCTK_STRING const sym_name) {\n int n;\n\n if (!sym_name) {\n return -1; /* illegal argument */\n }\n\n for (n = 0; n < SymBase_num_symmetries; ++n) {\n if (strcmp(sym_name, SymBase_symmetry_names[n]) == 0) {\n return n; /* found */\n }\n }\n\n return -2; /* not found */\n}\n\n/*@@\n @routine SymBase_SymmetryNameOfHandle\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Map a symmetry handle to a symmetry name\n @enddesc\n @var sym_handle\n @vtype CCTK_INT\n @vdesc Symmetry name\n @vio in\n @endvar\n @returntype CCTK_POINTER_TO_CONST\n @returndesc\n char const * containing the symmetry name\n NULL if no symmetry with that handle has been registered\n @endreturndesc\n@@*/\n\nCCTK_POINTER_TO_CONST\nSymBase_SymmetryNameOfHandle(CCTK_INT const sym_handle) {\n if (sym_handle < 0 || sym_handle >= SymBase_num_symmetries) {\n return NULL; /* illegal argument */\n }\n\n return SymBase_symmetry_names[sym_handle];\n}\n\n```\n\nmake.code.defn:\n```\n# Main make.code.defn file for thorn SymBase\n# $Header$\n\n# Source files in this directory\nSRCS = Check.c Faces.c Handles.c Interpolation.c Startup.c Statistics.c Table.c\n\n# Subdirectories containing source files\nSUBDIRS = \n\n```\n\nInterpolation.c:\n```\n/*@@\n @file Interpolation.c\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Apply symmetry conditions during interpolation\n @version $Header$\n @enddesc\n@@*/\n\n#include <stdio.h>\n#include <stdlib.h>\n\n#include \"cctk.h\"\n#include \"cctk_Arguments.h\"\n\n#include \"util_ErrorCodes.h\"\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Interpolation_c);\n\n/*@@\n @routine SymBase_SymmetryInterpolate\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components.\n All arguments are equivalent to the CCTK_InterpGridArrays\n function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 Input array has illegal group type\n -94 Mixing grid functions and grid arrays\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolate(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[]) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n CCTK_INT faces;\n int has_grid_arrays, has_only_grid_arrays;\n int n;\n int f;\n int ierr;\n\n /* Check arguments */\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n /* If this interpolates grid arrays, then do not apply symmetries --\n there are no symmetries registered for grid arrays (yet). */\n has_grid_arrays = 0;\n has_only_grid_arrays = 1;\n for (n = 0; n < N_input_arrays; ++n) {\n if (input_array_indices[n] != -1) {\n const int grouptype = CCTK_GroupTypeFromVarI(input_array_indices[n]);\n switch (grouptype) {\n case CCTK_GF:\n has_only_grid_arrays = 0;\n break;\n case CCTK_SCALAR:\n case CCTK_ARRAY:\n has_grid_arrays = 1;\n break;\n default: {\n char *groupname = CCTK_GroupName(input_array_indices[n]);\n CCTK_VWarn(CCTK_WARN_ALERT, __LINE__, __FILE__, CCTK_THORNSTRING,\n \"Could not determine group type of input arrays for group \"\n \"'%s' (%ld), received %d\",\n groupname, (long)input_array_indices[n], grouptype);\n free(groupname);\n }\n return -93;\n }\n }\n }\n if (has_grid_arrays && !has_only_grid_arrays) {\n CCTK_WARN(1, \"The input arrays contain both grid function and grid arrays; \"\n \"this is not possible\");\n return -94;\n }\n if (has_grid_arrays) {\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n return DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n }\n\n /* Check arguments */\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find all faces that need symmetries applied */\n faces = 0;\n for (f = 0; f < 2 * cctkGH->cctk_dim; ++f) {\n if (symmetry_interpolate[f]) {\n faces |= (1 << f);\n }\n }\n\n /* Forward the call */\n return SymBase_SymmetryInterpolateFaces(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays, output_array_types,\n output_arrays, faces);\n}\n\n/*@@\n @routine SymBase_SymmetryInterpolateFaces\n @author Erik Schnetter\n @date 2004-05-11\n @desc\n Adjust the coordinates of the interpolation points,\n call the driver's interpolation function,\n and then adjust the interpolated tensor components,\n but only for the selected faces.\n When no faces are selected, forward the call to the\n driver's interpolator throug the aliased function\n \"DriverInterpolate\".\n All arguments except \"faces\" are equivalent to the\n CCTK_InterpGridArrays function call.\n @enddesc\n @var cctkGH\n @vtype CCTK_POINTER_TO_CONST\n @vdesc Grid hierarchy\n @vio in\n @endvar\n @var N_dims\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var local_interp_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var param_table_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var coord_system_handle\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_interp_points\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords_type\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var interp_coords\n @vtype CCTK_POINTER_TO_CONST[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_input_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var input_array_indices\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var N_output_arrays\n @vtype CCTK_INT\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_array_types\n @vtype CCTK_INT[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var output_arrays\n @vtype CCTK_POINTER[]\n @vdesc same as for the CCTK_InterpGridArrays call\n @vio in\n @endvar\n @var faces\n @vtype CCTK_INT\n @vdesc Bit mask selecting which faces' symmetries should be treated.\n @vio in\n @endvar\n @returntype CCTK_INT\n @returndesc\n status code\n 0 for success\n -91 GH is NULL\n -92 N_dims is not equal to cctkGH->cctk_dim\n -93 faces is NULL\n or the return value from DriverInterpolate\n @endreturndesc\n@@*/\n\nCCTK_INT\nSymBase_SymmetryInterpolateFaces(\n CCTK_POINTER_TO_CONST const cctkGH_, CCTK_INT const N_dims,\n CCTK_INT const local_interp_handle, CCTK_INT const param_table_handle,\n CCTK_INT const coord_system_handle, CCTK_INT const N_interp_points,\n CCTK_INT const interp_coords_type,\n CCTK_POINTER_TO_CONST const interp_coords[], CCTK_INT const N_input_arrays,\n CCTK_INT const input_array_indices[], CCTK_INT const N_output_arrays,\n CCTK_INT const output_array_types[], CCTK_POINTER const output_arrays[],\n CCTK_INT const faces) {\n cGH const *restrict const cctkGH = cctkGH_;\n CCTK_INT sym_table;\n CCTK_FPOINTER symmetry_interpolate[100];\n int face;\n int ierr;\n\n /* Check arguments */\n\n if (!cctkGH) {\n CCTK_WARN(1, \"cctkGH is NULL\");\n return -91;\n }\n\n if (N_dims != cctkGH->cctk_dim) {\n CCTK_WARN(1, \"The number of dimensions is not equal to the GH's number of \"\n \"dimensions\");\n return -92;\n }\n\n /* Get table */\n sym_table = SymmetryTableHandleForGrid(cctkGH);\n if (sym_table < 0)\n CCTK_WARN(0, \"internal error\");\n\n /* Get table entries */\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr =\n Util_TableGetFPointerArray(sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr != 2 * cctkGH->cctk_dim) {\n CCTK_WARN(0, \"internal error\");\n }\n\n /* Find a face that needs a symmetry applied */\n for (face = 0; face < 2 * N_dims; ++face) {\n if (faces & (1 << face)) {\n break;\n }\n }\n\n if (face == 2 * N_dims) {\n /* All faces are done */\n\n /* Call the real interpolator */\n ierr = CCTK_IsFunctionAliased(\"DriverInterpolate\");\n if (!ierr) {\n CCTK_WARN(\n 0,\n \"The aliased function \\\"DriverInterpolate\\\" has not been provided\");\n }\n ierr = DriverInterpolate(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays);\n\n } else {\n /* Treat the face */\n\n /* Recursive call to a symmetry condition */\n if (!symmetry_interpolate[face]) {\n CCTK_WARN(0, \"internal error\");\n }\n ierr = ((SymmetryInterpolateFPointer)symmetry_interpolate[face])(\n cctkGH, N_dims, local_interp_handle, param_table_handle,\n coord_system_handle, N_interp_points, interp_coords_type, interp_coords,\n N_input_arrays, input_array_indices, N_output_arrays,\n output_array_types, output_arrays, faces);\n }\n\n return ierr;\n}\n\n```\n\nStartup.c:\n```\n/*@@\n @file Startup.c\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Thorn startup\n @version $Id$\n @enddesc\n@@*/\n\n#include <stdlib.h>\n\n#include \"cctk.h\"\n\n#include \"util_Table.h\"\n\n#include \"SymBase.h\"\n\n/* the rcs ID and its dummy function to use it */\nstatic const char *const rcsid = \"$Header$\";\nCCTK_FILEVERSION(CactusBase_SymBase_Startup_c);\n\n/*@@\n @routine SymBase_Startup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Register a GH extension and initialise the global variables\n @enddesc\n @returntype int\n @returndesc\n status code\n 0 for success\n @endreturndesc\n@@*/\n\nint SymBase_Startup(void) {\n int handle;\n int ierr;\n\n handle = CCTK_RegisterGHExtension(\"SymBase\");\n if (handle < 0) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create GH extension for symmetry data\");\n }\n\n ierr = CCTK_RegisterGHExtensionSetupGH(handle, SymBase_Setup);\n if (ierr != 1) { /* strange error code convention */\n CCTK_WARN(0,\n \"Internal Error: Could not register GH Extension setup routine\");\n }\n\n SymBase_num_symmetries = 0;\n SymBase_symmetry_names = NULL;\n\n return 0; /* no error */\n}\n\n/*@@\n @routine SymBase_Setup\n @author Erik Schnetter\n @date 2004-03-06\n @desc\n Initialise the GH extension\n @enddesc\n @var config\n @vtype tFleshConfig *\n @vdesc Internal flesh information, unused\n @vio in\n @endvar\n @var convlev\n @vtype int\n @vdesc Convergence level, unused\n @vio in\n @endvar\n @var cctkGH\n @vtype cGH *\n @vdesc Grid hierarchy\n @vio in\n @endvar\n@@*/\n\nvoid *SymBase_Setup(tFleshConfig *const config, int const convlev,\n cGH *const cctkGH) {\n struct SymBase *symdata;\n CCTK_INT symmetry_handle[100];\n CCTK_INT symmetry_zone_width[100];\n CCTK_FPOINTER symmetry_interpolate[100];\n int group;\n int face;\n int ierr;\n const void *dummy;\n\n /* avoid compiler warnings about unused parameters */\n dummy = &config;\n dummy = &convlev;\n dummy = &cctkGH;\n dummy = &dummy;\n\n /* Create GH extension */\n symdata = malloc(sizeof *symdata);\n if (!symdata) {\n CCTK_WARN(0, \"Failed to allocate memory for symmetry data\");\n }\n\n /* Initialise handle and zone width arrays */\n for (face = 0; face < 100; ++face) {\n symmetry_handle[face] = -1;\n symmetry_zone_width[face] = 0;\n symmetry_interpolate[face] = NULL;\n }\n\n /* Create grid symmetry table */\n symdata->sym_table = Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n\n if (symdata->sym_table < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table.\");\n }\n\n if (2 * cctkGH->cctk_dim > 100) {\n CCTK_WARN(0, \"Internal Error: Can currently only handle a hundred faces.\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_handle, \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr =\n Util_TableSetFPointerArray(symdata->sym_table, 2 * cctkGH->cctk_dim,\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n\n /* Create grid array symmetry tables */\n symdata->array_sym_tables =\n malloc(CCTK_NumGroups() * sizeof *symdata->array_sym_tables);\n if (!symdata->array_sym_tables) {\n CCTK_WARN(\n 0,\n \"Internal Error: Failed to create array for symmetry tables for GAs\");\n }\n\n for (group = 0; group < CCTK_NumGroups(); ++group) {\n switch (CCTK_GroupTypeI(group)) {\n case CCTK_GF:\n\n /* No table */\n symdata->array_sym_tables[group] = -1;\n break;\n\n case CCTK_SCALAR:\n /* FALL_THROUGH */\n\n case CCTK_ARRAY:\n\n /* Create array symmetry table */\n symdata->array_sym_tables[group] =\n Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);\n if (symdata->array_sym_tables[group] < 0) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry table for GA\");\n }\n\n if (2 * CCTK_GroupDimI(group) > 100) {\n CCTK_WARN(0, \"Internal Error: Can only handle 100 faces\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group), symmetry_handle,\n \"symmetry_handle\");\n if (ierr) {\n CCTK_WARN(0, \"Internal Error: Failed to create symmetry_handle array\");\n }\n ierr = Util_TableSetIntArray(symdata->array_sym_tables[group],\n 2 * CCTK_GroupDimI(group),\n symmetry_zone_width, \"symmetry_zone_width\");\n if (ierr) {\n CCTK_WARN(0,\n \"Internal Error: Failed to create symmetry_zone_width array\");\n }\n ierr = Util_TableSetFPointerArray(\n symdata->array_sym_tables[group], 2 * CCTK_GroupDimI(group),\n symmetry_interpolate, \"symmetry_interpolate\");\n if (ierr) {\n CCTK_WARN(\n 0, \"Internal Error: Failed to create symmetry_fold_points array\");\n }\n break;\n\n default:\n CCTK_WARN(0, \"Internal Error: Unknown GV type\");\n }\n }\n\n return symdata;\n}\n\n```\n\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":0,"numItemsPerPage":100,"numTotalItems":3068,"offset":0,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc3OTM4ODEzNiwic3ViIjoiL2RhdGFzZXRzL3hpbnNodW8vRVRfY29kZV93aXRoX2NvbnRleHQiLCJleHAiOjE3NzkzOTE3MzYsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.xV__sgsaMhiB0BbP98pv8SxBRjZ-K4X6-WHuCXYzateCWh2RFfAuOujvQe3H4l1_WSHEdoqGgfQzYUGs8tB1Bw","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":3068,"numBytesParquet":513592304},{"config":"default","split":"validation","numRows":346,"numBytesParquet":55278086},{"config":"default","split":"test","numRows":346,"numBytesParquet":55031958}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
thorn_name stringclasses 227
values | url stringclasses 26
values | configuration stringclasses 137
values | interface stringclasses 225
values | param stringclasses 220
values | schedule stringclasses 223
values | src_filename stringlengths 4 83 | src_code stringlengths 0 579k | context_filenames stringlengths 0 5.85k | context stringlengths 0 2.46M |
|---|---|---|---|---|---|---|---|---|---|
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | NoneBoundary.c | /*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, but then not actually
... | FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| FlatBoundary.c:
```
/*@@
@file FlatBoundary.c
@date Mon Mar 15 15:09:00 1999
@author Gerd Lanfermann
@desc
Routines for applying flat boundary conditions
@enddesc
@history
@hdate Tue 10 Apr 2001
@hauthor Thomas Radke
@hdesc BC routines generalized for applying to ar... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | FlatBoundary.c | /*@@
@file FlatBoundary.c
@date Mon Mar 15 15:09:00 1999
@author Gerd Lanfermann
@desc
Routines for applying flat boundary conditions
@enddesc
@history
@hdate Tue 10 Apr 2001
@hauthor Thomas Radke
@hdesc BC routines generalized for applying to arbitrary CCTK data ty... | NoneBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | Boundary.h | /*@@
@file Boundary.h
@date Tue Sep 26 11:50:46 2000
@author Gerd Lanfermann
@desc
Prototypes for boundary routines
@enddesc
@version $Header$
@@*/
#ifndef _BOUNDARY_H_
#define _BOUNDARY_H_
#ifdef __cplusplus
extern "C" {
#endif
/* data type for pointer to function which imple... | NoneBoundary.c
FlatBoundary.c
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | ScalarBoundary.c | /*@@
@file ScalarBoundary.c
@date Mon Mar 15 15:09:00 1999
@author Gabrielle Allen, Gerd Lanfermann
@desc
Routines for applying scalar boundary conditions
@enddesc
@history
@hdate Tue 10 Apr 2001
@hauthor Thomas Radke
@hdesc BC routines generalized for applying to a... | NoneBoundary.c
FlatBoundary.c
Boundary.h
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | Check.c | /*@@
@file Check.c
@date 19 May 2003
@author David Rideout
@desc
Check that the dimension of any grid variables is not greater than
what the faces specification can handle (currently 15).
@enddesc
@history
@hdate
@hauthor
@hdesc
@endhistory
@version $Header$
@@*/
#include "cctk... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | Register.c | /*@@
@file Register.c
@date Sat Oct 26 22:39:40 CEST 2002
@author David Rideout
@desc
Register implemented boundary conditions.
@enddesc
@version $Header$
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
#include "util_Table.h"
#include "Boundary.h... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | RadiationBoundary.c | /*@@
@file RadiationBoundary.c
@date Mon Mar 15 15:09:00 1999
@author Miguel Alcubierre, Gabrielle Allen, Gerd Lanfermann
@desc
Routines for applying radiation boundary conditions
The radiative boundary condition that is implemented is:
f = f0 + u(r - ... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | RobinBoundary.c | /*@@
@file RobinBoundary.c
@date July 6th 2000
@author Miguel Alcubierre, Gabrielle Allen, Gerd Lanfermann
@desc
Routines for Robin boundary conditions
@enddesc
@history
@hdate Tue 10 Apr 2001
@hauthor Thomas Radke
@hdesc BC routines generalized for applying to arbi... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | StaticBoundary.c | /*@@
@file StaticBoundary.c
@date Sat Mar 16 15:09:00 2001
@author Gabrielle Allen
@desc
Routines for applying static-boundary conditions
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "util_Table.h"
#include "util_ErrorCodes.h"
#... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
make.code.defn
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | make.code.defn | # Main make.code.defn file for thorn Boundary
# $Header$
# Source files in this directory
SRCS = ScalarBoundary.c\
StaticBoundary.c\
CopyBoundary.c\
FlatBoundary.c\
RadiationBoundary.c\
RobinBoundary.c\
NoneBoundary.c\
Boundary.c\
Register.c\
Check.c
| NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
Boundary.c
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | Boundary.c | /*@@
@file Boundary.c
@date Sat Oct 26 22:39:40 CEST 2002
@author David Rideout
@desc
Implements the new boundary specification.
@enddesc
@version $Header$
@@*/
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#include "ut... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
CopyBoundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/Boundary | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Boundary
# $Header$
# This will disappear once function aliasing has requires
PROVIDES Boundary
{
SCRIPT
LANG
}
| # Interface definition for thorn Boundary
# $Header$
implements: boundary
INCLUDES HEADER: Boundary.h in Boundary.h
# Implementation of new boundary spec:
CCTK_INT FUNCTION Boundary_RegisterPhysicalBC(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN CCTK_FPOINTER function_pointer(CCTK_POINTER_TO_CONST IN GH, \
... | # Parameter definitions for thorn Boundary
# $Header$
restricted:
INT radpower "Power of decay rate in extrapolation used in radiative boundaries"
{
: :: "A negative value switches off this feature"
} -1
BOOLEAN register_scalar "Register routine to handle the 'Scalar' boundary condition"
{
} "yes"
BOOLEAN registe... | # Schedule definitions for thorn Boundary
# $Header$
schedule Boundary_Check at CCTK_PARAMCHECK
{
LANG: C
} "Check dimension of grid variables"
schedule Boundary_RegisterBCs at CCTK_WRAGH
{
LANG: C
OPTIONS: global
} "Register boundary conditions that this thorn provides"
# New boundary infrastructure:
schedul... | CopyBoundary.c | /*@@
@file CopyBoundary.c
@date Mon Mar 15 15:09:00 1999
@author Gerd Lanfermann, Gabrielle Allen
@desc
Routines for applying copying-boundary conditions
@enddesc
@history
@hdate Sun 25 Feb 2001
@hauthor Thomas Radke
@hdesc BC routines generalized for applying to ar... | NoneBoundary.c
FlatBoundary.c
Boundary.h
ScalarBoundary.c
Check.c
Register.c
RadiationBoundary.c
RobinBoundary.c
StaticBoundary.c
make.code.defn
Boundary.c
| NoneBoundary.c:
```
/*@@
@file NoneBoundary.c
@date Sat Jan 4 05:43:35 CET 2003
@author David Rideout
@desc
Implements 'no boundary condition'. This can be used to
inform the Boundary thorn that this variable should have
boundary conditions applied to it, bu... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | ParamCheck.c | /*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_CartGrid3D_ParamChe... | GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| GetSymmetry.c:
```
/*@@
@file GetSymmetry.c
@date April 12 2002
@author Frank Herrmann
@desc
This file contains the routines for getting symmetry information
code stolen from SetSymmetry.c
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | GetSymmetry.c | /*@@
@file GetSymmetry.c
@date April 12 2002
@author Frank Herrmann
@desc
This file contains the routines for getting symmetry information
code stolen from SetSymmetry.c
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "cctk_Parameters.h"
... | ParamCheck.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | Symmetry.c | /*@@
@file SymmetryWrappers.c
@date April 2000
@author Gerd Lanfermann
@desc
Routines to apply the 1/2/3D Symmetries for
all symmetry domains (octant/bitant/quadrant).
@enddesc
@history
@hdate Sat 02 Nov 2002
@hauthor Thomas Radke
@hdesc routines genera... | ParamCheck.c
GetSymmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | DecodeSymParameters.c |
/*@@
@file DecodeSymParameters.c
@date Wed May 10 18:58:00 EST 2000
@author Erik Schnetter
@desc
Decode the symmetry parameters.
@enddesc
@version $Id$
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
#include "Symmetry.h"
static const char *rcsid = "$Head... | ParamCheck.c
GetSymmetry.c
Symmetry.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | make.code.defn | # Main make.code.defn file for thorn CartGrid3D
# $Header$
# Source files in this directory
SRCS = Startup.c ParamCheck.c DecodeSymParameters.c CartGrid3D.c \
GetSymmetry.c SetSymmetry.c Symmetry.c RegisterSymmetries.c
| ParamCheck.c
GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
CartGrid3D.c
SetSymmetry.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | CartGrid3D.c | /*@@
@file CartGrid3D.c
@date Thu Oct 7 13:20:06 1999
@author Tom Goodale
@desc
Set up coordinates for a 3D Cartesian grid.
C Conversion of Fortran routine written by Gab.
@version $Id$
@enddesc
@@*/
#include <stdio.h>
#include <math.h>
#include "cctk.h"
#include ... | ParamCheck.c
GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
SetSymmetry.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | SetSymmetry.c |
/*@@
@file Symmetry.c
@date Mon Mar 15 15:09:00 1999
@author Gerd Lanfermann
@desc
This file contains the routines for registering and applying symmetry
boundary conditions
@enddesc
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "cctk_FortranSt... | ParamCheck.c
GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
Startup.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | Startup.c | /*@@
@file Startup.c
@date Mon Mar 15 15:48:42 1999
@author Gerd Lanfermann
@desc
Startup file to register the GHextension and coordinates
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
#include "util_T... | ParamCheck.c
GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
RegisterSymmetries.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | RegisterSymmetries.c | /* $Header$ */
#include <stdlib.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
#include "Symmetry.h"
void DecodeSymParameters3D(int sym[6]);
void RegisterSymmetryBoundaries(CCTK_ARGUMENTS);
void RegisterSymmetryBoundaries(CCTK_ARGUMENTS) {
DECLARE_CCTK_ARGUMENTS;
DECLARE_CCTK_PAR... | ParamCheck.c
GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
Startup.c
Symmetry.h
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CartGrid3D | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CartGrid2D
# $Header$
# This will disappear once no-one calls anything from this thorn
PROVIDES CartGrid3D
{
SCRIPT
LANG
}
# This will disappear once the aliasing has a requires
REQUIRES CoordBase
| # Interface definition for thorn CartGrid3D
# $Header$
implements: grid
inherits: coordbase
INCLUDE HEADER: Symmetry.h in Symmetry.h
uses include header: CoordBase.h
# The overall size of the domain
CCTK_INT FUNCTION GetDomainSpecification \
(CCTK_INT IN size, \
CCTK_REAL OUT ARRAY physical_min, \
CCTK_REAL ... | # Parameter definitions for thorn CartGrid3D
# $Header$
shares: driver
USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y
USES BOOLEAN periodic_z
private:
BOOLEAN no_origin "DEPRECATED: Don't place grid points on the coordinate origin/axes"
{
: :: ""
} "yes"
BOOLEAN no_originx "DEPRECATED: Don... | # Schedule definitions for thorn CartGrid3D
# $Header$
STORAGE: coordinates gridspacings
schedule SymmetryStartup at CCTK_STARTUP
{
LANG: C
} "Register GH Extension for GridSymmetry"
schedule RegisterCartGrid3DCoords at CCTK_WRAGH
{
LANG:C
OPTIONS: meta
} "Register coordinates for the Cartesian grid"
schedule... | Symmetry.h | /*@@
@header Symmetry.h
@date Sun 7th Mar 1999
@author Gerd Lanfermann
@desc
The extensions to the GH structure for 3D grid symmetry treatment.
We'll have six int array for every GF, which holds a flag
for which symmetry or (physical) bnd-condition to ap... | ParamCheck.c
GetSymmetry.c
Symmetry.c
DecodeSymParameters.c
make.code.defn
CartGrid3D.c
SetSymmetry.c
Startup.c
RegisterSymmetries.c
| ParamCheck.c:
```
/*@@
@file ParamCheck.c
@date Thu Oct 7 17:11:44 1999
@author Tom Goodale
@desc
C version of Gab's paramcheck stuff
@enddesc
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(CactusBase_C... |
CactusBase/CoordBase | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CoordBase
# $Header$
# This will disappear once we have a requires for function aliasing
PROVIDES CoordBase
{
SCRIPT
LANG
}
| # Interface definition for thorn CoordBase
# $Header$
implements: CoordBase
# Old header file - should use aliased functions
include header: CoordBase.h in CoordBase.h
# Exported functions
CCTK_INT FUNCTION Coord_SystemRegister \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN dim, ... | # Parameter definitions for thorn CoordBase
# $Header$
###############################################################################
### Domain specification ###
###############################################################################
KEYWORD domainsize "D... | # Schedule definitions for thorn CoordBase
# $Header$
schedule CoordBase_Startup at CCTK_STARTUP
{
LANG: C
} "Register a GH extension to store the coordinate system handles"
| CoordBase.h | /*@@
@header CoordBase.h
@date Wed June 26 2002
@author Gabrielle Allen
@desc
Defines and prototypes for the coordinate base thorn
@enddesc
@version $Header$
@@*/
#ifndef _COORDBASE_H_
#define _COORDBASE_H_
#ifndef COORD_IN_COORDBASE
/* Since some people may still be including thi... | make.code.defn
coordbaseGH.h
GHExtension.c
CoordBase.c
Domain.c
| make.code.defn:
```
# Main make.code.defn file for thorn CoordBase
# $Header$
# Source files in this directory
SRCS = Domain.c CoordBase.c GHExtension.c
# Subdirectories containing source files
SUBDIRS =
```
coordbaseGH.h:
```
/*@@
@header coordbaseGH.h
@date Sun Sept 22 2002
@author Gabrielle All... |
CactusBase/CoordBase | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CoordBase
# $Header$
# This will disappear once we have a requires for function aliasing
PROVIDES CoordBase
{
SCRIPT
LANG
}
| # Interface definition for thorn CoordBase
# $Header$
implements: CoordBase
# Old header file - should use aliased functions
include header: CoordBase.h in CoordBase.h
# Exported functions
CCTK_INT FUNCTION Coord_SystemRegister \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN dim, ... | # Parameter definitions for thorn CoordBase
# $Header$
###############################################################################
### Domain specification ###
###############################################################################
KEYWORD domainsize "D... | # Schedule definitions for thorn CoordBase
# $Header$
schedule CoordBase_Startup at CCTK_STARTUP
{
LANG: C
} "Register a GH extension to store the coordinate system handles"
| make.code.defn | # Main make.code.defn file for thorn CoordBase
# $Header$
# Source files in this directory
SRCS = Domain.c CoordBase.c GHExtension.c
# Subdirectories containing source files
SUBDIRS =
| CoordBase.h
coordbaseGH.h
GHExtension.c
CoordBase.c
Domain.c
| CoordBase.h:
```
/*@@
@header CoordBase.h
@date Wed June 26 2002
@author Gabrielle Allen
@desc
Defines and prototypes for the coordinate base thorn
@enddesc
@version $Header$
@@*/
#ifndef _COORDBASE_H_
#define _COORDBASE_H_
#ifndef COORD_IN_COORDBASE
/* Since some people may still... |
CactusBase/CoordBase | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CoordBase
# $Header$
# This will disappear once we have a requires for function aliasing
PROVIDES CoordBase
{
SCRIPT
LANG
}
| # Interface definition for thorn CoordBase
# $Header$
implements: CoordBase
# Old header file - should use aliased functions
include header: CoordBase.h in CoordBase.h
# Exported functions
CCTK_INT FUNCTION Coord_SystemRegister \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN dim, ... | # Parameter definitions for thorn CoordBase
# $Header$
###############################################################################
### Domain specification ###
###############################################################################
KEYWORD domainsize "D... | # Schedule definitions for thorn CoordBase
# $Header$
schedule CoordBase_Startup at CCTK_STARTUP
{
LANG: C
} "Register a GH extension to store the coordinate system handles"
| coordbaseGH.h | /*@@
@header coordbaseGH.h
@date Sun Sept 22 2002
@author Gabrielle Allen
@desc
The extensions to the GH structure from CoordBase
@version $Header$
@@*/
#ifndef _COORDBASE_COORDBASEGH_H_
#define _COORDBASE_COORDBASEGH_H_ 1
#include "util_Hash.h"
#ifdef __cplusplus
extern "C" {
#en... | CoordBase.h
make.code.defn
GHExtension.c
CoordBase.c
Domain.c
| CoordBase.h:
```
/*@@
@header CoordBase.h
@date Wed June 26 2002
@author Gabrielle Allen
@desc
Defines and prototypes for the coordinate base thorn
@enddesc
@version $Header$
@@*/
#ifndef _COORDBASE_H_
#define _COORDBASE_H_
#ifndef COORD_IN_COORDBASE
/* Since some people may still... |
CactusBase/CoordBase | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CoordBase
# $Header$
# This will disappear once we have a requires for function aliasing
PROVIDES CoordBase
{
SCRIPT
LANG
}
| # Interface definition for thorn CoordBase
# $Header$
implements: CoordBase
# Old header file - should use aliased functions
include header: CoordBase.h in CoordBase.h
# Exported functions
CCTK_INT FUNCTION Coord_SystemRegister \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN dim, ... | # Parameter definitions for thorn CoordBase
# $Header$
###############################################################################
### Domain specification ###
###############################################################################
KEYWORD domainsize "D... | # Schedule definitions for thorn CoordBase
# $Header$
schedule CoordBase_Startup at CCTK_STARTUP
{
LANG: C
} "Register a GH extension to store the coordinate system handles"
| GHExtension.c | /*@@
@file GHExtension.c
@date Sun Sept 22 2002
@author Gabrielle Allen and David Rideout
@desc
CoordBase GHExtension setup
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "CoordBase.h"
#include "coordbaseGH.h"
#include "util_Hash.h"
static const cha... | CoordBase.h
make.code.defn
coordbaseGH.h
CoordBase.c
Domain.c
| CoordBase.h:
```
/*@@
@header CoordBase.h
@date Wed June 26 2002
@author Gabrielle Allen
@desc
Defines and prototypes for the coordinate base thorn
@enddesc
@version $Header$
@@*/
#ifndef _COORDBASE_H_
#define _COORDBASE_H_
#ifndef COORD_IN_COORDBASE
/* Since some people may still... |
CactusBase/CoordBase | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CoordBase
# $Header$
# This will disappear once we have a requires for function aliasing
PROVIDES CoordBase
{
SCRIPT
LANG
}
| # Interface definition for thorn CoordBase
# $Header$
implements: CoordBase
# Old header file - should use aliased functions
include header: CoordBase.h in CoordBase.h
# Exported functions
CCTK_INT FUNCTION Coord_SystemRegister \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN dim, ... | # Parameter definitions for thorn CoordBase
# $Header$
###############################################################################
### Domain specification ###
###############################################################################
KEYWORD domainsize "D... | # Schedule definitions for thorn CoordBase
# $Header$
schedule CoordBase_Startup at CCTK_STARTUP
{
LANG: C
} "Register a GH extension to store the coordinate system handles"
| CoordBase.c | /*@@
@file CoordBase.c
@date 23 July 2003
@author Gabrielle Allen and David Rideout
@desc
Functions which implement the coordinate API.
@enddesc
@version $Id$
@@*/
#include <string.h>
#include <stdlib.h>
#include "cctk.h"
#include "util_Table.h"
#include "util_Hash.h"
#include "util... | CoordBase.h
make.code.defn
coordbaseGH.h
GHExtension.c
Domain.c
| CoordBase.h:
```
/*@@
@header CoordBase.h
@date Wed June 26 2002
@author Gabrielle Allen
@desc
Defines and prototypes for the coordinate base thorn
@enddesc
@version $Header$
@@*/
#ifndef _COORDBASE_H_
#define _COORDBASE_H_
#ifndef COORD_IN_COORDBASE
/* Since some people may still... |
CactusBase/CoordBase | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn CoordBase
# $Header$
# This will disappear once we have a requires for function aliasing
PROVIDES CoordBase
{
SCRIPT
LANG
}
| # Interface definition for thorn CoordBase
# $Header$
implements: CoordBase
# Old header file - should use aliased functions
include header: CoordBase.h in CoordBase.h
# Exported functions
CCTK_INT FUNCTION Coord_SystemRegister \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN dim, ... | # Parameter definitions for thorn CoordBase
# $Header$
###############################################################################
### Domain specification ###
###############################################################################
KEYWORD domainsize "D... | # Schedule definitions for thorn CoordBase
# $Header$
schedule CoordBase_Startup at CCTK_STARTUP
{
LANG: C
} "Register a GH extension to store the coordinate system handles"
| Domain.c | #include <cctk.h>
#include <cctk_Parameters.h>
#include <util_Table.h>
CCTK_INT CoordBase_GetBoundarySpecification(CCTK_INT const size,
CCTK_INT *const nboundaryzones,
CCTK_INT *const is_internal,
... | CoordBase.h
make.code.defn
coordbaseGH.h
GHExtension.c
CoordBase.c
| CoordBase.h:
```
/*@@
@header CoordBase.h
@date Wed June 26 2002
@author Gabrielle Allen
@desc
Defines and prototypes for the coordinate base thorn
@enddesc
@version $Header$
@@*/
#ifndef _COORDBASE_H_
#define _COORDBASE_H_
#ifndef COORD_IN_COORDBASE
/* Since some people may still... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Types.F90 | #include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
| cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F... | cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
CCTK_POINTER config
end subroutine CCTK_Initialise
subroutine CCTK_Evolve (ierr, config)
implicit none
integer... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Main.F90 | #include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
CCTK_POINTER config
end subroutine CCTK_Initialise
subroutine CCTK_Evolve (ierr, config)
implicit none
integer ierr
C... | cctk_Types.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_IOMethods.F90:
```
#include "cctk.h"
module cctk_IOMethods
implicit none
interface
subroutine CCTKi_RegisterIOMethod (handle, thorn, name)
implicit none
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_IOMethods.F90 | #include "cctk.h"
module cctk_IOMethods
implicit none
interface
subroutine CCTKi_RegisterIOMethod (handle, thorn, name)
implicit none
integer handle
character(*) thorn
character(*) name
end subroutine CCTKi_RegisterIOMethod
subroutine CCTK_RegisterIOMethodOutputGH (ier... | cctk_Types.F90
cctk_Main.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
c... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_CommandLine.F90 | #include "cctk.h"
module cctk_CommandLine
implicit none
interface
! This subroutine has been renamed
! because it conflicts with the name of this module
subroutine CCTK_GetCommandLine (argc, outargv)
implicit none
integer argc
CCTK_POINTER outargv
end subroutine CCTK_GetComman... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
cct... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_GHExtensions.F90 | #include "cctk.h"
module cctk_GHExtensions
implicit none
interface
subroutine CCTK_RegisterGHExtension (ierr, name)
implicit none
integer ierr
character(*) name
end subroutine CCTK_RegisterGHExtension
subroutine CCTK_UnregisterGHExtension (ierr, name)
implicit non... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
cctk... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Constants.F90 | #include "cctk.h"
module cctk_Constants
implicit none
! This file declares no routines
end module cctk_Constants
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
c... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk.F90 | #include "cctk.h"
module cctk
use cctk_ActiveThorns
use cctk_Banner
use cctk_Comm
use cctk_CommandLine
use cctk_Complex
use cctk_Constants
use cctk_Coord
use cctk_DebugDefines
use cctk_Faces
use cctk_File
use cctk_Flesh
use cctk_FortranString1
use cctk_FortranWrappers
use cctk_GHExtensions
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamC... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Banner.F90 | #include "cctk.h"
module cctk_Banner
implicit none
interface
subroutine CCTK_RegisterBanner (ierr, banner)
implicit none
integer ierr
character(*) banner
end subroutine CCTK_RegisterBanner
end interface
end module cctk_Banner
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F9... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Version.F90 | #include "cctk.h"
module cctk_Version
implicit none
interface
subroutine CCTK_FullVersion (string, string_length)
implicit none
character(*) string
integer string_length
end subroutine CCTK_FullVersion
subroutine CCTK_MajorVersion (string, string_length)
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Reduction.F90 | #include "cctk.h"
module cctk_Reduction
implicit none
interface
subroutine CCTK_ReductionHandle (ierr, reduction)
implicit none
integer ierr
character(*) reduction
end subroutine CCTK_ReductionHandle
subroutine CCTK_ReductionArrayHandle (ierr, reduction)
implici... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
c... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_IO.F90 | #include "cctk.h"
module cctk_IO
implicit none
interface
subroutine CCTK_OutputGH (ierr, GH)
implicit none
integer ierr
CCTK_POINTER_TO_CONST GH
end subroutine CCTK_OutputGH
subroutine CCTK_OutputVarAs (ierr, GH, var, alias)
implicit none
integer ... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamChec... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Parameter.F90 | #include "cctk.h"
module cctk_Parameter
implicit none
interface
subroutine CCTK_ParameterLevel (level)
implicit none
integer level
end subroutine CCTK_ParameterLevel
subroutine CCTK_ParameterSet (ierr, name, thorn, value)
implicit none
integer ierr
characte... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
c... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| fortran.h | #ifndef FORTRAN_H
#define FORTRAN_H
#include "cctk.h"
#if FORTRAN_CPP_ANSI
/* For an ANSI-like cpp */
#define CONCAT(a,b) a##b
#define STRINGIFY(a) STRINGIFY_(a)
#define STRINGIFY_(a) #a
#else
/* For a traditional cpp */
#define CONCAT(a,b) a/**/b
#define STRINGIFY(a) "a"
#endif
#endif /* #ifdef FORTRAN_H */
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCh... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Comm.F90 | #include "cctk.h"
module cctk_Comm
implicit none
interface
subroutine CCTK_SyncGroup (ierr, GH, group)
implicit none
integer ierr
CCTK_POINTER_TO_CONST GH
character(*) group
end subroutine CCTK_SyncGroup
subroutine CCTK_Barrier (ierr, GH)
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Termination.F90 | #include "cctk.h"
module cctk_Termination
implicit none
interface
subroutine CCTK_TerminationReached (ires, cctkGH)
implicit none
integer ires
CCTK_POINTER_TO_CONST cctkGH
end subroutine CCTK_TerminationReached
subroutine CCTK_TerminateNext (cctkGH)
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
cct... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Schedule.F90 | #include "cctk.h"
module cctk_Schedule
implicit none
interface
subroutine CCTK_SchedulePrint (ierr, where)
implicit none
integer ierr
character(*) where
end subroutine CCTK_SchedulePrint
subroutine CCTK_SchedulePrintTimes (ierr, where)
implicit none
integer... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F90
... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Faces.F90 | #include "cctk.h"
module cctk_Faces
implicit none
end module cctk_Faces
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_FortranString1.F90
cctk_File.F90
cctk_ParamCheck.F... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_FortranString1.F90 | #include "cctk.h"
! This is the name of a subroutine, so the module must be called differently.
module cctk_FortranString1
implicit none
end module cctk_FortranString1
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_File.F90
cctk_ParamCheck.F90
cctk_F... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_File.F90 | #include "cctk.h"
module cctk_File
implicit none
interface
subroutine CCTK_CreateDirectory (ierr, mode, pathname)
implicit none
integer ierr
integer mode
character(*) pathname
end subroutine CCTK_CreateDirectory
end interface
end module cctk_File
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_ParamCheck.... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_ParamCheck.F90 | #include "cctk.h"
module cctk_ParamCheck
implicit none
end module cctk_ParamCheck
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_FortranWrappers.F90 | #include "cctk.h"
module cctk_FortranWrappers
implicit none
interface
subroutine CCTK_RegisterFortranWrapper (ierr, name, function)
implicit none
integer ierr
character(*) name
CCTK_FPOINTER function
end subroutine CCTK_RegisterFortranWrapper
subroutine CCTK_For... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_GNU.F90 | #include "cctk.h"
module cctk_GNU
implicit none
! This file only pulls in declarations for getopt and regex, which
! have no Fortran wrappers
end module cctk_GNU
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Timers.F90 | #include "cctk.h"
module cctk_Timers
implicit none
interface
subroutine CCTK_NumTimers (num_timers)
implicit none
integer num_timers
end subroutine CCTK_NumTimers
subroutine CCTK_NumClocks (num_clocks)
implicit none
integer num_clocks
end subroutine CCTK_NumClocks... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Malloc1.F90 | #include "cctk.h"
! This is the name of a subroutine, so the module must be called differently.
module cctk_Malloc1
implicit none
interface
subroutine CCTK_MemStat
implicit none
end subroutine CCTK_MemStat
subroutine CCTK_TotalMemory (amount)
implicit none
integer amount
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_ActiveThorns.F90 | #include "cctk.h"
module cctk_ActiveThorns
implicit none
interface
! This routine has been made a function instead of a subroutine
! and is declared in cctk.h
! subroutine CCTK_IsThornActive (ierr, name)
! implicit none
! integer ierr
! character(*) name
! end subroutine CCTK_IsTho... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_WarnLevel.F90 | #include "cctk.h"
module cctk_WarnLevel
implicit none
interface
subroutine CCTK_Warn (level, line, file, thorn, message)
implicit none
integer level
integer line
character(*) file
character(*) thorn
character(*) message
end subroutine CCTK_Warn
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| make.code.defn | # Main make.code.defn file for thorn Fortran
ifneq ($(strip $(F90)),none)
SRCS = cctk.F90 \
cctk_ActiveThorns.F90 \
cctk_Banner.F90 \
cctk_Comm.F90 \
cctk_CommandLine.F90 \
cctk_Complex.F90 ... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Sync.F90 | #include "cctk.h"
module cctk_Sync
implicit none
interface
subroutine CCTK_SyncGroupI (ierr, cctkGH, group)
implicit none
integer ierr
CCTK_POINTER_TO_CONST cctkGH
integer group
end subroutine CCTK_SyncGroupI
subroutine CCTK_SyncGroupWi... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| util_Table.F90 | #include "cctk.h"
module util_Table
implicit none
interface
! create/destroy
subroutine Util_TableCreate (handle, flags)
implicit none
integer handle
integer flags
end subroutine Util_TableCreate
subroutine Util_TableClone (ierr, handle)
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Coord.F90 | #include "cctk.h"
module cctk_Coord
implicit none
interface
subroutine CCTK_CoordDir (dir, name, systemname)
implicit none
integer dir
character(*) name
character(*) systemname
end subroutine CCTK_CoordDir
subroutine CCTK_CoordIndex (ierr, dir, name, systemname)
... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Math.F90 | module cctk_Math
implicit none
interface
double precision function CCTK_copysign (x, y)
implicit none
double precision, intent(in) :: x, y
end function CCTK_copysign
integer function CCTK_fpclassify (x)
implicit none
double precision, intent(in) :: x
end function C... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_MemAlloc.F90 | #include "cctk.h"
module cctk_MemAlloc
implicit none
interface
subroutine CCTK_Malloc (ptr, size, line, file)
implicit none
CCTK_POINTER ptr
integer size
integer line
character(*) file
end subroutine CCTK_Malloc
subroutine CCTK_Free (ptr)
implic... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Misc.F90 | #include "cctk.h"
module cctk_Misc
implicit none
interface
subroutine Util_SplitString (ierr, before, before_length, after, after_length, string, sep)
implicit none
integer ierr
character(*) before
integer before_length
character(*) after
integer afte... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Groups.F90 | #include "cctk.h"
module cctk_Groups
implicit none
interface
subroutine CCTK_DecomposeName (ierr, fullname, implementation, implementation_nchars, name, name_nchars)
implicit none
integer ierr
character(*) fullname
character(*) implementation
integer implementati... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_GroupsOnGH.F90 | #include "cctk.h"
module cctk_GroupsOnGH
implicit none
interface
subroutine CCTK_VarDataPtr (ptr, GH, timelevel, fullvarname)
implicit none
CCTK_POINTER ptr
CCTK_POINTER_TO_CONST GH
integer timelevel
character(*) fullvarname
end subrout... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_DebugDefines.F90 | #include "cctk.h"
module cctk_DebugDefines
implicit none
end module cctk_DebugDefines
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Complex.F90 | #include "cctk.h"
module cctk_Complex
implicit none
! Fortran handles complex numbers just fine all by itself
! and does not need an additional library
end module cctk_Complex
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| paramcheck.F90 | #include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Functions.h"
#include "cctk_Parameters.h"
subroutine CheckFortranParameters (CCTK_ARGUMENTS)
implicit none
DECLARE_CCTK_ARGUMENTS
DECLARE_CCTK_PARAMETERS
DECLARE_CCTK_FUNCTIONS
if (one /= 1) then
call CCTK_PARAMWARN ("Fortran parameters do ... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Interp.F90 | #include "cctk.h"
module cctk_Interp
implicit none
interface
subroutine CCTK_InterpHandle (handle, name)
implicit none
integer handle
character(*) name
end subroutine CCTK_InterpHandle
#if 0
C no Fortran 90 interface for following routines
C their names exceed the maxim... | cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/Fortran | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn Fortran
PROVIDES Fortran
{
SCRIPT fortran.sh
LANG sh
}
REQUIRES Fortran
| # Interface definition for thorn Fortran
IMPLEMENTS: Fortran
INCLUDES SOURCE: fortran.h IN fortran.h
| # Parameter definitions for thorn Fortran
CCTK_INT one "This parameter has the value one"
{
1:1 :: "1"
} 1
| # Schedule definitions for thorn Fortran
SCHEDULE CheckFortranParameters AT paramcheck
{
LANG: Fortran
} "Test whether Fortran parameters work correctly"
| cctk_Flesh.F90 | #include "cctk.h"
module cctk_Flesh
implicit none
interface
subroutine CCTK_Traverse (ierr, GH, where)
implicit none
integer ierr
CCTK_POINTER GH
character(*) where
end subroutine CCTK_Traverse
end interface
end module cctk_Flesh
| cctk_Types.F90
cctk_Main.F90
cctk_IOMethods.F90
cctk_CommandLine.F90
cctk_GHExtensions.F90
cctk_Constants.F90
cctk.F90
cctk_Banner.F90
cctk_Version.F90
cctk_Reduction.F90
cctk_IO.F90
cctk_Parameter.F90
fortran.h
cctk_Comm.F90
cctk_Termination.F90
cctk_Schedule.F90
cctk_Faces.F90
cctk_FortranString1.F90
cctk_File.F90
cc... | cctk_Types.F90:
```
#include "cctk.h"
module cctk_Types
implicit none
interface
end interface
end module cctk_Types
```
cctk_Main.F90:
```
#include "cctk.h"
module cctk_Main
implicit none
interface
subroutine CCTK_Initialise (ierr, config)
implicit none
integer ierr
... |
CactusBase/InitBase | https://bitbucket.org/cactuscode/cactusbase.git | # Interface definition for thorn InitBase
IMPLEMENTS: InitBase
| # Parameter definitions for thorn InitBase
RESTRICTED:
KEYWORD initial_data_setup_method "Procedure for setting up initial data"
{
"init_some_levels" :: "Set up at least one time level; other time levels are scratch space"
"init_single_level" :: "Set up exactly one time level; other time levels are not accessed"... | # Schedule definitions for thorn InitBase
| make.code.defn | # Main make.code.defn file for thorn InitBase
# Source files in this directory
SRCS =
# Subdirectories containing source files
SUBDIRS =
| |||
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | ioASCIIGH.h | /*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
extern "C" {
#endif
t... | Write1D.c
Output1D.c
Output2D.c
make.code.defn
Output3D.c
Write3D.c
Startup.c
Write2D.c
ChooseOutput.c
| Write1D.c:
```
/*@@
@file Write1D.c
@date March 1997
@author Paul Walker
@desc
Output one-dimensional lines in ASCII xgraph/gnuplot format.
@enddesc
@history
@hauthor Thomas Radke
@hdate 30 May 2000
@hdesc
Get rid of all the PUGH stuff by using ... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Write1D.c | /*@@
@file Write1D.c
@date March 1997
@author Paul Walker
@desc
Output one-dimensional lines in ASCII xgraph/gnuplot format.
@enddesc
@history
@hauthor Thomas Radke
@hdate 30 May 2000
@hdesc
Get rid of all the PUGH stuff by using thorn Hyperslab... | ioASCIIGH.h
Output1D.c
Output2D.c
make.code.defn
Output3D.c
Write3D.c
Startup.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Output1D.c | /*@@
@file IO_Output1D.c
@date Tue Jan 9 1999
@author Gabrielle Allen
@desc
Functions to deal with 1D ASCII output of variables
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "util_String.h"
#include "... | ioASCIIGH.h
Write1D.c
Output2D.c
make.code.defn
Output3D.c
Write3D.c
Startup.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Output2D.c | /*@@
@file Output2D.c
@date Thu May 11 2000
@author Thomas Radke
@desc
Functions to deal with 2D ASCII output of variables
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "util_String.h"
#include "Cactu... | ioASCIIGH.h
Write1D.c
Output1D.c
make.code.defn
Output3D.c
Write3D.c
Startup.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | make.code.defn | # Main make.code.defn file for thorn IOASCII
# $Header$
# Source files in this directory
SRCS = Startup.c ChooseOutput.c Output1D.c Write1D.c Output2D.c Write2D.c \
Output3D.c Write3D.c
| ioASCIIGH.h
Write1D.c
Output1D.c
Output2D.c
Output3D.c
Write3D.c
Startup.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Output3D.c | /*@@
@file Output3D.c
@date Wed 12 Dec 2001
@author Thomas Radke
@desc
Functions to deal with 3D ASCII output of variables
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "util_String.h"
#include "Cactu... | ioASCIIGH.h
Write1D.c
Output1D.c
Output2D.c
make.code.defn
Write3D.c
Startup.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Write3D.c | /*@@
@file Write3D.c
@date Wed 12 Dec 2001
@author Thomas Radke
@desc
Three-dimensional output of variables in ASCII gnuplot format.
@enddesc
@version $Id$
@@*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#in... | ioASCIIGH.h
Write1D.c
Output1D.c
Output2D.c
make.code.defn
Output3D.c
Startup.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Startup.c | /*@@
@file Startup.c
@date Sat Feb 6 1999
@author Gabrielle Allen
@desc
Startup routines for IOASCII.
@enddesc
@version $Id$
@@*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_IOMethods.h"
#include "cctk_Parameters.h"
#include "Cact... | ioASCIIGH.h
Write1D.c
Output1D.c
Output2D.c
make.code.defn
Output3D.c
Write3D.c
Write2D.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | Write2D.c | /*@@
@file Write2D.c
@date Thu May 11 2000
@author Thomas Radke
@desc
Output two-dimensional slices in ASCII gnuplot format.
@enddesc
@version $Id$
@@*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "u... | ioASCIIGH.h
Write1D.c
Output1D.c
Output2D.c
make.code.defn
Output3D.c
Write3D.c
Startup.c
ChooseOutput.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOASCII | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOASCII
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOASCII
# $Header$
implements: IOASCII
### FIXME: need private inheritance in order to be implementation-compatible
### with CarpetIOASCII
#inherits: IO
CCTK_INT FUNCTION \
Hyperslab_GetList (CCTK_POINTER_TO_CONST IN cctkGH, \
CCTK_INT IN mapping_handle... | # Parameter definitions for thorn IOASCII
# $Header$
#############################################################################
### declare IOASCII parameters
#############################################################################
private:
##########################
# Directories to output to
##############... | # Schedule definitions for thorn IOASCII
# $Header$
########################################################################
### register IOASCII routines
########################################################################
schedule IOASCII_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
sc... | ChooseOutput.c | /*@@
@file ChooseOutput.c
@author Gabrielle Allen
@date July 6 2000
@desc
Choose what 1D slices and 2D planes to output by IOASCII.
@enddesc
@version $Id$
@@*/
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Parameters.h"
#... | ioASCIIGH.h
Write1D.c
Output1D.c
Output2D.c
make.code.defn
Output3D.c
Write3D.c
Startup.c
Write2D.c
| ioASCIIGH.h:
```
/*@@
@header ioASCIIGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOASCII.
@version $Header$
@@*/
#ifndef _IOASCII_IOASCIIGH_H_
#define _IOASCII_IOASCIIGH_H_ 1
#include "StoreNamedData.h"
#ifdef __cplusplus
exter... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | WriteScalar.c | /*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> /* strlen(3) */
#in... | iobasicGH.h
OutputInfo.c
OutputScalar.c
make.code.defn
WriteInfo.c
Startup.c
| iobasicGH.h:
```
/*@@
@header iobasicGH.h
@date Friday 18th September 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOBasic.
@enddesc
@version $Header$
@@*/
#ifndef _IOBASIC_IOBASICGH_H_
#define _IOBASIC_IOBASICGH_H_ 1
#include "StoreNamedData.h"
typ... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | iobasicGH.h | /*@@
@header iobasicGH.h
@date Friday 18th September 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOBasic.
@enddesc
@version $Header$
@@*/
#ifndef _IOBASIC_IOBASICGH_H_
#define _IOBASIC_IOBASICGH_H_ 1
#include "StoreNamedData.h"
typedef struct IOBAS... | WriteScalar.c
OutputInfo.c
OutputScalar.c
make.code.defn
WriteInfo.c
Startup.c
| WriteScalar.c:
```
/*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> ... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | OutputInfo.c | /*@@
@file OutputInfo.c
@date June 31 1999
@author Gabrielle Allen
@desc
Functions to deal with info output of variables
@enddesc
@version $Id$
@@*/
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#inclu... | WriteScalar.c
iobasicGH.h
OutputScalar.c
make.code.defn
WriteInfo.c
Startup.c
| WriteScalar.c:
```
/*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> ... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | OutputScalar.c | /*@@
@file Output.c
@date Mon 21 September
@author Gabrielle Allen
@desc
Functions to deal with scalar output of grid variables
@enddesc
@@*/
/* #define IOBASIC_DEBUG 1 */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#inc... | WriteScalar.c
iobasicGH.h
OutputInfo.c
make.code.defn
WriteInfo.c
Startup.c
| WriteScalar.c:
```
/*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> ... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | make.code.defn | # Main make.code.defn file for thorn IOBasic
# $Header$
# Source files in this directory
SRCS = Startup.c \
OutputScalar.c \
OutputInfo.c \
WriteScalar.c \
WriteInfo.c
| WriteScalar.c
iobasicGH.h
OutputInfo.c
OutputScalar.c
WriteInfo.c
Startup.c
| WriteScalar.c:
```
/*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> ... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | WriteInfo.c | /*@@
@file WriteInfo.c
@date June 31 1999
@author Gabrielle Allen, Paul Walker, Thomas Radke
@desc
Gets the data for IOBasic's info output.
@enddesc
@version $Id: /cactusdevcvs/CactusBase/IOBasic/src/OutputInfo.c,v 1.24 2001
@@*/
#include <stdlib.h>
#include "cctk.h"
#in... | WriteScalar.c
iobasicGH.h
OutputInfo.c
OutputScalar.c
make.code.defn
Startup.c
| WriteScalar.c:
```
/*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> ... |
CactusBase/IOBasic | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definition for thorn IOBasic
# $Header$
REQUIRES IOUtil
REQUIRES THORNS: IOUtil
| # Interface definition for thorn IOBasic
# $Header$
implements: IOBasic
inherits: IO
real next_info_output_time type=scalar
real next_scalar_output_time type=scalar
CCTK_INT FUNCTION IO_TruncateOutputFiles \
(CCTK_POINTER_TO_CONST IN GH)
REQUIRES FUNCTION IO_TruncateOutputFiles
| # Parameter definitions for thorn IOBasic
# $Header$
#############################################################################
### declare IOBasic parameters
#############################################################################
private:
##########################
# Directory to output to
################... | # Schedule definitions for thorn IOBasic
# $Header$
########################################################################
### register IOBasic routines
########################################################################
schedule IOBasic_Startup at STARTUP after IOUtil_Startup
{
LANG:C
} "Startup routine"
#... | Startup.c | /*@@
@file Startup.c
@date Friday 18th September 1999
@author Gabrielle Allen
@desc
Startup routines for IOBasic.
@enddesc
@version $Id$
@@*/
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cc... | WriteScalar.c
iobasicGH.h
OutputInfo.c
OutputScalar.c
make.code.defn
WriteInfo.c
| WriteScalar.c:
```
/*@@
@routine WriteScalar.c
@date 18th September 1999
@author Gabrielle Allen
@desc
Dumps data for IOBasic's "Scalar" I/O method to output files
@enddesc
@version $Id$
@@*/
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h> ... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | ioutil_CheckpointRecovery.h | /*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IOUTIL_CHECKPOINTRECOVERY_H_
#ifde... | Utils.c
make.code.defn
ioutil_AdvertisedFiles.h
ioGH.h
ioutil_Utils.h
AdvertisedFiles.c
CheckpointRecovery.c
Startup.c
| Utils.c:
```
/*@@
@file Utils.c
@date Tue 4th July 2000
@author Gabrielle Allen
@desc
Utility routines which may be called by other I/O thorns.
@enddesc
@version $Id$
@@*/
#include <math.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Paramet... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | Utils.c | /*@@
@file Utils.c
@date Tue 4th July 2000
@author Gabrielle Allen
@desc
Utility routines which may be called by other I/O thorns.
@enddesc
@version $Id$
@@*/
#include <math.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#inclu... | ioutil_CheckpointRecovery.h
make.code.defn
ioutil_AdvertisedFiles.h
ioGH.h
ioutil_Utils.h
AdvertisedFiles.c
CheckpointRecovery.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | make.code.defn | # Main make.code.defn file for thorn IOUtil
# $Header$
# Source files in this directory
SRCS = Startup.c CheckpointRecovery.c AdvertisedFiles.c Utils.c
| ioutil_CheckpointRecovery.h
Utils.c
ioutil_AdvertisedFiles.h
ioGH.h
ioutil_Utils.h
AdvertisedFiles.c
CheckpointRecovery.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | ioutil_AdvertisedFiles.h | /*@@
@header ioutil_AdvertisedFiles.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Structures and function prototypes for advertising files.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_ADVERTISED_FILES_H_
#define _IOUTIL_ADVERTISED_FILES_H_
#ifdef __cplusplus
... | ioutil_CheckpointRecovery.h
Utils.c
make.code.defn
ioGH.h
ioutil_Utils.h
AdvertisedFiles.c
CheckpointRecovery.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | ioGH.h | /*@@
@header ioGH.h
@date Tue 9th Jan 1999
@author Gabrielle Allen
@desc
The extensions to the GH structure from IOUtil.
@enddesc
@version $Header$
@@*/
#ifndef _IOUTIL_IOGH_H_
#define _IOUTIL_IOGH_H_ 1
#ifdef __cplusplus
extern "C" {
#endif
/* advertise that this is the new ver... | ioutil_CheckpointRecovery.h
Utils.c
make.code.defn
ioutil_AdvertisedFiles.h
ioutil_Utils.h
AdvertisedFiles.c
CheckpointRecovery.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | ioutil_Utils.h | /*@@
@header ioutil_Utils.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Function prototypes for setting up slice centers.
@enddesc
@version $Header$
@@*/
#ifndef _IOUTIL_IOUTIL_UTILS_H_
#define _IOUTIL_IOUTIL_UTILS_H_ 1
#ifdef __cplusplus
extern "C" {
#endif
/* structure de... | ioutil_CheckpointRecovery.h
Utils.c
make.code.defn
ioutil_AdvertisedFiles.h
ioGH.h
AdvertisedFiles.c
CheckpointRecovery.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | AdvertisedFiles.c | /*@@
@file AdvertisedFiles.c
@date Mon 18 Sep 2000
@author Thomas Radke
@desc
IOUtil file advertising stuff.
@enddesc
@history
@endhistory
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "StoreNamedData.h"
#include "ioGH.h"
#include "ioutil_AdvertisedFiles.h"
static const char *rc... | ioutil_CheckpointRecovery.h
Utils.c
make.code.defn
ioutil_AdvertisedFiles.h
ioGH.h
ioutil_Utils.h
CheckpointRecovery.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | CheckpointRecovery.c | /*@@
@file CheckpointRecovery.c
@date Jun 04 1999
@author Thomas Radke
@desc
Utility routines for checkpointing/recovery and the filereader
The actual work is done by the IO thorns.
@enddesc
@version $Id$
@@*/
#include "cctk.h"
#include "cctk_Parameters.h"
... | ioutil_CheckpointRecovery.h
Utils.c
make.code.defn
ioutil_AdvertisedFiles.h
ioGH.h
ioutil_Utils.h
AdvertisedFiles.c
Startup.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/IOUtil | https://bitbucket.org/cactuscode/cactusbase.git | # Configuration definitions for thorn IOUTIL
# $Header$
# In future we can hopefully use function aliasing instead.
PROVIDES IOUTIL
{
SCRIPT
LANG
}
| # Interface definitions for thorn IOUtil
# $Header$
implements: IO
# aliased functions required from Coordinate base thorn
CCTK_INT FUNCTION Coord_GetDefaultSystem \
(CCTK_POINTER_TO_CONST IN GH, \
CCTK_INT IN systemdim)
USES FUNCTION Coord_GetDefaultSystem
CCTK_INT FUNCTION IO_TruncateOutputFile... | # Parameter definitione for thorn IOUtil
# $Header$
#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other I/O thorns.
#############################################################################
re... | # Schedule definitions for thorn IOUtil
# $Header$
schedule IOUtil_Startup at STARTUP after Driver_Startup
{
LANG:C
} "Startup routine"
if (! CCTK_Equals (recover, "no"))
{
schedule IOUtil_RecoverGH at RECOVER_VARIABLES
{
LANG:C
OPTIONS: level
} "Checkpoint recovery routine"
}
if (*filereader_ID_file... | Startup.c | /*@@
@file Startup.c
@date Sat Feb 6 1999
@author Gabrielle Allen
@desc
Startup routines for IOUtil.
@enddesc
@version $Id$
@@*/
#include "cctk.h"
#include "cctk_Arguments.h"
#include "cctk_Misc.h"
#include "cctk_Version.h"
#include "cctk_Parameters.h"
#include "util_Network.h"
... | ioutil_CheckpointRecovery.h
Utils.c
make.code.defn
ioutil_AdvertisedFiles.h
ioGH.h
ioutil_Utils.h
AdvertisedFiles.c
CheckpointRecovery.c
| ioutil_CheckpointRecovery.h:
```
/*@@
@header ioutil_CheckpointRecovery.h
@date Tue 19 Sep 2000
@author Thomas Radke
@desc
Typedefs and function prototypes for checkpointing and recovery.
@history
@endhistory
@version $Header$
@@*/
#ifndef _IOUTIL_CHECKPOINTRECOVERY_H_
#define _IO... |
CactusBase/SymBase | https://bitbucket.org/cactuscode/cactusbase.git | # 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 Symmet... | # Parameter definitions for thorn SymBase
# $Header$
BOOLEAN verbose "Output symmetry boundary face descriptions after registration"
{
} "yes"
| # Schedule definitions for thorn SymBase
# $Header$
SCHEDULE SymBase_Startup AT CCTK_STARTUP
{
LANG: C
} "Register GH Extension for SymBase"
SCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH
{
} "Wrapper group for SymBase"
SCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper
{
} "Register your symmetries here"
SCHEDULE ... | SymBase.h | /*@@
@file SymBase.h
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Declarations for thorn SymBase
@version $Header$
@enddesc
@@*/
#ifndef SYMBASE_H
#define SYMBASE_H
#include "cctk.h"
#include "cctk_Arguments.h"
/* SymBase's GH extension */
struct SymBase {
/* The t... | Table.c
Faces.c
Statistics.c
Check.c
Handles.c
make.code.defn
Interpolation.c
Startup.c
| Table.c:
```
/*@@
@file Table.c
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Get the symmetry table handle for a grid or grid array
@version $Header$
@enddesc
@@*/
#include "cctk.h"
#include "util_Table.h"
#include "SymBase.h"
/* the rcs ID and its dummy function to ... | |
CactusBase/SymBase | https://bitbucket.org/cactuscode/cactusbase.git | # 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 Symmet... | # Parameter definitions for thorn SymBase
# $Header$
BOOLEAN verbose "Output symmetry boundary face descriptions after registration"
{
} "yes"
| # Schedule definitions for thorn SymBase
# $Header$
SCHEDULE SymBase_Startup AT CCTK_STARTUP
{
LANG: C
} "Register GH Extension for SymBase"
SCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH
{
} "Wrapper group for SymBase"
SCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper
{
} "Register your symmetries here"
SCHEDULE ... | Table.c | /*@@
@file Table.c
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Get the symmetry table handle for a grid or grid array
@version $Header$
@enddesc
@@*/
#include "cctk.h"
#include "util_Table.h"
#include "SymBase.h"
/* the rcs ID and its dummy function to use it */
sta... | SymBase.h
Faces.c
Statistics.c
Check.c
Handles.c
make.code.defn
Interpolation.c
Startup.c
| SymBase.h:
```
/*@@
@file SymBase.h
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Declarations for thorn SymBase
@version $Header$
@enddesc
@@*/
#ifndef SYMBASE_H
#define SYMBASE_H
#include "cctk.h"
#include "cctk_Arguments.h"
/* SymBase's GH extension */
struct SymBa... | |
CactusBase/SymBase | https://bitbucket.org/cactuscode/cactusbase.git | # 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 Symmet... | # Parameter definitions for thorn SymBase
# $Header$
BOOLEAN verbose "Output symmetry boundary face descriptions after registration"
{
} "yes"
| # Schedule definitions for thorn SymBase
# $Header$
SCHEDULE SymBase_Startup AT CCTK_STARTUP
{
LANG: C
} "Register GH Extension for SymBase"
SCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH
{
} "Wrapper group for SymBase"
SCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper
{
} "Register your symmetries here"
SCHEDULE ... | Faces.c | /*@@
@file Faces.c
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Register a symmetry condition for a face
@version $Header$
@enddesc
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "util_Table.h"
#include "SymBase.h"
/* the rcs ID and its dummy function to use i... | SymBase.h
Table.c
Statistics.c
Check.c
Handles.c
make.code.defn
Interpolation.c
Startup.c
| SymBase.h:
```
/*@@
@file SymBase.h
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Declarations for thorn SymBase
@version $Header$
@enddesc
@@*/
#ifndef SYMBASE_H
#define SYMBASE_H
#include "cctk.h"
#include "cctk_Arguments.h"
/* SymBase's GH extension */
struct SymBa... | |
CactusBase/SymBase | https://bitbucket.org/cactuscode/cactusbase.git | # 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 Symmet... | # Parameter definitions for thorn SymBase
# $Header$
BOOLEAN verbose "Output symmetry boundary face descriptions after registration"
{
} "yes"
| # Schedule definitions for thorn SymBase
# $Header$
SCHEDULE SymBase_Startup AT CCTK_STARTUP
{
LANG: C
} "Register GH Extension for SymBase"
SCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH
{
} "Wrapper group for SymBase"
SCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper
{
} "Register your symmetries here"
SCHEDULE ... | Statistics.c | /*@@
@file Statistics.c
@author Erik Schnetter
@date 2004-05-25
@desc
Provide information about the registered symmetry conditions
@version $Header$
@enddesc
@@*/
#include <stdlib.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "util_Table.h"
#include "SymBase.h"
... | SymBase.h
Table.c
Faces.c
Check.c
Handles.c
make.code.defn
Interpolation.c
Startup.c
| SymBase.h:
```
/*@@
@file SymBase.h
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Declarations for thorn SymBase
@version $Header$
@enddesc
@@*/
#ifndef SYMBASE_H
#define SYMBASE_H
#include "cctk.h"
#include "cctk_Arguments.h"
/* SymBase's GH extension */
struct SymBa... | |
CactusBase/SymBase | https://bitbucket.org/cactuscode/cactusbase.git | # 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 Symmet... | # Parameter definitions for thorn SymBase
# $Header$
BOOLEAN verbose "Output symmetry boundary face descriptions after registration"
{
} "yes"
| # Schedule definitions for thorn SymBase
# $Header$
SCHEDULE SymBase_Startup AT CCTK_STARTUP
{
LANG: C
} "Register GH Extension for SymBase"
SCHEDULE GROUP SymBase_Wrapper AT CCTK_WRAGH
{
} "Wrapper group for SymBase"
SCHEDULE GROUP SymmetryRegister IN SymBase_Wrapper
{
} "Register your symmetries here"
SCHEDULE ... | Check.c | /*@@
@file Check.c
@author Erik Schnetter
@date 2004-06-19
@desc
Check whether the driver set up the grid consistently.
@version $Header$
@enddesc
@@*/
#include "util_Table.h"
#include "cctk.h"
#include "SymBase.h"
/* the rcs ID and its dummy function to use it */
static cons... | SymBase.h
Table.c
Faces.c
Statistics.c
Handles.c
make.code.defn
Interpolation.c
Startup.c
| SymBase.h:
```
/*@@
@file SymBase.h
@author Erik Schnetter
@date 2004/03/07 09:48:53
@desc
Declarations for thorn SymBase
@version $Header$
@enddesc
@@*/
#ifndef SYMBASE_H
#define SYMBASE_H
#include "cctk.h"
#include "cctk_Arguments.h"
/* SymBase's GH extension */
struct SymBa... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.