/usr/include/code_saturne/cs_parall.h is in code-saturne-include 3.2.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 | #ifndef __CS_PARALL_H__
#define __CS_PARALL_H__
/*============================================================================
* Functions dealing with parallelism
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2013 EDF S.A.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*============================================================================
* Public function prototypes for Fortran API
*============================================================================*/
/*----------------------------------------------------------------------------
* Compute the maximum value of a counter (int) for the entire domain in
* case of parallelism.
*
* Fortran Interface
*
* subroutine parcmx (counter)
* *****************
*
* integer counter <-> : input = local counter
* output = global max counter
*----------------------------------------------------------------------------*/
void
CS_PROCF (parcmx, PARCMX)(cs_int_t *counter);
/*----------------------------------------------------------------------------
* Compute the minimum value of a counter (int) for the entire domain in
* case of parallelism.
*
* Fortran Interface
*
* subroutine parcmn (counter)
* *****************
*
* integer counter <-> : input = local counter
* output = global min counter
*----------------------------------------------------------------------------*/
void
CS_PROCF (parcmn, PARCMN)(cs_int_t *counter);
/*----------------------------------------------------------------------------
* Compute the global sum of a counter (int) for the entire domain in case
* of parallelism.
*
* Fortran Interface :
*
* subroutine parcpt (counter)
* *****************
*
* integer counter : <-> : input = counter to sum
* output = global sum
*----------------------------------------------------------------------------*/
void
CS_PROCF (parcpt, PARCPT)(cs_int_t *counter);
/*----------------------------------------------------------------------------
* Compute the global sum of a real for the entire domain in case of parellism
*
* Fortran Interface :
*
* subroutine parsom (var)
* *****************
*
* double precision var : <-> : input = value to sum
* output = global sum
*----------------------------------------------------------------------------*/
void
CS_PROCF (parsom, PARSOM)(cs_real_t *var);
/*----------------------------------------------------------------------------
* Compute the maximum value of a real variable for the entire domain in case
* of parallelism.
*
* Fortran Interface :
*
* subroutine parmax (var)
* *****************
*
* double precision var : <-> : input = local maximum value
* output = global maximum value
*----------------------------------------------------------------------------*/
void
CS_PROCF (parmax, PARMAX)(cs_real_t *var);
/*----------------------------------------------------------------------------
* Compute the minimum value of a real variable for the entire domain in case
* of parallelism.
*
* Fortran Interface :
*
* subroutine parmin (var)
* *****************
*
* double precision var : <-> : input = local minimum value
* output = global minimum value
*----------------------------------------------------------------------------*/
void
CS_PROCF (parmin, PARMIN)(cs_real_t *var);
/*----------------------------------------------------------------------------
* Maximum value of a real and its related rank for the entire domain in
* case of parallelism.
*
* Fortran Interface
*
* subroutine parmxl (nbr, var, xyzvar)
* *****************
*
* integer nbr : <-- : size of the related variable
* double precision var : <-> : input: local max. value
* output: global max. value
* double precision xyzvar(nbr) : <-> : input: value related to local max.
* output: value related to global max.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parmxl, PARMXL)(cs_int_t *nbr,
cs_real_t *var,
cs_real_t xyzvar[]);
/*----------------------------------------------------------------------------
* Minimum value of a real and its related rank for the entire domain in
* case of parallelism.
*
* Fortran Interface
*
* Interface Fortran :
*
* subroutine parmnl (nbr, var, xyzvar)
* *****************
*
* integer nbr : <-- : size of the related variable
* double precision var : <-> : input: local max. value
* output: global max. value
* double precision xyzvar(nbr) : <-> : input: value related to local max.
* output: value related to global max.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parmnl, PARMNL)(cs_int_t *nbr,
cs_real_t *var,
cs_real_t xyzvar[]);
/*----------------------------------------------------------------------------
* Compute the global sum for each element of an array of int in case of
* parallelism.
*
* Fortran Interface
*
* subroutine parism (n_elts, array)
* *****************
*
* integer n_elts : <-- : size of the array.
* integer array(*) : <-> : input = local array
* output = array of global sum values.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parism, PARISM)(cs_int_t *n_elts,
cs_int_t array[]);
/*----------------------------------------------------------------------------
* Compute the global maximum value for each element of an array of int in
* case of parallelism.
*
* Fortran Interface :
*
* subroutine parimx (n_elts, array)
* *****************
*
* integer n_elts : <-- : size of the array.
* integer array(*) : <-> : input = local array
* output = array of global max. values.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parimx, PARIMX)(cs_int_t *n_elts,
cs_int_t array[]);
/*----------------------------------------------------------------------------
* Compute the global minimum value for each element of an array of int in
* case of parallelism.
*
* Fortran Interface :
*
* subroutine parimn (n_elts, array)
* *****************
*
* integer n_elts : <-- : size of the array.
* integer array(*) : <-> : input = local array
* output = array of global min. values.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parimn, PARIMN)(cs_int_t *n_elts,
cs_int_t array[]);
/*----------------------------------------------------------------------------
* Compute the global sum for each element of an array of real in case of
* parallelism.
*
* Fortran Interface
*
* subroutine parrsm (n_elts, array)
* *****************
*
* integer n_elts : <-- : size of the array.
* double precision array(*) : <-> : input = local array
* output = array of global sum values.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parrsm, PARRSM)(cs_int_t *n_elts,
cs_real_t array[]);
/*----------------------------------------------------------------------------
* Compute the global maximum value for each element of an array of real in
* case of parallelism.
*
* Fortran Interface :
*
* subroutine parrmx (n_elts, array)
* *****************
*
* integer n_elts : <-- : size of the array
* double precision array(*) : <-> : input = local array
* output = array of global max. values.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parrmx, PARRMX)(cs_int_t *n_elts,
cs_real_t array[]);
/*----------------------------------------------------------------------------
* Compute the global minimum value for each element of an array of real in
* case of parallelism.
*
* Fortran Interface :
*
* subroutine parrmn (n_elts, array)
* *****************
*
* integer n_elts : <-- : size of the array
* double precision array(*) : <-> : input = local array
* output = array of global min. values.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parrmn, PARRMN)(cs_int_t *n_elts,
cs_real_t array[]);
/*----------------------------------------------------------------------------
* Broadcast to all the ranks the value of each element of an array of int.
* (encapsulation of MPI_Bcast())
*
* Fortran Interface :
*
* subroutine parbci (irank, n_elts, array)
* *****************
*
* integer irank : <-- : rank related to the sending process
* integer n_elts : <-- : size of the array
* integer array(*) : <-> : array to broadcast
*----------------------------------------------------------------------------*/
void
CS_PROCF (parbci, PARBCI)(cs_int_t *irank,
cs_int_t *n_elts,
cs_int_t array[]);
/*----------------------------------------------------------------------------
* Broadcast to all the ranks the value of each element of an array of real.
* (encapsulation of MPI_Bcast())
*
* Fortran Interface :
*
* subroutine parbcr (irank, n_elts, array)
* *****************
*
* integer irank : <-- : rank related to the sending process
* integer n_elts : <-- : size of the array
* double precision array(*) : <-> : array to broadcast
*----------------------------------------------------------------------------*/
void
CS_PROCF (parbcr, PARBCR)(cs_int_t *irank,
cs_int_t *n_elts,
cs_real_t array[]);
/*----------------------------------------------------------------------------
* Build a global array from each local array in each domain. The size of
* each local array can be different.
*
* Fortran Interface :
*
* subroutine paragv (nvar, nvargb, var, vargb)
* *****************
*
* integer n_elts : <-- : size of the local array
* integer n_g_elts : <-- : size of the global array
* double precision array(*) : <-- : local array
* double precision g_array(*) : --> : global array
*----------------------------------------------------------------------------*/
void
CS_PROCF (paragv, PARAGV)(cs_int_t *n_elts,
cs_int_t *n_g_elts,
cs_real_t array[],
cs_real_t *g_array);
/*----------------------------------------------------------------------------
* Find a node which minimizes a given distance and its related rank.
* May be used to locate a node among several domains.
*
* Fortran Interface :
*
* subroutine parfpt (node, ndrang, dis2mn)
* *****************
*
* integer node : <-> : local number of the closest node
* integer ndrang : --> : rank id for which the distance is the
* smallest
* double precision dis2mn : <-- : square distance between the closest node
* and the wanted node.
*----------------------------------------------------------------------------*/
void
CS_PROCF (parfpt, PARFPT)(cs_int_t *node,
cs_int_t *ndrang,
cs_real_t *dis2mn);
/*----------------------------------------------------------------------------
* Return the value associated to a probe.
*
* Fortran Interface :
*
* subroutine parhis (node, ndrang, var, varcap)
* *****************
*
* integer node : <-- : local number of the element related to
* a measure node
* integer ndrang : <-- : rank of the process owning the closest
* node from the measure node
* double precision var(*) : <-- : values of the variable on local elements
* double precision varcap : --> : value of the variable for the element
* related to the measure node
*----------------------------------------------------------------------------*/
void
CS_PROCF (parhis, PARHIS)(cs_int_t *node,
cs_int_t *ndrang,
cs_real_t var[],
cs_real_t *varcap);
/*----------------------------------------------------------------------------
* Call a barrier in case of parallelism
*
* This function should not be necessary in production code,
* but it may be useful for debugging purposes.
*
* Fortran interface :
*
* subroutine parbar
* *****************
*----------------------------------------------------------------------------*/
void
CS_PROCF (parbar, PARBAR)(void);
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Sum counters on all default communicator processes.
*
* parameters:
* cpt <-> local counter value input, global counter value output (array)
* n <-- number of counter array values
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI_IN_PLACE)
inline static void
cs_parall_counter(cs_gnum_t cpt[],
const int n)
{
if (cs_glob_n_ranks > 1) {
MPI_Allreduce(MPI_IN_PLACE, cpt, n, CS_MPI_GNUM, MPI_SUM,
cs_glob_mpi_comm);
}
}
#elif defined(HAVE_MPI)
void
cs_parall_counter(cs_gnum_t cpt[],
const int n);
#else
#define cs_parall_counter(_cpt, _n)
#endif
/*----------------------------------------------------------------------------
* Maximum values of a counter on all default communicator processes.
*
* parameters:
* cpt <-> local counter value input, global counter value output (array)
* n <-- number of counter array values
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI_IN_PLACE)
inline static void
cs_parall_counter_max(cs_lnum_t cpt[],
const int n)
{
if (cs_glob_n_ranks > 1) {
MPI_Allreduce(MPI_IN_PLACE, cpt, n, CS_MPI_LNUM, MPI_MAX,
cs_glob_mpi_comm);
}
}
#elif defined(HAVE_MPI)
void
cs_parall_counter_max(cs_lnum_t cpt[],
const int n);
#else
#define cs_parall_counter_max(_cpt, _n)
#endif
/*----------------------------------------------------------------------------
* Sum values of a given datatype on all default communicator processes.
*
* parameters:
* n <-- number of values
* datatype <-- matching Code_Saturne datatype
* val <-> local value input, global value output (array)
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI_IN_PLACE)
inline static void
cs_parall_sum(int n,
cs_datatype_t datatype,
void *val)
{
if (cs_glob_n_ranks > 1) {
MPI_Allreduce(MPI_IN_PLACE, val, n, cs_datatype_to_mpi[datatype], MPI_SUM,
cs_glob_mpi_comm);
}
}
#elif defined(HAVE_MPI)
void
cs_parall_sum(int n,
cs_datatype_t datatype,
void *val);
#else
#define cs_parall_sum(_n, _datatype, _val);
#endif
/*----------------------------------------------------------------------------
* Maximum values of a given datatype on all default communicator processes.
*
* parameters:
* n <-- number of values
* datatype <-- matching Code_Saturne datatype
* val <-> local value input, global value output (array)
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI_IN_PLACE)
inline static void
cs_parall_max(int n,
cs_datatype_t datatype,
void *val)
{
if (cs_glob_n_ranks > 1) {
MPI_Allreduce(MPI_IN_PLACE, val, n, cs_datatype_to_mpi[datatype], MPI_MAX,
cs_glob_mpi_comm);
}
}
#elif defined(HAVE_MPI)
void
cs_parall_max(int n,
cs_datatype_t datatype,
void *val);
#else
#define cs_parall_max(_n, _datatype, _val);
#endif
/*----------------------------------------------------------------------------
* Minimum values of a given datatype on all default communicator processes.
*
* parameters:
* n <-- number of values
* datatype <-- matching Code_Saturne datatype
* val <-> local value input, global value output (array)
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI_IN_PLACE)
inline static void
cs_parall_min(int n,
cs_datatype_t datatype,
void *val)
{
if (cs_glob_n_ranks > 1) {
MPI_Allreduce(MPI_IN_PLACE, val, n, cs_datatype_to_mpi[datatype], MPI_MIN,
cs_glob_mpi_comm);
}
}
#elif defined(HAVE_MPI)
void
cs_parall_min(int n,
cs_datatype_t datatype,
void *val);
#else
#define cs_parall_min(_n, _datatype, _val);
#endif
/*----------------------------------------------------------------------------
* Return minimum recommended scatter or gather buffer size.
*
* This is used by some internal part to block or scatter/gather algorithms,
* so as to allow I/O buffer size tuning.
*
* returns:
* minimum recommended part to block or gather buffer size (in bytes)
*----------------------------------------------------------------------------*/
size_t
cs_parall_get_min_coll_buf_size(void);
/*----------------------------------------------------------------------------
* Define minimum recommended scatter or gather buffer size.
*
* This is used by some internal part to block or scatter/gather algorithms,
* so as to allow I/O buffer size tuning.
*
* parameters:
* minimum recommended part to block or gather buffer size (in bytes)
*----------------------------------------------------------------------------*/
void
cs_parall_set_min_coll_buf_size(size_t buffer_size);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __CS_PARALL_H__ */
|