146 lines
4.9 KiB
Text
146 lines
4.9 KiB
Text
/*! \mainpage The MASA Library
|
||
|
||
<b>Version \version</b>, Build Date: \builddate
|
||
|
||
Built by: \builduser on \buildhost
|
||
<hr>
|
||
|
||
\section overview Overview
|
||
|
||
The MASA (Manufactured Analytical Solutions Abstraction) library is
|
||
a software interface that provides access to all manufactured solutions to
|
||
be used by various models throughout the PECOS center.
|
||
The library is written in
|
||
C++, but provides an API for development in C and Fortran.
|
||
|
||
Thanks for your interest in MASA. To aid in usage, this manual is
|
||
further divided into the following subsections:
|
||
|
||
<ul>
|
||
<li> \subpage model "Library Overview" </li>
|
||
<li> \subpage install "Installation/Linkage" </li>
|
||
<li> \link masa.h C/C++ Interface \endlink </li>
|
||
<li> \subpage apif "Fortran Interface" </li>
|
||
<li> \link tut "Tutorial" </li>
|
||
<li> \subpage mms_avail "Available Manufactured Solutions"</li>
|
||
<li> \subpage add_sol "Adding Additional Manufactured Solutions to MASA" </li>
|
||
<li> <a href="http://buildbot.ices.utexas.edu/docs/buildbot/masa/docs/html/lcov/build/src/index.html">Buildbot Coverage</a> </li>
|
||
</ul>
|
||
|
||
<!-- \subpage apiF Fortran API -->
|
||
<!-- \subpage examples Examples -->
|
||
|
||
\section bugs Reporting Bugs
|
||
|
||
Bugs in the code and errors or omissions in the documentation can be
|
||
reported to masa-dev@ices.utexas.edu. Requests and contributions are
|
||
welcome at the same e-mail address. All bug reports should include:
|
||
<ul>
|
||
<li>the version number of the MASA library,
|
||
<li>the hardware and operating system,
|
||
<li>the compiler used, including version number and compilation options,
|
||
<li>a description of the bug behavior, and ideally,
|
||
<li>a short program which reproduces the bug.
|
||
</ul>
|
||
|
||
\section licence License
|
||
Copyright (C) 2010 The PECOS Development Team
|
||
\copydoc LicenseLGPL
|
||
|
||
\section acknowledgements Acknowledgments
|
||
\copydoc Acknowledgments
|
||
|
||
\section pecos-center More Information About PECOS
|
||
\copydoc About2
|
||
|
||
*/
|
||
|
||
|
||
/*! \page model Library Overview
|
||
|
||
\copydoc LicenseLGPL
|
||
|
||
The MASA (Manufactured Analytical Solutions Abstraction) library is a software interface that provides access
|
||
to various manufactured solutions for a wide variety of differential equations. The library is written in C++,
|
||
and provides an API for development in C and Fortran.
|
||
|
||
<h2>Software Verification</h2>
|
||
|
||
Verification of numerical computations, in which one asks if numerical results are an accurate representation of the solution
|
||
to the mathematical model that is being solved, is relatively well understood. It requires
|
||
careful attention to good software engineering practices, continuous software testing, and control of numerical
|
||
discretization errors, through error estimation and adaptivity. While verification processes are well understood,
|
||
they require substantial effort. As verification of numerical results is a prerequisite for reliable computational
|
||
predictions, verification processes are integral to all activities in scientific computation.
|
||
|
||
MASA is designed to simplify the verification process by providing a common repository of manufactured solutions
|
||
for common problems in scientific computation.
|
||
|
||
<h2>Manufactured Solution Generation</h2>
|
||
|
||
The analytical solutions used in this library were generated using symbolic manipulation software, such as Maple.
|
||
|
||
<h2>PECOS Center Background</h2>
|
||
|
||
The Center for Predictive Engineering and COmputational Sciences (PECOS) is a DOE-funded Center
|
||
of Excellence within the Institute for Computational Engineering and Sciences (ICES)
|
||
at The University of Texas at Austin. PECOS is one of five such centers sponsored under
|
||
the Predictive Science Academic Alliance Program (PSAAP) of the National Nuclear Security
|
||
Administration’s Advanced Simulation and Computing Program.
|
||
|
||
PECOS brings together an interdisciplinary, multi-university team with partners at the
|
||
DOE National Labs and NASA. The goal of the PECOS Center is to develop the next generation
|
||
of advanced computational methods for predictive simulation of multiscale, multiphysics phenomena,
|
||
and to apply these methods to the analysis of vehicles reentering the atmosphere. In pursuing
|
||
this research, PECOS is advancing the science and modeling of atmospheric reentry, and
|
||
the science of predictive simulation.
|
||
|
||
<h2> Developers </h2>
|
||
|
||
Developers of the MASA library include:
|
||
|
||
Paul Bauman
|
||
|
||
Kemelli Estacio-Hiroms
|
||
|
||
<a href="mailto:nick@ices.utexas.edu">Nicholas Malaya</a>
|
||
|
||
Todd Oliver
|
||
|
||
Onkar Sahni
|
||
|
||
Karl W. Schulz
|
||
|
||
Chris Simmons
|
||
|
||
Roy Stogner
|
||
|
||
<h2> Citing MASA </h2>
|
||
|
||
A paper detailing the MASA library has been submitted for publication.
|
||
Upon acceptance, this section will be updated.
|
||
Please check back for details on how to cite MASA.
|
||
|
||
*/
|
||
|
||
|
||
/*! \page mms_avail Available Manufactured Solutions
|
||
|
||
The following sections detail all available manufactured solutions in MASA.
|
||
|
||
<ul>
|
||
<li> \subpage heat </li>
|
||
<li> \subpage laplace </li>
|
||
<li> \subpage euler </li>
|
||
<li> \subpage cns </li>
|
||
<li> \subpage sod </li>
|
||
<li> \subpage rans </li>
|
||
</ul>
|
||
|
||
*/
|
||
|
||
/*! \page tut Tutorial
|
||
|
||
The following sections detail all available manufactured solutions in MASA.
|
||
|
||
*/
|