User: hinder Date: 2013/01/04 03:16 AM

Added: /trunk/ README

Log: Add README

The format of the README is slightly different to the other READMEs in the Einstein Toolkit. It is in reStructuredText format, a markdown format which can be easily converted to HTML. This was a test to see how well this would work.

File Changes:

Directory: /trunk/ ==================

File [added]: README Delta lines: +63 -0 =================================================================== --- trunk/README (rev 0) +++ trunk/README 2013-01-04 09:16:01 UTC (rev 88) @@ -0,0 +1,63 @@ + +========= +Multipole +========= + +============= ============================================================================================== +Authors Ian Hinder and Andrew Knapp +Maintainer Ian Hinder +Licence GNU GPL version 2 +Documentation http://einsteintoolkit.org/documentation/ThornGuide/ThornGuidech133.html#x14... +Download svn checkout https://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/Multipole/trunk Multipole +============= ============================================================================================== + +--------------------- +Purpose of This Thorn +--------------------- + +The Multipole thorn performs spherical harmonic mode decomposition of +Cactus grid functions on coordinate spheres. It can decompose +multiple grid functions with any spin-weight on multiple spheres. +This thorn uses the interpolator interface to access grid functions, +so works with mesh-refinement and multi-patch. + +--------------- +Required thorns +--------------- + +* An interpolator, e.g. AEILocalInterp + +-------------- +Related thorns +-------------- + +* WeylScal4 can be used to compute the Weyl scalars, which can then be + decomposed into modes on coordinate spheres by Multipole. + +------------ +Publications +------------ + +Multipole has been used in the following publications: + +--------- +Copyright +--------- + +This thorn is copyright (C) 2007-2011 (C) by Ian Hinder and Andrew +Knapp. + +This thorn 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 thorn 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 thorn (see the file COPYING in this directory); +if not, write to the Free Software Foundation, Inc., 59 Temple +Place, Suite 330, Boston, MA 02111-1307 USA