binaire.h

/*
 *  Definition of Lorene class Binaire
 *
 */

/*
 *   Copyright (c) 2000-2003 Eric Gourgoulhon
 *
 *   This file is part of LORENE.
 *
 *   LORENE 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.
 *
 *   LORENE 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 LORENE; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


#ifndef __BINAIRE_H_ 
#define __BINAIRE_H_ 

/*
 * $Id: binaire.h,v 1.7 2017/02/24 15:34:59 j_novak Exp $
 * $Log: binaire.h,v $
 * Revision 1.7  2017/02/24 15:34:59  j_novak
 * Removal of spurious comments
 *
 * Revision 1.6  2014/10/13 08:52:32  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.5  2009/06/18 18:42:13  k_taniguchi
 * Defined a slightly modified code to determine
 * the orbital angular velocity.
 *
 * Revision 1.4  2003/09/15 15:09:47  e_gourgoulhon
 * Added the member function write_global.
 *
 * Revision 1.3  2002/06/17 14:05:16  j_novak
 * friend functions are now also declared outside the class definition
 *
 * Revision 1.2  2001/12/20 13:00:31  k_taniguchi
 * Addition of the Komar mass, the virial error by Gourgoulhon and Bonazzola, and the virial error by Friedman, Uryu, and Shibata.
 *
 * Revision 1.1.1.1  2001/11/20 15:19:27  e_gourgoulhon
 * LORENE
 *
 * Revision 2.11  2001/02/28  14:27:32  keisuke
 * *** empty log message ***
 *
 * Revision 2.10  2000/07/07  14:10:04  eric
 * AJout de display_poly.
 *
 * Revision 2.9  2000/03/17  15:26:53  eric
 * Ajout de la fonction analytical_omega.
 *
 * Revision 2.8  2000/03/15  16:43:12  eric
 * Ajout de la fonction analytical_shift().
 *
 * Revision 2.7  2000/03/13  14:24:50  eric
 * Ajout des membres p_ham_constr et p_mom_constr ainsi que des
 * fonctions de calcul associees (verification des equations de contrainte).
 *
 * Revision 2.6  2000/02/18  14:52:05  eric
 * Ajout des membres p_virial et p_total_ener et des fonctions de calcul
 * associees.
 *
 * Revision 2.5  2000/02/12  17:36:39  eric
 * Ajout de la fonction separation().
 *
 * Revision 2.4  2000/02/12  17:09:02  eric
 * Ajout de la fonction orbit.
 *
 * Revision 2.3  2000/02/04  17:15:05  eric
 *  Ajout du membre ref_triad.
 *
 * Revision 2.2  2000/02/02  10:13:08  eric
 * Ajout des fonctions de lecture/ecriture omega, x_axe.
 *
 * Revision 2.1  2000/01/31  17:01:46  eric
 * *** empty log message ***
 *
 * Revision 2.0  2000/01/31  15:57:39  eric
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/binaire.h,v 1.7 2017/02/24 15:34:59 j_novak Exp $
 *
 */

#include "etoile.h"

namespace Lorene {
class Binaire {

    // Data : 
    // -----
    private: 
    const Base_vect_cart ref_triad ; 
    
    Etoile_bin star1 ;
     
    Etoile_bin star2 ;
    
    Etoile_bin* et[2] ; 
    
    double omega ;
    
    double x_axe ;
    
    // Derived data : 
    // ------------
    private: 
    mutable double* p_mass_adm ; 

    mutable double* p_mass_kom ; 

    mutable Tbl* p_angu_mom ; 

    mutable double* p_total_ener ; 

    mutable double* p_virial ; 

    mutable double* p_virial_gb ; 

    mutable double* p_virial_fus ; 
    
    mutable double* p_ham_constr ;
    
    mutable Tbl* p_mom_constr ;


    // Constructors - Destructor
    // -------------------------
    public:
    Binaire(Map& mp1, int nzet1, const Eos& eos1, int irrot1, 
        Map& mp2, int nzet2, const Eos& eos2, int irrot2,
        int relat) ;            


    Binaire(const Binaire& ) ;      

    Binaire(Map& mp1, const Eos& eos1, Map& mp2, const Eos& eos2, 
        FILE* fich) ;           

    ~Binaire() ;            
 

    // Memory management
    // -----------------
    private: 
    void del_deriv() const ; 
    
    void set_der_0x0() const ; 

    // Mutators / assignment
    // ---------------------
    public:
    void operator=(const Binaire&) ;    
    
    Etoile_bin& set(int i) 
        { assert( (i==1) || (i==2) ); 
          del_deriv() ; 
          return *et[i-1] ;} ; 

    double& set_omega() {return omega; } ; 

    double& set_x_axe() {return x_axe; } ; 
    

    // Accessors
    // ---------
    public:
    const Etoile_bin& operator()(int i) const 
        { assert( (i==1) || (i==2) ); 
          return *et[i-1] ;} ; 

    double get_omega() const {return omega; } ; 
    
    double get_x_axe() const {return x_axe; } ; 

    double separation() const ; 

    // Outputs
    // -------
    public:
    void sauve(FILE *) const ;      
    
    // Display
    friend ostream& operator<<(ostream& , const Binaire& ) ;    
    
    void display_poly(ostream& ) const ; 

    void write_global(ostream& ) const  ;
    
    private:
    ostream& operator>>(ostream& ) const ;    
    

    // Computational routines
    // ----------------------
    public:
        double mass_adm() const ;

        double mass_kom() const ;
    
        const Tbl& angu_mom() const ;   

        double total_ener() const ; 

        double virial() const ; 

        double virial_gb() const ;  

        double virial_fus() const ; 

        double ham_constr() const ; 

        const Tbl& mom_constr() const ; 

    void orbit(double fact_omeg_min, double fact_omeg_max, double& xgg1, 
           double& xgg2) ;
       
    void orbit_eqmass(double fact_omeg_min, double fact_omeg_max,
              double mass1, double mass2,
              double& xgg1, double& xgg2) ;

    void analytical_omega() ; 

    void analytical_shift() ; 

};
ostream& operator<<(ostream& , const Binaire& ) ;   

}
#endif