valeur.h

/*
 *  Definition of Lorene class Valeur
 *
 */

/*
 *   Copyright (c) 1999-2000 Jean-Alain Marck
 *   Copyright (c) 1999-2003 Eric Gourgoulhon
 *   Copyright (c) 1999-2001 Philippe Grandclement
 *   Copyright (c) 1999-2001 Jerome Novak
 *   Copyright (c) 2001 Keisuke Taniguchi
 *
 *   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 __VALEUR_H_ 
#define __VALEUR_H_ 

/*
 * $Id: valeur.h,v 1.23 2023/05/24 09:52:02 g_servignat Exp $
 * $Log: valeur.h,v $
 * Revision 1.23  2023/05/24 09:52:02  g_servignat
 * Added multiplication by \xi in a given shell, and dealiasing product in angular direction only
 *
 * Revision 1.22  2021/11/24 13:12:17  g_servignat
 * Addition of new method mult_xm1_shell(int) to multiply by (\xi +1) in a given shell.
 *
 * Revision 1.21  2021/11/22 15:19:45  j_novak
 * Addition of new method mult_xm1_shell(int) to multiply by (\xi -1) in a
 * given shell.
 *
 * Revision 1.20  2014/10/13 08:52:37  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.19  2014/10/06 15:09:40  j_novak
 * Modified #include directives to use c++ syntax.
 *
 * Revision 1.18  2013/06/05 15:06:10  j_novak
 * Legendre bases are treated as standard bases, when the multi-grid
 * (Mg3d) is built with BASE_LEG.
 *
 * Revision 1.17  2013/01/11 15:44:54  j_novak
 * Addition of Legendre bases (part 2).
 *
 * Revision 1.16  2012/01/18 14:43:42  j_penner
 * added a routine to return the computational coordinate xi as a Valeur
 *
 * Revision 1.15  2012/01/17 10:17:23  j_penner
 * functions added: Heaviside
 *
 * Revision 1.14  2005/11/17 15:18:46  e_gourgoulhon
 * Added Valeur + Mtbl and Valeur - Mtbl.
 *
 * Revision 1.13  2005/10/25 08:56:34  p_grandclement
 * addition of std_spectral_base in the case of odd functions near the origin
 *
 * Revision 1.12  2004/11/23 12:46:04  f_limousin
 * Add functiun filtre_tp(int nn, int nz1, int nz2).
 *
 * Revision 1.11  2004/08/24 09:14:40  p_grandclement
 * Addition of some new operators, like Poisson in 2d... It now requieres the
 * GSL library to work.
 *
 * Also, the way a variable change is stored by a Param_elliptic is changed and
 * no longer uses Change_var but rather 2 Scalars. The codes using that feature
 * will requiere some modification. (It should concern only the ones about monopoles)
 *
 * Revision 1.10  2004/07/06 13:36:27  j_novak
 * Added methods for desaliased product (operator |) only in r direction.
 *
 * Revision 1.9  2004/03/22 13:12:44  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.8  2003/11/06 14:43:37  e_gourgoulhon
 * Gave a name to const arguments in certain method prototypes (e.g.
 * constructors) to correct a bug of DOC++.
 *
 * Revision 1.7  2003/10/19 19:48:31  e_gourgoulhon
 * Introduced new method display_coef.
 *
 * Revision 1.6  2003/10/13 20:48:52  e_gourgoulhon
 * Added new method get_base() (to prepare the encapsulation of the member
 * base).
 *
 * Revision 1.5  2003/09/23 08:52:53  e_gourgoulhon
 * Added Scalar as a friend class.
 *
 * Revision 1.4  2002/10/16 14:36:30  j_novak
 * Reorganization of #include instructions of standard C++, in order to
 * use experimental version 3 of gcc.
 *
 * Revision 1.3  2002/09/13 09:17:33  j_novak
 * Modif. commentaires
 *
 * Revision 1.2  2002/06/17 14:05:17  j_novak
 * friend functions are now also declared outside the class definition
 *
 * Revision 1.1.1.1  2001/11/20 15:19:27  e_gourgoulhon
 * LORENE
 *
 * Revision 2.51  2001/05/29  16:11:58  eric
 * Modif commentaires (mise en conformite Doc++ 3.4.7).
 *
 * Revision 2.50  2001/05/26  14:49:37  eric
 * Ajout de l'operator% : produit de deux Valeur avec desaliasage.
 *
 * Revision 2.49  2001/01/16  15:09:13  keisuke
 * Change the argument of the function smooth.
 *
 * Revision 2.48  2001/01/16  14:54:01  keisuke
 * Ajout de la fonction smooth.
 *
 * Revision 2.47  2000/11/10  13:31:53  eric
 * Ajout de la fonction equipot_outward.
 *
 * Revision 2.46  2000/09/11  13:52:39  eric
 * Ajout des methodes mult_cp() et mult_sp() ainsi que des membres associes
 *  p_mult_cp et p_mult_sp
 *
 * Revision 2.45  2000/09/08  11:43:26  eric
 * Modif commentaires.
 *
 * Revision 2.44  2000/09/08  10:07:02  eric
 * Ajout des methodes set_base_r, etc...
 *
 * Revision 2.43  2000/08/04  11:53:59  eric
 * Ajout de l'operateur (int l) et de la fonction set(int l) pour l'acces
 * individuel aux Tbl.
 *
 * Revision 2.42  1999/12/29  13:19:51  eric
 * Modif commentaires.
 *
 * Revision 2.41  1999/12/29  13:11:08  eric
 * Ajout de la fonction val_point_jk.
 *
 * Revision 2.40  1999/12/20  16:35:47  eric
 * Ajout de la fonction set_base.
 *
 * Revision 2.39  1999/12/10  16:19:40  eric
 * Modif commentaires.
 *
 * Revision 2.38  1999/12/10  16:11:13  eric
 * Fonction set: suppression de l'appel a set_etat_c_qcq() pour
 *  augmenter l'efficacite.
 *
 * Revision 2.37  1999/12/07  14:52:43  eric
 * Changement ordre des arguments (phi,theta,xi) --> (xi,theta,phi)
 *  dans la routine val_point.
 *
 * Revision 2.36  1999/12/06  16:46:46  eric
 * Ajout de la fonction val_point.
 *
 * Revision 2.35  1999/11/30  12:41:21  eric
 * Le membre base est desormais un objet de type Base_val et non plus
 *  un pointeur vers une Base_val.
 *
 * Revision 2.34  1999/11/29  10:25:32  eric
 * Ajout de Valeur/Mtbl et Mtbl / Valeur dans l'arithmetique.
 *
 * Revision 2.33  1999/11/29  10:05:47  eric
 * Ajout de Valeur*Mtbl dans l'arithmetique.
 *
 * Revision 2.32  1999/11/23  16:15:24  eric
 * Suppression du membre statique Valeur_Zero.
 * Suppression du constructeur par defaut.
 *
 * Revision 2.31  1999/11/23  14:30:47  novak
 * Ajout des membres mult_ct et mult_st
 *
 * Revision 2.30  1999/11/22  15:40:48  eric
 * Ajout des operateurs set(l,k,j,i) et (l,k,j,i).
 * Ajout de la fonction annule(int l).
 *
 * Revision 2.29  1999/11/19  11:21:48  eric
 * Ajout du membre p_stdsdp et de la fonction correspondante stdsdp().
 *
 * Revision 2.28  1999/11/19  09:28:38  eric
 * Les valeurs de retour des operateurs differentiels sont desormais
 *   const Valeur &
 * et non plus Valeur.
 * Le laplacien angulaire (lapang) a desormais le meme statut que les
 * autres operateurs differentiels.
 *
 * Revision 2.27  1999/11/16  13:09:48  novak
 * Ajout de mult_x et scost
 *
 * Revision 2.26  1999/11/09  15:24:08  phil
 * ajout de la fonction mathematique calculant la racine cubique
 *
 * Revision 2.25  1999/10/29  15:14:33  eric
 * Ajout de fonctions mathematiques (abs, norme, etc...).
 *
 * Revision 2.24  1999/10/27  08:48:46  eric
 * La classe Cmp est desormais amie (pour que Cmp::del_t() puisse appeler
 * Valeur::del_t()).
 *
 * Revision 2.23  1999/10/21  14:21:06  eric
 * Constructeur par lecture de fichier.
 *
 * Revision 2.22  1999/10/20  15:38:52  eric
 * *** empty log message ***
 *
 * Revision 2.21  1999/10/20  15:31:04  eric
 * Ajout de l'arithmetique.
 *
 * Revision 2.20  1999/10/19  15:30:24  eric
 * Ajout de la fonction affiche_seuil.
 *
 * Revision 2.19  1999/10/18  15:07:02  eric
 *  La fonction membre annule() est rebaptisee annule_hard().
 * Introduction de la fonction membre annule(int, int).
 *
 * Revision 2.18  1999/10/18  13:39:38  eric
 * Routines de derivation --> const
 * Suppression de sxdsdx (non implemente).
 *
 * Revision 2.17  1999/10/13  15:49:57  eric
 * Depoussierage.
 * Documentation.
 *
 * Revision 2.16  1999/09/14  17:17:47  phil
 * *** empty log message ***
 *
 * Revision 2.15  1999/09/14  17:15:38  phil
 * ajout de Valeur operator* (double, const Valeur&)
 *
 * Revision 2.14  1999/09/13  14:53:26  phil
 * *** empty log message ***
 *
 * Revision 2.13  1999/09/13  14:17:52  phil
 * ajout de Valeur friend operator+ (Valeur, Valeur)
 *
 * Revision 2.12  1999/04/26  16:24:23  phil
 * ajout de mult2_xm1_zec()
 *
 * Revision 2.11  1999/04/26  16:12:45  phil
 * ajout de mult_xm1_zec()
 *
 * Revision 2.10  1999/04/26  15:48:11  phil
 * ajout de sxm1_zec()
 *
 * Revision 2.9  1999/04/26  12:57:24  phil
 * ajout de lapang()
 *
 * Revision 2.8  1999/04/13  16:44:55  phil
 * ajout de ylm_i()
 *
 * Revision 2.7  1999/04/13  16:31:46  phil
 * *** empty log message ***
 *
 * Revision 2.6  1999/04/13  16:26:08  phil
 * ajout ylm
 *
 * Revision 2.5  1999/02/24  15:24:34  hyc
 * *** empty log message ***
 *
 * Revision 2.4  1999/02/23  15:55:46  hyc
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/valeur.h,v 1.23 2023/05/24 09:52:02 g_servignat Exp $
 *
 */

