src/main/Traverse.c


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

 /*@@
   @file      Traverse.c
   @date      Mon Apr 17 19:16:40 2000
   @author    Tom Goodale
   @desc 
   Routines for traversal.
   @enddesc 
   @version $Header$
 @@*/

#include "cctk_Config.h"
#include "cGH.h"
#include "cctk_Flesh.h"
#include "cctki_GHExtensions.h"

static const char *rcsid="$Header$";

CCTK_FILEVERSION(main_Traverse_c);

/********************************************************************
 *********************     External Routines   **********************
 ********************************************************************/

 /*@@
   @routine    CCTK_Traverse
   @date       Thu Jan 27 14:42:16 2000
   @author     Tom Goodale
   @desc 
   Routine called to traverse functions 
   @enddesc 
   @calls     CCTKi_ScheduleTraverseGHExtensions
   @calledby   
   @history 
 
   @endhistory 
   @var     GH
   @vdesc   The cGH the functions operate on.
   @vtype   cGH
   @vio     inout
   @vcomment 
 
   @endvar 
   @var     where
   @vdesc   The schedule group to traverse
   @vtype   const char *
   @vio     in
   @vcomment 
 
   @endvar 

   @returntype int
   @returndesc
   Returns the return value of CCTKi_ScheduleTraverse
   @endreturndesc
@@*/
int CCTK_Traverse(cGH *GH, const char *where)
{
  int retcode;

  retcode = CCTKi_ScheduleTraverseGHExtensions(GH, where);

  return retcode;
}