aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschnetter <schnetter@ec5ace1c-6809-4267-9cad-ed2f0ecfe59c>2010-01-11 22:25:14 +0000
committerschnetter <schnetter@ec5ace1c-6809-4267-9cad-ed2f0ecfe59c>2010-01-11 22:25:14 +0000
commit571f4fec08bba4af5be3734ca515926325b729a7 (patch)
treefc725ac891e187cff24ad99f297ba0d899e285ce
parent6b4b7c39e9fb4d3763472b064edadb779ba408be (diff)
Add new thorn TerminationTrigger.
This thorn watches the elapsed walltime. If only n minutes are left before the some limit set by the user, it triggers termination of the simulation. Termination is also triggered if a special file with a special content exists. git-svn-id: http://svn.cactuscode.org/arrangements/CactusUtils/TerminationTrigger/trunk@2 ec5ace1c-6809-4267-9cad-ed2f0ecfe59c
-rw-r--r--COPYRIGHT352
-rw-r--r--README12
-rw-r--r--doc/documentation.tex134
-rw-r--r--interface.ccl5
-rw-r--r--param.ccl43
-rw-r--r--schedule.ccl38
-rw-r--r--src/file.c109
-rw-r--r--src/make.code.defn7
-rw-r--r--src/walltime.c81
9 files changed, 781 insertions, 0 deletions
diff --git a/COPYRIGHT b/COPYRIGHT
new file mode 100644
index 0000000..d4bf783
--- /dev/null
+++ b/COPYRIGHT
@@ -0,0 +1,352 @@
+
+
+This thorn is (c) Copyright the authors listed in the sources files. This
+thorn is distributed under the GNU GPL with the specific exception that
+the GNU GPL does not migrate to code linking to or using infrastructure
+from this thorn.
+
+- The Cactus Team <cactusmaint@cactuscode.org>
+
+**************************************************************************
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 675 Mass Ave, Cambridge, MA 02139, USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ Appendix: How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 19yy <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19yy name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
+
+
diff --git a/README b/README
new file mode 100644
index 0000000..6cac1bc
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+Cactus Code Thorn TerminationTrigger
+Author(s) : Christian D. Ott
+Maintainer(s): Cactus team
+Licence : LGPL
+--------------------------------------------------------------------------
+
+1. Purpose
+
+This thorn watches the elapsed walltime. If only n minutes are left
+before the some limit set by the user, it triggers termination of the
+simulation. Termination is also triggered if a special file with a
+special content exists.
diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..ba9840d
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,134 @@
+% *======================================================================*
+% Cactus Thorn template for ThornGuide documentation
+% Author: Ian Kelley
+% Date: Sun Jun 02, 2002
+% $Header$
+%
+% Thorn documentation in the latex file doc/documentation.tex
+% will be included in ThornGuides built with the Cactus make system.
+% The scripts employed by the make system automatically include
+% pages about variables, parameters and scheduling parsed from the
+% relevent thorn CCL files.
+%
+% This template contains guidelines which help to assure that your
+% documentation will be correctly added to ThornGuides. More
+% information is available in the Cactus UsersGuide.
+%
+% Guidelines:
+% - Do not change anything before the line
+% % START CACTUS THORNGUIDE",
+% except for filling in the title, author, date etc. fields.
+% - Each of these fields should only be on ONE line.
+% - Author names should be sparated with a \\ or a comma
+% - You can define your own macros, but they must appear after
+% the START CACTUS THORNGUIDE line, and must not redefine standard
+% latex commands.
+% - To avoid name clashes with other thorns, 'labels', 'citations',
+% 'references', and 'image' names should conform to the following
+% convention:
+% ARRANGEMENT_THORN_LABEL
+% For example, an image wave.eps in the arrangement CactusWave and
+% thorn WaveToyC should be renamed to CactusWave_WaveToyC_wave.eps
+% - Graphics should only be included using the graphix package.
+% More specifically, with the "includegraphics" command. Do
+% not specify any graphic file extensions in your .tex file. This
+% will allow us (later) to create a PDF version of the ThornGuide
+% via pdflatex. |
+% - References should be included with the latex "bibitem" command.
+% - Use \begin{abstract}...\end{abstract} instead of \abstract{...}
+% - Do not use \appendix, instead include any appendices you need as
+% standard sections.
+% - For the benefit of our Perl scripts, and for future extensions,
+% please use simple latex.
+%
+% *======================================================================*
+%
+% Example of including a graphic image:
+% \begin{figure}[ht]
+% \begin{center}
+% \includegraphics[width=6cm]{MyArrangement_MyThorn_MyFigure}
+% \end{center}
+% \caption{Illustration of this and that}
+% \label{MyArrangement_MyThorn_MyLabel}
+% \end{figure}
+%
+% Example of using a label:
+% \label{MyArrangement_MyThorn_MyLabel}
+%
+% Example of a citation:
+% \cite{MyArrangement_MyThorn_Author99}
+%
+% Example of including a reference
+% \bibitem{MyArrangement_MyThorn_Author99}
+% {J. Author, {\em The Title of the Book, Journal, or periodical}, 1 (1999),
+% 1--16. {\tt http://www.nowhere.com/}}
+%
+% *======================================================================*
+
+% If you are using CVS use this line to give version information
+% $Header$
+
+\documentclass{article}
+
+% Use the Cactus ThornGuide style file
+% (Automatically used from Cactus distribution, if you have a
+% thorn without the Cactus Flesh download this from the Cactus
+% homepage at www.cactuscode.org)
+\usepackage{../../../../doc/latex/cactus}
+
+\begin{document}
+
+% The author of the documentation
+\author{Cactus Maintainers \textless cactusmaint@cactuscode.org\textgreater}
+
+% The title of the document (not necessarily the name of the Thorn)
+\title{TerminationTrigger}
+
+\date{January 11, 2010}
+
+\maketitle
+
+% Do not delete next line
+% START CACTUS THORNGUIDE
+
+% Add all definitions used in this documentation here
+% \def\mydef etc
+
+% Add an abstract for this thorn's documentation
+\begin{abstract}
+ This thorn watches the elapsed walltime. If only $n$ minutes are
+ left before the some limit set by the user, it triggers termination
+ of the simulation. Termination is also triggered if a special file
+ with a special content exists.
+\end{abstract}
+
+% The following sections are suggestive only.
+% Remove them or add your own.
+
+\section{Using This Thorn}
+
+To use this thorn you only need to include it in your ActiveThorns
+parameter and set the relevent parameters. With default parameters
+the thorn does nothing.
+
+Current options are to gracefully terminate a simulation $n$ minutes
+before a set time limit, or to terminate a simulation when the user
+creates a certain file. The latter is one of a few possibilities to
+order a Cactus simulation to terminate from the outside while giving
+it time to checkpoint. (Another possibility is to use the web
+interface for this.)
+
+\subsection{Obtaining This Thorn}
+
+Available as part of the Cactus Computational Toolkit in arrangement
+CactusUtils.
+
+\subsection{Support and Feedback}
+
+To the Cactus Team at \texttt{cactusmaint@cactuscode.org} or through
+the Bug/Feature Request web pages at \texttt{www.cactuscode.org}.
+
+% Do not delete next line
+% END CACTUS THORNGUIDE
+
+\end{document}
diff --git a/interface.ccl b/interface.ccl
new file mode 100644
index 0000000..ecf34de
--- /dev/null
+++ b/interface.ccl
@@ -0,0 +1,5 @@
+# Interface definition for thorn TerminationTrigger
+
+IMPLEMENTS: TerminationTrigger
+
+CCTK_REAL watchminutes TYPE=scalar
diff --git a/param.ccl b/param.ccl
new file mode 100644
index 0000000..faaf79c
--- /dev/null
+++ b/param.ccl
@@ -0,0 +1,43 @@
+# Parameter definitions for thorn TerminationTrigger
+
+PRIVATE:
+
+REAL on_remaining_walltime "When to trigger termination in MINUTES" STEERABLE = ALWAYS
+{
+ 0.0 :: "Don't trigger termination"
+ (0.0:* :: "So many minutes before your job walltime is over"
+} 0.0
+
+REAL max_walltime "Walltime in HOURS allocated for this job" STEERABLE = ALWAYS
+{
+ 0.0 :: "Don't trigger termination"
+ (0.0:* :: "Should be positive, right"
+} 0.0
+
+BOOLEAN termination_from_file "Use termination file; specified by termination_filename" STEERABLE = ALWAYS
+{
+} "no"
+
+BOOLEAN create_termination_file "Create an empty termination file at startup" STEERABLE = RECOVER
+{
+} "no"
+
+STRING termination_file "Termination file name (either full path or relative to IO::out_dir)" STEERABLE = ALWAYS
+{
+ "" :: "Termination file"
+} "/tmp/cactus_terminate"
+
+INT check_file_every "Check termination file every n timesteps" STEERABLE = ALWAYS
+{
+ 1:* :: ""
+} 1
+
+REAL output_remtime_every_minutes "Output remaining wall time every n minutes" STEERABLE = ALWAYS
+{
+ 0.0 :: "No output"
+ (0.0:* :: "Output"
+} 60.0
+
+SHARES: IO
+
+USES STRING out_dir
diff --git a/schedule.ccl b/schedule.ccl
new file mode 100644
index 0000000..88f3c60
--- /dev/null
+++ b/schedule.ccl
@@ -0,0 +1,38 @@
+# Schedule definitions for thorn TerminationTrigger
+
+if (on_remaining_walltime > 0)
+{
+ STORAGE: watchminutes
+
+ SCHEDULE TerminationTrigger_StartTimer AT wragh
+ {
+ LANG: C
+ } "Start timer"
+
+ SCHEDULE TerminationTrigger_ResetMinutes AT post_recover_variables
+ {
+ LANG: C
+ OPTIONS: global
+ } "Reset Watchtime"
+
+ SCHEDULE TerminationTrigger_CheckWalltime AT analysis
+ {
+ LANG: C
+ } "Check elapsed job walltime"
+}
+
+if (termination_from_file)
+{
+ if (create_termination_file)
+ {
+ SCHEDULE TerminationTrigger_CreateFile AT wragh
+ {
+ LANG: C
+ } "Create termination file"
+ }
+
+ SCHEDULE TerminationTrigger_CheckFile AT analysis
+ {
+ LANG: C
+ } "Check termination file"
+}
diff --git a/src/file.c b/src/file.c
new file mode 100644
index 0000000..ec111ef
--- /dev/null
+++ b/src/file.c
@@ -0,0 +1,109 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "cctk.h"
+#include "cctk_Arguments.h"
+#include "cctk_Parameters.h"
+#include "cctk_Termination.h"
+#include "cctk_Timers.h"
+#include "util_String.h"
+
+
+
+enum { BUFLEN = 10000 };
+
+
+
+static
+const char * get_termination_file (void)
+{
+ DECLARE_CCTK_PARAMETERS;
+
+ static char filename[BUFLEN];
+
+ if (strlen (termination_file) == 0)
+ {
+ const char * pbs_jobid = getenv ("MANUAL_TERMINATION_JOB_ID");
+ if (pbs_jobid == NULL)
+ pbs_jobid = getenv ("PBS_JOBID");
+
+ if (pbs_jobid == NULL)
+ CCTK_VWarn (CCTK_WARN_ABORT, __LINE__, __FILE__, "ManualTermination",
+ "Could not find environment variable "
+ "'MANUAL_TERMINATION_JOB_ID' or 'PBS_JOBID'");
+ else
+ Util_snprintf (filename, BUFLEN, "/tmp/cactus_terminate.%s", pbs_jobid);
+ }
+ else
+ {
+ if (termination_file[0] == '/')
+ {
+ /* file name begins with a slash, do not use IO::out_dir */
+ Util_snprintf (filename, BUFLEN, "%s", termination_file);
+ }
+ else
+ {
+ /* add IO::out_dir to filename */
+ Util_snprintf (filename, BUFLEN,
+ "%s/%s", out_dir, termination_file);
+ }
+ }
+ return filename;
+}
+
+
+
+void TerminationTrigger_CreateFile (CCTK_ARGUMENTS)
+{
+ DECLARE_CCTK_ARGUMENTS;
+ DECLARE_CCTK_PARAMETERS;
+
+ FILE *file;
+
+ /* only one processor needs to create the file */
+ if (CCTK_MyProc (cctkGH) != 0)
+ {
+ return;
+ }
+
+ file = fopen (get_termination_file(), "w");
+ fclose (file);
+}
+
+
+
+void TerminationTrigger_CheckFile (CCTK_ARGUMENTS)
+{
+ DECLARE_CCTK_ARGUMENTS;
+ DECLARE_CCTK_PARAMETERS;
+
+ FILE *file;
+ int terminate;
+
+ /* only one processor needs to check the file */
+ if (CCTK_MyProc (cctkGH) != 0)
+ {
+ return;
+ }
+
+ if (cctk_iteration % check_file_every != 0)
+ {
+ return;
+ }
+
+ file = fopen (get_termination_file(), "r");
+
+ if (file != NULL) {
+ terminate = 0;
+ fscanf (file, "%d", &terminate);
+ fclose (file);
+
+ if (terminate == 1) {
+ CCTK_INFO ("Found termination signal in termination file. "
+ "Triggering termination...");
+
+ CCTK_TerminateNext (cctkGH);
+ }
+ }
+}
diff --git a/src/make.code.defn b/src/make.code.defn
new file mode 100644
index 0000000..044fea0
--- /dev/null
+++ b/src/make.code.defn
@@ -0,0 +1,7 @@
+# Main make.code.defn file for thorn TerminationTrigger
+
+# Source files in this directory
+SRCS = walltime.c file.c
+
+# Subdirectories containing source files
+SUBDIRS =
diff --git a/src/walltime.c b/src/walltime.c
new file mode 100644
index 0000000..85209ed
--- /dev/null
+++ b/src/walltime.c
@@ -0,0 +1,81 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "cctk.h"
+#include "cctk_Arguments.h"
+#include "cctk_Parameters.h"
+#include "cctk_Termination.h"
+#include "cctk_Timers.h"
+
+
+
+void TerminationTrigger_StartTimer (CCTK_ARGUMENTS)
+{
+ DECLARE_CCTK_ARGUMENTS;
+ DECLARE_CCTK_PARAMETERS;
+
+ /* only one processor needs to query the elapsed runtime */
+ if (CCTK_MyProc (cctkGH) != 0)
+ {
+ return;
+ }
+
+ *watchminutes = output_remtime_every_minutes;
+
+ CCTK_VInfo (CCTK_THORNSTRING,
+ "Reminding you every %g minutes about remaining walltime",
+ (double) output_remtime_every_minutes);
+}
+
+
+
+void TerminationTrigger_ResetMinutes (CCTK_ARGUMENTS)
+{
+ DECLARE_CCTK_ARGUMENTS;
+ DECLARE_CCTK_PARAMETERS;
+
+ /* only one processor needs to query the elapsed runtime */
+ if (CCTK_MyProc (cctkGH) != 0)
+ {
+ return;
+ }
+
+ *watchminutes = output_remtime_every_minutes;
+}
+
+
+
+void TerminationTrigger_CheckWalltime (CCTK_ARGUMENTS)
+{
+ DECLARE_CCTK_ARGUMENTS;
+ DECLARE_CCTK_PARAMETERS;
+
+ CCTK_REAL time;
+
+ /* only one processor needs to query the elapsed runtime */
+ if (CCTK_MyProc (cctkGH) != 0)
+ {
+ return;
+ }
+
+ /* get walltime in seconds */
+ time = CCTK_RunTime();
+
+ if ((time/60.0 > *watchminutes) && *watchminutes != 0) {
+ *watchminutes += output_remtime_every_minutes;
+ CCTK_INFO ("***********************************************************");
+ CCTK_VInfo (CCTK_THORNSTRING,
+ "Remaining wallclock time for your job is %g minutes",
+ (double) (max_walltime*60.0 - time/60.0));
+ CCTK_INFO ("***********************************************************");
+ }
+
+ if (time/60.0 >= (max_walltime*60.0 - on_remaining_walltime)) {
+ CCTK_VInfo (CCTK_THORNSTRING,
+ "Remaining wallclock time for your job is %g minutes. "
+ "Triggering termination...",
+ (double) (max_walltime*60.0 - time/60.0));
+ CCTK_TerminateNext (cctkGH);
+ }
+}