excision_surf.h

/*
 *  Definition of Lorene class Excision_surf, friend class of Spheroid.
 *
 */

/*
 *   Copyright (c) 2008  Jose-Luis Jaramillo & Nicolas Vasset
 *
 *   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 __EXCISIONSURF_H_ 
#define __EXCISIONSURF_H_ 

/*
 * $Header: /cvsroot/Lorene/C++/Include/excision_surf.h,v 1.7 2014/10/13 08:52:34 j_novak Exp $
 *
 */
#include "metric.h"
#include "spheroid.h"

namespace Lorene {
class Excision_surf {


    // Data : 
    // -----
 protected:
  Spheroid sph ;
  
  Scalar conf_fact ; 
  
  Scalar lapse ;
  
  Vector shift ;
  
  Metric gamij ; 
  
  Sym_tensor Kij ;
  
  double delta_t;

  double no_of_steps;

  Scalar expa;
  
  Scalar dt_expa;
  

    // Derived data : 
    // ------------
 protected:

    mutable Scalar* p_get_BC_conf_fact_1 ; 
    mutable Scalar* p_get_BC_lapse_1 ;   
    mutable Vector* p_get_BC_shift_1 ; 
    mutable Scalar* p_get_BC_Npsi_1 ; 
    mutable Scalar* p_get_BC_conf_fact_2 ; 
    mutable Scalar* p_get_BC_conf_fact_3 ; 
    mutable Scalar* p_get_BC_conf_fact_4 ; 
    mutable Scalar* p_get_BC_lapse_2 ;   
    mutable Scalar* p_get_BC_lapse_3 ;   
    mutable Scalar* p_get_BC_lapse_4 ;   
    mutable Scalar* p_derive_t_expa ;   
    mutable Vector* p_get_BC_shift_2 ; 
    mutable Vector* p_get_BC_shift_3 ; 
    mutable Vector* p_get_BC_shift_4 ; 
    mutable Scalar* p_get_BC_Npsi_2 ; 
    mutable Scalar* p_get_BC_Npsi_3 ; 
    mutable Scalar* p_get_BC_Npsi_4 ; 
    mutable Scalar* p_get_BC_Npsi_5 ; 


    // Constructors - Destructor
    // -------------------------
    public:

    Excision_surf(const Scalar& h_in, const Metric& gij, const Sym_tensor& Kij2, const Scalar& ppsi, const Scalar& nn, const Vector& beta, double timestep, int int_nos) ;
    Excision_surf(const Excision_surf& ) ;      

    Excision_surf(FILE* ) ;         

    virtual ~Excision_surf() ;          
 

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



    // Mutators / assignment
    // ---------------------
    public:
    void operator=(const Excision_surf&) ;  


    // Functions/Accessors
    //---------------------

    void get_evol_params_from_ID(double alpha, double beta, double gamma, Scalar& Ee, Vector& Jj, Sym_tensor& Ss) ;

    void set_expa_parab(double c_theta_lap, double c_theta_fin, Scalar& expa_fin) ;
    void set_expa_hyperb(double alph0, double beta0, double gamma0) ;


    // Accessors
    // ---------
    public:
    const Spheroid& get_sph() const {return sph; }; 
    
    const Scalar& get_conf_fact() const {return conf_fact; } ;

    const Scalar& get_lapse() const {return lapse ; } ;

    const Vector& get_shift() const {return shift ; } ;

    const Metric& get_gamij() const {return gamij ; } ;

    const Sym_tensor& get_Kij() const {return Kij ; } ;

    double get_delta_t() const {return delta_t ;};

    double get_no_of_steps() const {return no_of_steps ;};

    const Scalar & get_expa() const {return expa; };

    const Scalar& get_dt_expa() const {return dt_expa;} ;

    Spheroid& set_sph() {del_deriv() ; return sph ;};

    Scalar& set_conf_fact() {del_deriv() ; return conf_fact ; } ;

    Scalar& set_lapse() {del_deriv() ; return lapse ; } ;

    Vector& set_shift() {del_deriv() ; return shift ; } ;

    Metric& set_gamij() {del_deriv() ; return gamij ; } ;

    Sym_tensor& set_Kij() {del_deriv() ; return Kij ; } ;

    double set_delta_t() {del_deriv() ; return delta_t ; } ;

    double set_no_of_steps() {del_deriv() ; return no_of_steps ; } ;


    Scalar& set_expa() {del_deriv(); return expa;};


    Scalar& set_dt_expa() {del_deriv(); return dt_expa;};
    
    // Computational functions
    // -----------------------
    public:
    const Scalar& get_BC_conf_fact_1(bool isMOTS = false) const ;
// Source for an arbitrary Dirichlet BC on the lapse    
    const Scalar& get_BC_lapse_1(double value) const ;
// Source for a global Dirichlet BC on the shift, imposing a conformal Killing symmetry on \f$ \varphi \f$.
    const Vector& get_BC_shift_1(double Omega) const ;
// Source for a Dirichlet arbitrary BC on (N*Psi1)
    const Scalar& get_BC_Npsi_1(double value) const ;
    const Scalar& get_BC_conf_fact_2(double c_psi_lap, double c_psi_fin, Scalar& expa_fin) const ;
    const Scalar& get_BC_conf_fact_3(double c_theta_lap, double c_theta_fin, Scalar& expa_fin) const ;
    const Scalar& get_BC_conf_fact_4() const ;
    const Scalar& get_BC_lapse_2(double lapse_fin, double c_lapse_lap, double c_lapse_fi) const ;
    const Scalar& get_BC_lapse_3(Scalar& dttheta, Scalar& Ee, Vector& Jj, Sym_tensor& Sij, bool sph_sym = true) const ;
    const Scalar& get_BC_lapse_4 (Scalar& old_nn, Vector& beta_point, Sym_tensor& strain_tens) const ;
    const Scalar& derive_t_expa(Scalar& Ee, Vector& Jj, Sym_tensor& Sij) const;
    const Vector& get_BC_shift_2(double c_bb_lap, double c_bb_fin, double c_V_lap, double epsilon) const ;
    const Vector& get_BC_shift_3(Scalar& dtpsi, double c_V_lap, double epsilon) const ;
    const Vector & get_BC_shift_4(Scalar& dttheta, Scalar& Ee, Vector& Jj, Sym_tensor& Sij, double c_V_lap, double epsilon, bool sph_sym= true) const ;
    const Scalar& get_BC_Npsi_2(double value, double c_npsi_lap, double c_npsi_fin) const ;        
    const Scalar& get_BC_Npsi_3(double n_0, double beta) const ;      
    const Scalar& get_BC_Npsi_4(double Kappa) const ;      
    const Scalar& get_BC_Npsi_5(double Kappa) const ; 
    // Outputs
    // -------
    public:
    virtual void sauve(FILE *) const ;      
    
    friend ostream& operator<<(ostream& , const Spheroid& ) ;   

};

ostream& operator<<(ostream& , const Spheroid& ) ;


}
#endif