Provide aliased functions which can be used to announce certain events

(key/value pairs) to Formaline.

Provide a simulation ID as well as the existing build ID and run ID.
A simulation ID should remain constant over restarts with the same
parameter file, the run ID should change.  A simulation ID thus
describes a particular physics setup.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusUtils/Formaline/trunk@126 83718e91-0e4f-0410-abf4-91180603181f

1 files changed, 39 insertions, 0 deletions

diff --git a/interface.ccl b/interface.ccl
index 9a447c8..fa8779b 100644
--- a/interface.ccl
+++ b/interface.ccl
@@ -29,3 +29,42 @@ FUNCTION UniqueSimulationID (CCTK_POINTER_TO_CONST IN cctkGH)
 PROVIDES FUNCTION UniqueSimulationID \
     WITH Formaline_UniqueSimulationID \
     LANGUAGE C
+
+
+
+# Return a pointer to an unmodifiable C string
+# which contains a unique ID for this run
+CCTK_POINTER_TO_CONST \
+FUNCTION UniqueRunID (CCTK_POINTER_TO_CONST IN cctkGH)
+
+PROVIDES FUNCTION UniqueRunID \
+    WITH Formaline_UniqueRunID \
+    LANGUAGE C
+
+
+
+# Announce some information
+# Note the order (value, key);
+# this is necessary because string arguments have to be at the end
+# of the argument list.
+void \
+FUNCTION AnnounceBoolean (CCTK_POINTER_TO_CONST IN cctkGH, \
+                          CCTK_INT              IN value, \
+                          CCTK_STRING           IN key)
+void \
+FUNCTION AnnounceInt     (CCTK_POINTER_TO_CONST IN cctkGH, \
+                          CCTK_INT              IN value, \
+                          CCTK_STRING           IN key)
+void \
+FUNCTION AnnounceReal    (CCTK_POINTER_TO_CONST IN cctkGH, \
+                          CCTK_REAL             IN value, \
+                          CCTK_STRING           IN key)
+void \
+FUNCTION AnnounceString  (CCTK_POINTER_TO_CONST IN cctkGH, \
+                          CCTK_STRING           IN value, \
+                          CCTK_STRING           IN key)
+
+PROVIDES FUNCTION AnnounceBoolean WITH Formaline_AnnounceBoolean LANGUAGE C
+PROVIDES FUNCTION AnnounceInt     WITH Formaline_AnnounceInt     LANGUAGE C
+PROVIDES FUNCTION AnnounceReal    WITH Formaline_AnnounceReal    LANGUAGE C
+PROVIDES FUNCTION AnnounceString  WITH Formaline_AnnounceString  LANGUAGE C