aboutsummaryrefslogtreecommitdiff
path: root/src/Output.c
blob: cb0782a746a8842cb3ab804e692ed973f1e6417e (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
 /*@@
   @file      Output.c
   @date      Mon 21 September
   @author    Gabrielle Allen
   @desc 
   Functions to deal with scalar output of grid variables
   @enddesc 
 @@*/
 
/*#define IO_DEBUG*/

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

#include "cctk.h"
#include "cctk_parameters.h"
#include "CactusBase/IOUtil/src/ioGH.h"
#include "iobasicGH.h"


int IOBasic_OutputGH (cGH *GH)
{
  DECLARE_CCTK_PARAMETERS
  int i;
  int grouptype;
  char *name=NULL;
  iobasicGH *myGH;

  /* Get the GH extensions for IOBasic */
  myGH = (iobasicGH *) GH->extensions [CCTK_GHExtensionHandle ("IOBasic")];

  /* Return if no output is required */
  if (myGH->outScalar_every <= 0)
    return 0;

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

    grouptype = CCTK_GroupTypeFromVarI (i);

    /* Check this GF should be output */
    if (myGH->do_outScalar [i]
        && (grouptype == GROUP_GF||grouptype == GROUP_SCALAR) 
        && (GH->cctk_iteration % myGH->outScalar_every == 0)) {

      /* Check GF not already output this iteration */
      if (myGH->outScalar_last [i] == GH->cctk_iteration) {
        char *msg, *varname;

        varname = CCTK_VarName (i);
        msg = (char *) malloc (200 * sizeof (char) + strlen (varname));
        sprintf (msg, "Already done Scalar output for '%s' on this timestep",
                 varname);
        CCTK_WARN (2, msg);
        free (msg);
      }
      else 
      {

        /* Get the variable name for this index (for filename) */
        name = CCTK_VarName(i);

#ifdef IO_DEBUG
  printf("\nIn IOBasic_OutputGH\n----------------\n");
  printf("  Index = %d\n",i);
  printf("  Variable = -%s-\n",name);
  printf("  Last output iteration was = %d\n",myGH->outScalar_last[i]);
#endif
  
        /* Make the IO call */
        if (grouptype == GROUP_SCALAR)
	{
	  IOBasic_Write (GH, i, name);
        }
	else
	{
	  IOBasic_WriteGF (GH, i, name);
	}

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

  return 0;

  USE_CCTK_PARAMETERS

}


int IOBasic_OutputVarAs (cGH *GH, const char *fullname, const char *alias)
{
  int index;
  int grouptype;
  index = CCTK_VarIndex (fullname);

#ifdef IO_DEBUG
  printf("\nIn IOBasic_OutputVarAs\n-------------------\n");
  printf("  Fullname = -%s-\n",fullname);
  printf("  Alias = -%s-\n",alias);
  printf("  Index = %d\n",index);
#endif

  grouptype = CCTK_GroupTypeFromVarI (index);

  if (grouptype == GROUP_SCALAR)
  {
    IOBasic_Write (GH, index, alias);
  }
  else
  {
    IOBasic_WriteGF (GH, index, alias);
  }
    
  return 0;
}


 /*@@
   @routine    IOBasic_TimeForOutput
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc 
   Decides if it is time to output a variable using Scalar output
   method
   @enddesc 
   @calls    CCTK_GHExtensionHandle 
             CCTK_GroupTypeFromVar
             CCTK_WARN
   @calledby   
   @history 
 
   @endhistory 
   @var     GH
   @vdesc   Pointer to CCTK GH
   @vtype   cGH
   @vio     in
   @vcomment 
   @endvar 
   @var     var
   @vdesc   index of variable
   @vtype   int
   @vio     in
   @vcomment 
   @endvar 
@@*/
                  
int IOBasic_TimeForOutput (cGH *GH, int var)
{
  int return_type;
  int grouptype;
  iobasicGH *myGH;

  /* Default is do not do output */
  return_type = 0;

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

  grouptype = CCTK_GroupTypeFromVarI (var);
  
  /* Check this GF should be output */
  if (myGH->do_outScalar [var]
      && (grouptype == GROUP_GF || grouptype == GROUP_SCALAR)
      && (GH->cctk_iteration % myGH->outScalar_every == 0)) {
      
    /* Check GF not already output this iteration */
    if (myGH->outScalar_last [var] == GH->cctk_iteration)
      CCTK_WARN (2, "Already done Scalar output in IO");
    else
      return_type = 1;
  }

  return return_type;
}

int IOBasic_TriggerOutput (cGH *GH, int variable)
{
  char *var;
  int grouptype;
  iobasicGH *myGH;

  /* Get the GH extension for IOBasic */
  myGH = (iobasicGH *) GH->extensions [CCTK_GHExtensionHandle ("IOBasic")];
  
  var = CCTK_VarName (variable);

#ifdef IO_DEBUG
  printf("\nIn IOBasic_TriggerOutput\n---------------------\n");
  printf("  Index = %d\n",variable);
  printf("  Variable = -%s-\n",var);
#endif
  
  /* Do the Scalar output */

  grouptype = CCTK_GroupTypeFromVarI (variable);

  if (grouptype == GROUP_SCALAR)
  {
    IOBasic_Write (GH, variable, var);
  }
  else
  {
    IOBasic_WriteGF (GH, variable, var);
  }
  
  /* Register variable as having Scalar output this iteration */
  myGH->outScalar_last [variable] = GH->cctk_iteration;
  
  return 0;
}