// Fichier includes
#include <cstdio>

#include "mtbl.h"
#include "mtbl_cf.h"

namespace Lorene {
class Coord ;
class Itbl ; 

class Valeur {

    // Data : 
    // -----
    private:
    const Mg3d* mg ;  

    int etat ;  

    public:
    mutable Mtbl* c ;       

    mutable Mtbl_cf* c_cf ;     

    Base_val base ;    

    // Derived data : 
    // ------------
    private:
    mutable Valeur* p_dsdx ;    
    mutable Valeur* p_d2sdx2 ;  
    mutable Valeur* p_sx ;      
    mutable Valeur* p_sx2 ;     
    mutable Valeur* p_mult_x ;  

    mutable Valeur* p_dsdt ;    
    mutable Valeur* p_d2sdt2 ;  
    mutable Valeur* p_ssint ;   
        mutable Valeur* p_scost ;   
    mutable Valeur* p_mult_ct ; 
    mutable Valeur* p_mult_st ; 

    mutable Valeur* p_dsdp ;    
    mutable Valeur* p_stdsdp ;  
    mutable Valeur* p_d2sdp2 ;  
    mutable Valeur* p_mult_cp ; 
    mutable Valeur* p_mult_sp ; 

    mutable Valeur* p_lapang ;  

    // Constructors - Destructor
    // -------------------------
    
