Initial import of thorn SphericalSurface from AEIDevelopment.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusNumerical/SphericalSurface/trunk@2 40f6ab95-0e4f-0410-8daa-ee8d7420be1d

8 files changed, 886 insertions, 0 deletions

diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..5b6e7c6
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  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
+
+	    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) <year>  <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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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) year 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..778babc
--- /dev/null
+++ b/README
@@ -0,0 +1,10 @@
+CVS info   : $Header$
+
+Cactus Code Thorn SphericalSurface
+Thorn Author(s)     : Erik Schnetter <schnetter@aei.mpg.de>
+Thorn Maintainer(s) : Erik Schnetter <schnetter@aei.mpg.de>
+--------------------------------------------------------------------------
+
+Purpose of the thorn:
+
+Store spherical surfaces.
diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..7699b35
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,309 @@
+% *======================================================================*
+%  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 
+%  relevant 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 separated 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 graphicx package. 
+%     More specifically, with the "\includegraphics" command.  Do
+%     not specify any graphic file extensions in your .tex file. This 
+%     will allow us 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{Erik Schnetter \textless schnetter@aei.mpg.de\textgreater}
+
+% The title of the document (not necessarily the name of the Thorn)
+\title{SphericalSurface}
+
+% the date your document was last changed, if your document is in CVS, 
+% please use:
+\date{$ $Date$ $}
+
+\maketitle
+
+% Do not delete next line
+% START CACTUS THORNGUIDE
+
+% Add all definitions used in this documentation here 
+%   \def\mydef etc
+
+\begin{abstract}
+This thorn provides a repository for two-dimensional surfaces with
+spherical topology.  This thorn does not actually do anything with
+these surfaces, but allow other thorns to store and retrieve the
+surfaces and some associated information.  The exact interpretation of
+the stored quantities is up to the using thorns, but certain standard
+definitions are suggested.
+\end{abstract}
+
+
+
+\section{Introduction}
+
+Many thorns work on manifolds that are two-dimensional, closed
+surfaces.  Examples are apparent and event horizons, or the surfaces
+on which gravitational waves are extracted.  Other such surfaces might
+be excision or outer boundaries (although these are currently not
+treated as such).  There is a need to have a common representation for
+such surfaces, so that the surface-finding thorns and the thorns
+working with these surfaces can be independent.  A common
+representation will also facilitate visualisation.  This thorn
+\texttt{SphericalSurface} provides just such a common representation.
+
+This thorn is not meant to do anything else but be a ``repository''
+for surfaces.  It is up to the surface-finding and surface-using
+thorns to agree on the details of the information stored.  Of course,
+standard definitions for the stored quantities are suggested.  (For
+example, there is no exact definition of the quadrupole moment,
+because this definition will depend on the kind of surface that is
+stored.  However, it is specified that the quadrupole moment should be
+calculate with respect to the centroid, and that it should not be
+trace-free.)
+
+This thorn provides storage for several independent surfaces,
+identified by an \emph{index}.  It is up to the user to specify,
+probably in the parameter file, which thorns use what surfaces for
+what purpose.
+
+
+
+\section{Surface Definition}
+
+This thorn provides, for each surface, a two-dimensional grid array
+\texttt{sf\_radius} and grid scalars \texttt{sf\_origin\_x},
+\texttt{sf\_origin\_y}, and \texttt{sf\_origin\_z}.  The number of
+surfaces is determined by the parameter \texttt{nsurfaces}, which has
+to be set in the parameter file.
+
+\texttt{sf\_radius} should contain the radius of the surface as
+measured from its origin, where the arrays indices vary in the
+$\theta$ and $\phi$ direction, respectively.  Both the radius array
+and the surface origin are supposed to be set when a surface is
+stored.
+
+The coordinates on the surface, i.e.\ the grid origin and spacing in
+the $\theta$ and $\phi$ directions, is available from the grid scalars
+\texttt{sf\_origin\_theta}, \texttt{sf\_origin\_phi},
+\texttt{sf\_delta\_theta}, and \texttt{sf\_delta\_phi}.  These grid
+scalars are set by the thorn SphericalSurface in the \texttt{basegrid}
+bin, and are meant to be read-only for other thorns.
+
+
+
+\begin{quotation}
+\subsection*{A note on vector grid variables}
+
+A relatively new addition to Cactus (in November 2003) are vector grid
+variables.  These are essentially arrays of grid variables.  Thorn
+SphericalSurface makes use of these by storing the surfaces in such
+arrays.  That means that in order to access data from a single
+surface, on has to use the corresponding surface index as array index.
+In a similar manner, thorn SurfaceIndex uses array parameters for its
+parameters (except certain global ones).
+
+This should be kept in mind when writing source code.  C has the
+unfortunate property of converting arrays into meaningless integers if
+an array subscript is accidentally omitted.  Fortran knows whole-array
+expressions, meaning that it would act on all surfaces instead of a
+single one if an array subscript is accidentally omitted.
+
+Each element of a vector grid function is a grid function.  (The term
+``grid function vector'' might have been more appropriate.)  As such,
+it has a name, which can be used e.g.\ for output.  The name consists
+of the vector grid function name to which the surface index in square
+brackets has been appended.
+\end{quotation}
+
+
+
+\subsection{Global Surface Quantities}
+
+In many cases, only some abstract information about the surface is of
+interest, such as its mean radius or its quadrupole moment.  For that
+purpose there are additional grid scalars that carry this information.
+These grid scalars are also supposed to be set when a surface is
+stored.  These grid scalars are
+\begin{description}
+
+\item[\texttt{sf\_mean\_radius}] Mean of the surface radius.  This
+should be the arithmetic mean where the radii have been weighted with
+$\sin\theta$, or a suitable generalisation thereof.  This quantity is
+also supposed to be a measure of the surface's monopole moment.  One
+suggested expression is $M=\sqrt{A}$ with $A = \int_S d\Omega\, r^2 /
+\int_S d\Omega$.
+
+\item[\texttt{sf\_min\_radius}, \texttt{sf\_max\_radius}] Minimum and
+maximum of the surface radius.
+
+\item[\texttt{sf\_centroid\_x}, \texttt{sf\_centroid\_y},
+\texttt{sf\_centroid\_z}] The centre of the surface.  While the
+quantities \texttt{sf\_origin\_*} denote the point from which the
+radius of the surface is measured, the quantities
+\texttt{sf\_centroid\_*} should contain the point which is
+``logically'' the centre of the surface.  This quantity is supposed to
+be a measure of the dipole moment of the surface.  One suggested
+expression is $D^i = \int_S d\Omega\, x^i / A$.
+
+\item[\texttt{sf\_quadrupole\_xx}, \texttt{sf\_quadrupole\_xy},
+\texttt{sf\_quadrupole\_xz}, \texttt{sf\_quadrupole\_yy},
+\texttt{sf\_quadrupole\_yz}, \texttt{sf\_quadrupole\_zz}] The
+quadrupole moment of the surface. This should be the full quadrupole
+moment and not a trace-free quantity.  One suggested expression is
+$Q^{ij} = \int_S d\Omega\, y^i y^j / A$ with $y^i = x^i - D^i$.
+
+\item[\texttt{sf\_min\_x}, \texttt{sf\_min\_y}, \texttt{sf\_min\_z},
+\texttt{sf\_max\_x}, \texttt{sf\_max\_y}, \texttt{sf\_max\_z}] The
+bounding box of the surface.
+
+\end{description}
+Note that the integral expressions are only suggestions which should
+be adapted to whatever is natural for the stored surface.  The
+suggested integral expressions also depend on the metric which is
+used; this should be a ``natural'' metric for the surface.  E.g.\ for
+apparent horizons, this might be the induced two-metric $q_{ij}$ from
+the projection of the ADM three-metric $\gamma_{ij}$.
+
+
+
+\subsection{Validity of Surface Data}
+
+There is also an integer flag \texttt{valid} available.  Its
+definition is up to the surface-providing thorn.  The following
+interpretations are \emph{suggested}:
+\begin{description}
+
+\item[zero:] No surface is provided at this time step.
+
+\item[negative:] No surface could be found at this time step.  This
+indicates an error.
+
+\item[positive:] The surface data are valid.
+
+\end{description}
+Note that, if this flag is used, it is necessary to set this flag at
+every iteration.  This flag is not automatically reset to zero.
+
+
+
+\section{Surface Array Shape}
+
+The number of grid points in the radius array \texttt{sf\_radius} is
+determined by the parameters \texttt{ntheta} and \texttt{nphi}.  These
+arrays exist for each surface.  (Internally, thorn SphericalSurface
+stores all surfaces with the same array shape \texttt{maxntheta} and
+\texttt{maxnphi}, so that the parameters  \texttt{ntheta} and
+\texttt{nphi} must not be used for index calculations.  Use the
+surfaces \texttt{lsh} instead.)  The surface array shape includes
+ghost or boundary zones at the array edges.  These ghost zones have
+the same size for all surfaces.
+
+
+
+\section{Surface Symmetries}
+
+It is often the case that one uses symmetries to reduce the size of
+the simulation domain, such as octant or quadrant mode.  Whenever a
+symmetry plane intersects a surface, only part of the surface is
+actually stored.  The user has to define the symmetries of each
+surface in the parameter file via the parameters
+\texttt{sf\_symmetry\_x}, \texttt{sf\_symmetry\_y}, and
+\texttt{sf\_symmetry\_z}.  The indicate that a 
+reflection symmetry exists in the corresponding direction.  The
+surface origin is required to lie in the corresponding symmetry
+planes.
+
+Thorn SphericalSurface takes these symmetries into account when it
+calculates the grid spacing and the origin of the surface coordinates
+$\theta$ and $\phi$.
+
+
+
+\section{Input and Output}
+
+As the surfaces are stored as grid variables, the standard input and
+output routines will work for them.  The standard visualisation tools
+will be able to visualise them.  The surfaces will also automatically
+be checkpointed and restored.
+
+
+
+\subsection{Acknowledgements}
+
+This thorn was suggested during meetings of the numerical relativity
+group at the AEI.  Jonathan Thornburg provided many detailed and
+useful suggestions.  Ed Evans, Carsten Gundlach, Ian Hawke, and Denis
+Pollney contributed comments and suggestions.
+
+% Do not delete next line
+% END CACTUS THORNGUIDE
+
+\end{document}
diff --git a/interface.ccl b/interface.ccl
new file mode 100644
index 0000000..2e8ccbc
--- /dev/null
+++ b/interface.ccl
@@ -0,0 +1,49 @@
+# Interface definition for thorn SphericalSurface
+# $Header$
+
+IMPLEMENTS: SphericalSurface
+
+
+
+PUBLIC:
+
+# to be defined by the setting thorn
+CCTK_INT sf_valid[nsurfaces] TYPE=scalar
+
+
+
+CCTK_REAL sf_info[nsurfaces] TYPE=scalar
+{
+  # monopole moment; M := sqrt(A / 4pi)   with A := int(S) r^2 dS
+  sf_mean_radius
+  sf_min_radius sf_max_radius
+
+  # dipole moment; D^i := int(S) x^i dS / A
+  sf_centroid_x sf_centroid_y sf_centroid_z
+
+  # quadrupole moment; Q^ij := int(S) y^i y^j dS / A   with y^i := x^i - D^i
+  sf_quadrupole_xx sf_quadrupole_xy sf_quadrupole_xz
+  sf_quadrupole_yy sf_quadrupole_yz sf_quadrupole_zz
+
+  # bounding box
+  sf_min_x sf_min_y sf_min_z sf_max_x sf_max_y sf_max_z
+} "Surface information"
+
+
+
+CCTK_REAL sf_radius[nsurfaces] TYPE=array DIM=2 SIZE=maxntheta,maxnphi DISTRIB=constant
+
+CCTK_REAL sf_origin[nsurfaces] TYPE=scalar
+{
+  # these are to be set together with the radius grid array
+  sf_origin_x sf_origin_y sf_origin_z
+}
+
+
+  
+CCTK_REAL sf_coordinate_descriptors[nsurfaces] TYPE=scalar
+{
+  # these are set up by this thorn, and should be treated as read-only
+  sf_origin_theta sf_origin_phi
+  sf_delta_theta sf_delta_phi
+} "Surface coordinate descriptors"
diff --git a/param.ccl b/param.ccl
new file mode 100644
index 0000000..00ddf73
--- /dev/null
+++ b/param.ccl
@@ -0,0 +1,71 @@
+# Parameter definitions for thorn SphericalSurface
+# $Header$
+
+RESTRICTED:
+
+# You can enlarge the possible number of surfaces by changing the maximum
+# 42 in the parameter nsurfaces, and by changing the array sizes [42] found
+# in many of the parameters below.
+
+CCTK_INT nsurfaces "Number of surfaces"
+{
+  0:42 :: ""
+} 0
+
+
+
+PRIVATE:
+
+CCTK_INT nghoststheta "Number of ghost zones in the theta direction"
+{
+  0:* :: ""
+} 1
+
+CCTK_INT nghostsphi "Number of ghost zones in the phi direction"
+{
+  0:* :: ""
+} 1
+
+
+
+# Default parameter values do not trigger accumulator expressions.
+# Therefore the default values here must be large enough for the default
+# surface shape.
+
+CCTK_INT maxntheta "do not set this parameter directly" ACCUMULATOR=((x>y)*x+!(x>y)*y)
+{
+  0:* :: ""
+} 19
+
+CCTK_INT maxnphi "do not set this parameter directly" ACCUMULATOR=((x>y)*x+!(x>y)*y)
+{
+  0:* :: ""
+} 38
+
+
+
+RESTRICTED:
+
+CCTK_INT ntheta[42] "Number of grid points in the theta direction"
+{
+  0:* :: "must be at least 3*nghoststheta"
+} 19
+
+CCTK_INT nphi[42] "Number of grid points in the phi direction"
+{
+  0:* :: "must be at least 3*nghostsphi"
+} 38
+
+
+
+BOOLEAN symmetric_x[42] "Reflection symmetry in the x direction"
+{
+} no
+
+BOOLEAN symmetric_y[42] "Reflection symmetry in the y direction"
+{
+} no
+
+BOOLEAN symmetric_z[42] "Reflection symmetry in the z direction"
+{
+} no
diff --git a/schedule.ccl b/schedule.ccl
new file mode 100644
index 0000000..14e37f0
--- /dev/null
+++ b/schedule.ccl
@@ -0,0 +1,14 @@
+# Schedule definitions for thorn SphericalSurface
+# $Header$
+
+STORAGE: sf_valid
+STORAGE: sf_info
+STORAGE: sf_radius sf_origin
+STORAGE: sf_coordinate_descriptors
+
+
+
+SCHEDULE SphericalSurfaceInfo_Setup AT basegrid
+{
+  LANG: C
+} "Calculate surface coordinate descriptors"
diff --git a/src/make.code.defn b/src/make.code.defn
new file mode 100644
index 0000000..af99905
--- /dev/null
+++ b/src/make.code.defn
@@ -0,0 +1,9 @@
+# Main make.code.defn file for thorn SphericalSurface
+# $Header$
+
+# Source files in this directory
+SRCS = setup.c
+
+# Subdirectories containing source files
+SUBDIRS = 
+
diff --git a/src/setup.c b/src/setup.c
new file mode 100644
index 0000000..fc6420c
--- /dev/null
+++ b/src/setup.c
@@ -0,0 +1,84 @@
+/* $Header$ */
+
+#include <assert.h>
+
+#include "cctk.h"
+#include "cctk_Arguments.h"
+#include "cctk_Parameters.h"
+
+
+
+void SphericalSurfaceInfo_Setup (CCTK_ARGUMENTS)
+{
+  DECLARE_CCTK_ARGUMENTS;
+  DECLARE_CCTK_PARAMETERS;
+  
+  CCTK_REAL const pi = 3.1415926535897932384626433832795028841971693993751;
+  int n;
+  
+  
+  
+  for (n=0; n<nsurfaces; ++n) {
+    
+    /* internal consistency checks */
+    assert (ntheta[n] >= 3*nghoststheta && ntheta[n] <= maxntheta);
+    assert (nphi[n] >= 3*nghostsphi && nphi[n] <= maxnphi);
+    
+    
+    
+    /* coordinates in the theta direction */
+    /* avoid_sf_origin_theta = 1 */
+    if (symmetric_z[n]) {
+      
+      /* upper hemisphere: z>=0, theta in (0, pi/2) */
+      sf_delta_theta[n] = pi/2 / (ntheta[n] - 2*nghoststheta - 0.5);
+      sf_origin_theta[n] = - (nghoststheta - 0.5) * sf_delta_theta[n];
+      
+    } else {
+      
+      /* both hemispheres: theta in (0, pi) */
+      sf_delta_theta[n] = pi / (ntheta[n] - 2*nghoststheta);
+      sf_origin_theta[n] = - (nghoststheta - 0.5) * sf_delta_theta[n];
+      
+    }
+    
+    
+    
+    /* coordinates in the phi direction */
+    /* avoid_sf_origin_phi = 0 */
+    if (symmetric_x[n]) {
+      if (symmetric_y[n]) {
+        
+        /* one quadrant: x>=0, y>=0, phi in [0, pi/2] */
+        assert (nphi[n] - 2*nghostsphi >= 1);
+        sf_delta_phi[n] = pi/2 / (nphi[n] - 2*nghostsphi - 1);
+        sf_origin_phi[n] = - nghostsphi * sf_delta_phi[n];
+        
+      } else {
+        
+        /* two quadrants: x>=0, phi in [-pi/2, pi/2] */
+        assert (nphi[n] - 2*nghostsphi >= 2);
+        sf_delta_phi[n] = pi / (nphi[n] - 2*nghostsphi - 1);
+        sf_origin_phi[n] = - pi/2 - nghostsphi * sf_delta_phi[n];
+        
+      }
+    } else {
+      if (symmetric_y[n]) {
+        
+        /* two quadrants: y>=0, phi in [0, pi] */
+        assert (nphi[n] - 2*nghostsphi >= 2);
+        sf_delta_phi[n] = pi / (nphi[n] - 2*nghostsphi - 1);
+        sf_origin_phi[n] = - nghostsphi * sf_delta_phi[n];
+        
+      } else {
+        
+        /* all quadrants: phi in [0, 2pi) */
+        assert (nphi[n] - 2*nghostsphi >= 4);
+        sf_delta_phi[n] = 2*pi / (nphi[n] - 2*nghostsphi);
+        sf_origin_phi[n] = - nghostsphi * sf_delta_phi[n];
+        
+      }
+    }
+    
+  }
+}