LORENE
valeur_ylm.C
1/*
2 * Copyright (c) 1999-2003 Eric Gourgoulhon
3 * Copyright (c) 1999-2001 Philippe Grandclement
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
25
26
27/*
28 * Fonction membre de la classe Valeur qui calcule les coefficients
29 * de la decomposition spectrale en harmoniques spheriques
30 * a partir des coefficients en cos(l*theta) / sin(l*theta)
31 *
32 */
33
34/*
35 * $Id: valeur_ylm.C,v 1.13 2016/12/05 16:18:21 j_novak Exp $
36 * $Log: valeur_ylm.C,v $
37 * Revision 1.13 2016/12/05 16:18:21 j_novak
38 * Suppression of some global variables (file names, loch, ...) to prevent redefinitions
39 *
40 * Revision 1.12 2014/10/13 08:53:51 j_novak
41 * Lorene classes and functions now belong to the namespace Lorene.
42 *
43 * Revision 1.11 2014/10/06 15:13:25 j_novak
44 * Modified #include directives to use c++ syntax.
45 *
46 * Revision 1.10 2009/10/23 12:56:29 j_novak
47 * New base T_LEG_MI
48 *
49 * Revision 1.9 2009/10/13 13:49:58 j_novak
50 * New base T_LEG_MP.
51 *
52 * Revision 1.8 2005/11/22 10:13:44 p_grandclement
53 * Correction of the normalization in the case nt=1
54 *
55 * Revision 1.7 2005/02/16 15:33:38 m_forot
56 * Correct the case T_LEG
57 *
58 * Revision 1.6 2004/11/23 15:17:20 m_forot
59 * Added the bases for the cases without any equatorial symmetry
60 * (T_COSSIN_C, T_COSSIN_S, T_LEG, R_CHEBPI_P, R_CHEBPI_I).
61 *
62 * Revision 1.5 2003/10/13 20:52:58 e_gourgoulhon
63 * Loop variables i and l have now local scope.
64 *
65 * Revision 1.4 2003/09/17 12:30:22 j_novak
66 * New checks for changing to T_LEG* bases.
67 *
68 * Revision 1.3 2003/09/16 08:54:09 j_novak
69 * Addition of the T_LEG_II base (odd in theta, only for odd m) and the
70 * transformation functions to and from the T_SIN_P base.
71 *
72 * Revision 1.2 2002/10/16 14:37:16 j_novak
73 * Reorganization of #include instructions of standard C++, in order to
74 * use experimental version 3 of gcc.
75 *
76 * Revision 1.1.1.1 2001/11/20 15:19:27 e_gourgoulhon
77 * LORENE
78 *
79 * Revision 2.12 2000/09/29 16:10:21 eric
80 * Ajout des bases T_LEG_IP et T_LEG_PI.
81 *
82 * Revision 2.11 2000/03/31 15:58:40 phil
83 * changement des bases meme si etat est zero
84 *
85 * Revision 2.10 1999/12/22 16:25:26 eric
86 * Traitement du cas ETATZERO
87 * Test sur c_cf avant d'appeler coef().
88 *
89 * Revision 2.9 1999/12/16 16:41:38 phil
90 * *** empty log message ***
91 *
92 * Revision 2.8 1999/12/16 16:09:56 phil
93 * correction cas nt=1
94 *
95 * Revision 2.7 1999/11/30 12:46:33 eric
96 * Valeur::base est desormais du type Base_val et non plus Base_val*.
97 *
98 * Revision 2.6 1999/11/19 09:25:57 eric
99 * *** empty log message ***
100 *
101 * Revision 2.5 1999/10/18 14:12:09 eric
102 * Les bases sont desormais membres des Mtbl_cf.
103 *
104 * Revision 2.4 1999/04/14 10:19:46 phil
105 * *** empty log message ***
106 *
107 * Revision 2.3 1999/04/14 09:52:28 phil
108 * remplacement de malloc en new
109 *
110 * Revision 2.2 1999/04/14 09:36:03 phil
111 * Changement liberation memoire : free -> delete
112 *
113 * Revision 2.1 1999/04/13 16:44:07 phil
114 * *** empty log message ***
115 *
116 * Revision 2.0 1999/04/13 16:36:57 phil
117 * *** empty log message ***
118 *
119 * Revision 1.1 1999/04/13 16:36:14 phil
120 * Initial revision
121 *
122 *
123 * $Header: /cvsroot/Lorene/C++/Source/Valeur/valeur_ylm.C,v 1.13 2016/12/05 16:18:21 j_novak Exp $
124 *
125 */
126
127// headers du C
128#include <cassert>
129#include <cstdlib>
130#include <cmath>
131
132// headers Lorene
133#include "type_parite.h"
134#include "valeur.h"
135#include "proto.h"
136
137namespace Lorene {
138void ylm_pasprevu(const int*, const double*, double*) ;
139
140//******************************************************************************
142
143 static void (*chbase_t[MAX_BASE])(const int*, const double*,
144 double*) ;
145 static int nouv_base_t[MAX_BASE] ;
146 static int premier_appel = 1 ;
147
148 int deg[3] ;
149
150 if (premier_appel==1) {
151 premier_appel = 0 ;
152
153 for (int i=0; i<MAX_BASE; i++) {
154 chbase_t[i] = ylm_pasprevu ;
155 nouv_base_t[i] = NONDEF ;
156 }
157
158 chbase_t[T_COSSIN_CP >> TRA_T] = chb_cossincp_legp ;
159 nouv_base_t[T_COSSIN_CP >> TRA_T] = T_LEG_P ;
160
161 chbase_t[T_COSSIN_CI >> TRA_T] = chb_cossinci_legi ;
162 nouv_base_t[T_COSSIN_CI >> TRA_T] = T_LEG_I ;
163
164 chbase_t[T_COSSIN_C >> TRA_T] = chb_cossinc_leg ;
165 nouv_base_t[T_COSSIN_C >> TRA_T] = T_LEG ;
166
167 chbase_t[T_COS_P >> TRA_T] = chb_cosp_legpp ;
168 nouv_base_t[T_COS_P >> TRA_T] = T_LEG_PP ;
169
170 chbase_t[T_COS_I >> TRA_T] = chb_cosi_legip ;
171 nouv_base_t[T_COS_I >> TRA_T] = T_LEG_IP ;
172
173 chbase_t[T_SIN_I >> TRA_T] = chb_sini_legpi ;
174 nouv_base_t[T_SIN_I >> TRA_T] = T_LEG_PI ;
175
176 chbase_t[T_SIN_P >> TRA_T] = chb_sinp_legii ;
177 nouv_base_t[T_SIN_P >> TRA_T] = T_LEG_II ;
178
179 chbase_t[T_COS >> TRA_T] = chb_cos_legmp ;
180 nouv_base_t[T_COS >> TRA_T] = T_LEG_MP ;
181
182 chbase_t[T_SIN >> TRA_T] = chb_sin_legmi ;
183 nouv_base_t[T_SIN >> TRA_T] = T_LEG_MI ;
184 }
185
186//---------------------------------------------------------------------------
187// fin des operation de premier appel
188//---------------------------------------------------------------------------
189
190 // Tout null ?
191 int nzone = get_mg()->get_nzone() ;
192 if (etat == ETATZERO) {
193 for (int l=0 ; l<nzone ; l++) {
194 int vbase_r = base.b[l] & MSQ_R ;
195 int vbase_t = base.b[l] & MSQ_T ;
196 int vbase_p = base.b[l] & MSQ_P ;
197 int vbase_t_tra = vbase_t >> TRA_T ;
198 base.b[l] = ( vbase_p | nouv_base_t[vbase_t_tra] ) | vbase_r ;
199 }
200 return ;
201 }
202
203 // Protection
204 assert(etat != ETATNONDEF) ;
205
206 if (c_cf == 0x0) {
207 coef() ; // The coefficients are required
208 }
209
210// Boucle sur les differentes zones
211
212 for (int l=0; l<nzone; l++) {
213
214// On recupere les anciennes bases en r, phi et theta :
215 int vbase_r = base.b[l] & MSQ_R ;
216 int vbase_t = base.b[l] & MSQ_T ;
217 int vbase_p = base.b[l] & MSQ_P ;
218
219 if ((vbase_t != T_LEG_P) && (vbase_t != T_LEG_IP) &&
220 (vbase_t != T_LEG_PP) && (vbase_t != T_LEG_I) &&
221 (vbase_t != T_LEG_II) && (vbase_t != T_LEG_PI) &&
222 (vbase_t != T_LEG) && (vbase_t != T_LEG_MP) &&
223 (vbase_t != T_LEG_MI) )
224 { // cas ou le calcul est necessaire
225
226 int vbase_t_tra = vbase_t >> TRA_T ;
227 assert(vbase_t_tra < MAX_BASE) ;
228 bool pair = ( (vbase_t == T_COS_P) || (vbase_t == T_COS_I) ||
229 (vbase_t == T_COS) ) ;
230 bool impair = ( (vbase_t == T_SIN_P) || (vbase_t == T_SIN_I) ||
231 (vbase_t == T_SIN) ) ;
232
233// Nouvelle base :
234 base.b[l] = ( vbase_p | nouv_base_t[vbase_t_tra] ) | vbase_r ;
235 if (get_mg()->get_nt(l)==1) {
236 *c_cf->t[l] *=sqrt(2.) ;
237 continue ;
238 }
239
240//... tbl contenant les coefficients dans la zone l :
241 Tbl* cf = c_cf->t[l] ;
242
243 if (cf->get_etat() == ETATZERO) continue ; // On ne fait rien si le tbl = 0
244
245 deg[0] = get_mg()->get_np(l) ; // nb. de degres de liberte en phi
246 deg[1] = get_mg()->get_nt(l) ; // nb. de degres de liberte en theta
247 deg[2] = get_mg()->get_nr(l) ; // nb. de degres de liberte en r
248
249//... resultat du calcul :
250 double* resu = new double [cf->get_taille()] ;
251
252// Transformation en theta:
253//-------------------------
254
255 if ((pair && (vbase_p == P_COSSIN_I)) ||
256 (impair && (vbase_p == P_COSSIN_P)) )
257 ylm_pasprevu(deg, (cf->t), resu ) ;
258 else
259 chbase_t[vbase_t_tra](deg, (cf->t), resu ) ;
260
261// On branche le tbl contenant les coef sur resu :
262 delete [] cf->t ; // les anciens coef. sont oublies
263 cf->t = resu ; // nouveaux coef.
264
265 } // fin du cas ou la transformation devait etre effectuee
266
267 } // fin de la boucle sur les differentes zones
268
269 // On met les bonnes bases dans c_cf :
270 c_cf->base = base ;
271
272}
273
274//******************************************************************************
275
276void ylm_pasprevu(const int* , const double*, double* ) {
277
278 cout <<
279 "Valeur::ylm: change of basis not implemented yet !"
280 << endl ;
281 abort() ;
282}
283
284}
int get_np(int l) const
Returns the number of points in the azimuthal direction ( ) in domain no. l.
Definition grilles.h:479
int get_nt(int l) const
Returns the number of points in the co-latitude direction ( ) in domain no. l.
Definition grilles.h:474
int get_nzone() const
Returns the number of domains.
Definition grilles.h:465
int get_nr(int l) const
Returns the number of points in the radial direction ( ) in domain no. l.
Definition grilles.h:469
Basic array class.
Definition tbl.h:161
int get_etat() const
Gives the logical state.
Definition tbl.h:394
int get_taille() const
Gives the total size (ie dim.taille).
Definition tbl.h:397
double * t
The array of double.
Definition tbl.h:173
void ylm()
Computes the coefficients of *this.
Definition valeur_ylm.C:141
Mtbl_cf * c_cf
Coefficients of the spectral expansion of the function.
Definition valeur.h:312
void coef() const
Computes the coeffcients of *this.
const Mg3d * get_mg() const
Returns the Mg3d on which the this is defined.
Definition valeur.h:763
Base_val base
Bases on which the spectral expansion is performed.
Definition valeur.h:315
int etat
Logical state (ETATNONDEF , ETATQCQ or ETATZERO ).
Definition valeur.h:305
Cmp sqrt(const Cmp &)
Square root.
Definition cmp_math.C:223
#define TRA_T
Translation en Theta, used for a bitwise shift (in hex).
#define T_LEG_MP
fct. de Legendre associees avec m pair
#define P_COSSIN_P
dev. sur Phi = 2*phi, freq. paires
#define MAX_BASE
Nombre max. de bases differentes.
#define T_LEG_PI
fct. de Legendre associees paires avec m impair
#define T_LEG
fct. de Legendre associees
#define T_SIN_P
dev. sin seulement, harmoniques paires
#define MSQ_R
Extraction de l'info sur R.
#define T_LEG_P
fct. de Legendre associees paires
#define T_LEG_IP
fct. de Legendre associees impaires avec m pair
#define NONDEF
base inconnue
#define T_COS_P
dev. cos seulement, harmoniques paires
#define T_COSSIN_CI
cos impair-sin pair alternes, cos pour m=0
#define P_COSSIN_I
dev. sur Phi = 2*phi, freq. impaires
#define T_LEG_MI
fct. de Legendre associees avec m impair
#define MSQ_T
Extraction de l'info sur Theta.
#define T_COSSIN_CP
cos pair-sin impair alternes, cos pour m=0
#define T_LEG_II
fct. de Legendre associees impaires avec m impair
#define T_LEG_I
fct. de Legendre associees impaires
#define T_SIN_I
dev. sin seulement, harmoniques impaires
#define T_COS
dev. cos seulement
#define MSQ_P
Extraction de l'info sur Phi.
#define T_SIN
dev. sin seulement
#define T_LEG_PP
fct. de Legendre associees paires avec m pair
#define T_COS_I
dev. cos seulement, harmoniques impaires
#define T_COSSIN_C
dev. cos-sin alternes, cos pour m=0
Lorene prototypes.
Definition app_hor.h:67