Added 3D ASCII output for 3D variables.

Closes PR BetaThorns/742 (??).


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@87 94b1c47f-dcfd-45ef-a468-0854c0e9e350

1 files changed, 390 insertions, 0 deletions

diff --git a/src/Output3D.c b/src/Output3D.c
new file mode 100644
index 0000000..1bd1085
--- /dev/null
+++ b/src/Output3D.c
@@ -0,0 +1,390 @@
+ /*@@
+   @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 <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "cctk.h"
+#include "cctk_Parameters.h"
+#include "util_String.h"
+#include "ioASCIIGH.h"
+
+/* the rcs ID and its dummy function to use it */
+static const char *rcsid = "$Id$";
+CCTK_FILEVERSION(CactusBase_IOASCII_Output3D_c)
+
+/* define this if you want debug output */
+/*#define IOASCII_DEBUG 1*/
+
+
+/* prototypes of routines defined in this source file */
+static int CheckOutputVar (int vindex);
+static void CheckSteerableParameters (asciiioGH *myGH);
+static void SetOutputFlag (int vindex, const char *optstring, void *arg);
+
+
+/*@@
+   @routine    IOASCII_Output3DGH
+   @date       Wed 12 Dec 2001
+   @author     Thomas Radke
+   @desc
+               Loops over all variables and outputs them if necessary
+   @enddesc
+   @calls      IOASCII_TimeFor3D
+               IOASCII_Write3D
+
+   @var        GH
+   @vdesc      Pointer to CCTK GH
+   @vtype      const cGH *
+   @vio        in
+   @endvar
+@@*/
+int IOASCII_Output3DGH (const cGH *GH)
+{
+  int vindex;
+  asciiioGH *myGH;
+  const char *name;
+
+
+  /* Get the GH extensions for IOASCII */
+  myGH = (asciiioGH *) CCTK_GHExtension (GH, "IOASCII");
+
+  CheckSteerableParameters (myGH);
+
+  /* Return if no output is required */
+  if (myGH->out3D_every <= 0)
+  {
+    return (0);
+  }
+
+  /* Loop over all variables */
+  for (vindex = 0; vindex < CCTK_NumVars (); vindex++) 
+  {
+
+    /* Check if this variable should be output */
+    if (! IOASCII_TimeFor3D (GH, vindex))
+    {
+       continue;
+    }
+
+    /* Get the variable name for this index (for filename) */
+    name = CCTK_VarName (vindex);
+
+#ifdef IO_DEBUG
+    printf ("\nIn IOASCII Output3DGH\n---------------------\n");
+    printf ("  Index = %d\n", vindex);
+    printf ("  Variable = -%s-\n", name);
+    printf ("  On iteration %d\n", GH->cctk_iteration);
+    printf ("  Last output iteration was = %d\n", myGH->out3D_last[vindex]);
+#endif
+  
+    /* Make the IO call */
+    IOASCII_Write3D (GH, vindex, name);
+        
+    /* Register GF as having 3D output this iteration */
+    myGH->out3D_last[vindex] = GH->cctk_iteration;
+
+  } /* end of loop over all variables */
+
+  return (0);
+}
+
+
+/*@@
+   @routine    IOASCII_Output3DVarAs
+   @date       Wed 12 Dec 2001
+   @author     Thomas Radke
+   @desc
+               Unconditional output of a variable
+               using the IOASCII 3D output method
+   @enddesc
+   @calls      IOASCII_Write3D
+
+   @var        GH
+   @vdesc      Pointer to CCTK GH
+   @vtype      const cGH *
+   @vio        in
+   @endvar
+   @var        fullname
+   @vdesc      complete name of variable to output
+   @vtype      const char *
+   @vio        in
+   @endvar
+   @var        alias
+   @vdesc      alias name of variable to output
+               (used to generate output filename)
+   @vtype      const char *
+   @vio        in
+   @endvar
+@@*/
+int IOASCII_Output3DVarAs (const cGH *GH, const char *fullname, const char *alias)
+{
+  int vindex;
+
+
+  vindex = CCTK_VarIndex (fullname);
+
+#ifdef IO_DEBUG
+  printf ("\nIn IOASCII Output3DVarAs\n-------------------\n");
+  printf ("  Fullname = -%s-\n", fullname);
+  printf ("  Alias = -%s-\n", alias);
+  printf ("  Index = %d\n", vindex);
+#endif
+
+  if (CheckOutputVar (vindex) == 0)
+  {
+    IOASCII_Write3D (GH, vindex, alias);
+  }
+
+  return (0);
+}
+
+
+ /*@@
+   @routine    IOASCII_TimeFor3D
+   @date       Wed 12 Dec 2001
+   @author     Thomas Radke
+   @desc 
+               Decides if it is time to output a variable
+               using the IOASCII 3D output method
+   @enddesc 
+
+   @var        GH
+   @vdesc      Pointer to CCTK GH
+   @vtype      const cGH *
+   @vio        in
+   @endvar
+   @var        vindex
+   @vdesc      index of variable
+   @vtype      int
+   @vio        in
+   @endvar
+@@*/
+int IOASCII_TimeFor3D (const cGH *GH, int vindex)
+{
+  int return_type;
+  asciiioGH *myGH;
+  char *fullname;
+
+
+  /* Default is do not do output */
+  return_type = 0;
+
+  /* Get the GH extensions for IOASCII */
+  myGH = (asciiioGH *) CCTK_GHExtension (GH, "IOASCII");
+
+  CheckSteerableParameters (myGH);
+
+  /* return if no output requested */
+  if (myGH->out3D_every <= 0)
+  {
+    return (0);
+  }
+
+  /* Check if this variable should be output */
+  if (myGH->do_out3D[vindex] && (GH->cctk_iteration % myGH->out3D_every == 0)) 
+  {
+    /* Check if variable wasn't already output this iteration */
+    if (myGH->out3D_last[vindex] == GH->cctk_iteration)
+    {
+      fullname = CCTK_FullName (vindex);
+      CCTK_VWarn (5, __LINE__, __FILE__, CCTK_THORNSTRING,
+                  "Already done IOASCII 3D output for '%s' in current "
+                  "iteration (probably via triggers)", fullname);
+      free (fullname);
+    }
+    else
+    {
+      return_type = 1;
+    }
+  }
+
+  return (return_type);
+}
+
+
+/*@@
+   @routine    IOASCII_TriggerOutput3D
+   @date       Wed 12 Dec 2001
+   @author     Thomas Radke
+   @desc
+               Triggers the output of a variable
+               using the IOASCII 3D output method
+   @enddesc
+   @calls      IOASCII_Write3D
+
+   @var        GH
+   @vdesc      Pointer to CCTK GH
+   @vtype      const cGH *
+   @vio        in
+   @endvar
+   @var        vindex
+   @vdesc      index of variable to output
+   @vtype      int
+   @vio        in
+   @endvar
+@@*/
+int IOASCII_TriggerOutput3D (const cGH *GH, int vindex)
+{
+  const char *var;
+  asciiioGH *myGH;
+
+
+  /* get GH extensions for IOASCII */
+  myGH = (asciiioGH *) CCTK_GHExtension (GH, "IOASCII");
+  
+  var = CCTK_VarName (vindex);
+
+  /* Do the 3D output */
+#ifdef IO_DEBUG
+  printf ("\nIn IOASCII TriggerOutput3D\n---------------------\n");
+  printf ("  Index = %d\n", vindex);
+  printf ("  Variable = -%s-\n", var);
+#endif
+  
+  IOASCII_Write3D (GH, vindex, var);
+  
+  /* Register variables as having 3D output this iteration */
+  myGH->out3D_last[vindex] = GH->cctk_iteration;
+  
+  return (0);
+}
+
+
+/**************************** local functions ******************************/
+/* check if steerable parameters have changed */
+static void CheckSteerableParameters (asciiioGH *myGH)
+{
+  int i, out_old, times_set, num_vars;
+  char *fullname, *msg;
+  static int out3D_vars_lastset = -1;
+  DECLARE_CCTK_PARAMETERS
+
+
+  out_old = myGH->out3D_every;
+
+  /* How often to output */
+  myGH->out3D_every = out_every > 0 ? out_every : -1;
+  if (out3D_every > 0)
+  {
+    myGH->out3D_every = out3D_every;
+  }
+
+  /* Report if frequency changed */
+
+  if (myGH->out3D_every != out_old)
+  {
+    if (CCTK_Equals (newverbose, "standard") ||
+        CCTK_Equals (newverbose, "full"))
+    {
+      CCTK_VInfo (CCTK_THORNSTRING, "IOASCII_3D: Output every %d iterations",
+                  myGH->out3D_every);
+    }
+  }
+
+  /* re-parse the 'out3D_vars' parameter if it was changed */
+  times_set = CCTK_ParameterQueryTimesSet ("out3D_vars", CCTK_THORNSTRING);
+  if (times_set != out3D_vars_lastset) 
+  {
+    num_vars = CCTK_NumVars ();
+    memset (myGH->do_out3D, 0, num_vars);
+    CCTK_TraverseString (out3D_vars, SetOutputFlag, myGH->do_out3D,
+                         CCTK_GROUP_OR_VAR);
+
+    if (CCTK_Equals (newverbose, "standard") ||
+        CCTK_Equals (newverbose, "full"))
+    {
+      msg = NULL;
+      for (i = 0; i < num_vars; i++)
+      {
+        if (myGH->do_out3D[i])
+        {
+          fullname = CCTK_FullName (i);
+          if (! msg)
+          {
+            Util_asprintf (&msg, "IOASCII_3D: Output requested for %s",
+                           fullname);
+          }
+          else
+          {
+            Util_asprintf (&msg, "%s %s", msg, fullname);
+          }
+          free (fullname);
+        }
+      }
+      if (msg)
+      {
+        CCTK_INFO (msg);
+        free (msg);
+      }
+    }    
+
+    /* Save the last setting of 'out3D_vars' parameter */
+    out3D_vars_lastset = times_set;
+  }
+
+}
+
+
+/* check if this variable can be output (static conditions) */
+static int CheckOutputVar (int vindex)
+{
+  int groupindex;
+  cGroup groupinfo;
+  char *fullname;
+  const char *errormsg;
+
+
+  /* get the variable group information */
+  groupindex = CCTK_GroupIndexFromVarI (vindex);
+  CCTK_GroupData (groupindex, &groupinfo);
+
+  /* check if variable is grid array type with 3 dimensions */
+  errormsg = NULL;
+  if (groupinfo.dim != 3)
+  {
+    errormsg = "No IOASCII 3D output for '%s' (dim != 3)";
+  }
+  else if (groupinfo.grouptype != CCTK_GF && groupinfo.grouptype != CCTK_ARRAY)
+  {
+    errormsg = "No IOASCII 3D output for '%s' (not a grid function or array)";
+  }
+
+  if (errormsg)
+  {
+    fullname = CCTK_FullName (vindex);
+    CCTK_VWarn (2, __LINE__, __FILE__, CCTK_THORNSTRING, errormsg, fullname);
+    free (fullname);
+  }
+
+  return (errormsg != NULL);
+}
+
+
+/* callback for CCTK_TraverseString() to set the output flag 
+   for the given variable */
+static void SetOutputFlag (int vindex, const char *optstring, void *arg)
+{
+  char *flags = (char *) arg;
+
+
+  /* Check the variable type */
+  if (CheckOutputVar (vindex) == 0)
+  {
+    flags[vindex] = 1;
+  }
+
+  if (optstring)
+  {
+    CCTK_VWarn (5, __LINE__, __FILE__, CCTK_THORNSTRING,
+                "Optional string '%s' in variable name ignored", optstring);
+  }
+}