aboutsummaryrefslogtreecommitdiff
path: root/src/Output3D.c
blob: 5bfcfaf1fab90a061fd867e555f811a82b63062b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 /*@@
   @file      Output3D.c
   @date      Tue Jan 9 1999
   @author    Gabrielle Allen
   @desc 
   Functions to deal 3D HDF5 output of variables
   @enddesc 
   @history
   @hauthor Thomas Radke @hdate 16 Mar 1999
   @hdesc Converted to Cactus 4.0
   @hendhistory
 @@*/



#include <stdio.h>
#include <stdlib.h>

#include "cctk.h"
#include "cctk_Parameters.h"
#include "ioHDF5GH.h"


/* function prototypes */
int IOHDF5_TimeFor3D (cGH *GH, int index);
int IOHDF5_Output3DVarAs (cGH *GH, const char *var, const char *alias);
static void CheckSteerableParameters (ioHDF5GH *myGH);
static void SetOutputFlag (int index, const char *optstring, void *arg);


/*@@
   @routine    IOHDF5_Output3DGH
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   Loops over all variables and outputs them if necessary
   @enddesc
   @calledby   CCTK_OutputGH ("IOHDF5_3D")
   @history

   @endhistory
   @var     GH
   @vdesc   Pointer to CCTK GH
   @vtype   cGH
   @vio     in
   @endvar
@@*/

int IOHDF5_Output3DGH (cGH *GH)
{
  DECLARE_CCTK_PARAMETERS
  int i;
  ioHDF5GH *myGH;
  const char *name;
  char *fullname;

  /* Get the GH extension for IOHDF5 */
  myGH = (ioHDF5GH *) GH->extensions [CCTK_GHExtensionHandle ("IOHDF5")];

  CheckSteerableParameters (myGH);

  if (myGH->out3D_every <= 0)
    return (0);

  /* Loop over all variables */
  for (i = 0; i < CCTK_NumVars (); i++)
  {

    if (IOHDF5_TimeFor3D (GH, i))
    {

      name     = CCTK_VarName (i);
      fullname = CCTK_FullName (i);

      if (verbose)
        CCTK_VInfo (CCTK_THORNSTRING, "IOHDF5_Output3DGH: fullname / name = "
                    "%s / %s", fullname, name);

      IOHDF5_Output3DVarAs (GH, fullname, name);

      free (fullname);

      /* Register variable as having 3D output this iteration */
      myGH->out3D_last [i] = GH->cctk_iteration;
    }
  }
  if (verbose)
    CCTK_INFO("IOHDF5_Output3DGH Done \n\n");

  return (0);
}


/*@@
   @routine    IOHDF5_Output3DVarAs
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   unconditional output of a variable using the IOHDF5 3D output method
   @enddesc
   @calledby IOHDF5_Output3DGH, CCTK_OutputVarAsByMethod ("IOHDF5_3D")
   @var     GH
   @vdesc   Pointer to CCTK GH
   @vtype   cGH
   @vio     in
   @vcomment
   @endvar
   @var     fullname
   @vdesc   complete name of variable to output
   @vtype   const char *
   @vio     in
   @vcomment
   @endvar
   @var     alias
   @vdesc   alias name of variable to output (used to generate output filename)
   @vtype   const char *
   @vio     in
   @vcomment
   @endvar
@@*/

int IOHDF5_Output3DVarAs (cGH *GH, const char *fullname, const char *alias)
{
  DECLARE_CCTK_PARAMETERS
  int index;


  index = CCTK_VarIndex (fullname);

  if (verbose)
    CCTK_VInfo (CCTK_THORNSTRING, "IOHDF5_Output3DVarAs: fullname, alias, "
                "index = (%s, %s, %d)", fullname, alias, index); 

  /* Do the 3D output */
  IOHDF5_Write3D (GH, index, alias);

  return (0);
}


