/*@@
   @file      rfrInterface.c
   @date      Wed Feb  3 14:42:24 1999
   @author    Tom Goodale
   @desc 
   Routine used by cactus to talk to the rfr.
   @enddesc 
 @@*/

/*#define RFRDEBUG*/

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

#include "cctk_Flesh.h"
#include "cctk_GHExtensions.h"
#include "cctk_Groups.h"
#include "CactusrfrInterface.h"
#include "rfrConstants.h"
#include "CactusCommFunctions.h"
#include "cctk_IOMethods.h"
#include "cctk_parameters.h"
#include "rfrInterface.h"

static char *rcsid = "$Header$";


 /*@@
   @routine    CCTKi_rfrTraverse
   @date       Wed Feb  3 14:45:57 1999
   @author     Tom Goodale
   @desc 
   Calls the rfrTraverse, then deals with extensions.
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/
int CCTKi_rfrTraverse(cGH *GH, int rfrpoint)
{
  
  CCTKi_rfrTraverseGHExtensions(GH, rfrpoint);

  return 0;
}


 /*@@
   @routine    rfrPrintTree
   @date       14 Mar 1999
   @author     Gabrielle Allen
   @desc 
               Prints the order of the RFR calling tree
   @enddesc 
   @calls      
   @history 
   @endhistory
 
   @var        
   @vdesc      
   @vtype      
   @vio        
   @vcomment 
   @endvar 

   @returntype int
   @returndesc
      0 = routine did not print rfr tree
      1 = routine did print rfr tree
   @endreturndesc

   @version    $Header$
@@*/

int CCTKi_rfrPrintTree(cGH *GH,void *rfr_top)
{
  DECLARE_CCTK_PARAMETERS

  static int showed_tree = 0;

  /* Return if the users doesn't want to see the tree */
  if (!cctk_show_rfr_tree || cctk_brief_output) return 0;

  if (!showed_tree) 
  {

    showed_tree = 1;

    printf ("-------------------------------------------------------------------------------------\n");
    printf ("Evolution tree from the RFR\n");

    rfrPrintDescs(rfr_top,GH,CCTK_BASEGRID,"CCTK_BASEGRID","");
    rfrPrintDescs(rfr_top,GH,CCTK_INITIAL, "CCTK_INITIAL","");
    rfrPrintDescs(rfr_top,GH,CCTK_POSTINITIAL, "CCTK_POSTINITIAL","");
    rfrPrintDescs(rfr_top,GH,CCTK_POSTSTEP,"CCTK_POSTSTEP","");
    printf ("\n   do loop over timesteps\n");
    rfrPrintDescs(rfr_top,GH,CCTK_PRESTEP,"CCTK_PRESTEP","   ");
    rfrPrintDescs(rfr_top,GH,CCTK_EVOL,"CCTK_EVOL","   ");
    rfrPrintDescs(rfr_top,GH,CCTK_BOUND,"CCTK_BOUND","   ");
    
    printf ("     t = t+dt\n");
    rfrPrintDescs(rfr_top,GH,CCTK_POSTSTEP,"CCTK_POSTSTEP","   ");
    
    printf ("     if (analysis)\n");
    rfrPrintDescs(rfr_top,GH,CCTK_ANALYSIS,"CCTK_ANALYSIS","      ");
    printf ("     endif\n");
    printf ("   enddo\n");
    printf ("-------------------------------------------------------------------------------------\n");

  }

  return 1;

}

 /*@@
   @routine    CCTKi_rfrStorageOn
   @date       Sat Feb 13 17:06:30 1999
   @author     Tom Goodale
   @desc 
   Routine called by the rfr to switch storage on for a group
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/
int CCTKi_rfrStorageOn(void *GH, int group)
{
  int retcode;
  char *group_name;

  group_name = CCTK_GroupName(group);

  if(group_name)
  {
#ifdef RFRDEBUG
    printf("Turning on storage in rfrInterface.c for group %s (%d)\n",group_name,group);
#endif
    retcode = CCTK_EnableGroupStorage(GH, group_name);
    free(group_name);
  }
  else
  {
    retcode = 0;
  }

  return retcode;
}

 /*@@
   @routine    CCTKi_rfrStorageOff
   @date       Sat Feb 13 17:06:30 1999
   @author     Tom Goodale
   @desc 
   Routine called by the rfr to switch storage off for a group
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/
int CCTKi_rfrStorageOff(void *GH, int group)
{
  int retcode;
  char *group_name;

  group_name = CCTK_GroupName(group);
  if(group_name)
  {
#ifdef RFRDEBUG
    printf("Turning off storage in rfrInterface.c for group %s (%d)\n",group_name,group);
#endif
    retcode = CCTK_DisableGroupStorage(GH, group_name);

    free(group_name);
  }
  else
  {
    retcode = 0;
  }

  return retcode;
}

 /*@@
   @routine    CCTKi_rfrCommunicationOn
   @date       Sat Feb 13 17:06:30 1999
   @author     Tom Goodale
   @desc 
   Routine called by the rfr to switch communication on for a group
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/
int CCTKi_rfrCommunicationOn(void *GH, int group)
{
  int retcode;
  char *group_name;

  group_name = CCTK_GroupName(group);
  if(group_name)
  {
#ifdef RFRDEBUG
    printf("Turning on comm in rfrInterface.c for group %s (%d)\n",group_name,group);
#endif
    retcode = CCTK_EnableGroupComm(GH, group_name);

    free(group_name);
  }
  else
  {
    retcode = 0;
  }

  return retcode;
}

 /*@@
   @routine    CCTKi_rfrCommunicationOff
   @date       Sat Feb 13 17:06:30 1999
   @author     Tom Goodale
   @desc 
   Routine called by the rfr to switch communication off for a group
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/
int CCTKi_rfrCommunicationOff(void *GH, int group)
{
  int retcode;
  char *group_name;

  group_name = CCTK_GroupName(group);
  if(group_name)
  {
#ifdef RFRDEBUG
    printf("Turning off comm in rfrInterface.c for group %s (%d)\n",group_name,group);
#endif
    retcode = CCTK_DisableGroupComm(GH, group_name);

    free(group_name);
  }
  else
  {
    retcode = 0;
  }

  return retcode;
}

 /*@@
   @routine    CCTKi_rfrTriggerable
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc 
   Returns true if this rfr entry point should be triggerable
   for some event, otherwise returns false in which case none 
   of the triggers stuff is done.
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 
   @var     entrypoint 
   @vdesc   describes the entrypoint of the RFR
   @vtype   int
   @vio     in
   @vcomment RFR entrypoint macros are in src/include/rfr_constants.h
   @endvar 
@@*/

int CCTKi_rfrTriggerable(int entrypoint)
{
  if (entrypoint == CCTK_ANALYSIS)
    {
      return 1;
    }
  else 
    return 0;
}



 /*@@
   @routine    CCTKi_rfrCallFunc
   @date       Sat Feb 13 17:08:39 1999
   @author     Tom Goodale
   @desc 
   Routine called by the rfr to call a function.
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/
int CCTKi_rfrCallFunc(void *GH, int language, void *function)
{

  void (*calledfunc)(void *);

  calledfunc = (void (*)(void *))function;

  /* Call the function. */
  
  calledfunc(GH);

  return 0;
}