    public:
    explicit Valeur(const Mg3d& mgrid) ;        
    explicit Valeur(const Mg3d* p_mgrid) ;      

    Valeur(const Mg3d&, FILE* ) ;           

    Valeur(const Valeur& ) ;    
    ~Valeur() ;         

    // Assignement
    // -----------
    public: 
    void operator=(const Valeur& a) ; 
    void operator=(const Mtbl& mt) ;     
    void operator=(const Mtbl_cf& mtcf) ; 
    void operator=(double ) ;   

    // Access to individual elements
    // -----------------------------
    public:
    Tbl& set(int l) {
        assert(l < mg->get_nzone()) ;
        assert(etat == ETATQCQ) ;
        if (c == 0x0) {
        coef_i() ;
        }
        if (c_cf != 0x0) {
        delete c_cf ; 
        c_cf = 0 ; 
        }
        return c->set(l) ;
    };
    
    
    const Tbl& operator()(int l) const {
        assert(l < mg->get_nzone()) ;
        assert(etat == ETATQCQ) ;
        if (c == 0x0) {
        coef_i() ;
        }
        return (*c)(l) ;
    };


    double& set(int l, int k, int j, int i) {
        assert(l < mg->get_nzone()) ;
        assert(etat == ETATQCQ) ;
        if (c == 0x0) {
        coef_i() ;
        }
        if (c_cf != 0x0) {
        delete c_cf ; 
        c_cf = 0 ; 
        }
        return c->set(l, k, j, i) ;
    };
    
    
    double operator()(int l, int k, int j, int i) const {
        assert(etat != ETATNONDEF) ;
        assert(l < mg->get_nzone()) ;
        if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
        }
        else{       
        if (c == 0x0) {
            coef_i() ;
        }
            return (*c)(l, k, j, i) ;
        }
    };

