LORENE
FFTW3/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 bibliotheque fftw
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 + 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 char cftsin_C[] = "$Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftsin.C,v 1.3 2014/10/13 08:53:19 j_novak Exp $" ;
82 
83 /*
84  * $Id: cftsin.C,v 1.3 2014/10/13 08:53:19 j_novak Exp $
85  * $Log: cftsin.C,v $
86  * Revision 1.3 2014/10/13 08:53:19 j_novak
87  * Lorene classes and functions now belong to the namespace Lorene.
88  *
89  * Revision 1.2 2014/10/06 15:18:48 j_novak
90  * Modified #include directives to use c++ syntax.
91  *
92  * Revision 1.1 2004/12/21 17:06:02 j_novak
93  * Added all files for using fftw3.
94  *
95  * Revision 1.1 2004/11/23 15:13:50 m_forot
96  * Added the bases for the cases without any equatorial symmetry
97  * (T_COSSIN_C, T_COSSIN_S, T_LEG, R_CHEBPI_P, R_CHEBPI_I).
98  *
99  * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftsin.C,v 1.3 2014/10/13 08:53:19 j_novak Exp $
100  *
101  */
102 
103 // headers du C
104 #include <cstdlib>
105 #include <fftw3.h>
106 
108 #include "tbl.h"
109 
110 // Prototypage des sous-routines utilisees:
111 namespace Lorene {
112 fftw_plan prepare_fft(int, Tbl*&) ;
113 double* cheb_ini(const int) ;
114 //*****************************************************************************
115 
116 void cftsin(const int* deg, const int* dimf, double* ff, const int* dimc,
117  double* cf)
118 {
119 
120 int i, j, k ;
121 
122 // Dimensions des tableaux ff et cf :
123  int n1f = dimf[0] ;
124  int n2f = dimf[1] ;
125  int n3f = dimf[2] ;
126  int n1c = dimc[0] ;
127  int n2c = dimc[1] ;
128  int n3c = dimc[2] ;
129 
130 // Nombre de degres de liberte en theta :
131  int nt = deg[1] ;
132 
133 // Tests de dimension:
134  if (nt > n2f) {
135  cout << "cftsin: nt > n2f : nt = " << nt << " , n2f = "
136  << n2f << endl ;
137  abort () ;
138  exit(-1) ;
139  }
140  if (nt > n2c) {
141  cout << "cftsin: nt > n2c : nt = " << nt << " , n2c = "
142  << n2c << endl ;
143  abort () ;
144  exit(-1) ;
145  }
146  if (n1f > n1c) {
147  cout << "cftsin: n1f > n1c : n1f = " << n1f << " , n1c = "
148  << n1c << endl ;
149  abort () ;
150  exit(-1) ;
151  }
152  if (n3f > n3c) {
153  cout << "cftsin: n3f > n3c : n3f = " << n3f << " , n3c = "
154  << n3c << endl ;
155  abort () ;
156  exit(-1) ;
157  }
158 
159 // Nombre de points pour la FFT:
160  int nm1 = nt - 1;
161  int nm1s2 = nm1 / 2;
162 
163 // Recherche des tables pour la FFT:
164  Tbl* pg = 0x0 ;
165  fftw_plan p = prepare_fft(nm1, pg) ;
166  Tbl& g = *pg ;
167 
168 // Recherche de la table des sin(psi) :
169  double* sinp = cheb_ini(nt);
170 
171 // boucle sur phi et r (les boucles vont resp. de 0 a max(dimf[0]-2,0) et
172 // 0 a dimf[2]-1 )
173 
174  int n2n3f = n2f * n3f ;
175  int n2n3c = n2c * n3c ;
176 
177 /*
178  * Borne de la boucle sur phi:
179  * si n1f = 1, on effectue la boucle une fois seulement.
180  * si n1f > 1, on va jusqu'a j = n1f-2 en sautant j = 1 (les coefficients
181  * j=n1f-1 et j=0 ne sont pas consideres car nuls).
182  */
183  int borne_phi = ( n1f > 1 ) ? n1f-1 : 1 ;
184 
185  for (j=0; j< borne_phi; j++) {
186 
187  if (j==1) continue ; // on ne traite pas le terme en sin(0 phi)
188 
189  for (k=0; k<n3f; k++) {
190 
191  int i0 = n2n3f * j + k ; // indice de depart
192  double* ff0 = ff + i0 ; // tableau des donnees a transformer
193 
194  i0 = n2n3c * j + k ; // indice de depart
195  double* cf0 = cf + i0 ; // tableau resultat
196 
197 // Fonction G(psi) = F+(psi)sin(psi) + F_(psi)
198 //---------------------------------------------
199  for ( i = 1; i < nm1s2 ; i++ ) {
200 // ... indice (dans le tableau g) du pt symetrique de psi par rapport a pi/2:
201  int isym = nm1 - i ;
202 // ... indice (dans le tableau ff0) du point theta correspondant a psi
203  int ix = n3f * i ;
204 // ... indice (dans le tableau ff0) du point theta correspondant a sym(psi)
205  int ixsym = n3f * isym ;
206 // ... F+(psi)
207  double fp = 0.5 * ( ff0[ix] + ff0[ixsym] ) * sinp[i] ;
208 // ... F_(psi) sin(psi)
209  double fms = 0.5 * ( ff0[ix] - ff0[ixsym] ) ;
210  g.set(i) = fp + fms ;
211  g.set(isym) = fp - fms ;
212  }
213 //... cas particuliers:
214  g.set(0) = 0.5 * ( ff0[0] + ff0[ n3f*nm1 ] );
215  g.set(nm1s2) = ff0[ n3f*nm1s2 ];
216 
217 // Developpement de G en series de Fourier par une FFT
218 //----------------------------------------------------
219 
220  fftw_execute(p) ;
221 
222 // Coefficients pairs du developmt. sin(l theta) de f
223 //----------------------------------------------------
224 // Ces coefficients sont egaux aux coefficients en sinus du developpement
225 // de G en series de Fourier (le facteur -2/nm1 vient de la normalisation
226 // de fftw) :
227 
228  double fac = -2. / double(nm1) ;
229  cf0[0] = 0. ;
230  for (i=2; i<nm1; i += 2 ) cf0[n3c*i] = fac * g(nm1 - i/2) ;
231  cf0[n3c*nm1] = 0. ;
232 
233 // Coefficients impairs du developmt. en sin(l theta) de f
234 //---------------------------------------------------------
235 // 1. Coef. c'_k (recurrence amorcee a partir de zero):
236 // Le 4/nm1 en facteur de g[i] est du a la normalisation de fftw
237 // (si fftw donnait reellement les coef. en sinus, il faudrait le
238 // remplacer par un -2.)
239 
240  cf0[n3c] = -fac * g(0);
241  fac *= -2. ;
242  for ( i = 3; i < nt; i += 2 ) {
243  cf0[n3c*i] = cf0[n3c*(i-2)] + fac * g(i/2) ;
244  }
245 
246  } // fin de la boucle sur r
247  } // fin de la boucle sur phi
248 
249 }
250 }
Lorene prototypes.
Definition: app_hor.h:64