FFTW3/cftcosi.C

/*
 *   Copyright (c) 1999-2002 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
 *
 */
 
 
 
 
/*
 * Transformation en cos((2*l+1)*theta) sur le deuxieme indice (theta)
 *  d'un tableau 3-D representant une fonction antisymetrique par rapport
 *  au plan z=0.
 *  Utilise la bibliotheque fftw.
 *
 * Entree:
 * -------
 *   int* deg   : tableau du nombre effectif de degres de liberte dans chacune 
 *        des 3 dimensions: le nombre de points de collocation
 *        en theta est  nt = deg[1] et doit etre de la forme
 *          nt = 2*p + 1 
 *   int* dimf  : tableau du nombre d'elements de ff dans chacune des trois 
 *            dimensions.
 *        On doit avoir  dimf[1] >= deg[1] = nt. 
 *        NB: pour dimf[0] = 1 (un seul point en phi), la transformation
 *            est bien effectuee.
 *            pour dimf[0] > 1 (plus d'un point en phi), la
 *            transformation n'est effectuee que pour les indices (en phi)
 *            j != 1 et j != dimf[0]-1 (cf. commentaires sur borne_phi).
 *
 *   double* ff : tableau des valeurs de la fonction aux nt points de
 *                        de collocation
 *
 *            theta_l =  pi/2 l/(nt-1)       0 <= l <= nt-1 
 *
 *            L'espace memoire correspondant a ce
 *                        pointeur doit etre dimf[0]*dimf[1]*dimf[2] et doit 
 *            etre alloue avant l'appel a la routine.    
 *            Les valeurs de la fonction doivent etre stokees
 *            dans le tableau ff comme suit
 *          f( theta_l ) = ff[ dimf[1]*dimf[2] * j + k + dimf[2] * l ]
 *           ou j et k sont les indices correspondant a
 *           phi et r respectivement.
 *
 *   int* dimc  : tableau du nombre d'elements de cc dans chacune des trois 
 *            dimensions.
 *        On doit avoir  dimc[1] >= deg[1] = nt. 
 * Sortie:
 * -------
 *   double* cf :   tableau des coefficients c_l de la fonction definis
 *            comme suit (a r et phi fixes)
 *
 *             f(theta) = som_{l=0}^{nt-2} c_l cos( (2 l+1) theta ) .
 *
 *            L'espace memoire correspondant a ce
 *                        pointeur doit etre dimc[0]*dimc[1]*dimc[2] et doit 
 *            etre alloue avant l'appel a la routine.    
 *           Le coefficient c_l (0 <= l <= nt-1) est stoke dans
 *           le tableau cf comme suit
 *                c_l = cf[ dimc[1]*dimc[2] * j + k + dimc[2] * l ]
 *           ou j et k sont les indices correspondant a
 *           phi et r respectivement. On a c_{nt-1}=0.
 *
 * NB: Si le pointeur ff est egal a cf, la routine ne travaille que sur un 
 *     seul tableau, qui constitue une entree/sortie.
 *
 */
 
/*
 * $Id: cftcosi.C,v 1.4 2016/12/05 16:18:05 j_novak Exp $
 * $Log: cftcosi.C,v $
 * Revision 1.4  2016/12/05 16:18:05  j_novak
 * Suppression of some global variables (file names, loch, ...) to prevent redefinitions
 *
 * Revision 1.3  2014/10/13 08:53:19  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.2  2014/10/06 15:18:48  j_novak
 * Modified #include directives to use c++ syntax.
 *
 * Revision 1.1  2004/12/21 17:06:02  j_novak
 * Added all files for using fftw3.
 *
 * Revision 1.4  2003/01/31 10:31:23  e_gourgoulhon
 * Suppressed the directive #include <malloc.h> for malloc is defined
 * in <stdlib.h>
 *
 * Revision 1.3  2002/10/16 14:36:44  j_novak
 * Reorganization of #include instructions of standard C++, in order to
 * use experimental version 3 of gcc.
 *
 * Revision 1.2  2002/09/09 13:00:39  e_gourgoulhon
 * Modification of declaration of Fortran 77 prototypes for
 * a better portability (in particular on IBM AIX systems):
 * All Fortran subroutine names are now written F77_* and are
 * defined in the new file C++/Include/proto_f77.h.
 *
 * Revision 1.1.1.1  2001/11/20 15:19:29  e_gourgoulhon
 * LORENE
 *
 * Revision 2.0  1999/02/22  15:47:57  hyc
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftcosi.C,v 1.4 2016/12/05 16:18:05 j_novak Exp $
 *
 */
 
 
