binary.h

/*
 *  Definition of Lorene class Binary
 *
 */

/*
 *   Copyright (c) 2004  Limousin Francois
 *
 *   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 version 2
 *   as published by the Free Software Foundation.
 *
 *   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 __BINARY_H_ 
#define __BINARY_H_ 

/*
 * $Id: binary.h,v 1.10 2014/10/13 08:52:32 j_novak Exp $
 * $Log: binary.h,v $
 * Revision 1.10  2014/10/13 08:52:32  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.9  2006/04/11 14:26:12  f_limousin
 * New version of the code : improvement of the computation of some
 * critical sources, estimation of the dirac gauge, helical symmetry...
 *
 * Revision 1.8  2005/11/08 20:17:55  f_limousin
 * Add function dirac_gauge() used to impose Dirac gauge during an iteration.
 *
 * Revision 1.7  2005/09/15 15:56:28  e_gourgoulhon
 * Made the documentation compliant with Doxygen.
 *
 * Revision 1.6  2005/09/13 19:38:32  f_limousin
 * Reintroduction of the resolution of the equations in cartesian coordinates.
 *
 * Revision 1.5  2004/07/21 11:45:20  f_limousin
 * Add function mass_adm_vol() to compute the ADM mass of the system
 * with a volume integral instead of a surface one.
 *
 * Revision 1.4  2004/05/25 14:50:06  f_limousin
 * Add the virial theorem for conformally flat configurations.
 *
 * Revision 1.3  2004/01/20 15:25:39  f_limousin
 * Nex class binary
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/binary.h,v 1.10 2014/10/13 08:52:32 j_novak Exp $
 *
 */

// Lorene headers
#include "star.h"

namespace Lorene {
class Binary {

    // Data : 
    // -----
    protected:

    Star_bin star1 ;
     
    Star_bin star2 ;
    
    Star_bin* et[2] ; 
    
    double omega ;
    
    double x_axe ;


    // Derived data : 
    // ------------
    protected:
    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_ham_constr ;
    
    mutable Tbl* p_mom_constr ;

    

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


    Binary(const Binary& ) ;        

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

    ~Binary() ;         
 


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


    // Mutators / assignment
    // ---------------------
    public:
    void operator=(const Binary&) ; 
    
    Star_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 Star_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 ;      
    
    friend ostream& operator<<(ostream& , const Binary& ) ; 

    void display_poly(ostream& ) const ; 

    void write_global(ostream& ) const  ;

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


    // Computational routines
    // ----------------------
    public:

        double mass_adm() const ;

        double mass_adm_vol() const ;

        double mass_kom() const ;
    
        double mass_kom_vol() const ;

        const Tbl& angu_mom() const ;   

        double total_ener() const ; 

        double virial() 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 analytical_omega() ; 

    void analytical_shift() ; 

    void fait_decouple () ;

    void dirac_gauge() ;

    void helical() ;

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

}
#endif