User: zetienne Date: 2013/10/07 11:25 AM

Modified: /trunk/src/ driver_conserv_to_prims.C

Log: Add code description & license info in header to Conserv-to-Prims solver

File Changes:

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

File [modified]: driver_conserv_to_prims.C Delta lines: +27 -3 =================================================================== --- trunk/src/driver_conserv_to_prims.C 2013-10-07 15:24:04 UTC (rev 7) +++ trunk/src/driver_conserv_to_prims.C 2013-10-07 16:25:07 UTC (rev 8) @@ -1,6 +1,30 @@ -// Here is a wrapper for the 2d solver described in Noble et al. -// It is meant to be an interface with their code. -// Note that it assumes a simple gamma law for the moment. No hybrid. +/* We evolve forward in time a set of functions called the + * "conservative variables" forward in time, and any time + * the conserv's are updated, we must solve for the + * primitive variables (rho, pressure, velocities) using a + * Newton-Raphson technique, before reconstructing & + * evaluating the RHSs of the MHD equations again. + * + * This file contains the driver routine for this Newton- + * Raphson solver. Truncation errors in conservative + * variables can lead to no solutions in primitive + * variables. We correct for these errors in the code + * through a number of tricks described in the appendices + * of http://arxiv.org/pdf/1112.0568.pdf. + * + * This is a wrapper for the 2d solver of Noble et al. See + * harm_utoprim_2d.c for references and copyright notice + * for that solver. This wrapper was primarily written by + * Zachariah Etienne & Yuk Tung Liu, in 2011-2013. + * + * For optimal compatibility, this wrapper is licensed under + * the GPL v2 or any later version. + * + * Note that this code assumes a simple gamma law for the + * moment, though it would be easy to extend to a piecewise + * polytrope. */ + + #include <iostream> #include <iomanip> #include <fstream>