diff options
Diffstat (limited to 'Carpet/Carpet/src/Doxygen.hh')
| -rw-r--r-- | Carpet/Carpet/src/Doxygen.hh | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/Carpet/Carpet/src/Doxygen.hh b/Carpet/Carpet/src/Doxygen.hh new file mode 100644 index 000000000..edd2ff9a5 --- /dev/null +++ b/Carpet/Carpet/src/Doxygen.hh @@ -0,0 +1,32 @@ +/** + \file + + \mainpage + + \author Erik Schnetter + \date August, 2010 + + http://www.carpetcode.org + + %Carpet is a parallel AMR (adaptive mesh refinement) driver with MPI + for Cactus. This documentation is for developers of %Carpet (users + of %Carpet should instead see the User Documentation obtained by + typing "make Carpet-ThornDoc" in the Cactus directory). + + Important source files: + + Carpet/src/Initialise.cc + + Carpet/src/Evolve.cc + + Carpet/src/Recompose.cc + + Important classes: + + vect + bbox + bboxset + Carpet::bbvect + region_t + +*/ |