15f34f2dcSJed Brown #include <petsc/private/viewercgnsimpl.h> /*I "petscviewer.h" I*/ 2472b9844SJames Wright #include <petsc/private/dmpleximpl.h> /*I "petscdmplex.h" I*/ 35f34f2dcSJed Brown #if defined(PETSC_HDF5_HAVE_PARALLEL) 45f34f2dcSJed Brown #include <pcgnslib.h> 55f34f2dcSJed Brown #else 65f34f2dcSJed Brown #include <cgnslib.h> 75f34f2dcSJed Brown #endif 8472b9844SJames Wright #include <cgns_io.h> 9472b9844SJames Wright #include <ctype.h> 105f34f2dcSJed Brown 11d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerSetFromOptions_CGNS(PetscViewer v, PetscOptionItems *PetscOptionsObject) 12d71ae5a4SJacob Faibussowitsch { 1325760affSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)v->data; 144d86920dSPierre Jolivet 155f34f2dcSJed Brown PetscFunctionBegin; 165f34f2dcSJed Brown PetscOptionsHeadBegin(PetscOptionsObject, "CGNS Viewer Options"); 17da0802e2SStefano Zampini PetscCall(PetscOptionsInt("-viewer_cgns_batch_size", "Max number of steps to store in single file when using a template cgns:name-\%d.cgns", "", cgv->batch_size, &cgv->batch_size, NULL)); 185f34f2dcSJed Brown PetscOptionsHeadEnd(); 193ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 205f34f2dcSJed Brown } 215f34f2dcSJed Brown 22d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerView_CGNS(PetscViewer v, PetscViewer viewer) 23d71ae5a4SJacob Faibussowitsch { 245f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)v->data; 255f34f2dcSJed Brown 265f34f2dcSJed Brown PetscFunctionBegin; 2748a46eb9SPierre Jolivet if (cgv->filename) PetscCall(PetscViewerASCIIPrintf(viewer, "Filename: %s\n", cgv->filename)); 283ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 295f34f2dcSJed Brown } 305f34f2dcSJed Brown 31d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerFileClose_CGNS(PetscViewer viewer) 32d71ae5a4SJacob Faibussowitsch { 335f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 345f34f2dcSJed Brown 355f34f2dcSJed Brown PetscFunctionBegin; 365f34f2dcSJed Brown if (cgv->output_times) { 376497c311SBarry Smith PetscCount size, width = 32, *steps; 385f34f2dcSJed Brown char *solnames; 395f34f2dcSJed Brown PetscReal *times; 405f34f2dcSJed Brown cgsize_t num_times; 415f34f2dcSJed Brown PetscCall(PetscSegBufferGetSize(cgv->output_times, &size)); 425f34f2dcSJed Brown PetscCall(PetscSegBufferExtractInPlace(cgv->output_times, ×)); 435f34f2dcSJed Brown num_times = size; 445f34f2dcSJed Brown PetscCallCGNS(cg_biter_write(cgv->file_num, cgv->base, "TimeIterValues", num_times)); 455f34f2dcSJed Brown PetscCallCGNS(cg_goto(cgv->file_num, cgv->base, "BaseIterativeData_t", 1, NULL)); 465f34f2dcSJed Brown PetscCallCGNS(cg_array_write("TimeValues", CGNS_ENUMV(RealDouble), 1, &num_times, times)); 475f34f2dcSJed Brown PetscCall(PetscSegBufferDestroy(&cgv->output_times)); 485f34f2dcSJed Brown PetscCallCGNS(cg_ziter_write(cgv->file_num, cgv->base, cgv->zone, "ZoneIterativeData")); 495f34f2dcSJed Brown PetscCallCGNS(cg_goto(cgv->file_num, cgv->base, "Zone_t", cgv->zone, "ZoneIterativeData_t", 1, NULL)); 505f34f2dcSJed Brown PetscCall(PetscMalloc(size * width + 1, &solnames)); 519812b6beSJed Brown PetscCall(PetscSegBufferExtractInPlace(cgv->output_steps, &steps)); 526497c311SBarry Smith for (PetscCount i = 0; i < size; i++) PetscCall(PetscSNPrintf(&solnames[i * width], width + 1, "FlowSolution%-20zu", (size_t)steps[i])); 539812b6beSJed Brown PetscCall(PetscSegBufferDestroy(&cgv->output_steps)); 545f34f2dcSJed Brown cgsize_t shape[2] = {(cgsize_t)width, (cgsize_t)size}; 555f34f2dcSJed Brown PetscCallCGNS(cg_array_write("FlowSolutionPointers", CGNS_ENUMV(Character), 2, shape, solnames)); 565f34f2dcSJed Brown // The VTK reader looks for names like FlowSolution*Pointers. 576497c311SBarry Smith for (PetscCount i = 0; i < size; i++) PetscCall(PetscSNPrintf(&solnames[i * width], width + 1, "%-32s", "CellInfo")); 585f34f2dcSJed Brown PetscCallCGNS(cg_array_write("FlowSolutionCellInfoPointers", CGNS_ENUMV(Character), 2, shape, solnames)); 595f34f2dcSJed Brown PetscCall(PetscFree(solnames)); 605f34f2dcSJed Brown 615f34f2dcSJed Brown PetscCallCGNS(cg_simulation_type_write(cgv->file_num, cgv->base, CGNS_ENUMV(TimeAccurate))); 625f34f2dcSJed Brown } 635f34f2dcSJed Brown PetscCall(PetscFree(cgv->filename)); 645f34f2dcSJed Brown #if defined(PETSC_HDF5_HAVE_PARALLEL) 65753e5362SJed Brown if (cgv->file_num) PetscCallCGNS(cgp_close(cgv->file_num)); 665f34f2dcSJed Brown #else 675f34f2dcSJed Brown if (cgv->file_num) PetscCallCGNS(cg_close(cgv->file_num)); 685f34f2dcSJed Brown #endif 695f34f2dcSJed Brown cgv->file_num = 0; 7025760affSJed Brown PetscCall(PetscFree(cgv->node_l2g)); 7125760affSJed Brown PetscCall(PetscFree(cgv->nodal_field)); 723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 7325760affSJed Brown } 7425760affSJed Brown 7525760affSJed Brown PetscErrorCode PetscViewerCGNSFileOpen_Internal(PetscViewer viewer, PetscInt sequence_number) 7625760affSJed Brown { 7725760affSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 784d86920dSPierre Jolivet 7925760affSJed Brown PetscFunctionBegin; 8025760affSJed Brown PetscCheck((cgv->filename == NULL) ^ (sequence_number < 0), PetscObjectComm((PetscObject)viewer), PETSC_ERR_ARG_INCOMP, "Expect either a template filename or non-negative sequence number"); 8125760affSJed Brown if (!cgv->filename) { 8225760affSJed Brown char filename_numbered[PETSC_MAX_PATH_LEN]; 8325760affSJed Brown // Cast sequence_number so %d can be used also when PetscInt is 64-bit. We could upgrade the format string if users 8425760affSJed Brown // run more than 2B time steps. 8525760affSJed Brown PetscCall(PetscSNPrintf(filename_numbered, sizeof filename_numbered, cgv->filename_template, (int)sequence_number)); 8625760affSJed Brown PetscCall(PetscStrallocpy(filename_numbered, &cgv->filename)); 8725760affSJed Brown } 8825760affSJed Brown switch (cgv->btype) { 8925760affSJed Brown case FILE_MODE_READ: 90472b9844SJames Wright #if defined(PETSC_HDF5_HAVE_PARALLEL) 91472b9844SJames Wright PetscCallCGNS(cgp_mpi_comm(PetscObjectComm((PetscObject)viewer))); 92472b9844SJames Wright PetscCallCGNS(cgp_open(cgv->filename, CG_MODE_READ, &cgv->file_num)); 93472b9844SJames Wright #else 94472b9844SJames Wright PetscCallCGNS(cg_open(filename, CG_MODE_READ, &cgv->file_num)); 95472b9844SJames Wright #endif 9625760affSJed Brown break; 9725760affSJed Brown case FILE_MODE_WRITE: 9825760affSJed Brown #if defined(PETSC_HDF5_HAVE_PARALLEL) 9925760affSJed Brown PetscCallCGNS(cgp_mpi_comm(PetscObjectComm((PetscObject)viewer))); 10025760affSJed Brown PetscCallCGNS(cgp_open(cgv->filename, CG_MODE_WRITE, &cgv->file_num)); 10125760affSJed Brown #else 10225760affSJed Brown PetscCallCGNS(cg_open(filename, CG_MODE_WRITE, &cgv->file_num)); 10325760affSJed Brown #endif 10425760affSJed Brown break; 10525760affSJed Brown case FILE_MODE_UNDEFINED: 10625760affSJed Brown SETERRQ(PetscObjectComm((PetscObject)viewer), PETSC_ERR_ORDER, "Must call PetscViewerFileSetMode() before PetscViewerFileSetName()"); 10725760affSJed Brown default: 10825760affSJed Brown SETERRQ(PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Unsupported file mode %s", PetscFileModes[cgv->btype]); 10925760affSJed Brown } 1103ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 11125760affSJed Brown } 11225760affSJed Brown 11325760affSJed Brown PetscErrorCode PetscViewerCGNSCheckBatch_Internal(PetscViewer viewer) 11425760affSJed Brown { 11525760affSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 1166497c311SBarry Smith PetscCount num_steps; 11725760affSJed Brown 11825760affSJed Brown PetscFunctionBegin; 1193ba16761SJacob Faibussowitsch if (!cgv->filename_template) PetscFunctionReturn(PETSC_SUCCESS); // Batches are closed when viewer is destroyed 12025760affSJed Brown PetscCall(PetscSegBufferGetSize(cgv->output_times, &num_steps)); 1216497c311SBarry Smith if (num_steps >= (PetscCount)cgv->batch_size) PetscCall(PetscViewerFileClose_CGNS(viewer)); 1223ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1235f34f2dcSJed Brown } 1245f34f2dcSJed Brown 125d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerDestroy_CGNS(PetscViewer viewer) 126d71ae5a4SJacob Faibussowitsch { 1275f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 1285f34f2dcSJed Brown 1295f34f2dcSJed Brown PetscFunctionBegin; 1305f34f2dcSJed Brown PetscCall(PetscViewerFileClose_CGNS(viewer)); 131472b9844SJames Wright PetscCall(PetscFree(cgv->solution_name)); 1325f34f2dcSJed Brown PetscCall(PetscFree(cgv)); 1335f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerFileSetName_C", NULL)); 1345f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerFileGetName_C", NULL)); 1355f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerFileSetMode_C", NULL)); 1365f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)viewer, "PetscViewerFileGetMode_C", NULL)); 1373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1385f34f2dcSJed Brown } 1395f34f2dcSJed Brown 140d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerFileSetMode_CGNS(PetscViewer viewer, PetscFileMode type) 141d71ae5a4SJacob Faibussowitsch { 1425f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 1435f34f2dcSJed Brown 1445f34f2dcSJed Brown PetscFunctionBegin; 1455f34f2dcSJed Brown cgv->btype = type; 1463ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1475f34f2dcSJed Brown } 1485f34f2dcSJed Brown 149d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerFileGetMode_CGNS(PetscViewer viewer, PetscFileMode *type) 150d71ae5a4SJacob Faibussowitsch { 1515f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 1525f34f2dcSJed Brown 1535f34f2dcSJed Brown PetscFunctionBegin; 1545f34f2dcSJed Brown *type = cgv->btype; 1553ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1565f34f2dcSJed Brown } 1575f34f2dcSJed Brown 158d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerFileSetName_CGNS(PetscViewer viewer, const char *filename) 159d71ae5a4SJacob Faibussowitsch { 1605f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 16125760affSJed Brown char *has_pattern; 1625f34f2dcSJed Brown 1635f34f2dcSJed Brown PetscFunctionBegin; 1645f34f2dcSJed Brown if (cgv->file_num) PetscCallCGNS(cg_close(cgv->file_num)); 1655f34f2dcSJed Brown PetscCall(PetscFree(cgv->filename)); 16625760affSJed Brown PetscCall(PetscFree(cgv->filename_template)); 16725760affSJed Brown PetscCall(PetscStrchr(filename, '%', &has_pattern)); 16825760affSJed Brown if (has_pattern) { 16925760affSJed Brown PetscCall(PetscStrallocpy(filename, &cgv->filename_template)); 17025760affSJed Brown // Templated file names open lazily, once we know DMGetOutputSequenceNumber() 17125760affSJed Brown } else { 1725f34f2dcSJed Brown PetscCall(PetscStrallocpy(filename, &cgv->filename)); 17325760affSJed Brown PetscCall(PetscViewerCGNSFileOpen_Internal(viewer, -1)); 1745f34f2dcSJed Brown } 1753ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1765f34f2dcSJed Brown } 1775f34f2dcSJed Brown 178d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscViewerFileGetName_CGNS(PetscViewer viewer, const char **filename) 179d71ae5a4SJacob Faibussowitsch { 1805f34f2dcSJed Brown PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 1815f34f2dcSJed Brown 1825f34f2dcSJed Brown PetscFunctionBegin; 1835f34f2dcSJed Brown *filename = cgv->filename; 1843ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1855f34f2dcSJed Brown } 1865f34f2dcSJed Brown 1875f34f2dcSJed Brown /*MC 1885f34f2dcSJed Brown PETSCVIEWERCGNS - A viewer for CGNS files 1895f34f2dcSJed Brown 1905f34f2dcSJed Brown Level: beginner 191811af0c4SBarry Smith 1923f423023SBarry Smith Options Database Key: 1933f423023SBarry Smith . -viewer_cgns_batch_size SIZE - set max number of output sequence times to write per batch 19425760affSJed Brown 1953f423023SBarry Smith Note: 19625760affSJed Brown If the filename contains an integer format character, the CGNS viewer will created a batched output sequence. For 19725760affSJed Brown example, one could use `-ts_monitor_solution cgns:flow-%d.cgns`. This is desirable if one wants to limit file sizes or 19825760affSJed Brown if the job might crash/be killed by a resource manager before exiting cleanly. 19925760affSJed Brown 20025760affSJed Brown .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerCreate()`, `VecView()`, `DMView()`, `PetscViewerFileSetName()`, `PetscViewerFileSetMode()`, `TSSetFromOptions()` 2015f34f2dcSJed Brown M*/ 2025f34f2dcSJed Brown 203d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscViewerCreate_CGNS(PetscViewer v) 204d71ae5a4SJacob Faibussowitsch { 2055f34f2dcSJed Brown PetscViewer_CGNS *cgv; 2065f34f2dcSJed Brown 2075f34f2dcSJed Brown PetscFunctionBegin; 2084dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&cgv)); 2095f34f2dcSJed Brown 2105f34f2dcSJed Brown v->data = cgv; 2115f34f2dcSJed Brown v->ops->destroy = PetscViewerDestroy_CGNS; 2125f34f2dcSJed Brown v->ops->setfromoptions = PetscViewerSetFromOptions_CGNS; 2135f34f2dcSJed Brown v->ops->view = PetscViewerView_CGNS; 2145f34f2dcSJed Brown cgv->btype = FILE_MODE_UNDEFINED; 2155f34f2dcSJed Brown cgv->filename = NULL; 21625760affSJed Brown cgv->batch_size = 20; 217472b9844SJames Wright cgv->solution_index = -1; // Default to use the "last" solution 218472b9844SJames Wright cgv->base = 1; 219472b9844SJames Wright cgv->zone = 1; 2205f34f2dcSJed Brown 2215f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerFileSetName_C", PetscViewerFileSetName_CGNS)); 2225f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerFileGetName_C", PetscViewerFileGetName_CGNS)); 2235f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerFileSetMode_C", PetscViewerFileSetMode_CGNS)); 2245f34f2dcSJed Brown PetscCall(PetscObjectComposeFunction((PetscObject)v, "PetscViewerFileGetMode_C", PetscViewerFileGetMode_CGNS)); 2253ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2265f34f2dcSJed Brown } 227472b9844SJames Wright 228472b9844SJames Wright // Find DataArray_t node under the current node (determined by `cg_goto` and friends) that matches `name` 229472b9844SJames Wright // Return the index of that array and (optionally) other data about the array 230472b9844SJames Wright static inline PetscErrorCode CGNS_Find_Array(MPI_Comm comm, const char name[], int *A_index, CGNS_ENUMT(DataType_t) * data_type, int *dim, cgsize_t size[]) 231472b9844SJames Wright { 232472b9844SJames Wright int narrays; // number of arrays under the current node 233472b9844SJames Wright char array_name[CGIO_MAX_NAME_LENGTH + 1]; 234472b9844SJames Wright CGNS_ENUMT(DataType_t) data_type_local; 235472b9844SJames Wright int _dim; 236472b9844SJames Wright cgsize_t _size[12]; 237472b9844SJames Wright PetscBool matches_name = PETSC_FALSE; 238472b9844SJames Wright 239472b9844SJames Wright PetscFunctionBeginUser; 240472b9844SJames Wright PetscCallCGNS(cg_narrays(&narrays)); 241472b9844SJames Wright for (int i = 1; i <= narrays; i++) { 242472b9844SJames Wright PetscCallCGNS(cg_array_info(i, array_name, &data_type_local, &_dim, _size)); 243472b9844SJames Wright PetscCall(PetscStrcmp(name, array_name, &matches_name)); 244472b9844SJames Wright if (matches_name) { 245472b9844SJames Wright *A_index = i; 246472b9844SJames Wright if (data_type) *data_type = data_type_local; 247472b9844SJames Wright if (dim) *dim = _dim; 248472b9844SJames Wright if (size) PetscArraycpy(size, _size, _dim); 249472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 250472b9844SJames Wright } 251472b9844SJames Wright } 252472b9844SJames Wright SETERRQ(comm, PETSC_ERR_SUP, "Cannot find %s array under current CGNS node", name); 253472b9844SJames Wright } 254472b9844SJames Wright 255472b9844SJames Wright /*@ 256472b9844SJames Wright PetscViewerCGNSOpen - Opens a file for CGNS input/output. 257472b9844SJames Wright 258472b9844SJames Wright Collective 259472b9844SJames Wright 260472b9844SJames Wright Input Parameters: 261472b9844SJames Wright + comm - MPI communicator 262472b9844SJames Wright . name - name of file 263472b9844SJames Wright - type - type of file 264472b9844SJames Wright .vb 265472b9844SJames Wright FILE_MODE_WRITE - create new file for binary output 266472b9844SJames Wright FILE_MODE_READ - open existing file for binary input 267472b9844SJames Wright FILE_MODE_APPEND - open existing file for binary output 268472b9844SJames Wright .ve 269472b9844SJames Wright 270472b9844SJames Wright Output Parameter: 271472b9844SJames Wright . viewer - `PETSCVIEWERCGNS` `PetscViewer` for CGNS input/output to use with the specified file 272472b9844SJames Wright 273472b9844SJames Wright Level: beginner 274472b9844SJames Wright 275472b9844SJames Wright .seealso: `PETSCVIEWERCGNS`, `PetscViewer`, `PetscViewerPushFormat()`, `PetscViewerDestroy()`, 276472b9844SJames Wright `DMLoad()`, `PetscFileMode`, `PetscViewerSetType()`, `PetscViewerFileSetMode()`, `PetscViewerFileSetName()` 277472b9844SJames Wright @*/ 278472b9844SJames Wright PetscErrorCode PetscViewerCGNSOpen(MPI_Comm comm, const char name[], PetscFileMode type, PetscViewer *viewer) 279472b9844SJames Wright { 280472b9844SJames Wright PetscFunctionBegin; 281472b9844SJames Wright PetscCall(PetscViewerCreate(comm, viewer)); 282472b9844SJames Wright PetscCall(PetscViewerSetType(*viewer, PETSCVIEWERCGNS)); 283472b9844SJames Wright PetscCall(PetscViewerFileSetMode(*viewer, type)); 284472b9844SJames Wright PetscCall(PetscViewerFileSetName(*viewer, name)); 285472b9844SJames Wright PetscCall(PetscViewerSetFromOptions(*viewer)); 286472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 287472b9844SJames Wright } 288472b9844SJames Wright 289472b9844SJames Wright /*@ 290472b9844SJames Wright PetscViewerCGNSSetSolutionIndex - Set index of solution 291472b9844SJames Wright 292472b9844SJames Wright Not Collective 293472b9844SJames Wright 294472b9844SJames Wright Input Parameters: 295472b9844SJames Wright + viewer - `PETSCVIEWERCGNS` `PetscViewer` for CGNS input/output to use with the specified file 296472b9844SJames Wright - solution_id - Index of the solution id, or `-1` for the last solution on the file 297472b9844SJames Wright 298472b9844SJames Wright Level: intermediate 299472b9844SJames Wright 300472b9844SJames Wright Notes: 301472b9844SJames Wright By default, `solution_id` is set to `-1` to mean the last solution available in the file. 302472b9844SJames Wright If the file contains a FlowSolutionPointers node, then that array is indexed to determine which FlowSolution_t node to read from. 303472b9844SJames Wright Otherwise, `solution_id` indexes the total available FlowSolution_t nodes in the file. 304472b9844SJames Wright 305472b9844SJames Wright This solution index is used by `VecLoad()` to determine which solution to load from the file 306472b9844SJames Wright 307472b9844SJames Wright .seealso: `PETSCVIEWERCGNS`, `PetscViewerCGNSGetSolutionIndex()`, `PetscViewerCGNSGetSolutionInfo()` 308472b9844SJames Wright 309472b9844SJames Wright @*/ 310472b9844SJames Wright PetscErrorCode PetscViewerCGNSSetSolutionIndex(PetscViewer viewer, PetscInt solution_id) 311472b9844SJames Wright { 312472b9844SJames Wright PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 313472b9844SJames Wright 314472b9844SJames Wright PetscFunctionBeginUser; 315472b9844SJames Wright PetscCheck((solution_id != 0) && (solution_id > -2), PetscObjectComm((PetscObject)viewer), PETSC_ERR_USER_INPUT, "Solution index must be either -1 or greater than 0, not %" PetscInt_FMT, solution_id); 316472b9844SJames Wright cgv->solution_index = solution_id; 317472b9844SJames Wright cgv->solution_file_index = 0; // Reset sol_index when solution_id changes (0 is invalid) 318472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 319472b9844SJames Wright } 320472b9844SJames Wright 321472b9844SJames Wright /*@ 322472b9844SJames Wright PetscViewerCGNSGetSolutionIndex - Get index of solution 323472b9844SJames Wright 324472b9844SJames Wright Not Collective 325472b9844SJames Wright 326472b9844SJames Wright Input Parameter: 327472b9844SJames Wright . viewer - `PETSCVIEWERCGNS` `PetscViewer` for CGNS input/output to use with the specified file 328472b9844SJames Wright 329472b9844SJames Wright Output Parameter: 330472b9844SJames Wright . solution_id - Index of the solution id 331472b9844SJames Wright 332472b9844SJames Wright Level: intermediate 333472b9844SJames Wright 334472b9844SJames Wright Notes: 335472b9844SJames Wright By default, solution_id is set to `-1` to mean the last solution available in the file 336472b9844SJames Wright 337472b9844SJames Wright .seealso: `PETSCVIEWERCGNS`, `PetscViewerCGNSSetSolutionIndex()`, `PetscViewerCGNSGetSolutionInfo()` 338472b9844SJames Wright 339472b9844SJames Wright @*/ 340472b9844SJames Wright PetscErrorCode PetscViewerCGNSGetSolutionIndex(PetscViewer viewer, PetscInt *solution_id) 341472b9844SJames Wright { 342472b9844SJames Wright PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 343472b9844SJames Wright 344472b9844SJames Wright PetscFunctionBeginUser; 345472b9844SJames Wright *solution_id = cgv->solution_index; 346472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 347472b9844SJames Wright } 348472b9844SJames Wright 349472b9844SJames Wright // Gets the index for the solution in this CGNS file 350472b9844SJames Wright PetscErrorCode PetscViewerCGNSGetSolutionFileIndex_Internal(PetscViewer viewer, int *sol_index) 351472b9844SJames Wright { 352472b9844SJames Wright PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 353472b9844SJames Wright MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 354472b9844SJames Wright int nsols, cgns_ier; 355472b9844SJames Wright char buffer[CGIO_MAX_NAME_LENGTH + 1]; 356472b9844SJames Wright CGNS_ENUMT(GridLocation_t) gridloc; // Throwaway 357472b9844SJames Wright 358472b9844SJames Wright PetscFunctionBeginUser; 359472b9844SJames Wright if (cgv->solution_file_index > 0) { 360472b9844SJames Wright *sol_index = cgv->solution_file_index; 361472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 362472b9844SJames Wright } 363472b9844SJames Wright 364472b9844SJames Wright PetscCallCGNS(cg_nsols(cgv->file_num, cgv->base, cgv->zone, &nsols)); 365472b9844SJames Wright cgns_ier = cg_goto(cgv->file_num, cgv->base, "Zone_t", cgv->zone, "ZoneIterativeData_t", 1, "FlowSolutionPointers", 0, NULL); 366472b9844SJames Wright if (cgns_ier == CG_NODE_NOT_FOUND) { 367472b9844SJames Wright // If FlowSolutionPointers does not exist, then just index off of nsols (which can include non-solution data) 368472b9844SJames Wright PetscCheck(cgv->solution_index == -1 || cgv->solution_index <= nsols, comm, PETSC_ERR_ARG_OUTOFRANGE, "CGNS Solution index (%" PetscInt_FMT ") not in [1, %d]", cgv->solution_index, nsols); 369472b9844SJames Wright 370472b9844SJames Wright cgv->solution_file_index = cgv->solution_index == -1 ? nsols : cgv->solution_index; 371472b9844SJames Wright } else { 372472b9844SJames Wright // If FlowSolutionPointers exists, then solution_id should index that array of FlowSolutions 373472b9844SJames Wright char *pointer_id_name; 374472b9844SJames Wright PetscBool matches_name = PETSC_FALSE; 375472b9844SJames Wright int sol_id; 376472b9844SJames Wright 377472b9844SJames Wright PetscCheck(cgns_ier == CG_OK, PETSC_COMM_SELF, PETSC_ERR_LIB, "CGNS error %d %s", cgns_ier, cg_get_error()); 378472b9844SJames Wright cgns_ier = cg_goto(cgv->file_num, cgv->base, "Zone_t", cgv->zone, "ZoneIterativeData_t", 1, NULL); 379472b9844SJames Wright 380472b9844SJames Wright { // Get FlowSolutionPointer name corresponding to solution_id 381472b9844SJames Wright cgsize_t size[12]; 382472b9844SJames Wright int dim, A_index, pointer_id; 383472b9844SJames Wright char *pointer_names, *pointer_id_name_ref; 384472b9844SJames Wright 385472b9844SJames Wright PetscCall(CGNS_Find_Array(comm, "FlowSolutionPointers", &A_index, NULL, &dim, size)); 386472b9844SJames Wright PetscCheck(cgv->solution_index == -1 || cgv->solution_index <= size[1], comm, PETSC_ERR_ARG_OUTOFRANGE, "CGNS Solution index (%" PetscInt_FMT ") not in range of FlowSolutionPointers [1, %" PRIdCGSIZE "]", cgv->solution_index, size[1]); 387472b9844SJames Wright PetscCall(PetscCalloc1(size[0] * size[1] + 1, &pointer_names)); // Need the +1 for (possibly) setting \0 for the last pointer name if it's full 388472b9844SJames Wright PetscCallCGNS(cg_array_read_as(1, CGNS_ENUMV(Character), pointer_names)); 389472b9844SJames Wright pointer_id = cgv->solution_index == -1 ? size[1] : cgv->solution_index; 390472b9844SJames Wright pointer_id_name_ref = &pointer_names[size[0] * (pointer_id - 1)]; 391472b9844SJames Wright { // Set last non-whitespace character of the pointer name to \0 (CGNS pads with spaces) 392472b9844SJames Wright int str_idx; 393472b9844SJames Wright for (str_idx = size[0] - 1; str_idx > 0; str_idx--) { 394472b9844SJames Wright if (!isspace((unsigned char)pointer_id_name_ref[str_idx])) break; 395472b9844SJames Wright } 396472b9844SJames Wright pointer_id_name_ref[str_idx + 1] = '\0'; 397472b9844SJames Wright } 398472b9844SJames Wright PetscCall(PetscStrallocpy(pointer_id_name_ref, &pointer_id_name)); 399472b9844SJames Wright PetscCall(PetscFree(pointer_names)); 400472b9844SJames Wright } 401472b9844SJames Wright 402472b9844SJames Wright // Find FlowSolution_t node that matches pointer_id_name 403472b9844SJames Wright for (sol_id = 1; sol_id <= nsols; sol_id++) { 404472b9844SJames Wright PetscCallCGNS(cg_sol_info(cgv->file_num, cgv->base, cgv->zone, sol_id, buffer, &gridloc)); 405472b9844SJames Wright PetscCall(PetscStrcmp(pointer_id_name, buffer, &matches_name)); 406472b9844SJames Wright if (matches_name) break; 407472b9844SJames Wright } 408472b9844SJames Wright PetscCheck(matches_name, comm, PETSC_ERR_LIB, "Cannot find FlowSolution_t node %s in file", pointer_id_name); 409472b9844SJames Wright cgv->solution_file_index = sol_id; 410472b9844SJames Wright PetscCall(PetscFree(pointer_id_name)); 411472b9844SJames Wright } 412472b9844SJames Wright 413472b9844SJames Wright *sol_index = cgv->solution_file_index; 414472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 415472b9844SJames Wright } 416472b9844SJames Wright 417472b9844SJames Wright /*@ 418472b9844SJames Wright PetscViewerCGNSGetSolutionTime - Gets the solution time for the FlowSolution of the viewer 419472b9844SJames Wright 420472b9844SJames Wright Collective 421472b9844SJames Wright 422472b9844SJames Wright Input Parameter: 423472b9844SJames Wright . viewer - `PETSCVIEWERCGNS` `PetscViewer` for CGNS input/output to use with the specified file 424472b9844SJames Wright 425*7dcfde4dSJose E. Roman Output Parameters: 426472b9844SJames Wright + time - Solution time of the FlowSolution_t node 427472b9844SJames Wright - set - Whether the time data is in the file 428472b9844SJames Wright 429472b9844SJames Wright Level: intermediate 430472b9844SJames Wright 431472b9844SJames Wright Notes: 432472b9844SJames Wright Reads data from a DataArray named `TimeValues` under a `BaseIterativeData_t` node 433472b9844SJames Wright 434472b9844SJames Wright .seealso: `PETSCVIEWERCGNS`, `PetscViewer`, `PetscViewerCGNSSetSolutionIndex()`, `PetscViewerCGNSGetSolutionIndex()`, `PetscViewerCGNSGetSolutionName()` 435472b9844SJames Wright @*/ 436472b9844SJames Wright PetscErrorCode PetscViewerCGNSGetSolutionTime(PetscViewer viewer, PetscReal *time, PetscBool *set) 437472b9844SJames Wright { 438472b9844SJames Wright PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 439472b9844SJames Wright int cgns_ier, A_index = 0; 440472b9844SJames Wright PetscReal *times; 441472b9844SJames Wright cgsize_t size[12]; 442472b9844SJames Wright 443472b9844SJames Wright PetscFunctionBeginUser; 444472b9844SJames Wright cgns_ier = cg_goto(cgv->file_num, cgv->base, "BaseIterativeData_t", 1, NULL); 445472b9844SJames Wright if (cgns_ier == CG_NODE_NOT_FOUND) { 446472b9844SJames Wright *set = PETSC_FALSE; 447472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 448472b9844SJames Wright } else PetscCallCGNS(cgns_ier); 449472b9844SJames Wright PetscCall(CGNS_Find_Array(PetscObjectComm((PetscObject)viewer), "TimeValues", &A_index, NULL, NULL, size)); 450472b9844SJames Wright PetscCall(PetscMalloc1(size[0], ×)); 451472b9844SJames Wright PetscCallCGNS(cg_array_read_as(A_index, CGNS_ENUMV(RealDouble), times)); 452472b9844SJames Wright *time = times[cgv->solution_index - 1]; 453472b9844SJames Wright *set = PETSC_TRUE; 454472b9844SJames Wright PetscCall(PetscFree(times)); 455472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 456472b9844SJames Wright } 457472b9844SJames Wright 458472b9844SJames Wright /*@ 459472b9844SJames Wright PetscViewerCGNSGetSolutionName - Gets name of FlowSolution of the viewer 460472b9844SJames Wright 461472b9844SJames Wright Collective 462472b9844SJames Wright 463472b9844SJames Wright Input Parameter: 464472b9844SJames Wright . viewer - `PETSCVIEWERCGNS` `PetscViewer` for CGNS input/output to use with the specified file 465472b9844SJames Wright 466472b9844SJames Wright Output Parameter: 467472b9844SJames Wright . name - Name of the FlowSolution_t node corresponding to the solution index 468472b9844SJames Wright 469472b9844SJames Wright Level: intermediate 470472b9844SJames Wright 471472b9844SJames Wright Notes: 472472b9844SJames Wright Currently assumes there is only one Zone in the CGNS file 473472b9844SJames Wright 474472b9844SJames Wright .seealso: `PETSCVIEWERCGNS`, `PetscViewer`, `PetscViewerCGNSSetSolutionIndex()`, `PetscViewerCGNSGetSolutionIndex()`, `PetscViewerCGNSGetSolutionTime()` 475472b9844SJames Wright @*/ 476472b9844SJames Wright PetscErrorCode PetscViewerCGNSGetSolutionName(PetscViewer viewer, const char *name[]) 477472b9844SJames Wright { 478472b9844SJames Wright PetscViewer_CGNS *cgv = (PetscViewer_CGNS *)viewer->data; 479472b9844SJames Wright int sol_id; 480472b9844SJames Wright char buffer[CGIO_MAX_NAME_LENGTH + 1]; 481472b9844SJames Wright CGNS_ENUMT(GridLocation_t) gridloc; // Throwaway 482472b9844SJames Wright 483472b9844SJames Wright PetscFunctionBeginUser; 484472b9844SJames Wright PetscCall(PetscViewerCGNSGetSolutionFileIndex_Internal(viewer, &sol_id)); 485472b9844SJames Wright 486472b9844SJames Wright PetscCallCGNS(cg_sol_info(cgv->file_num, cgv->base, cgv->zone, sol_id, buffer, &gridloc)); 487472b9844SJames Wright if (cgv->solution_name) PetscCall(PetscFree(cgv->solution_name)); 488472b9844SJames Wright PetscCall(PetscStrallocpy(buffer, &cgv->solution_name)); 489472b9844SJames Wright *name = cgv->solution_name; 490472b9844SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 491472b9844SJames Wright } 492