LORENE
FFTW3/cftcosp.C
1 /*
2  * Copyright (c) 1999-2002 Eric Gourgoulhon
3  *
4  * This file is part of LORENE.
5  *
6  * LORENE is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * LORENE is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with LORENE; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  */
21 
22 
23 char cftcosp_C[] = "$Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftcosp.C,v 1.3 2014/10/13 08:53:19 j_novak Exp $" ;
24 
25 
26 /*
27  * Transformation en cos(2*l*theta) sur le deuxieme indice (theta)
28  * d'un tableau 3-D representant une fonction symetrique par rapport
29  * au plan z=0.
30  * Utilise la bibliotheque fftw.
31  *
32  * Entree:
33  * -------
34  * int* deg : tableau du nombre effectif de degres de liberte dans chacune
35  * des 3 dimensions: le nombre de points de collocation
36  * en theta est nt = deg[1] et doit etre de la forme
37  * nt = 2*p + 1
38  * int* dimf : tableau du nombre d'elements de ff dans chacune des trois
39  * dimensions.
40  * On doit avoir dimf[1] >= deg[1] = nt.
41  * NB: pour dimf[0] = 1 (un seul point en phi), la transformation
42  * est bien effectuee.
43  * pour dimf[0] > 1 (plus d'un point en phi), la
44  * transformation n'est effectuee que pour les indices (en phi)
45  * j != 1 et j != dimf[0]-1 (cf. commentaires sur borne_phi).
46  *
47  * double* ff : tableau des valeurs de la fonction aux nt points de
48  * de collocation
49  *
50  * theta_l = pi/2 l/(nt-1) 0 <= l <= nt-1
51  *
52  * L'espace memoire correspondant a ce
53  * pointeur doit etre dimf[0]*dimf[1]*dimf[2] et doit
54  * etre alloue avant l'appel a la routine.
55  * Les valeurs de la fonction doivent etre stokees
56  * dans le tableau ff comme suit
57  * f( theta_l ) = ff[ dimf[1]*dimf[2] * j + k + dimf[2] * l ]
58  * ou j et k sont les indices correspondant a
59  * phi et r respectivement.
60  *
61  * int* dimc : tableau du nombre d'elements de cc dans chacune des trois
62  * dimensions.
63  * On doit avoir dimc[1] >= deg[1] = nt.
64  * Sortie:
65  * -------
66  * double* cf : tableau des coefficients c_l de la fonction definis
67  * comme suit (a r et phi fixes)
68  *
69  * f(theta) = som_{l=0}^{nt-1} c_l cos( 2 l theta ) .
70  *
71  * L'espace memoire correspondant a ce
72  * pointeur doit etre dimc[0]*dimc[1]*dimc[2] et doit
73  * etre alloue avant l'appel a la routine.
74  * Le coefficient c_l (0 <= l <= nt-1) est stoke dans
75  * le tableau cf comme suit
76  * c_l = cf[ dimc[1]*dimc[2] * j + k + dimc[2] * l ]
77  * ou j et k sont les indices correspondant a
78  * phi et r respectivement.
79  *
80  * NB: Si le pointeur ff est egal a cf, la routine ne travaille que sur un
81  * seul tableau, qui constitue une entree/sortie.
82  *
83  */
84 
85 /*
86  * $Id: cftcosp.C,v 1.3 2014/10/13 08:53:19 j_novak Exp $
87  * $Log: cftcosp.C,v $
88  * Revision 1.3 2014/10/13 08:53:19 j_novak
89  * Lorene classes and functions now belong to the namespace Lorene.
90  *
91  * Revision 1.2 2014/10/06 15:18:48 j_novak
92  * Modified #include directives to use c++ syntax.
93  *
94  * Revision 1.1 2004/12/21 17:06:02 j_novak
95  * Added all files for using fftw3.
96  *
97  * Revision 1.4 2003/01/31 10:31:23 e_gourgoulhon
98  * Suppressed the directive #include <malloc.h> for malloc is defined
99  * in <stdlib.h>
100  *
101  * Revision 1.3 2002/10/16 14:36:44 j_novak
102  * Reorganization of #include instructions of standard C++, in order to
103  * use experimental version 3 of gcc.
104  *
105  * Revision 1.2 2002/09/09 13:00:39 e_gourgoulhon
106  * Modification of declaration of Fortran 77 prototypes for
107  * a better portability (in particular on IBM AIX systems):
108  * All Fortran subroutine names are now written F77_* and are
109  * defined in the new file C++/Include/proto_f77.h.
110  *
111  * Revision 1.1.1.1 2001/11/20 15:19:29 e_gourgoulhon
112  * LORENE
113  *
114  * Revision 2.0 1999/02/22 15:47:50 hyc
115  * *** empty log message ***
116  *
117  *
118  * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftcosp.C,v 1.3 2014/10/13 08:53:19 j_novak Exp $
119  *
120  */
121 
122 // headers du C
123 #include <cstdlib>
124 #include <fftw3.h>
125 
126 //Lorene prototypes
127 #include "tbl.h"
128 
129 // Prototypage des sous-routines utilisees:
130 namespace Lorene {
131 fftw_plan prepare_fft(int, Tbl*&) ;
132 double* cheb_ini(const int) ;
133 
134 //*****************************************************************************
135 
136 void cftcosp(const int* deg, const int* dimf, double* ff, const int* dimc,
137  double* cf)
138 {
139 
140 int i, j, k ;
141 
142 // Dimensions des tableaux ff et cf :
143  int n1f = dimf[0] ;
144  int n2f = dimf[1] ;
145  int n3f = dimf[2] ;
146  int n1c = dimc[0] ;
147  int n2c = dimc[1] ;
148  int n3c = dimc[2] ;
149 
150 // Nombre de degres de liberte en theta :
151  int nt = deg[1] ;
152 
153 // Tests de dimension:
154  if (nt > n2f) {
155  cout << "cftcosp: nt > n2f : nt = " << nt << " , n2f = "
156  << n2f << endl ;
157  abort () ;
158  exit(-1) ;
159  }
160  if (nt > n2c) {
161  cout << "cftcosp: nt > n2c : nt = " << nt << " , n2c = "
162  << n2c << endl ;
163  abort () ;
164  exit(-1) ;
165  }
166  if (n1f > n1c) {
167  cout << "cftcosp: n1f > n1c : n1f = " << n1f << " , n1c = "
168  << n1c << endl ;
169  abort () ;
170  exit(-1) ;
171  }
172  if (n3f > n3c) {
173  cout << "cftcosp: n3f > n3c : n3f = " << n3f << " , n3c = "
174  << n3c << endl ;
175  abort () ;
176  exit(-1) ;
177  }
178 
179 // Nombre de points pour la FFT:
180  int nm1 = nt - 1;
181  int nm1s2 = nm1 / 2;
182 
183 // Recherche des tables pour la FFT:
184  Tbl* pg = 0x0 ;
185  fftw_plan p = prepare_fft(nm1, pg) ;
186  Tbl& g = *pg ;
187 
188 // Recherche de la table des sin(psi) :
189  double* sinp = cheb_ini(nt);
190 
191 // boucle sur phi et r (les boucles vont resp. de 0 a max(dimf[0]-2,0) et
192 // 0 a dimf[2]-1 )
193 
194  int n2n3f = n2f * n3f ;
195  int n2n3c = n2c * n3c ;
196 
197 /*
198  * Borne de la boucle sur phi:
199  * si n1f = 1, on effectue la boucle une fois seulement.
200  * si n1f > 1, on va jusqu'a j = n1f-2 en sautant j = 1 (les coefficients
201  * j=n1f-1 et j=0 ne sont pas consideres car nuls).
202  */
203  int borne_phi = ( n1f > 1 ) ? n1f-1 : 1 ;
204 
205  for (j=0; j< borne_phi; j++) {
206 
207  if (j==1) continue ; // on ne traite pas le terme en sin(0 phi)
208 
209  for (k=0; k<n3f; k++) {
210 
211  int i0 = n2n3f * j + k ; // indice de depart
212  double* ff0 = ff + i0 ; // tableau des donnees a transformer
213 
214  i0 = n2n3c * j + k ; // indice de depart
215  double* cf0 = cf + i0 ; // tableau resultat
216 
217 /*
218  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
219  * reliee a theta par psi = 2 theta et F(psi) = f(theta(psi)).
220  */
221 
222 // Valeur en psi=0 de la partie antisymetrique de F, F_ :
223  double fmoins0 = 0.5 * ( ff0[0] - ff0[ n3f*nm1 ] );
224 
225 // Fonction G(psi) = F+(psi) + F_(psi) sin(psi)
226 //---------------------------------------------
227  for ( i = 1; i < nm1s2 ; i++ ) {
228 // ... indice (dans le tableau g) du pt symetrique de psi par rapport a pi/2:
229  int isym = nm1 - i ;
230 // ... indice (dans le tableau ff0) du point theta correspondant a psi
231  int ix = n3f * i ;
232 // ... indice (dans le tableau ff0) du point theta correspondant a sym(psi)
233  int ixsym = n3f * isym ;
234 // ... F+(psi)
235  double fp = 0.5 * ( ff0[ix] + ff0[ixsym] ) ;
236 // ... F_(psi) sin(psi)
237  double fms = 0.5 * ( ff0[ix] - ff0[ixsym] ) * sinp[i] ;
238  g.set(i) = fp + fms ;
239  g.set(isym) = fp - fms ;
240  }
241 //... cas particuliers:
242  g.set(0) = 0.5 * ( ff0[0] + ff0[ n3f*nm1 ] );
243  g.set(nm1s2) = ff0[ n3f*nm1s2 ];
244 
245 // Developpement de G en series de Fourier par une FFT
246 //----------------------------------------------------
247 
248  fftw_execute(p) ;
249 
250 // Coefficients pairs du developmt. cos(2l theta) de f
251 //----------------------------------------------------
252 // Ces coefficients sont egaux aux coefficients en cosinus du developpement
253 // de G en series de Fourier (le facteur 2/nm1 vient de la normalisation
254 // de fftw) :
255 
256  double fac = 2./double(nm1) ;
257  cf0[0] = g(0) / double(nm1) ;
258  for (i=2; i<nm1; i += 2 ) cf0[n3c*i] = fac*g(i/2) ;
259  cf0[n3c*nm1] = g(nm1s2) / double(nm1) ;
260 
261 // Coefficients impairs du developmt. en cos(2l theta) de f
262 //---------------------------------------------------------
263 // 1. Coef. c'_k (recurrence amorcee a partir de zero):
264 // Le 4/nm1 en facteur de g[i] est du a la normalisation de fftw
265 // (si fftw donnait reellement les coef. en sinus, il faudrait le
266 // remplacer par un -2.)
267  fac *= 2. ;
268  cf0[n3c] = 0 ;
269  double som = 0;
270  for ( i = 3; i < nt; i += 2 ) {
271  cf0[n3c*i] = cf0[n3c*(i-2)] + fac * g(nm1 - i/2) ;
272  som += cf0[n3c*i] ;
273  }
274 
275 // 2. Calcul de c_1 :
276  double c1 = ( fmoins0 - som ) / nm1s2 ;
277 
278 // 3. Coef. c_k avec k impair:
279  cf0[n3c] = c1 ;
280  for ( i = 3; i < nt; i += 2 ) cf0[n3c*i] += c1 ;
281 
282 
283  } // fin de la boucle sur r
284  } // fin de la boucle sur phi
285 
286 }
287 }
Lorene prototypes.
Definition: app_hor.h:64