star_rot_diff_cfc.C

/*
 *  Methods of class Star_rot_diff_CFC
 *
 *    (see file star_rot_diff_cfc.h for documentation).
 *
 */

/*
 *   Copyright (c) 2025 Santiago Jaraba
 *
 *   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
 *
 */

 // Lorene headers
#include "star_rot_diff_cfc.h"
#include "eos.h"
#include "nbr_spx.h"
#include "utilitaires.h"
#include "unites.h"   


                   //--------------//
                   // Constructors //
                   //--------------//

// Standard constructor
//-------------------------
namespace Lorene {
Star_rot_diff_CFC::Star_rot_diff_CFC(Map& mpi, int nzet_i, const Eos& eos_i, int relat_i, int filter,
                double (*omega_frot_i)(double, const Tbl&), 
                double (*primfrot_i)(double, const Tbl&), 
                const Tbl& par_frot_i)
                        :Star_rot_CFC(mpi, nzet_i, eos_i, relat_i, filter),
                omega_frot(omega_frot_i), 
                primfrot(primfrot_i), 
                par_frot(par_frot_i), 
                omega_field(mpi), 
                prim_field(mpi)
                {
    
    // To make sure that omega is not used
    omega = __infinity ;

    // Initialization to a static state : 
    omega_field = 0 ; 
    prim_field = 0 ; 
    omega_min = 0 ;
    omega_max = 0 ; 
    
} 

// Copy constructor
//-----------------
Star_rot_diff_CFC::Star_rot_diff_CFC(const Star_rot_diff_CFC& star)
                   : Star_rot_CFC(star), 
                 omega_frot(star.omega_frot), 
                 primfrot(star.primfrot), 
             par_frot(star.par_frot), 
             omega_field(star.omega_field), 
             omega_min(star.omega_min), 
             omega_max(star.omega_max),  
             prim_field(star.prim_field)
             {}

//Constructor from a file
//------------------------
Star_rot_diff_CFC::Star_rot_diff_CFC(Map& mpi, const Eos& eos_i, FILE* fich,
             double (*omega_frot_i)(double, const Tbl&), 
             double (*primfrot_i)(double, const Tbl&) )
            : Star_rot_CFC(mpi, eos_i, fich),
              omega_frot(omega_frot_i), 
              primfrot(primfrot_i), 
              par_frot(fich), 
              omega_field(mpi), 
              prim_field(mpi)
             {

    Scalar omega_field_file(mp, *(mp.get_mg()), fich) ; 
    omega_field = omega_field_file ; 
    fait_prim_field() ; 
                
    // omega_min and omega_max are read in the file:     
    fread_be(&omega_min, sizeof(double), 1, fich) ;     
    fread_be(&omega_max, sizeof(double), 1, fich) ; 
    
    // Overwriting the call on construction in Star_rot_CFC, which uses omega instead of omega_field
    hydro_euler() ;

    // Recomputing \hat{A}^{ij} and its norm, necessary for correct GRV2 and GRV3
    //------------------------------------------
    Vector sou_Xi = 2*Unites::qpig*psi4*psi4*psi2*j_euler ;
    double lambda = 1./3. ;
    Vector Xi_new = sou_Xi.poisson(lambda) ;
    
    hatA = Xi_new.ope_killing_conf(flat) ;
    hatA_quad = contract(hatA, 0, 1, hatA.up_down(flat), 0, 1) ;

}

                      //------------// 
                      // Destructor //
                      //------------//

Star_rot_diff_CFC::~Star_rot_diff_CFC(){}

                    //---------------//
                    //  Assignment   //
                    //---------------//   

// Assignment to another Star_rot_Dirac_diff
// ------------------------------------

void Star_rot_diff_CFC::operator=(const Star_rot_diff_CFC& star) {

    // Assignment of quantities common to all the derived classes of 
    // Star_rot_CFC
    Star_rot_CFC::operator=(star) ;

    // Assignment of proper quantities of class Star_rot
   omega_frot = star.omega_frot ; 
   primfrot = star.primfrot ; 
   par_frot = star.par_frot ; 
   omega_field = star.omega_field ; 
   prim_field = star.prim_field ; 
   omega_min = star.omega_min ; 
   omega_max = star.omega_max ; 

}


