aboutsummaryrefslogtreecommitdiff
path: root/src/Output2D.c
blob: f8639705669ba59cbc8debd4cee010910aa77c88 (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
 /*@@
   @file      Output2D.c
   @date      Tue Jan 9 1999
   @author    Gabrielle Allen
   @desc 
   Functions to deal 2D output of GFs
   @enddesc 
   @history
   @hauthor Thomas Radke @hdate 16 Mar 1999
   @hdesc Converted to Cactus 4.0
   @hendhistory
 @@*/

#include <stdio.h>
#include <string.h>

#include "flesh.h"
#include "Groups.h"
#include "declare_parameters.h"
#include "CactusBase/IOUtil/src/ioGH.h"
#include "ioFlexGH.h"


int IOFlexIO_Output2DVarAs (cGH *GH, const char *var, const char *alias);
int IOFlexIO_TimeFor2D (cGH *GH, int index);

/*@@
   @routine    IOFlexIO_Output2DGH
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc 
   Loops over all variables and outputs them if necessary
   @enddesc 
   @calls    CCTK_GetGHExtensionHandle 
             CCTK_GetNumVars
	     CCTK_GetImplementationFromVar
	     CCTK_GetVarName
             IOFlexIO_TimeFor2D
	     IOFlexIO_Output2DVarAs  	     
   @calledby
   @history 
 
   @endhistory 
   @var     GH
   @vdesc   Pointer to CCTK GH
   @vtype   cGH
   @vio     in
   @vcomment 
   @endvar 
@@*/

int IOFlexIO_Output2DGH (cGH *GH)
{
  DECLARE_PARAMETERS
  int i;
  flexioGH *myGH;
  char *name, *fullname;

  /* Get the GH extension for IOFlexIO */
  myGH = (flexioGH *) GH->extensions [CCTK_GetGHExtensionHandle ("IOFlexIO")];

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

    if (IOFlexIO_TimeFor2D (GH, i)) {

      name = CCTK_GetVarName (i);
      fullname = CCTK_GetFullName (i);

      if (IO_verbose) {
        printf("IOFlexIO Output2DGH : \n");
        printf("  fullname/name = %s/%s\n", fullname, name);
      }

      IOFlexIO_Output2DVarAs (GH, fullname, name);

      free (fullname);

      /* Register another 2D output for this GF */
      myGH->IO_2Dnum[i]++;

      /* Register GF as having 2D output this iteration */
      myGH->IO_2Dlast[i] = GH->cctk_iteration;
    }
  }

  return (0);
}


/*@@
   @routine    IOFlexIO_Output2DVarAs
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc 
   unconditional output of a variable using the IO 2D output method
   @enddesc 
   @calls    CCTK_DecomposeName
	     CCTK_GetVarIndex
	     CCTK_GetGHExtensionHandle
	     IOFlexIO_Write2D  	     
   @calledby IOFlexIO_Output2DGH
   @history 
 
   @endhistory 
   @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 IOFlexIO_Output2DVarAs (cGH *GH, const char *fullname, const char *alias)
{
  DECLARE_PARAMETERS
  int index, first;
  flexioGH *myGH;

  index = CCTK_GetVarIndex (fullname);

  /* get the handle for IOFlexIO extensions */
  myGH = (flexioGH *) GH->extensions [CCTK_GetGHExtensionHandle ("IOFlexIO")];

  /* Output with correct file opening behaviour */
  first = (myGH->IO_2Dnum [index] == 1);

  if (IO_verbose) {
    printf ("\nIn IOFlexIO Output2DVarAs\n-------------------\n");
    printf ("  Fullname = -%s-\n", fullname);
    printf ("  Alias = -%s-\n", alias);
    printf ("  Index = %d\n", index);
  }

  /* Do the 2D output */
  IOFlexIO_Write2D (GH, index, alias, first);

  return (0);
}


 /*@@
   @routine    IOFlexIO_TimeFor2D
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc 
   Decides if it is time to output a variable using the IO 2D output
   method
   @enddesc 
   @calls    CCTK_GetGHExtensionHandle 
             CCTK_GetVarGType
	     CCTK_WARN
	     CCTK_QueryGroupStorage_ByIndex
	     CCTK_GetGroupNameFromVar_ByIndex
   @calledby IOFlexIO_Output2DGH
   @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 IOFlexIO_TimeFor2D (cGH *GH, int index)
{
  ioGH *ioUtilGH;
  flexioGH *myGH;

  /* Get the GH extension for IOUtil and IOFlexIO */
  ioUtilGH = (ioGH *) GH->extensions [CCTK_GetGHExtensionHandle ("IO")];
  myGH = (flexioGH *) GH->extensions [CCTK_GetGHExtensionHandle ("IOFlexIO")];

  /* Check this GF should be output */
  if (! (CCTK_GetVarGType (index) == GROUP_GF && myGH->IO_2Dnum [index] != 0
         && GH->cctk_iteration % ioUtilGH->IO_2Devery == 0))
    return (0);

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

  /* Check GF has storage */
  if (! CCTK_QueryGroupStorage_ByIndex (GH,
            CCTK_GetGroupIndexFromVar_ByIndex(index))) {
    char *fullname = CCTK_GetFullName (index);
    char *msg = (char *) malloc (80 + strlen (fullname));

    sprintf (msg, "No IOFlexIO 2D output for '%s' (no storage)", fullname);
    CCTK_WARN (2, msg);
    free (fullname);
    free (msg);
    return (0);
  }

  return (1);
}


/*@@
   @routine    IOFlexIO_TriggerOutput2D
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc 
   Triggers the output a variable using the IO 2D output
   method
   @enddesc 
   @calls    CCTK_GetGHExtensionHandle 
             CCTK_GetVarName
	     IOFlexIO_Write2D  	     
   @calledby   
   @history 
 
   @endhistory 
   @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 IOFlexIO_TriggerOutput2D (cGH *GH, int index)
{
  DECLARE_PARAMETERS
  int first;
  flexioGH *myGH;
  char *varname;

  varname = CCTK_GetVarName (index);

  /* get the handle for IOFlexIO extensions */
  myGH = (flexioGH *) GH->extensions [CCTK_GetGHExtensionHandle ("IOFlexIO")];

  /* Output with correct file opening behaviour */
  first =  (myGH->IO_2Dnum [index] == 1);

  if (IO_verbose) {
    printf("\nIn IOFlexIO TriggerOutput2D\n---------------------\n");
    printf("  Index = %d\n", index);
    printf("  Variable = -%s-\n", varname);
  }

  /* Do the 2D output */
  IOFlexIO_Write2D (GH, index, varname, first);

  /* Register another 2D output for this GF */
  myGH->IO_2Dnum [index]++;

  /* Register GF as having 2D output this iteration */
  myGH->IO_2Dlast [index] = GH->cctk_iteration;

  return (0);
}