// headers du C
#include <cstdlib>
#include <fftw3.h>
 
//Lorene prototypes
#include "tbl.h"
 
// Prototypage des sous-routines utilisees:
namespace Lorene {
fftw_plan prepare_fft(int, Tbl*&) ;
double* cheb_ini(const int) ;
double* chebimp_ini(const int ) ;
//*****************************************************************************
 
void cftcosi(const int* deg, const int* dimf, double* ff, const int* dimc,
        double* cf)
{
 
int i, j, k ;
 
// Dimensions des tableaux ff et cf  :
    int n1f = dimf[0] ;
    int n2f = dimf[1] ;
    int n3f = dimf[2] ;
    int n1c = dimc[0] ;
    int n2c = dimc[1] ;
    int n3c = dimc[2] ;
 
// Nombre de degres de liberte en theta :    
    int nt = deg[1] ;
    
// Tests de dimension:
    if (nt > n2f) {
    cout << "cftcosi: nt > n2f : nt = " << nt << " ,  n2f = " 
    << n2f << endl ;
    abort () ;
    exit(-1) ;
    }
    if (nt > n2c) {
    cout << "cftcosi: nt > n2c : nt = " << nt << " ,  n2c = " 
    << n2c << endl ;
    abort () ;
    exit(-1) ;
    }
    if (n1f > n1c) {
    cout << "cftcosi: n1f > n1c : n1f = " << n1f << " ,  n1c = " 
    << n1c << endl ;
    abort () ;
    exit(-1) ;
    }
    if (n3f > n3c) {
    cout << "cftcosi: n3f > n3c : n3f = " << n3f << " ,  n3c = " 
    << n3c << endl ;
    abort () ;
    exit(-1) ;
    }
 
// Nombre de points pour la FFT:
    int nm1 = nt - 1;
    int nm1s2 = nm1 / 2;
 
// Recherche des tables pour la FFT:
    Tbl* pg = 0x0 ;
    fftw_plan p = prepare_fft(nm1, pg) ;
    Tbl& g = *pg ;
 
// Recherche de la table des sin(psi) :
    double* sinp = cheb_ini(nt);    
 
// Recherche de la table des points de collocations x_k :
    double* x = chebimp_ini(nt);    
    
// boucle sur phi et r (les boucles vont resp. de 0 a max(dimf[0]-2,0) et 
//          0 a dimf[2]-1 )
 
    int n2n3f = n2f * n3f ;
    int n2n3c = n2c * n3c ;
 
/*   
 * Borne de la boucle sur phi: 
 *    si n1f = 1, on effectue la boucle une fois seulement.
 *    si n1f > 1, on va jusqu'a j = n1f-2 en sautant j = 1 (les coefficients
 *  j=n1f-1 et j=0 ne sont pas consideres car nuls). 
 */
    int borne_phi = ( n1f > 1 ) ? n1f-1 : 1 ;
 
    for (j=0; j< borne_phi; j++) {
    
        if (j==1) continue ;    // on ne traite pas le terme en sin(0 phi)
 
    for (k=0; k<n3f; k++) {
 
        int i0 = n2n3f * j + k ; // indice de depart 
        double* ff0 = ff + i0 ;    // tableau des donnees a transformer
 
        i0 = n2n3c * j + k ; // indice de depart 
        double* cf0 = cf + i0 ;    // tableau resultat
 
// Multiplication de la fonction par x=cos(theta) (pour la rendre paire) 
// NB: dans les commentaires qui suivent, on note h(x) = x f(x).
// (Les valeurs de h dans l'espace des configurations sont stokees dans le
//  tableau cf0).
        for (i=0; i<nt-1; i++) cf0[n3c*i] = x[nm1-i] * ff0[n3f*i] ;
        cf0[n3c*nm1] = 0 ;
 
/*
 * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
 *     reliee a theta par  psi = 2 theta   et F(psi) = f(theta(psi)).  
 */
 
// Valeur en psi=0 de la partie antisymetrique de F, F_ :
            double fmoins0 = 0.5 * ( cf0[0] - cf0[ n3c*nm1 ] );
 
// Fonction G(psi) = F+(psi) + F_(psi) sin(psi) 
//---------------------------------------------
            for ( i = 1; i < nm1s2 ; i++ ) {
// ... indice (dans le tableau g) du pt symetrique de psi par rapport a pi/2:
        int isym = nm1 - i ; 
// ... indice (dans le tableau cf0) du point theta correspondant a psi
        int ix = n3c * i ;
// ... indice (dans le tableau cf0) du point theta correspondant a sym(psi)
        int ixsym = n3c * isym ;
// ... F+(psi)
        double fp = 0.5 * ( cf0[ix] + cf0[ixsym] ) ;    
// ... F_(psi) sin(psi)
        double fms = 0.5 * ( cf0[ix] - cf0[ixsym] ) * sinp[i] ; 
        g.set(i) = fp + fms ;
        g.set(isym) = fp - fms ;
            }
//... cas particuliers:
            g.set(0) = 0.5 * ( cf0[0] + cf0[ n3c*nm1 ] );
            g.set(nm1s2) = cf0[ n3c*nm1s2 ];
 
// Developpement de G en series de Fourier par une FFT
//----------------------------------------------------
 
        fftw_execute(p) ;
 
// Coefficients pairs du developmt. de Tchebyshev de h
//----------------------------------------------------
//  Ces coefficients sont egaux aux coefficients en cosinus du developpement
//  de G en series de Fourier (le facteur 2/nm1 vient de la normalisation
//  de fftw; si fftw donnait reellement les coef. en cosinus, il faudrait le
//   remplacer par un +1.)  :
 
        double fac = 2./double(nm1) ;
        cf0[0] = g(0) / double(nm1) ;
            for (i=2; i<nm1; i += 2 ) cf0[n3c*i] = fac * g(i/2) ;   
        cf0[n3c*nm1] = g(nm1s2) ;    
 
// Coefficients impairs du developmt. de Tchebyshev de h
//------------------------------------------------------
// 1. Coef. c'_k (recurrence amorcee a partir de zero)
//  Le 4/nm1 en facteur de g(i) est du a la normalisation de fftw
//  (si fftw donnait reellement les coef. en sinus, il faudrait le
//   remplacer par un -2.) 
        fac *= 2. ;
            cf0[n3c] = 0 ;
            double som = 0;
            for ( i = 3; i < nt; i += 2 ) {
        cf0[n3c*i] = cf0[n3c*(i-2)] + fac * g(nm1 - i/2) ;
            som += cf0[n3c*i] ;
            }
 
// 2. Calcul de c_1 :
            double c1 = ( fmoins0 - som ) / nm1s2 ;
 
// 3. Coef. c_k avec k impair:  
            cf0[n3c] = c1 ;
            for ( i = 3; i < nt; i += 2 ) cf0[n3c*i] += c1 ;
 
 
// Coefficients de f en fonction de ceux de h
//-------------------------------------------
 
    cf0[0] = 2* cf0[0] ;
    for (i=1; i<nm1; i++) {
    cf0[n3c*i] = 2 * cf0[n3c*i] - cf0[n3c*(i-1)] ;
    }    
    cf0[n3c*nm1] = 0 ;
 
    }   // fin de la boucle sur r 
   }    // fin de la boucle sur phi
 
}
}