/*@@
   @routine    IOHDF5_TimeFor3D
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   Decides if it is time to output a variable using the IOHDF5 3D output
   method
   @enddesc
   @calledby IOHDF5_Output3DGH
   @history

   @endhistory
   @var     GH
   @vdesc   Pointer to CCTK GH
   @vtype   cGH
   @vio     in
   @vcomment
   @endvar
   @var     index
   @vdesc   index of variable
   @vtype   int
   @vio     in
   @vcomment
   @endvar
@@*/

int IOHDF5_TimeFor3D (cGH *GH, int index)
{
  ioHDF5GH *myGH;


  /* Get the GH extension for IOHDF5 */
  myGH = (ioHDF5GH *) GH->extensions [CCTK_GHExtensionHandle ("IOHDF5")];

  CheckSteerableParameters (myGH);

  /* Check if any output was requested */
  if(myGH->out3D_every <= 0)
    return (0);

  /* Check this variable should be output */
  if (! (myGH->do_out3D [index] && GH->cctk_iteration % myGH->out3D_every == 0))
    return (0);

  /* Check variable not already output this iteration */
  if (myGH->out3D_last [index] == GH->cctk_iteration)
  {
      CCTK_WARN (2, "Already done 3D output in IOHDF5");
      return (0);
  }

  return (1);
}


/*@@
   @routine    IOHDF5_TriggerOutput3D
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   Triggers the output a variable using the IOHDF5 3D output
   method
   @enddesc
   @calledby   CCTK scheduler
   @var     GH
   @vdesc   Pointer to CCTK GH
   @vtype   cGH
   @vio     in
   @vcomment
   @endvar
   @var     index
   @vdesc   index of variable to output
   @vtype   int
   @vio     in
   @vcomment
   @endvar
@@*/

int IOHDF5_TriggerOutput3D (cGH *GH, int index)
{
  DECLARE_CCTK_PARAMETERS
  ioHDF5GH *myGH;
  const char *varname;

  varname = CCTK_VarName (index);

  myGH = (ioHDF5GH *) GH->extensions [CCTK_GHExtensionHandle ("IOHDF5")];

  if (verbose)
    CCTK_VInfo (CCTK_THORNSTRING, "IOHDF5_TriggerOutput3D: varname, index = "
                "(%s, %d)", varname, index);

  /* Do the 3D output */
  IOHDF5_Write3D (GH, index, varname);

  /* Register variable as having 3D output this iteration */
  myGH->out3D_last [index] = GH->cctk_iteration;

  return (0);
}


/**************************** local functions ******************************/
static void CheckSteerableParameters (ioHDF5GH *myGH)
{
  DECLARE_CCTK_PARAMETERS
  int out3D_vars_current_nset;
  static int out3D_vars_lastset = 0;


  /* How often to output */
  myGH->out3D_every = out_every > 0 ? out_every : -1;
  if (out3D_every > 0)
    myGH->out3D_every = out3D_every;

  /* re-parse the 'IOHDF5::out3D_vars' parameter if it was changed */
  out3D_vars_current_nset = CCTK_ParameterQueryTimesSet ("out3D_vars",
                                                         CCTK_THORNSTRING);
  if (out3D_vars_current_nset != out3D_vars_lastset)
  {
    memset (myGH->do_out3D, 0, CCTK_NumVars ());
    CCTK_TraverseString (out3D_vars, SetOutputFlag, myGH->do_out3D,
                         CCTK_GROUP_OR_VAR);

    /* Save the last setting of 'out3D_vars' parameter */
    out3D_vars_lastset = out3D_vars_current_nset;
  }
}


/* callback for CCTK_TraverseString() to set the output flag
   for the given variable */
static void SetOutputFlag (int index, const char *optstring, void *arg)
{
  char *flags = (char *) arg;


  flags[index] = 1;

  if (optstring)
  {
    CCTK_VWarn (5, __LINE__, __FILE__, CCTK_THORNSTRING,
                "Optional string '%s' in variable name ignored", optstring);
  }
}