    double val_point(int l, double x, double theta, double phi) const ; 

    double val_point_jk(int l, double x, int j, int k) const ; 

   
    // Operations on coefficients
    // --------------------------
    public:
    void coef() const ; 
    void coef_i() const ;   
    void ylm() ;        
    void ylm_i() ;      

    void val_propre_1d() ;
    void val_propre_1d_i() ;
    
    const Base_val& get_base() const {return base; } ; 

    void set_base(const Base_val& ) ; 

    void std_base_scal() ;   
    
    void std_base_scal_odd() ;   
    
    void set_base_r(int l, int base_r) ; 

    void set_base_t(int base_t) ; 

    void set_base_p(int base_p) ; 

    void filtre_tp(int nn, int nz1, int nz2) ;



    // Differential operators
    // ----------------------
    public:
    const Valeur& dsdx() const ;        
    const Valeur& d2sdx2() const ;     

    const Valeur& dsdt() const ;    
    const Valeur& d2sdt2() const ;  
    const Valeur& ssint() const ;   
        const Valeur& scost() const ;  
    const Valeur& mult_ct() const ;
    const Valeur& mult_st() const ;

    const Valeur& dsdp() const ;    
    const Valeur& stdsdp() const ;  
    const Valeur& d2sdp2() const ;  
    const Valeur& mult_cp() const ;
    const Valeur& mult_sp() const ;
    
    const Valeur& lapang() const ;      

    const Valeur& sx() const ;
            
    const Valeur& sx2() const ;     
    
    const Valeur& mult_x() const ;
    
    void sxm1_zec() ;

    void mult_xm1_shell(int index) ;

    void mult_xp1_shell(int index) ;
    
    void mult_x_shell(int index) ;  
  
    void mult_xm1_zec() ;   

    void mult2_xm1_zec() ;  
    
    void va_x() ;
            
    
    // Outputs
    // -------
    public:
    void sauve(FILE *) const ;      
    
    void display_coef(double threshold = 1.e-7, int precision = 4, 
               ostream& ostr = cout) const ;

    void affiche_seuil(ostream& ostr, int type = 0, int precision = 4, 
               double threshold = 1.e-7) const ;

    friend ostream& operator<<(ostream& , const Valeur& ) ;   

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

    // State manipulations
    public:

    void set_etat_nondef() ;  

    void set_etat_zero() ;      

    void set_etat_c_qcq() ;     

    void set_etat_cf_qcq() ;    

    void annule_hard() ;            

    void annule(int l) ; 

    void annule(int l_min, int l_max) ; 


    // Extraction of information
    // -------------------------
    public:
    int get_etat() const {return etat ; };   

    const Mg3d* get_mg() const { return mg ; }; 
    
