LORENE
FFT991/citcosp.C
1 /*
2  * Copyright (c) 1999-2001 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 citcosp_C[] = "$Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFT991/citcosp.C,v 1.4 2014/10/15 12:48:21 j_novak Exp $" ;
24 
25 
26 /*
27  * Transformation en cos(2*l*theta) inverse 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 routine FFT Fortran FFT991
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 3^q 5^r + 1
38  * int* dimc : tableau du nombre d'elements de cc dans chacune des trois
39  * dimensions.
40  * On doit avoir dimc[1] >= deg[1] = nt.
41  * NB: pour dimc[0] = 1 (un seul point en phi), la transformation
42  * est bien effectuee.
43  * pour dimc[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 != dimc[0]-1 (cf. commentaires sur borne_phi).
46  *
47  * double* cf : tableau des coefficients c_l de la fonction definis
48  * comme suit (a r et phi fixes)
49  *
50  * f(theta) = som_{l=0}^{nt-1} c_l cos( 2 l theta ) .
51  *
52  * L'espace memoire correspondant a ce
53  * pointeur doit etre dimc[0]*dimc[1]*dimc[2] et doit
54  * avoir ete alloue avant l'appel a la routine.
55  * Le coefficient c_l (0 <= l <= nt-1) doit etre stoke dans
56  * le tableau cf comme suit
57  * c_l = cf[ dimc[1]*dimc[2] * j + k + dimc[2] * l ]
58  * ou j et k sont les indices correspondant a
59  * phi et r respectivement.
60  *
61  * int* dimf : tableau du nombre d'elements de ff dans chacune des trois
62  * dimensions.
63  * On doit avoir dimf[1] >= deg[1] = nt.
64  *
65  * Sortie:
66  * -------
67  * double* ff : tableau des valeurs de la fonction aux nt points de
68  * de collocation
69  *
70  * theta_l = pi/2 l/(nt-1) 0 <= l <= nt-1
71  *
72  * L'espace memoire correspondant a ce
73  * pointeur doit etre dimf[0]*dimf[1]*dimf[2] et doit
74  * avoir ete alloue avant l'appel a la routine.
75  * Les valeurs de la fonction sont stokees
76  * dans le tableau ff comme suit
77  * f( theta_l ) = ff[ dimf[1]*dimf[2] * j + k + dimf[2] * l ]
78  * ou j et k sont les indices correspondant a
79  * phi et r respectivement.
80  *
81  * NB: Si le pointeur cf est egal a ff, la routine ne travaille que sur un
82  * seul tableau, qui constitue une entree/sortie.
83  *
84  */
85 
86 /*
87  * $Id: citcosp.C,v 1.4 2014/10/15 12:48:21 j_novak Exp $
88  * $Log: citcosp.C,v $
89  * Revision 1.4 2014/10/15 12:48:21 j_novak
90  * Corrected namespace declaration.
91  *
92  * Revision 1.3 2014/10/13 08:53:17 j_novak
93  * Lorene classes and functions now belong to the namespace Lorene.
94  *
95  * Revision 1.2 2014/10/06 15:18:46 j_novak
96  * Modified #include directives to use c++ syntax.
97  *
98  * Revision 1.1 2004/12/21 17:06:01 j_novak
99  * Added all files for using fftw3.
100  *
101  * Revision 1.4 2003/01/31 10:31:23 e_gourgoulhon
102  * Suppressed the directive #include <malloc.h> for malloc is defined
103  * in <stdlib.h>
104  *
105  * Revision 1.3 2002/10/16 14:36:53 j_novak
106  * Reorganization of #include instructions of standard C++, in order to
107  * use experimental version 3 of gcc.
108  *
109  * Revision 1.2 2002/09/09 13:00:40 e_gourgoulhon
110  * Modification of declaration of Fortran 77 prototypes for
111  * a better portability (in particular on IBM AIX systems):
112  * All Fortran subroutine names are now written F77_* and are
113  * defined in the new file C++/Include/proto_f77.h.
114  *
115  * Revision 1.1.1.1 2001/11/20 15:19:29 e_gourgoulhon
116  * LORENE
117  *
118  * Revision 2.0 1999/02/22 15:42:46 hyc
119  * *** empty log message ***
120  *
121  *
122  * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFT991/citcosp.C,v 1.4 2014/10/15 12:48:21 j_novak Exp $
123  *
124  */
125 
126 
127 // headers du C
128 #include <cassert>
129 #include <cstdlib>
130 
131 // Prototypes of F77 subroutines
132 #include "headcpp.h"
133 #include "proto_f77.h"
134 
135 // Prototypage des sous-routines utilisees:
136 namespace Lorene {
137 int* facto_ini(int ) ;
138 double* trigo_ini(int ) ;
139 double* cheb_ini(const int) ;
140 //*****************************************************************************
141 
142 void citcosp(const int* deg, const int* dimc, double* cf, const int* dimf,
143  double* ff)
144 {
145 
146 int i, j, k ;
147 
148 // Dimensions des tableaux ff et cf :
149  int n1f = dimf[0] ;
150  int n2f = dimf[1] ;
151  int n3f = dimf[2] ;
152  int n1c = dimc[0] ;
153  int n2c = dimc[1] ;
154  int n3c = dimc[2] ;
155 
156 // Nombres de degres de liberte en theta :
157  int nt = deg[1] ;
158 
159 // Tests de dimension:
160  if (nt > n2f) {
161  cout << "citcosp: nt > n2f : nt = " << nt << " , n2f = "
162  << n2f << endl ;
163  abort () ;
164  exit(-1) ;
165  }
166  if (nt > n2c) {
167  cout << "citcosp: nt > n2c : nt = " << nt << " , n2c = "
168  << n2c << endl ;
169  abort () ;
170  exit(-1) ;
171  }
172  if ( (n1f > 1) && (n1c > n1f) ) {
173  cout << "citcosp: n1c > n1f : n1c = " << n1c << " , n1f = "
174  << n1f << endl ;
175  abort () ;
176  exit(-1) ;
177  }
178  if (n3c > n3f) {
179  cout << "citcosp: n3c > n3f : n3c = " << n3c << " , n3f = "
180  << n3f << endl ;
181  abort () ;
182  exit(-1) ;
183  }
184 
185 // Nombre de points pour la FFT:
186  int nm1 = nt - 1;
187  int nm1s2 = nm1 / 2;
188 
189 // Recherche des tables pour la FFT:
190  int* facto = facto_ini(nm1) ;
191  double* trigo = trigo_ini(nm1) ;
192 
193 // Recherche de la table des sin(psi) :
194  double* sinp = cheb_ini(nt);
195 
196  // tableau de travail t1 et g
197  // (la dimension nm1+2 = nt+1 est exigee par la routine fft991)
198  double* g = (double*)( malloc( (nm1+2)*sizeof(double) ) ) ;
199  double* t1 = (double*)( malloc( (nm1+2)*sizeof(double) ) ) ;
200 
201 // Parametres pour la routine FFT991
202  int jump = 1 ;
203  int inc = 1 ;
204  int lot = 1 ;
205  int isign = 1 ;
206 
207 // boucle sur phi et r (les boucles vont resp. de 0 a max(dimc[0]-2,0) et
208 // 0 a dimc[2]-1 )
209 
210  int n2n3f = n2f * n3f ;
211  int n2n3c = n2c * n3c ;
212 
213 /*
214  * Borne de la boucle sur phi:
215  * si n1f = 1, on effectue la boucle une fois seulement.
216  * si n1f > 1, on va jusqu'a j = n1c-2 en sautant j = 1 (les coefficients
217  * j=n1c-1 et j=0 ne sont pas consideres car nuls).
218  */
219  int borne_phi = n1c-1 ;
220  if (n1f == 1) borne_phi = 1 ;
221 
222  for (j=0; j< borne_phi; j++) {
223 
224  if (j==1) continue ; // on ne traite pas le terme en sin(0 phi)
225 
226  for (k=0; k<n3c; k++) {
227 
228  int i0 = n2n3c * j + k ; // indice de depart
229  double* cf0 = cf + i0 ; // tableau des donnees a transformer
230 
231  i0 = n2n3f * j + k ; // indice de depart
232  double* ff0 = ff + i0 ; // tableau resultat
233 
234 /*
235  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
236  * reliee a theta par psi = 2 theta et F(psi) = f(theta(psi)).
237  */
238 
239 // Calcul des coefficients de Fourier de la fonction
240 // G(psi) = F+(psi) + F_(psi) sin(psi)
241 // en fonction des coefficients en cos(2l theta) de f:
242 
243 // Coefficients impairs de G
244 //--------------------------
245 
246  double c1 = cf0[n3c] ;
247 
248  double som = 0;
249  ff0[n3f] = 0 ;
250  for ( i = 3; i < nt; i += 2 ) {
251  ff0[ n3f*i ] = cf0[ n3c*i ] - c1 ;
252  som += ff0[ n3f*i ] ;
253  }
254 
255 // Valeur en psi=0 de la partie antisymetrique de F, F_ :
256  double fmoins0 = nm1s2 * c1 + som ;
257 
258 // Coef. impairs de G
259 // NB: le facteur 0.25 est du a la normalisation de fft991; si fft991
260 // donnait exactement les coef. des sinus, ce facteur serait -0.5.
261  g[1] = 0 ;
262  for ( i = 3; i < nt; i += 2 ) {
263  g[i] = 0.25 * ( ff0[ n3f*i ] - ff0[ n3f*(i-2) ] ) ;
264  }
265  g[nt] = 0 ;
266 
267 
268 // Coefficients pairs de G
269 //------------------------
270 // Ces coefficients sont egaux aux coefficients pairs du developpement de
271 // f.
272 // NB: le facteur 0.5 est du a la normalisation de fft991; si fft991
273 // donnait exactement les coef. des cosinus, ce facteur serait 1.
274 
275  g[0] = cf0[0] ;
276  for (i=2; i<nm1; i += 2 ) g[i] = 0.5 * cf0[ n3c*i ] ;
277  g[nm1] = cf0[ n3c*nm1 ] ;
278 
279 // Transformation de Fourier inverse de G
280 //---------------------------------------
281 
282 // FFT inverse
283  F77_fft991( g, t1, trigo, facto, &inc, &jump, &nm1, &lot, &isign) ;
284 
285 // Valeurs de f deduites de celles de G
286 //-------------------------------------
287 
288  for ( i = 1; i < nm1s2 ; i++ ) {
289 // ... indice du pt symetrique de psi par rapport a pi/2:
290  int isym = nm1 - i ;
291 
292  double fp = 0.5 * ( g[i] + g[isym] ) ;
293  double fm = 0.5 * ( g[i] - g[isym] ) / sinp[i] ;
294  ff0[ n3f*i ] = fp + fm ;
295  ff0[ n3f*isym ] = fp - fm ;
296  }
297 
298 //... cas particuliers:
299  ff0[0] = g[0] + fmoins0 ;
300  ff0[ n3f*nm1 ] = g[0] - fmoins0 ;
301  ff0[ n3f*nm1s2 ] = g[nm1s2] ;
302 
303 
304  } // fin de la boucle sur r
305  } // fin de la boucle sur phi
306 
307  // Menage
308  free (t1) ;
309  free (g) ;
310 
311 }
312 }
Lorene prototypes.
Definition: app_hor.h:64