7.2
general documentation
cs_cdo_blas.h
Go to the documentation of this file.
1 #ifndef __CS_CDO_BLAS_H__
2 #define __CS_CDO_BLAS_H__
3 
4 /*============================================================================
5  * Functions computing BLAS 1 operations (like square norms and dot products
6  * from CDO quantities)
7  *============================================================================*/
8 
9 /*
10  This file is part of code_saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2022 EDF S.A.
13 
14  This program is free software; you can redistribute it and/or modify it under
15  the terms of the GNU General Public License as published by the Free Software
16  Foundation; either version 2 of the License, or (at your option) any later
17  version.
18 
19  This program is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22  details.
23 
24  You should have received a copy of the GNU General Public License along with
25  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26  Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 */
28 
29 /*----------------------------------------------------------------------------*/
30 
31 /*----------------------------------------------------------------------------
32  * Local headers
33  *----------------------------------------------------------------------------*/
34 
35 #include "cs_base.h"
36 #include "cs_cdo_connect.h"
37 #include "cs_cdo_quantities.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
41 BEGIN_C_DECLS
42 
43 /*============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /*----------------------------------------------------------------------------*/
61 /*----------------------------------------------------------------------------*/
62 
63 typedef cs_real_t
64 (cs_cdo_blas_dotprod_t) (const cs_real_t *a,
65  const cs_real_t *b);
66 
67 /*----------------------------------------------------------------------------*/
76 /*----------------------------------------------------------------------------*/
77 
78 typedef cs_real_t
79 (cs_cdo_blas_square_norm_t) (const cs_real_t *array);
80 
81 /*----------------------------------------------------------------------------*/
93 /*----------------------------------------------------------------------------*/
94 
95 typedef cs_real_t
96 (cs_cdo_blas_square_norm_diff_t) (const cs_real_t *a,
97  const cs_real_t *b);
98 
99 /*============================================================================
100  * Public function prototypes
101  *============================================================================*/
102 
103 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 void
113 cs_cdo_blas_init_sharing(const cs_cdo_quantities_t *quant,
114  const cs_cdo_connect_t *connect);
115 
116 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
129 cs_real_t
130 cs_cdo_blas_square_norm_pcsp(const cs_real_t *array);
131 
132 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 cs_real_t
147 cs_cdo_blas_square_norm_pcsp_diff(const cs_real_t *a,
148  const cs_real_t *b);
149 
150 /*----------------------------------------------------------------------------*/
164 /*----------------------------------------------------------------------------*/
165 
166 cs_real_t
167 cs_cdo_blas_square_norm_pcsp_ndiff(const cs_real_t *a,
168  const cs_real_t *ref);
169 
170 /*----------------------------------------------------------------------------*/
182 /*----------------------------------------------------------------------------*/
183 
184 double
185 cs_cdo_blas_dotprod_vertex(const cs_real_t *a,
186  const cs_real_t *b);
187 
188 /*----------------------------------------------------------------------------*/
198 /*----------------------------------------------------------------------------*/
199 
200 double
201 cs_cdo_blas_square_norm_vertex(const cs_real_t *array);
202 
203 /*----------------------------------------------------------------------------*/
217 /*----------------------------------------------------------------------------*/
218 
219 double
220 cs_cdo_blas_dotprod_pvsp(const cs_real_t *a,
221  const cs_real_t *b);
222 
223 /*----------------------------------------------------------------------------*/
234 /*----------------------------------------------------------------------------*/
235 
236 cs_real_t
237 cs_cdo_blas_square_norm_pvsp(const cs_real_t *array);
238 
239 /*----------------------------------------------------------------------------*/
251 /*----------------------------------------------------------------------------*/
252 
253 cs_real_t
254 cs_cdo_blas_square_norm_pvsp_diff(const cs_real_t *a,
255  const cs_real_t *b);
256 
257 /*----------------------------------------------------------------------------*/
269 /*----------------------------------------------------------------------------*/
270 
271 double
272 cs_cdo_blas_square_norm_2pvsp(const cs_real_t *array);
273 
274 /*----------------------------------------------------------------------------*/
288 /*----------------------------------------------------------------------------*/
289 
290 double
291 cs_cdo_blas_dotprod_2pvsp(const cs_real_t *a,
292  const cs_real_t *b);
293 
294 /*----------------------------------------------------------------------------*/
306 /*----------------------------------------------------------------------------*/
307 
308 cs_real_t
309 cs_cdo_blas_dotprod_face(const cs_real_t *a,
310  const cs_real_t *b);
311 
312 /*----------------------------------------------------------------------------*/
322 /*----------------------------------------------------------------------------*/
323 
324 cs_real_t
325 cs_cdo_blas_square_norm_face(const cs_real_t *array);
326 
327 /*----------------------------------------------------------------------------*/
339 /*----------------------------------------------------------------------------*/
340 
341 cs_real_t
342 cs_cdo_blas_square_norm_pfsp(const cs_real_t *array);
343 
344 /*----------------------------------------------------------------------------*/
356 /*----------------------------------------------------------------------------*/
357 
358 cs_real_t
359 cs_cdo_blas_square_norm_pfvp(const cs_real_t *array);
360 
361 /*----------------------------------------------------------------------------*/
375 /*----------------------------------------------------------------------------*/
376 
377 cs_real_t
378 cs_cdo_blas_dotprod_pfsf(const cs_real_t *a,
379  const cs_real_t *b);
380 
381 /*----------------------------------------------------------------------------*/
393 /*----------------------------------------------------------------------------*/
394 
395 cs_real_t
396 cs_cdo_blas_square_norm_pfsf(const cs_real_t *array);
397 
398 /*----------------------------------------------------------------------------*/
411 /*----------------------------------------------------------------------------*/
412 
413 cs_real_t
414 cs_cdo_blas_square_norm_pfsf_diff(const cs_real_t *a,
415  const cs_real_t *b);
416 
417 /*----------------------------------------------------------------------------*/
418 
419 END_C_DECLS
420 
421 #endif /* __CS_CDO_BLAS_H__ */
cs_base.h
cs_cdo_connect.h
cs_cdo_blas_square_norm_diff_t
cs_real_t() cs_cdo_blas_square_norm_diff_t(const cs_real_t *a, const cs_real_t *b)
Generic function pointer for computing a square norm of the difference between two arrays (defined at...
Definition: cs_cdo_blas.h:96
cs_cdo_blas_square_norm_face
cs_real_t cs_cdo_blas_square_norm_face(const cs_real_t *array)
Compute the square norm of an array using an Euclidean 2-norm. Case of a scalar-valued array defined ...
Definition: cs_cdo_blas.c:1015
cs_cdo_blas_dotprod_t
cs_real_t() cs_cdo_blas_dotprod_t(const cs_real_t *a, const cs_real_t *b)
Generic function pointer for computing a dot product. Parallel synchronization is performed...
Definition: cs_cdo_blas.h:64
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_cdo_blas_square_norm_pfsf_diff
cs_real_t cs_cdo_blas_square_norm_pfsf_diff(const cs_real_t *a, const cs_real_t *b)
Compute the norm ||b - a||**2 Case of a scalar-valued array defined as a flux at primal faces...
Definition: cs_cdo_blas.c:1281
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_blas_dotprod_pvsp
double cs_cdo_blas_dotprod_pvsp(const cs_real_t *a, const cs_real_t *b)
Compute the dot product of two arrays using a weighted Euclidean dot product relying on CDO quantitie...
Definition: cs_cdo_blas.c:660
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:132
cs_cdo_blas_square_norm_2pvsp
double cs_cdo_blas_square_norm_2pvsp(const cs_real_t *array)
Compute the square norm of an array Case of a non-interlaced scalar-valued array of stride = 2 define...
Definition: cs_cdo_blas.c:864
cs_cdo_blas_square_norm_t
cs_real_t() cs_cdo_blas_square_norm_t(const cs_real_t *array)
Generic function pointer for computing a square norm. Parallel synchronization is performed...
Definition: cs_cdo_blas.h:79
cs_fuel_incl::a
double precision, save a
Definition: cs_fuel_incl.f90:146
cs_cdo_blas_init_sharing
void cs_cdo_blas_init_sharing(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect)
Set shared pointers to main domain members.
Definition: cs_cdo_blas.c:330
cs_cdo_blas_square_norm_vertex
double cs_cdo_blas_square_norm_vertex(const cs_real_t *array)
Compute the square norm of an array using an Euclidean 2-norm. Case of a scalar-valued array defined ...
Definition: cs_cdo_blas.c:634
cs_cdo_blas_square_norm_pvsp
cs_real_t cs_cdo_blas_square_norm_pvsp(const cs_real_t *array)
Compute the square norm of an array Case of a scalar-valued array defined as a potential at primal ve...
Definition: cs_cdo_blas.c:748
cs_cdo_blas_square_norm_pfvp
cs_real_t cs_cdo_blas_square_norm_pfvp(const cs_real_t *array)
Compute the square norm of an array Case of a vector-valued array defined as a potential at primal fa...
Definition: cs_cdo_blas.c:1065
cs_cdo_blas_square_norm_pcsp_diff
cs_real_t cs_cdo_blas_square_norm_pcsp_diff(const cs_real_t *a, const cs_real_t *b)
Compute the norm ||b - a||**2 Case of two scalar-valued arrays a and b defined as a potential at prim...
Definition: cs_cdo_blas.c:435
cs_cdo_quantities.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_cdo_blas_dotprod_2pvsp
double cs_cdo_blas_dotprod_2pvsp(const cs_real_t *a, const cs_real_t *b)
Compute the dot product of two arrays using a weighted Euclidean dot product relying on CDO quantitie...
Definition: cs_cdo_blas.c:903
cs_cdo_blas_dotprod_face
cs_real_t cs_cdo_blas_dotprod_face(const cs_real_t *a, const cs_real_t *b)
Compute the dot product of two arrays using the classical Euclidean dot product (without weight)...
Definition: cs_cdo_blas.c:996
cs_cdo_blas_square_norm_pfsp
cs_real_t cs_cdo_blas_square_norm_pfsp(const cs_real_t *array)
Compute the square norm of an array Case of a scalar-valued array defined as a potential at primal fa...
Definition: cs_cdo_blas.c:1039
cs_cdo_blas_dotprod_pfsf
cs_real_t cs_cdo_blas_dotprod_pfsf(const cs_real_t *a, const cs_real_t *b)
Compute the dot product of two arrays using a weighted Euclidean dot product relying on CDO quantitie...
Definition: cs_cdo_blas.c:1093
cs_cdo_blas_square_norm_pcsp_ndiff
cs_real_t cs_cdo_blas_square_norm_pcsp_ndiff(const cs_real_t *a, const cs_real_t *ref)
Compute the norm ||a - ref||**2 / || ref||**2 Case of two scalar-valued arrays a and ref defined as a...
Definition: cs_cdo_blas.c:520
cs_cdo_blas_dotprod_vertex
double cs_cdo_blas_dotprod_vertex(const cs_real_t *a, const cs_real_t *b)
Compute the dot product of two arrays using the classical Euclidean dot product (without weight)...
Definition: cs_cdo_blas.c:615
cs_cdo_blas_square_norm_pvsp_diff
cs_real_t cs_cdo_blas_square_norm_pvsp_diff(const cs_real_t *a, const cs_real_t *b)
Compute the norm ||b - a||**2 Case of two scalar-valued arrays a and b defined as a potential at prim...
Definition: cs_cdo_blas.c:774
cs_cdo_blas_square_norm_pcsp
cs_real_t cs_cdo_blas_square_norm_pcsp(const cs_real_t *array)
Compute the square norm of an array Case of a scalar-valued array defined as a potential at primal ce...
Definition: cs_cdo_blas.c:353
cs_cdo_blas_square_norm_pfsf
cs_real_t cs_cdo_blas_square_norm_pfsf(const cs_real_t *array)
Compute the square norm of an array Case of a scalar-valued array defined as a flux at primal faces...
Definition: cs_cdo_blas.c:1187
cs_fuel_incl::b
double precision, save b
Definition: cs_fuel_incl.f90:146