/usr/include/code_saturne/cs_grid.h is in code-saturne-include 3.3.2-4.
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 | #ifndef __CS_GRID_H__
#define __CS_GRID_H__
/*============================================================================
* Grid connectivity and data used for multigrid coarsening
* and associated matrix construction.
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2014 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_base.h"
#include "cs_halo.h"
#include "cs_matrix.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*============================================================================
* Macro definitions
*============================================================================*/
/*============================================================================
* Type definitions
*============================================================================*/
/* Structure associated with opaque grid object */
typedef struct _cs_grid_t cs_grid_t;
/*============================================================================
* Global variables
*============================================================================*/
/*============================================================================
* Public function prototypes Fortran API
*============================================================================*/
/*----------------------------------------------------------------------------
* Set the default parameters for multigrid coarsening.
*----------------------------------------------------------------------------*/
void CS_PROCF(clmopt, CLMOPT)
(
const cs_int_t *mltmmn, /* <-- Mean number of cells under which merging
* should take place */
const cs_int_t *mltmgl, /* <-- Global number of cells under which
* merging should take place */
const cs_int_t *mltmmr, /* <-- Number of active ranks under which no
* merging takes place */
const cs_int_t *mltmst, /* <-- Number of ranks over which merging
* takes place */
const cs_int_t *mlttyp /* <-- Coarsening algorithm selection */
);
/*----------------------------------------------------------------------------
* Print the default parameters for multigrid coarsening.
*----------------------------------------------------------------------------*/
void CS_PROCF(clmimp, CLMIMP)
(
void
);
/*----------------------------------------------------------------------------
* Order an array of real numbers by increasing value.
*----------------------------------------------------------------------------*/
void CS_PROCF(clmlgo, CLMLGO)
(
const cs_int_t *nfac, /* <-- Number of internal faces */
const cs_real_t critr[], /* <-- Array to order */
cs_int_t iord[] /* <-> ordering */
);
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Create base grid by mapping from shared mesh values.
*
* Note that as arrays given as arguments are shared by the created grid
* (which can only access them, not modify them), the grid should be
* destroyed before those arrays.
*
* parameters:
* n_cells <-- Local number of cells
* n_cells_ext <-- Local number of cells + ghost cells
* n_faces <-- Local number of faces
* symmetric <-- True if xam is symmetric, false otherwise
* diag_block_size <-- Block sizes for diagonal, or NULL
* extra_diag_block_size <-- Block sizes for extra diagonal, or NULL
* face_cell <-- Face -> cells connectivity (1 to n)
* halo <-- Halo structure associated with this level,
* or NULL.
* numbering <-- vectorization or thread-related numbering info,
* or NULL.
* cell_cen <-- Cell center (size: 3.n_cells_ext)
* cell_vol <-- Cell volume (size: n_cells_ext)
* face_normal <-- Internal face normals (size: 3.n_faces)
* da <-- Matrix diagonal (size: n_cell_ext)
* xa <-- Matrix extra-diagonal terms
* (size: n_faces if symmetric, 2.n_faces otherwise)
*
* returns:
* base grid structure
*----------------------------------------------------------------------------*/
cs_grid_t *
cs_grid_create_from_shared(cs_lnum_t n_cells,
cs_lnum_t n_cells_ext,
cs_lnum_t n_faces,
bool symmetric,
const int *diag_block_size,
const int *extra_diag_block_size,
const cs_lnum_t *face_cell,
const cs_halo_t *halo,
const cs_numbering_t *numbering,
const cs_real_t *cell_cen,
const cs_real_t *cell_vol,
const cs_real_t *face_normal,
const cs_real_t *da,
const cs_real_t *xa);
/*----------------------------------------------------------------------------
* Destroy a grid structure.
*
* parameters:
* grid <-> Pointer to grid structure pointer
*----------------------------------------------------------------------------*/
void
cs_grid_destroy(cs_grid_t **grid);
/*----------------------------------------------------------------------------
* Get grid information.
*
* parameters:
* g <-- Grid structure
* level --> Level in multigrid hierarchy (or NULL)
* symmetric --> Symmetric matrix coefficients indicator (or NULL)
* db_size --> Size of the diagonal block (or NULL)
* eb_size --> Size of the extra diagonal block (or NULL)
* n_ranks --> number of ranks with data (or NULL)
* n_cells --> Number of local cells (or NULL)
* n_cells_ext --> Number of cells including ghosts (or NULL)
* n_faces --> Number of faces (or NULL)
* n_g_cells --> Number of global cells (or NULL)
*----------------------------------------------------------------------------*/
void
cs_grid_get_info(const cs_grid_t *g,
int *level,
bool *symmetric,
int *db_size,
int *eb_size,
int *n_ranks,
cs_lnum_t *n_cells,
cs_lnum_t *n_cells_ext,
cs_lnum_t *n_faces,
cs_gnum_t *n_g_cells);
/*----------------------------------------------------------------------------
* Get number of cells corresponding to a grid.
*
* parameters:
* g <-- Grid structure
*
* returns:
* number of cells of grid structure
*----------------------------------------------------------------------------*/
cs_lnum_t
cs_grid_get_n_cells(const cs_grid_t *g);
/*----------------------------------------------------------------------------
* Get number of extended (local + ghost) cells corresponding to a grid.
*
* parameters:
* g <-- Grid structure
*
* returns:
* number of extended cells of grid structure
*----------------------------------------------------------------------------*/
cs_lnum_t
cs_grid_get_n_cells_ext(const cs_grid_t *g);
/*----------------------------------------------------------------------------
* Get maximum number of extended (local + ghost) cells corresponding to
* a grid, both with and without merging between ranks
*
* parameters:
* g <-- Grid structure
*
* returns:
* maximum number of extended cells of grid structure, with or without
* merging
*----------------------------------------------------------------------------*/
cs_lnum_t
cs_grid_get_n_cells_max(const cs_grid_t *g);
/*----------------------------------------------------------------------------
* Get global number of cells corresponding to a grid.
*
* parameters:
* g <-- Grid structure
*
* returns:
* global number of cells of grid structure
*----------------------------------------------------------------------------*/
cs_gnum_t
cs_grid_get_n_g_cells(const cs_grid_t *g);
/*----------------------------------------------------------------------------
* Get grid's associated matrix information.
*
* parameters:
* g <-- Grid structure
*
* returns:
* pointer to matrix structure
*----------------------------------------------------------------------------*/
const cs_matrix_t *
cs_grid_get_matrix(const cs_grid_t *g);
#if defined(HAVE_MPI)
/*----------------------------------------------------------------------------
* Get the MPI subcommunicator for a given grid.
*
* parameters:
* g <-- Grid structure
*
* returns:
* MPI communicator
*----------------------------------------------------------------------------*/
MPI_Comm
cs_grid_get_comm(const cs_grid_t *g);
#endif
/*----------------------------------------------------------------------------
* Create coarse grid from fine grid.
*
* parameters:
* f <-- Fine grid structure
* verbosity <-- Verbosity level
* aggregation_limit <-- Maximum allowed fine cells per coarse cell
* relaxation_parameter <-- P0/P1 relaxation factor
*
* returns:
* coarse grid structure
*----------------------------------------------------------------------------*/
cs_grid_t *
cs_grid_coarsen(const cs_grid_t *f,
int verbosity,
int aggregation_limit,
double relaxation_parameter);
/*----------------------------------------------------------------------------
* Compute coarse cell variable values from fine cell values
*
* parameters:
* f <-- Fine grid structure
* c <-- Fine grid structure
* f_var <-- Variable defined on fine grid cells
* c_var --> Variable defined on coarse grid cells
*
* returns:
* coarse grid structure
*----------------------------------------------------------------------------*/
void
cs_grid_restrict_cell_var(const cs_grid_t *f,
const cs_grid_t *c,
const cs_real_t *f_var,
cs_real_t *c_var);
/*----------------------------------------------------------------------------
* Compute fine cell integer values from coarse cell values
*
* parameters:
* c <-- Fine grid structure
* f <-- Fine grid structure
* c_num --> Variable defined on coarse grid cells
* f_num <-- Variable defined on fine grid cells
*----------------------------------------------------------------------------*/
void
cs_grid_prolong_cell_num(const cs_grid_t *c,
const cs_grid_t *f,
int *c_num,
int *f_num);
/*----------------------------------------------------------------------------
* Compute fine cell variable values from coarse cell values
*
* parameters:
* c <-- Fine grid structure
* f <-- Fine grid structure
* c_var --> Variable defined on coarse grid cells
* f_var <-- Variable defined on fine grid cells
*----------------------------------------------------------------------------*/
void
cs_grid_prolong_cell_var(const cs_grid_t *c,
const cs_grid_t *f,
cs_real_t *c_var,
cs_real_t *f_var);
/*----------------------------------------------------------------------------
* Project coarse grid cell numbers to base grid.
*
* If a global coarse grid cell number is larger than max_num, its
* value modulo max_num is used.
*
* parameters:
* g <-- Grid structure
* n_base_cells <-- Number of cells in base grid
* max_num <-- Values of c_cell_num = global_num % max_num
* c_cell_num --> Global coarse cell number (modulo max_num)
*----------------------------------------------------------------------------*/
void
cs_grid_project_cell_num(const cs_grid_t *g,
cs_lnum_t n_base_cells,
int max_num,
int c_cell_num[]);
/*----------------------------------------------------------------------------
* Project coarse grid cell rank to base grid.
*
* parameters:
* g <-- Grid structure
* n_base_cells <-- Number of cells in base grid
* f_cell_rank --> Global coarse cell rank projected to fine cells
*----------------------------------------------------------------------------*/
void
cs_grid_project_cell_rank(const cs_grid_t *g,
cs_lnum_t n_base_cells,
int f_cell_rank[]);
/*----------------------------------------------------------------------------
* Project variable from coarse grid to base grid
*
* parameters:
* g <-- Grid structure
* n_base_cells <-- Number of cells in base grid
* c_var <-- Cell variable on coarse grid
* f_var --> Cell variable projected to fine grid
*----------------------------------------------------------------------------*/
void
cs_grid_project_var(const cs_grid_t *g,
cs_lnum_t n_base_cells,
const cs_real_t c_var[],
cs_real_t f_var[]);
/*----------------------------------------------------------------------------
* Compute diagonal dominance metric and project it to base grid
*
* parameters:
* g <-- Grid structure
* n_base_cells <-- Number of cells in base grid
* diag_dom --> Diagonal dominance metric (on fine grid)
*----------------------------------------------------------------------------*/
void
cs_grid_project_diag_dom(const cs_grid_t *g,
cs_lnum_t n_base_cells,
cs_real_t diag_dom[]);
/*----------------------------------------------------------------------------
* Get the default parameters for multigrid coarsening.
*
* parameters:
* merge_mean_threshold --> mean number of cells under which merging
* should take place, or NULL
* merge_glob_threshold --> global number of cells under which merging
* should take place, or NULL
* merge_min_ranks --> number of active ranks under which no merging
* takes place, or NULL
* merge_stride --> number of ranks over which merging takes place,
* or NULL
* coarsening_type --> coarsening type:
* 0: algebraic with natural face traversal;
* 1: algebraic with face traveral by criteria;
* 2: algebraic with Hilbert face traversal;
*----------------------------------------------------------------------------*/
void
cs_grid_get_defaults(int *merge_mean_threshold,
int *merge_glob_threshold,
int *merge_min_ranks,
int *merge_stride,
int *coarsening_type);
/*----------------------------------------------------------------------------
* Set the default parameters for multigrid coarsening.
*
* parameters:
* merge_mean_threshold <-- mean number of cells under which merging
* should take place
* merge_glob_threshold <-- global number of cells under which merging
* should take place
* merge_min_ranks <-- number of active ranks under which no merging
* takes place
* merge_stride <-- number of ranks over which merging takes place
* coarsening_type <-- coarsening type:
* 0: algebraic with natural face traversal;
* 1: algebraic with face traveral by criterai;
* 2: algebraic with Hilbert face traversal;
*----------------------------------------------------------------------------*/
void
cs_grid_set_defaults(int merge_mean_threshold,
int merge_glob_threshold,
int merge_min_ranks,
int merge_stride,
int coarsening_type);
/*----------------------------------------------------------------------------
* Return the merge_stride if merging is active.
*
* returns:
* grid merge stride if merging is active, 1 otherwise
*----------------------------------------------------------------------------*/
int
cs_grid_get_merge_stride(void);
/*----------------------------------------------------------------------------
* Set matrix tuning behavior for multigrid coarse meshes.
*
* The finest mesh (level 0) is handled by the default tuning options,
* so only coarser meshes are considered here.
*
* parameters:
* fill_type <-- associated matrix fill type
* max_level <-- maximum leval for which tuning is active
*----------------------------------------------------------------------------*/
void
cs_grid_set_matrix_tuning(cs_matrix_fill_type_t fill_type,
int max_level);
/*----------------------------------------------------------------------------
* Set matrix tuning behavior for multigrid coarse meshes.
*
* The finest mesh (level 0) is handled by the default tuning options,
* so only coarser meshes are considered here.
*
* parameters:
* fill_type <-- associated matrix fill type
* level <-- level for which variant is assiged
* mv <-- matrix variant to assign (NULL to unassign)
*----------------------------------------------------------------------------*/
void
cs_grid_set_matrix_variant(cs_matrix_fill_type_t fill_type,
int level,
const cs_matrix_variant_t *mv);
/*----------------------------------------------------------------------------
* Print the default parameters for multigrid coarsening.
*----------------------------------------------------------------------------*/
void
cs_grid_log_defaults(void);
/*----------------------------------------------------------------------------
* Finalize global info related to multigrid solvers
*----------------------------------------------------------------------------*/
void
cs_grid_finalize(void);
/*----------------------------------------------------------------------------
* Dump grid structure
*
* parameters:
* g <-- grid structure that should be dumped
*----------------------------------------------------------------------------*/
void
cs_grid_dump(const cs_grid_t *g);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __CS_GRID_H__ */
|