mtbl.h

/*
 *  Definition of Lorene class Mtbl
 *
 */

/*
 *   Copyright (c) 1999-2000 Jean-Alain Marck
 *   Copyright (c) 1999-2001 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 __MTBL_H_
#define __MTBL_H_

/*
 * $Id: mtbl.h,v 1.7 2014/10/13 08:52:36 j_novak Exp $
 * $Log: mtbl.h,v $
 * Revision 1.7  2014/10/13 08:52:36  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.6  2012/01/17 10:22:13  j_penner
 * function added: Heaviside
 *
 * Revision 1.5  2004/03/22 13:12:42  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.4  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.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.9  2000/08/16  10:29:45  eric
 * Suppression du membre dzpuis.
 *
 * Revision 2.8  2000/08/04  11:40:58  eric
 * Ajout de l'operateur (int l) et de la fonction set(int l) pour l'acces
 * individuel aux Tbl.
 *
 * Revision 2.7  1999/12/02  17:55:07  phil
 * *** empty log message ***
 *
 * Revision 2.6  1999/10/29  15:05:43  eric
 * Suppression des fonctions membres min() et max():
 * elles deviennent des fonctions externes.
 * Ajout de fonctions mathematiques (abs, norme, etc...).
 *
 * Revision 2.5  1999/10/18  15:06:25  eric
 * La fonction membre annule() est rebaptisee annule_hard().
 * Introduction de la fonction membre annule(int, int).
 *
 * Revision 2.4  1999/10/01  10:35:58  eric
 * Amelioration des commentaires.
 *
 * Revision 2.3  1999/10/01  10:08:25  eric
 * Depoussierage
 * Documentation.
 *
 * Revision 2.2  1999/03/02  18:54:50  eric
 * Ajout de la fonction affiche_seuil.
 *
 * Revision 2.1  1999/02/22  15:23:49  hyc
 * *** empty log message ***
 *
 *
 * Revision 2.0  1999/01/15  09:10:39  hyc
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/mtbl.h,v 1.7 2014/10/13 08:52:36 j_novak Exp $
 *
 */


// Headers Lorene 
#include "tbl.h"
#include "grilles.h"

namespace Lorene {
class Coord ;

class Mtbl {

    // Data : 
    // -----
    private:
    const Mg3d* mg ;  
    int nzone ; 
    int etat ;  

    public:
    Tbl** t;    

    // Constructors - Destructor
    // -------------------------
    
    public:
    explicit Mtbl(const Mg3d& mgrid) ;  
    explicit Mtbl(const Mg3d* p_mgrid) ;    
    Mtbl(const Mg3d&, FILE* ) ;         
    Mtbl(const Coord& c) ;      
    Mtbl(const Mtbl& a) ;           
    ~Mtbl() ;               

    // Assignement
    // -----------
    public:
    void operator=(const Mtbl& ) ;      
    void operator=(double ) ;       
    void operator=(int ) ;          

    // Memory management
    // -----------------
    private:
    void del_t() ;  
            
    public:

    void set_etat_nondef() ;
    
    void set_etat_zero() ;          

    void set_etat_qcq() ;           

    void annule_hard() ;    
    
    void annule(int l_min, int l_max) ; 


    // Access to individual elements
    // -----------------------------
    public:
    Tbl& set(int l) {
        assert(l < nzone) ;
        assert(etat == ETATQCQ) ;
        return *(t[l]) ;
    };
    
    
    const Tbl& operator()(int l) const {
        assert(l < nzone) ;
        assert(etat == ETATQCQ) ;
        return *(t[l]) ;
    };

    double& set(int l, int k, int j, int i) {
        assert(l < nzone) ;
        assert(etat == ETATQCQ) ;
        return (t[l])->set(k, j, i) ;
    };
    
    
    double operator()(int l, int k, int j, int i) const {
        assert(etat != ETATNONDEF) ;
        assert(l < nzone) ;
        if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
        }
        else return (*t[l])(k, j, i) ;
    };


    // Extraction of information
    // -------------------------
    public:
    const Mg3d* get_mg() const { return mg ; }; 

    int get_etat() const { return etat ; };   
    
    int get_nzone() const { return nzone ; } ; 
    
    // Outputs
    // -------
    public:
    void sauve(FILE *) const ;      
    
    void affiche_seuil(ostream& ostr, int precision = 4, 
               double threshold = 1.e-7) const ;
    friend ostream& operator<<(ostream& , const Mtbl & ) ;   

    // Member arithmetics
    // ------------------
    public:
    void operator+=(const Mtbl & ) ;    
    void operator+=(double ) ;      
    void operator-=(const Mtbl & ) ;    
    void operator-=(double ) ;      
    void operator*=(const Mtbl & ) ;    
    void operator*=(double ) ;      
    void operator/=(const Mtbl & ) ;    
    void operator/=(double ) ;      

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

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

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

double totalmax(const Mtbl& ) ;   

double totalmin(const Mtbl& ) ;   

Tbl max(const Mtbl& ) ;   

Tbl min(const Mtbl& ) ;   

Tbl norme(const Mtbl& ) ;   

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

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

}
#endif