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