Line data    Source code

       1           1 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : /// \file
       5             : /// Documents the `IrrotationalBns` namespace
       6             : 
       7             : #pragma once
       8             : 
       9             : /*!
      10             :  * \ingroup EllipticSystemsGroup
      11             :  * \brief Items related to solving for irrotational Binary Neutron Star initial
      12             :  * data.
      13             :  *
      14             :  * We solve the equations for the relativistic quasi-equilibrium configuration
      15             :  * associated with an object in a quasi-circular orbit around a binary
      16             :  * companion.  We assume the compact object is nonspinning, which allows the
      17             :  * solution to be written in terms of a "velocity potential", which is a
      18             :  * function \f$\Phi\f$ such that \f$D_i \Phi = \rho h u_i\f$, with \f$ \rho,
      19             :  * h\f$ the rest mass density and specific enthalpy respectively, and \f$u_i \f$
      20             :  * the spatial part of the four velocity
      21             :  *
      22             :  */
      23           1 : namespace BnsInitialData {}