                //--------------//
                //    Outputs   //
                //--------------//

// Save in a file
// --------------

void Star_rot_diff_CFC::sauve(FILE* fich) const {

    Star_rot_CFC::sauve(fich) ;

    par_frot.sauve(fich) ; 
  
    omega_field.sauve(fich) ; 
  
    fwrite_be(&omega_min, sizeof(double), 1, fich) ;        
    fwrite_be(&omega_max, sizeof(double), 1, fich) ;        

}


// Printing
// --------

ostream& Star_rot_diff_CFC::operator>>(ostream& ost) const {
    
  using namespace Unites ;
  
    Star_rot_CFC::operator>>(ost) ; 

    // TODO: check this section and figure out what to output
    
    ost << endl ; 
    ost << "Differentially rotating  star" << endl ; 
    ost << "-----------------------------" << endl ; 
    
    ost << endl << "Parameters of Omega(F) : " << endl ; 
    ost << par_frot << endl ; 
    
    ost << "Min, Max of Omega/(2pi) : " << omega_min / (2*M_PI) * f_unit 
        << " Hz,  " << omega_max / (2*M_PI) * f_unit << " Hz" << endl ; 
    int lsurf = nzet - 1; 
    int nt = mp.get_mg()->get_nt(lsurf) ; 
    int nr = mp.get_mg()->get_nr(lsurf) ; 
    ost << "Central, equatorial value of Omega:        "
    << omega_field.val_grid_point(0, 0, 0, 0) * f_unit << " rad/s,   " 
    << omega_field.val_grid_point(nzet-1, 0, nt-1, nr-1) * f_unit << " rad/s" << endl ; 
    
    ost << "Central, equatorial value of Omega/(2 Pi): "
    << omega_field.val_grid_point(0, 0, 0, 0) * f_unit / (2*M_PI) << " Hz,      " 
    << omega_field.val_grid_point(nzet-1, 0, nt-1, nr-1) * f_unit / (2*M_PI) 
    << " Hz" << endl ; 

    double nbar_max = max( max( nbar ) ) ; 
    double ener_max = max( max( ener ) ) ; 
    double press_max = max( max( press ) ) ; 
    ost << "Max prop. bar. dens. :          " << nbar_max 
    << " x 0.1 fm^-3 = " << nbar_max / nbar.val_grid_point(0, 0, 0, 0) << " central"
    << endl ; 
    ost << "Max prop. ener. dens. (e_max) : " << ener_max
    << " rho_nuc c^2 = " << ener_max / ener.val_grid_point(0, 0, 0, 0) << " central"
    << endl ; 
    ost << "Max pressure :                  " << press_max
    << " rho_nuc c^2 = " << press_max / press.val_grid_point(0, 0, 0, 0) << " central"
    << endl ; 
   
    // Length scale set by the maximum energy density:
    double len_rho = 1. / sqrt( ggrav * ener_max ) ;
    ost << endl << "Value of A = par_frot(1) in units of e_max^{1/2} : " << 
        par_frot(1) / len_rho << endl ; 
    
    ost << "Value of A / r_eq : " << 
        par_frot(1) / ray_eq() << endl ; 
    
    ost << "r_p/r_eq : " << aplat() << endl ; 
    ost << "KEH l^2 = (c/G^2)^{2/3} J^2 e_max^{1/3} M_B^{-10/3} : " <<
    angu_mom() * angu_mom() / pow(len_rho, 0.6666666666666666)
    / pow(mass_b(), 3.3333333333333333) 
    / pow(ggrav, 1.3333333333333333) << endl ;
     
    ost << "M e_max^{1/2} : " << ggrav * mass_g() / len_rho << endl ; 
    
    ost << "r_eq e_max^{1/2} : " << ray_eq() / len_rho << endl ; 
    
    ost << "T/W : " << tsw() << endl ; 
    
    ost << "Omega_c / e_max^{1/2} : " << get_omega_c() * len_rho << endl ; 
     
    display_poly(ost) ; 

    return ost ;

}

// display_poly
// ------------

void Star_rot_diff_CFC::display_poly(ostream& ost) const {

    using namespace Unites ;

      const Eos_poly* p_eos_poly = dynamic_cast<const Eos_poly*>( &eos ) ;    

      if (p_eos_poly != 0x0) {

        double kappa = p_eos_poly->get_kap() ; 

        // kappa^{n/2}
        double kap_ns2 = pow( kappa,  0.5 /(p_eos_poly->get_gam()-1) ) ; 
        
        // Polytropic unit of length in terms of r_unit : 
        double r_poly = kap_ns2 / sqrt(ggrav) ; 
        
        // Polytropic unit of time in terms of t_unit :
        double t_poly = r_poly ; 

        // Polytropic unit of mass in terms of m_unit :
        double m_poly = r_poly / ggrav ; 
        
        // Polytropic unit of angular momentum in terms of j_unit :
        double j_poly = r_poly * r_poly / ggrav ; 
        
        // Polytropic unit of density in terms of rho_unit :
        double rho_poly = 1. / (ggrav * r_poly * r_poly) ;  

        ost.precision(10) ; 
        ost << endl << "Quantities in polytropic units : " << endl ; 
        ost  << "==============================" << endl ; 
        ost << " ( r_poly = " << r_poly / km << " km )" << endl ; 
        ost << "  n_c     : " << nbar.val_grid_point(0, 0, 0, 0) / rho_poly << endl ; 
        ost << "  e_c     : " << ener.val_grid_point(0, 0, 0, 0) / rho_poly << endl ; 
        ost << "  Omega_c : " << get_omega_c() * t_poly << endl ; 
        ost << "  P_c     : " << 2.*M_PI / get_omega_c() / t_poly << endl ; 
        ost << "  M_bar   : " << mass_b() / m_poly << endl ; 
        ost << "  M       : " << mass_g() / m_poly << endl ; 
        ost << "  J   : " << angu_mom() / j_poly << endl ; 
        ost << "  r_eq    : " << ray_eq() / r_poly << endl ; 
        ost << "  R_circ_eq  : " << r_circ() / r_poly << endl ; 
    
        ost << "  n_max     : " << max( max( nbar ) ) / rho_poly << endl ; 
        ost << "  e_max     : " << max( max( ener ) ) / rho_poly << endl ; 
        ost << "  P_min     : " << 2.*M_PI / omega_max / t_poly << endl ; 
        ost << "  P_max     : " << 2.*M_PI / omega_min / t_poly << endl ; 
        
        int lsurf = nzet - 1; 
        int nt = mp.get_mg()->get_nt(lsurf) ; 
        int nr = mp.get_mg()->get_nr(lsurf) ; 
        ost << "  P_eq      : " << 2.*M_PI / 
            omega_field.val_grid_point(nzet-1, 0, nt-1, nr-1) / t_poly << endl ; 
          
      }
  }



