/*@@
   @file      Output3D.c
   @date      Tue Jan 9 1999
   @author    Gabrielle Allen
   @desc 
   Functions to deal 3D output of variables
   @enddesc 
   @history
   @hauthor Thomas Radke @hdate 16 Mar 1999
   @hdesc Converted to Cactus 4.0
   @hendhistory
 @@*/

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

#include "cctk.h"
#include "cctk_Parameters.h"
#include "CactusBase/IOUtil/src/ioGH.h"
#include "ioFlexGH.h"

/* function prototypes */
int IOFlexIO_Output3DVarAs (cGH *GH, const char *var, const char *alias);
int IOFlexIO_TimeFor3D (cGH *GH, int index);
static void CheckSteerableParameters (flexioGH *myGH);


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

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

int IOFlexIO_Output3DGH (cGH *GH)
{
  DECLARE_CCTK_PARAMETERS
  int i;
  flexioGH *myGH;
  const char *name;
  char *fullname;


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

  CheckSteerableParameters (myGH);

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

  /* Loop over all variables */
  for (i = 0; i < CCTK_NumVars (); i++) {
    if (IOFlexIO_TimeFor3D (GH, i)) {
      name           = CCTK_VarName (i);
      fullname       = CCTK_FullName (i);

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

      IOFlexIO_Output3DVarAs (GH, fullname, name);

      free (fullname);

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

  return (0);

  
}


/*@@
   @routine    IOFlexIO_Output3DVarAs
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   unconditional output of a variable using the IOFlexIO 3D output method
   @enddesc
   @calledby   IOFlexIO_Output3DGH, CCTK_OutputVarAsByMethod ("IOFlexIO_3D")
   @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_Output3DVarAs (cGH *GH, const char *fullname, const char *alias)
{
  DECLARE_CCTK_PARAMETERS
  int index;


  index = CCTK_VarIndex (fullname);

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

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

  return (0);

  
}


/*@@
   @routine    IOFlexIO_TimeFor3D
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   Decides if it is time to output a variable using the IOFlexIO 3D output
   method
   @enddesc
   @calledby   IOFlexIO_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 IOFlexIO_TimeFor3D (cGH *GH, int index)
{
  flexioGH *myGH;


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

  CheckSteerableParameters (myGH);

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

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

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

  return (1);
}


/*@@
   @routine    IOFlexIO_TriggerOutput3D
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
   Triggers the output a variable using the IOFlexIO 3D output
   method
   @enddesc
   @calledby   CCTK scheduler
   @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_TriggerOutput3D (cGH *GH, int index)
{
  DECLARE_CCTK_PARAMETERS
  flexioGH *myGH;
  const char *varname;


  varname = CCTK_VarName (index);

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

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

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

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

  return (0);

}


/**************************** local functions ******************************/
static void CheckSteerableParameters (flexioGH *myGH)
{
  DECLARE_CCTK_PARAMETERS
  const cParamData *paramdata;
  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;

  /* Check the 'out3D_vars' parameter */
  paramdata = CCTK_ParameterData ("out3D_vars", CCTK_THORNSTRING);
  if (! paramdata) 
  {
    CCTK_WARN (1, "Couldn't get info on parameter 'out3D_vars'");
    return;
  }

  /* re-parse the 'out3D_vars' parameter if it was changed */
  if (paramdata->n_set != out3D_vars_lastset) 
  {
    ParseVarsForOutput (out3D_vars, myGH->do_out3D);

    /* Save the last setting of 'out3D_vars' parameter */
    out3D_vars_lastset = paramdata->n_set;
  }

}