    // Member arithmetics
    // ------------------
    public:
    void operator+=(const Valeur& ) ;   
    void operator-=(const Valeur& ) ;   
    void operator*=(const Valeur& ) ;   

    // Miscellaneous
    // -------------
    public:
    void equipot(double uu0, int nz_search, double precis, int nitermax,
             int& niter, Itbl& l_iso, Tbl& xi_iso) const ; 
    
    void equipot_outward(double uu0, int nz_search, double precis, 
                 int nitermax, int& niter, Itbl& l_iso, 
                 Tbl& xi_iso) const ; 

    void smooth(int nzet, Valeur& uuva) const ;

    friend class Cmp ;      
    friend class Scalar ;       
    friend void rotate_propre_pair (Valeur&, bool) ; 
    friend void rotate_propre_impair (Valeur&, bool) ; 
};
ostream& operator<<(ostream& , const Valeur& ) ;   

Valeur operator+(const Valeur& ) ;  
Valeur operator-(const Valeur& ) ;  
Valeur operator+(const Valeur&, const Valeur& ) ; 
Valeur operator+(const Valeur&, const Mtbl& ) ; 
Valeur operator+(const Mtbl&, const Valeur& ) ; 
Valeur operator+(const Valeur&, double ) ;    
Valeur operator+(double, const Valeur& ) ;    
Valeur operator+(const Valeur&, int ) ;       
Valeur operator+(int, const Valeur& ) ;       
Valeur operator-(const Valeur&, const Valeur& ) ; 
Valeur operator-(const Valeur&, const Mtbl& ) ; 
Valeur operator-(const Mtbl&, const Valeur& ) ; 
Valeur operator-(const Valeur&, double ) ;    
Valeur operator-(double, const Valeur& ) ;    
Valeur operator-(const Valeur&, int ) ;       
Valeur operator-(int, const Valeur& ) ;       
Valeur operator*(const Valeur&, const Valeur& ) ; 

Valeur operator%(const Valeur&, const Valeur& ) ; 

Valeur operator&(const Valeur&, const Valeur& ) ;

Valeur operator|(const Valeur&, const Valeur& ) ; 

Valeur operator*(const Valeur&, double ) ;    
Valeur operator*(double, const Valeur& ) ;    
Valeur operator*(const Valeur&, int ) ;       
Valeur operator*(int, const Valeur& ) ;       
Valeur operator*(const Valeur& a, const Mtbl& b) ;    
Valeur operator*(const Mtbl& b, const Valeur& a) ;    
Valeur operator*(const Valeur& a, const Coord& c) ;  
Valeur operator*(const Coord& c, const Valeur& a) ;  
Valeur operator/(const Valeur& a, const Valeur& b) ; 
Valeur operator/(const Valeur&, double ) ;    
Valeur operator/(double, const Valeur& ) ;    
Valeur operator/(const Valeur&, int ) ;       
Valeur operator/(int, const Valeur& ) ;       
Valeur operator/(const Valeur& a, const Mtbl& b) ;    
Valeur operator/(const Mtbl& b, const Valeur& a) ;    

Valeur sin(const Valeur& ) ;        
Valeur cos(const Valeur& ) ;        
Valeur tan(const Valeur& ) ;        
Valeur asin(const Valeur& ) ;       
Valeur acos(const Valeur& ) ;       
Valeur atan(const Valeur& ) ;       
Valeur exp(const Valeur& ) ;        
Valeur Heaviside(const Valeur& ) ;      
Valeur log(const Valeur& ) ;        
Valeur log10(const Valeur& ) ;      
Valeur sqrt(const Valeur& ) ;       
Valeur pow(const Valeur& , int ) ;  
Valeur pow(const Valeur& , double ) ; 
Valeur abs(const Valeur& ) ;        
Valeur racine_cubique (const Valeur&) ; 

double totalmax(const Valeur& ) ;   

double totalmin(const Valeur& ) ;   

Tbl max(const Valeur& ) ;   

Tbl min(const Valeur& ) ;   

Tbl norme(const Valeur& ) ;   

Tbl diffrel(const Valeur& a, const Valeur& b) ; 

Tbl diffrelmax(const Valeur& a, const Valeur& b) ; 


}
#endif