        //-----------------------//
        //  Miscellaneous    //
        //-----------------------//

double Star_rot_diff_CFC::omega_funct(double F) const {

    return omega_frot(F, par_frot) ;
    
}

double Star_rot_diff_CFC::prim_funct_omega(double F) const {

    return primfrot(F, par_frot) ;
    
}

double Star_rot_diff_CFC::get_omega_c() const {
    
    return omega_field.val_grid_point(0, 0, 0, 0) ;
    
}

void Star_rot_diff_CFC::partial_display(ostream& ost) const {
    
  using namespace Unites ;

    double omega_c = get_omega_c() ; 
    double freq = omega_c / (2.*M_PI) ;  
    ost << "Central Omega : " << omega_c * f_unit 
        << " rad/s     f : " << freq * f_unit << " Hz" << endl ; 
    ost << "Rotation period : " << 1000. / (freq * f_unit) << " ms"
     << endl ;
    ost << endl << "Central enthalpy : " << ent.val_grid_point(0,0,0,0) << " c^2" << endl ; 
    ost << "Central proper baryon density : " << nbar.val_grid_point(0,0,0,0) 
    << " x 0.1 fm^-3" << endl ; 
    ost << "Central proper energy density : " << ener.val_grid_point(0,0,0,0) 
    << " rho_nuc c^2" << endl ; 
    ost << "Central pressure : " << press.val_grid_point(0,0,0,0) 
    << " rho_nuc c^2" << endl ; 

    ost << "Central value of log(N)        : " 
    << logn.val_grid_point(0, 0, 0, 0) << endl ; 
    ost << "Central lapse N :      " << nn.val_grid_point(0,0,0,0) <<  endl ; 
    ost << "Central value of psi : " << psi.val_grid_point(0,0,0,0) <<  endl ; 

    double nphi_c = beta(3).val_grid_point(0, 0, 0, 0) ;
    if ( (omega_c==0) && (nphi_c==0) ) {
        ost << "Central azimuthal shift :               " << nphi_c << endl ;
    }
    else{
        ost << "Central azimuthal shift /Omega :         " << nphi_c / omega_c 
                            << endl ;
    }
        

    int lsurf = nzet - 1; 
    int nt = mp.get_mg()->get_nt(lsurf) ; 
    int nr = mp.get_mg()->get_nr(lsurf) ; 
    ost << "Equatorial value of the velocity U:         " 
     << u_euler(3).val_grid_point(nzet-1, 0, nt-1, nr-1) << " c" << endl ; 

    ost << endl 
    << "Coordinate equatorial radius r_eq =    " 
    << ray_eq()/km << " km" << endl ;  
    ost << "Flattening r_pole/r_eq :        " << aplat() << endl ;

}

}