From 1198ef6e175f651646fb7989e8cdce06d424d684 Mon Sep 17 00:00:00 2001 From: schnetter Date: Mon, 28 Sep 2009 18:13:48 +0000 Subject: Move thorn TmunuBase from AEIThorns to CactusEinstein. Thorn TmunuBase provides grid functions for the stress-energy tensor T_ab. This allows spacetime codes to be independent of hydrodynamics formulations, or other formulations contributing to the stress-energy tensor. TmunuBase is backwards compatible with the old CalcTmunu.inc mechanism. git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinBase/TmunuBase/trunk@2 b83b3108-af97-48ba-8c81-9293ccf7f924 --- COPYRIGHT | 352 +++++++++++++++++++++++++++++++++++++++++++ README | 9 ++ configuration.ccl | 4 + doc/documentation.tex | 167 ++++++++++++++++++++ interface.ccl | 64 ++++++++ param.ccl | 25 +++ schedule.ccl | 116 ++++++++++++++ src/CopyTmunu.F90 | 44 ++++++ src/SetStressEnergyState.F90 | 20 +++ src/SetTmunu.F | 64 ++++++++ src/TmunuBase_CalcTmunu.inc | 60 ++++++++ src/ZeroTmunu.F90 | 25 +++ src/make.code.defn | 7 + 13 files changed, 957 insertions(+) create mode 100644 COPYRIGHT create mode 100644 README create mode 100644 configuration.ccl create mode 100644 doc/documentation.tex create mode 100644 interface.ccl create mode 100644 param.ccl create mode 100644 schedule.ccl create mode 100644 src/CopyTmunu.F90 create mode 100644 src/SetStressEnergyState.F90 create mode 100644 src/SetTmunu.F create mode 100644 src/TmunuBase_CalcTmunu.inc create mode 100644 src/ZeroTmunu.F90 create mode 100644 src/make.code.defn 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 + +************************************************************************** + + 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. + + + Copyright (C) 19yy + + 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. + + , 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..5e437fa --- /dev/null +++ b/README @@ -0,0 +1,9 @@ +Cactus Code Thorn TmunuBase +Author(s) : Erik Schnetter +Maintainer(s): Cactus team +Licence : LGPL +-------------------------------------------------------------------------- + +1. Purpose + +This thorn provides grid functions for the stress-energy tensor. diff --git a/configuration.ccl b/configuration.ccl new file mode 100644 index 0000000..fa23cbd --- /dev/null +++ b/configuration.ccl @@ -0,0 +1,4 @@ +# Configuration definition for thorn TmunuBase + +# Thorn ADMMacros must be compiled in and activated at run time +REQUIRES THORNS: ADMMacros diff --git a/doc/documentation.tex b/doc/documentation.tex new file mode 100644 index 0000000..6bfaceb --- /dev/null +++ b/doc/documentation.tex @@ -0,0 +1,167 @@ +% 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. + +\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} + +\author{Erik Schnetter \textless schnetter@cct.lsu.edu\textgreater} + +\title{TmunuBase} + +\date{2008-04-07} + +\maketitle + +% Do not delete next line +% START CACTUS THORNGUIDE + +\begin{abstract} + Provide grid functions for the stress-energy tensor $T_{\mu\nu}$, + and schedule when these grid functions are calculated. This allows + different thorns to cooperate without explicitly depending on each + other. This thorn is compatible with the \texttt{CalcTmumu.inc} + interface, in the sense that thorns using this interface will work + correctly with TmunuBase. Thorn TmunuBase is for the stress-energy + tensor what thorn ADMBase is for the metric tensor. +\end{abstract} + +\section{Introduction} + +Thorn \texttt{TmunuBase} provides core infrastructure for thorns +implementing some kind of energy or matter in general relativity, for +example general relativistic hydrodynamics formulations. It provides +the basic variables, i.e., the stress-energy tensor $T_{\mu\nu}$, in +addition to a set of parameters to regulate their use. These +variables are used to communicate between (possibly multiple) thorns +contributing to the stress-energy content of the spacetime, and thorns +needing to evaluate the stress-energy tensor such as spacetime +evolution methods. It also provides schedule groups to manage when +$T_{\mu\nu}$ is calculated and when it is ready for access. + +\section{Using TmunuBase} + +\subsection{Variables} + +TmunuBase weakly assumes (but does not require) that the spacetime is +described in terms of a $3+1$ decomposition. The variables provided +by \texttt{TmunuBase} are: +\begin{itemize} +\item The ``scalar'' part of $T_{\mu\nu}$, its time-time component: + \texttt{eTtt} +\item The ``vector'' part of $T_{\mu\nu}$, its time-space components: + \texttt{eTtx}, \texttt{eTty}, \texttt{eTtz} +\item The ``tensor'' part of $T_{\mu\nu}$, its space-space components: + \texttt{eTxx}, \texttt{eTxy}, \texttt{eTxz}, \texttt{eTyy}, + \texttt{eTyz}, \texttt{eTzz} +\end{itemize} +These components have the prefix \texttt{e} to avoid naming conflicts +with existing variables. Many thorns dealing with matter already use +variable names such as \texttt{Ttt}. + +These variables have up to three time levels. + +\subsection{Parameters} + +By default, the TmunuBase variables have no storage, and TmunuBase is +inactive. This makes it possible to add a matter interface to +existing vacuum spacetime methods without changing their behaviour. + +Several parameters choose how TmunuBase behaves at run time: +\begin{itemize} +\item The parameter \texttt{stress\_energy\_storage} activates storage + for $T_{\mu\nu}$ and enables the schedule groups which calculate it. +\item The parameter \texttt{stress\_energy\_at\_RHS} moves calculating + the $T_{\mu\nu}$ from the \texttt{evol} bin into the + \texttt{MoL\_PostStep} group. This increases the order of accuracy + of the spacetime--matter coupling, but is only possible when thorn + MoL is used.\footnote{This was one of the main reason why thorn MoL + was instroduced.} Generally, this parameter should be set when + MoL is used. +\item The parameter \texttt{timelevels} chooses the number of time + levels for $T_{\mu\nu}$. The default is a single time level, which + is sufficient for unigrid simulation. Mesh refinement simulation + may require several time levels if mesh refinement boundaries + require correct values. +\item The parameter \texttt{prolongation\_type} defines the + prolongation operator for mesh refinement boundaries. The default + is Lagrange interpolation. +\end{itemize} + +The grid scalar \texttt{stress\_energy\_state} describes whether the +$T_{\mu\nu}$ variables have storage. + +\section{Programming with TmunuBase} + +\subsection{Contributing to $T_{\mu\nu}$} + +There may be multiple thorns contributing to $T_{\mu\nu}$. Therefore, +thorn TmunuBase initialises $T_{\mu\nu}$ to zero, and each thorn has +to add to the existing values in $T_{\mu\nu}$. The corresponding +routine should be scheduled in the bin \texttt{AddToTmunu}. +\emph{Note:} Do not schedule anything in the schedule bin +\texttt{SetTmunu}. + +\subsection{Reading from $T_{\mu\nu}$} + +Since the values of $T_{\mu\nu}$ change at each time step, or -- if a +thorn like \texttt{MoL} is used -- at each substep, $T_{\mu\nu}$ needs +to be recalculated frequently. This happens either in the schedule +bin \texttt{evol} or in the schedule group \texttt{MoL\_PostStep}. +$T_{\mu\nu}$ may only be accessed after it has been calculated, e.g.\ +\texttt{IN MoL\_PostStep AFTER SetTmunu}. $T_{\mu\nu}$ can be freely +accessed at other times, e.g.\ in \texttt{MoL\_CalcRHS} or at +\texttt{poststep} or \texttt{analyisis}. + +\section{Compatibility to ADMCoupling} + +Cactus provides another interface for contributing to the +stress-energy tensor, called \texttt{CalcTmunu}. This alternative +interface (which is described in thorn \texttt{ADMCoupling}) requires +writing routines in fixed-format Fortran 77 and inserting lines of +code into a file \texttt{CalcTmunu.inc}. We suggest to use exactly +one of these two interface and not to mix them. + +Thorn TmunuBase takes contributions from the \texttt{CalcTmunu} +interface automatically into account as well. It also collects the +values which are added to its $T_{\mu\nu}$ and provides these to other +thorns which use the \texttt{CalcTmunu.inc} interface. That is, thorn +TmunuBase is fully backwards compatible. + +\subsection{Comparison to ADMCoupling} + +The \texttt{CalcTmunu} interface and this thorn TmunuBase make +different space/performance tradeoffs. \texttt{CalcTmunu} does not +store any components of the stress-energy tensor, which saves memory +and is also more efficient if its components can be quickly calculated +from other variables (presumably the state vector of a hydrodynamics +thorn). + +TmunuBase requires explicit storage for $T_{\mu\nu}$. This is +necessary if $T_{\mu\nu}$ needs to be interpolated e.g.\ for dynamical +horizon calculations. Compared to the overall number of grid function +in a typical simulation the number of additional variables is +tolerable (typical numbers are 10 additional variables with 200 +existing variables). With the exception of the parts ensuring +compatibility to \texttt{CalcTmunu}, TmunuBase is also a much simpler +and more flexible mechanism. + +\subsection{Acknowledgements} + +We thank I. Hawke for designing and implementing thorn MoL, without +which a generic high-order coupling between spacetime and +hydrodynamics methods would not be possible. + +% Do not delete next line +% END CACTUS THORNGUIDE + +\end{document} diff --git a/interface.ccl b/interface.ccl new file mode 100644 index 0000000..b45fcb7 --- /dev/null +++ b/interface.ccl @@ -0,0 +1,64 @@ +# Interface definition for thorn TmunuBase + +IMPLEMENTS: TmunuBase + +INHERITS: ADMBase StaticConformal + +FRIEND: ADMCoupling + +INCLUDES SOURCE: TmunuBase_CalcTmunu.inc IN CalcTmunu.inc + + + +# These are our grid functions. +# They contain T_munu, the complete stress energy tensor. + +PUBLIC: + +INT stress_energy_state TYPE=scalar "State of storage for stress-energy tensor" + +REAL stress_energy_scalar TYPE=gf TIMELEVELS=3 TAGS='tensortypealias="Scalar" ProlongationParameter="TmunuBase::prolongation_type"' +{ + eTtt +} "Stress-energy tensor, 3-scalar part T_00" + +REAL stress_energy_vector TYPE=gf TIMELEVELS=3 TAGS='tensortypealias="D" ProlongationParameter="TmunuBase::prolongation_type"' +{ + eTtx eTty eTtz +} "Stress-energy tensor, 3-vector part T_0i" + +REAL stress_energy_tensor TYPE=gf TIMELEVELS=3 TAGS='tensortypealias="DD_sym" ProlongationParameter="TmunuBase::prolongation_type"' +{ + eTxx eTxy eTxz eTyy eTyz eTzz +} "Stress-energy tensor, 3-tensor part T_ij" + + + +# These are (almost) copies our grid functions. +# They contain T_munu, the stress energy tensor, excluding the contributions +# that other thorns add via the CalcTmunu.inc mechanism. +# That is, this copy includes only the contributions from the AddToTmunu +# mechanism. + +# This copy is protected, so that it is pushed into ADMCoupling's list of +# grid functions, so that other thorns can access it implicitly via the +# CalcTmunu.inc mechanism. + +PROTECTED: + +INT stress_energy_2_state TYPE=scalar "State of storage for stress-energy tensor" + +REAL stress_energy_2_scalar TYPE=gf TAGS='tensortypealias="Scalar" checkpoint="no" prolongation="none"' +{ + eT2tt +} "Stress-energy tensor, 3-scalar part T_00" + +REAL stress_energy_2_vector TYPE=gf TAGS='tensortypealias="D" checkpoint="no" prolongation="none"' +{ + eT2tx eT2ty eT2tz +} "Stress-energy tensor, 3-vector part T_0i" + +REAL stress_energy_2_tensor TYPE=gf TAGS='tensortypealias="DD_sym" checkpoint="no" prolongation="none"' +{ + eT2xx eT2xy eT2xz eT2yy eT2yz eT2zz +} "Stress-energy tensor, 3-tensor part T_ij" diff --git a/param.ccl b/param.ccl new file mode 100644 index 0000000..8b6ed2b --- /dev/null +++ b/param.ccl @@ -0,0 +1,25 @@ +# Parameter definitions for thorn TmunuBase + +BOOLEAN stress_energy_storage "Should the stress-energy tensor have storage?" +{ +} no + +BOOLEAN stress_energy_at_RHS "Should the stress-energy tensor be calculated for the RHS evaluation?" +{ +} no + +BOOLEAN support_old_CalcTmunu_mechanism "Should the old CalcTmunu.inc mechanism be supported?" +{ +} yes + +INT timelevels "Number of time levels" +{ + 0:3 :: "" +} 1 + +STRING prolongation_type "The kind of boundary prolongation for the stress-energy tensor" +{ + "^Lagrange$" :: "standard prolongation (requires several time levels)" + "^none$" :: "no prolongation (use this if you do not have enough time levels active)" + "" :: "any other supported prolongation type" +} "Lagrange" diff --git a/schedule.ccl b/schedule.ccl new file mode 100644 index 0000000..6e5b65a --- /dev/null +++ b/schedule.ccl @@ -0,0 +1,116 @@ +# Schedule definitions for thorn TmunuBase + +STORAGE: stress_energy_state +STORAGE: stress_energy_2_state + + + +# Initialise stuff + +SCHEDULE TmunuBase_SetStressEnergyState AT basegrid +{ + LANG: Fortran + OPTIONS: global +} "Set the stress_energy_state variable" + + + +# Do nothing unless storage is requested + +if (stress_energy_storage) +{ + + # Storage management + + if (timelevels == 1) + { + STORAGE: stress_energy_scalar[1] + STORAGE: stress_energy_vector[1] + STORAGE: stress_energy_tensor[1] + } + else if (timelevels == 2) + { + STORAGE: stress_energy_scalar[2] + STORAGE: stress_energy_vector[2] + STORAGE: stress_energy_tensor[2] + } + else if (timelevels == 3) + { + STORAGE: stress_energy_scalar[3] + STORAGE: stress_energy_vector[3] + STORAGE: stress_energy_tensor[3] + } + + if (support_old_CalcTmunu_mechanism) + { + STORAGE: stress_energy_2_scalar + STORAGE: stress_energy_2_vector + STORAGE: stress_energy_2_tensor + } + + + + # Calculate T_munu after the initial data + + SCHEDULE GROUP SetTmunu AT initial AFTER (ADMBase_InitialData ADMBase_InitialGauge Whisky_Initial) + { + } "Calculate the stress-energy tensor" + + # Calculate T_munu during evolution; + # either within MoL, or (the default) after each time step + + # if (stress_energy_at_RHS) + # { + # SCHEDULE GROUP SetTmunu IN MoL_PostStep AFTER Whisky_PostStep + # { + # } "Calculate the stress-energy tensor" + # } else { + # SCHEDULE GROUP SetTmunu AT evol AFTER MoL_Evolution + # { + # } "Calculate the stress-energy tensor" + # } + if (stress_energy_at_RHS) + { + SCHEDULE GROUP SetTmunu IN MoL_PreStep + { + } "Group for calculating the stress-energy tensor" + } + SCHEDULE GROUP SetTmunu AT evol AFTER MoL_Evolution + { + } "Group for calculating the stress-energy tensor" + + + + # This is how T_munu is calculated. + # First it is set via the CalcTmunu.inc mechanism, + # then other thorns can add to that via the AddToTmunu mechanism. + # In the end, the copy T2munu is calculated. + + if (support_old_CalcTmunu_mechanism) + { + SCHEDULE TmunuBase_SetTmunu IN SetTmunu + { + LANG: Fortran + } "Calculate the stress-energy tensor using the old CalcTmunu mechanism" + } + else + { + SCHEDULE TmunuBase_ZeroTmunu IN SetTmunu + { + LANG: Fortran + } "Initialise the stress-energy tensor to zero" + } + + SCHEDULE GROUP AddToTmunu IN SetTmunu AFTER TmunuBase_SetTmunu + { + } "Add to the stress-energy tensor here" + + if (support_old_CalcTmunu_mechanism) + { + SCHEDULE TmunuBase_CopyTmunu IN SetTmunu AFTER AddToTmunu + { + LANG: Fortran + } "Copy the stress-energy tensor" + } + +} /* if stress_energy_storage */ diff --git a/src/CopyTmunu.F90 b/src/CopyTmunu.F90 new file mode 100644 index 0000000..dde5804 --- /dev/null +++ b/src/CopyTmunu.F90 @@ -0,0 +1,44 @@ +#include "cctk.h" +#include "cctk_Arguments.h" +#include "cctk_Parameters.h" + + + +! Calculate the T2munu copy. +! On input, T2munu contains the contribution to Tmunu that is calculated +! via the CalcTmunu.inc mechanism, and Tmunu contains the complete stress +! energy tensor. +! On output, T2munu should contain the contribution to Tmunu that is +! calculated via the AddToTmunu mechanism. +! We just need to calculate the difference. + +subroutine TmunuBase_CopyTmunu (CCTK_ARGUMENTS) + implicit none + DECLARE_CCTK_ARGUMENTS + DECLARE_CCTK_PARAMETERS + + if (support_old_CalcTmunu_mechanism == 0) then + call CCTK_WARN (0, "internal error") + end if + + if (stress_energy_state == 0) then + call CCTK_WARN (1, "The stress energy tensor does not have storage") + return + end if + + stress_energy_2_state = stress_energy_state + + eT2tt = eTtt - eT2tt + + eT2tx = eTtx - eT2tx + eT2ty = eTty - eT2ty + eT2tz = eTtz - eT2tz + + eT2xx = eTxx - eT2xx + eT2xy = eTxy - eT2xy + eT2xz = eTxz - eT2xz + eT2yy = eTyy - eT2yy + eT2yz = eTyz - eT2yz + eT2zz = eTzz - eT2zz + +end subroutine TmunuBase_CopyTmunu diff --git a/src/SetStressEnergyState.F90 b/src/SetStressEnergyState.F90 new file mode 100644 index 0000000..2418555 --- /dev/null +++ b/src/SetStressEnergyState.F90 @@ -0,0 +1,20 @@ +#include "cctk.h" +#include "cctk_Arguments.h" +#include "cctk_Parameters.h" + + + +! Set the stress energy (storage) state grid scalar from the parameter. + +subroutine TmunuBase_SetStressEnergyState (CCTK_ARGUMENTS) + implicit none + DECLARE_CCTK_ARGUMENTS + DECLARE_CCTK_PARAMETERS + + stress_energy_state = stress_energy_storage + if (support_old_CalcTmunu_mechanism /= 0) then + stress_energy_2_state = stress_energy_state + else + stress_energy_2_state = 0 + end if +end subroutine TmunuBase_SetStressEnergyState diff --git a/src/SetTmunu.F b/src/SetTmunu.F new file mode 100644 index 0000000..36dbd0d --- /dev/null +++ b/src/SetTmunu.F @@ -0,0 +1,64 @@ +#include "cctk.h" +#include "cctk_Arguments.h" +#include "cctk_Functions.h" +#include "cctk_Parameters.h" + + + +c Calculate the contribution to the stress energy tensor T_munu +c which are calcualated via the CalcTmunu.inc mechanism. +c Then make a copy of that into the T2munu variables. + + subroutine TmunuBase_SetTmunu (CCTK_ARGUMENTS) + implicit none + DECLARE_CCTK_ARGUMENTS + DECLARE_CCTK_FUNCTIONS + DECLARE_CCTK_PARAMETERS + +#define TMUNUBASE_SETTMUNU + +#include "CactusEinstein/ADMMacros/src/macro/STRESSENERGY_declare.h" + + integer i, j, k + + do k = 1, cctk_lsh(3) + do j = 1, cctk_lsh(2) + do i = 1, cctk_lsh(1) + +#include "CactusEinstein/ADMMacros/src/macro/STRESSENERGY_guts.h" + + eTtt(i,j,k) = Ttt + + eTtx(i,j,k) = Ttx + eTty(i,j,k) = Tty + eTtz(i,j,k) = Ttz + + eTxx(i,j,k) = Txx + eTxy(i,j,k) = Txy + eTxz(i,j,k) = Txz + eTyy(i,j,k) = Tyy + eTyz(i,j,k) = Tyz + eTzz(i,j,k) = Tzz + +#include "CactusEinstein/ADMMacros/src/macro/STRESSENERGY_undefine.h" + + end do + end do + end do + +#undef TMUNUBASE_SETTMUNU + + eT2tt = eTtt + + eT2tx = eTtx + eT2ty = eTty + eT2tz = eTtz + + eT2xx = eTxx + eT2xy = eTxy + eT2xz = eTxz + eT2yy = eTyy + eT2yz = eTyz + eT2zz = eTzz + + end diff --git a/src/TmunuBase_CalcTmunu.inc b/src/TmunuBase_CalcTmunu.inc new file mode 100644 index 0000000..8cc9571 --- /dev/null +++ b/src/TmunuBase_CalcTmunu.inc @@ -0,0 +1,60 @@ +/* Add the contributions to T_munu that we gathered via the AddToTmunu + mechanism, using the CalcTmunu.inc mechanism. */ + + + +/* Only add if we are not included from this thorn; otherwise we would + be adding to ourselves. */ +#ifndef TMUNUBASE_SETTMUNU + +#ifdef CCODE + + if (* stress_energy_2_state) + { + +#ifndef NDEBUG + if ((ijk) < 0 || (ijk) >= cctk_lsh[0] * cctk_lsh[1] * cctk_lsh[2]) + { + CCTK_WARN (0, "Illegal array index"); + } +#endif + + Ttt += eT2tt[ijk]; + + Ttx += eT2tx[ijk]; + Tty += eT2ty[ijk]; + Ttz += eT2tz[ijk]; + + Txx += eT2xx[ijk]; + Txy += eT2xy[ijk]; + Txz += eT2xz[ijk]; + Tyy += eT2yy[ijk]; + Tyz += eT2yz[ijk]; + Tzz += eT2zz[ijk]; + + } + +#endif + +#ifdef FCODE + + if (stress_energy_2_state .ne. 0) then + + Ttt = Ttt + eT2tt(i,j,k) + + Ttx = Ttx + eT2tx(i,j,k) + Tty = Tty + eT2ty(i,j,k) + Ttz = Ttz + eT2tz(i,j,k) + + Txx = Txx + eT2xx(i,j,k) + Txy = Txy + eT2xy(i,j,k) + Txz = Txz + eT2xz(i,j,k) + Tyy = Tyy + eT2yy(i,j,k) + Tyz = Tyz + eT2yz(i,j,k) + Tzz = Tzz + eT2zz(i,j,k) + + end if + +#endif + +#endif /* ifndef TMUNUBASE_SETTMUNU */ diff --git a/src/ZeroTmunu.F90 b/src/ZeroTmunu.F90 new file mode 100644 index 0000000..c99b169 --- /dev/null +++ b/src/ZeroTmunu.F90 @@ -0,0 +1,25 @@ +#include "cctk.h" +#include "cctk_Arguments.h" + + + +! Initialise Tmunu to zero + +subroutine TmunuBase_ZeroTmunu (CCTK_ARGUMENTS) + implicit none + DECLARE_CCTK_ARGUMENTS + + eTtt = 0 + + eTtx = 0 + eTty = 0 + eTtz = 0 + + eTxx = 0 + eTxy = 0 + eTxz = 0 + eTyy = 0 + eTyz = 0 + eTzz = 0 + +end subroutine TmunuBase_ZeroTmunu diff --git a/src/make.code.defn b/src/make.code.defn new file mode 100644 index 0000000..4f58c44 --- /dev/null +++ b/src/make.code.defn @@ -0,0 +1,7 @@ +# Main make.code.defn file for thorn TmunuBase + +# Source files in this directory +SRCS = CopyTmunu.F90 SetStressEnergyState.F90 SetTmunu.F ZeroTmunu.F90 + +# Subdirectories containing source files +SUBDIRS = -- cgit v1.2.3