programmer's documentation
cs_matrix_assembler.h
Go to the documentation of this file.
1 #ifndef __CS_MATRIX_ASSEMBLER_H__
2 #define __CS_MATRIX_ASSEMBLER_H__
3 
4 /*============================================================================
5  * Incremental or general construction of matrix.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 
36 #include "cs_halo.h"
37 #include "cs_log.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
42 
43 /*============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
51 #define CS_MATRIX_DISTANT_ROW_USE_COL_IDX (1 << 0)
52 #define CS_MATRIX_DISTANT_ROW_USE_COL_G_ID (1 << 1)
53 
54 #define CS_MATRIX_EXTERNAL_HALO (1 << 2)
55 
56 /*============================================================================
57  * Type definitions
58  *============================================================================*/
59 
62 typedef struct _cs_matrix_assembler_t cs_matrix_assembler_t;
63 
66 typedef struct _cs_matrix_assembler_values_t cs_matrix_assembler_values_t;
67 
68 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 typedef void
86  const cs_lnum_t *db_size,
87  const cs_lnum_t *eb_size);
88 
89 /*----------------------------------------------------------------------------*/
114 /*----------------------------------------------------------------------------*/
115 
116 typedef void
118  cs_lnum_t n,
119  cs_lnum_t stride,
120  const cs_lnum_t row_id[],
121  const cs_lnum_t col_idx[],
122  const cs_real_t vals[]);
123 
124 /*----------------------------------------------------------------------------*/
146 /*----------------------------------------------------------------------------*/
147 
148 typedef void
150  cs_lnum_t n,
151  cs_lnum_t stride,
152  const cs_gnum_t row_g_id[],
153  const cs_gnum_t col_g_id[],
154  const cs_real_t vals[]);
155 
156 /*----------------------------------------------------------------------------*/
167 /*----------------------------------------------------------------------------*/
168 
169 typedef void
171 
172 /*----------------------------------------------------------------------------*/
184 /*----------------------------------------------------------------------------*/
185 
186 typedef void
188 
189 /*============================================================================
190  * Global variables
191  *============================================================================*/
192 
193 /*=============================================================================
194  * Public function prototypes
195  *============================================================================*/
196 
197 /*----------------------------------------------------------------------------*/
210 /*----------------------------------------------------------------------------*/
211 
213 cs_matrix_assembler_create(const cs_gnum_t l_range[2],
214  bool separate_diag);
215 
216 /*----------------------------------------------------------------------------*/
234 /*----------------------------------------------------------------------------*/
235 
238  bool separate_diag,
239  const cs_lnum_t row_idx[],
240  const cs_lnum_t col_id[],
241  const cs_halo_t *halo);
242 
243 /*----------------------------------------------------------------------------*/
249 /*----------------------------------------------------------------------------*/
250 
251 void
253 
254 /*----------------------------------------------------------------------------*/
265 /*----------------------------------------------------------------------------*/
266 
267 void
269  cs_lnum_t n,
270  const cs_gnum_t g_row_id[],
271  const cs_gnum_t g_col_id[]);
272 
273 /*----------------------------------------------------------------------------*/
283 /*----------------------------------------------------------------------------*/
284 
285 void
287 
288 /*----------------------------------------------------------------------------*/
320 /*----------------------------------------------------------------------------*/
321 
322 void
324  int flags);
325 
326 /*----------------------------------------------------------------------------*/
337 /*----------------------------------------------------------------------------*/
338 
339 int
341 
342 #if defined(HAVE_MPI)
343 
344 /*----------------------------------------------------------------------------*/
353 /*----------------------------------------------------------------------------*/
354 
355 void
356 cs_matrix_assembler_set_comm(cs_matrix_assembler_t *ma,
357  MPI_Comm comm);
358 
359 #endif /* HAVE_MPI */
360 
361 /*----------------------------------------------------------------------------*/
370 /*----------------------------------------------------------------------------*/
371 
372 const cs_gnum_t *
374 
375 /*----------------------------------------------------------------------------*/
384 /*----------------------------------------------------------------------------*/
385 
386 const cs_halo_t *
388 
389 /*----------------------------------------------------------------------------*/
398 /*----------------------------------------------------------------------------*/
399 
400 bool
402 
403 /*----------------------------------------------------------------------------*/
411 /*----------------------------------------------------------------------------*/
412 
413 cs_lnum_t
415 
416 /*----------------------------------------------------------------------------*/
424 /*----------------------------------------------------------------------------*/
425 
426 cs_lnum_t
428 
429 /*----------------------------------------------------------------------------*/
445 /*----------------------------------------------------------------------------*/
446 
447 const cs_lnum_t *
449 
450 /*----------------------------------------------------------------------------*/
468 /*----------------------------------------------------------------------------*/
469 
470 const cs_lnum_t *
472 
473 /*----------------------------------------------------------------------------*/
487 /*----------------------------------------------------------------------------*/
488 
489 void
491  int rc[4]);
492 
493 /*----------------------------------------------------------------------------*/
501 /*----------------------------------------------------------------------------*/
502 
503 void
505  cs_log_t log_id,
506  const char *name);
507 
508 /*----------------------------------------------------------------------------*/
547 /*----------------------------------------------------------------------------*/
548 
551  bool sep_diag,
552  const cs_lnum_t *db_size,
553  const cs_lnum_t *eb_size,
554  void *matrix,
560 
561 /*----------------------------------------------------------------------------*/
571 /*----------------------------------------------------------------------------*/
572 
573 void
575 
576 /*----------------------------------------------------------------------------*/
601 /*----------------------------------------------------------------------------*/
602 
603 void
605  cs_lnum_t n,
606  const cs_lnum_t row_id[],
607  const cs_lnum_t col_id[],
608  const cs_real_t val[]);
609 
610 /*----------------------------------------------------------------------------*/
635 /*----------------------------------------------------------------------------*/
636 
637 void
639  cs_lnum_t n,
640  const cs_gnum_t g_row_id[],
641  const cs_gnum_t g_col_id[],
642  const cs_real_t val[]);
643 
644 /*----------------------------------------------------------------------------*/
662 /*----------------------------------------------------------------------------*/
663 
664 void
666 
667 /*----------------------------------------------------------------------------*/
668 
670 
671 #endif /* __CS_MATRIX_ASSEMBLER_H__ */
cs_lnum_t cs_matrix_assembler_get_n_columns(const cs_matrix_assembler_t *ma)
Return the number of columns associated with a matrix assembler.
Definition: cs_matrix_assembler.c:3096
unsigned long cs_gnum_t
global mesh entity number
Definition: cs_defs.h:281
cs_matrix_assembler_t * cs_matrix_assembler_create(const cs_gnum_t l_range[2], bool separate_diag)
Create a matrix assembler structure.
Definition: cs_matrix_assembler.c:2606
void cs_matrix_assembler_values_done(cs_matrix_assembler_values_t *mav)
Start assembly of matrix values structure.
Definition: cs_matrix_assembler.c:3741
void() cs_matrix_assembler_values_end_t(void *matrix)
Function pointer to complete the final assembly of matrix coefficients.
Definition: cs_matrix_assembler.h:187
void cs_matrix_assembler_get_rank_counts(const cs_matrix_assembler_t *ma, int rc[4])
Return info on the number of neighbor ranks a matrix assembler may communicate with.
Definition: cs_matrix_assembler.c:3172
struct _cs_matrix_assembler_values_t cs_matrix_assembler_values_t
Definition: cs_matrix_assembler.h:66
void cs_matrix_assembler_set_options(cs_matrix_assembler_t *ma, int flags)
Set option flags for a given matrix assembler structure.
Definition: cs_matrix_assembler.c:2868
const cs_lnum_t * cs_matrix_assembler_get_col_ids(const cs_matrix_assembler_t *ma)
Return a column ids associated with a matrix assembler.
Definition: cs_matrix_assembler.c:3150
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
void() cs_matrix_assembler_values_add_g_t(void *matrix, cs_lnum_t n, cs_lnum_t stride, const cs_gnum_t row_g_id[], const cs_gnum_t col_g_id[], const cs_real_t vals[])
Function pointer for addition to matrix coefficients using global row ids and column indexes...
Definition: cs_matrix_assembler.h:149
Definition: cs_halo.h:71
void cs_matrix_assembler_values_add(cs_matrix_assembler_values_t *mav, cs_lnum_t n, const cs_lnum_t row_id[], const cs_lnum_t col_id[], const cs_real_t val[])
Add values to a matrix assembler values structure using local row and column ids. ...
Definition: cs_matrix_assembler.c:3397
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_matrix_assembler_t * cs_matrix_assembler_create_from_shared(cs_lnum_t n_rows, bool separate_diag, const cs_lnum_t row_idx[], const cs_lnum_t col_id[], const cs_halo_t *halo)
Create a matrix assembler structure based on a given connectivity and associated halo structure...
Definition: cs_matrix_assembler.c:2693
void matrix(const int *iconvp, const int *idiffp, const int *ndircp, const int *isym, const cs_real_t *thetap, const int *imucpp, const cs_real_t coefbp[], const cs_real_t cofbfp[], const cs_real_t rovsdt[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t xcpp[], cs_real_t da[], cs_real_t xa[])
Definition: cs_matrix_building.c:111
void cs_matrix_assembler_compute(cs_matrix_assembler_t *ma)
Compute internal structures required by a matrix assembler.
Definition: cs_matrix_assembler.c:2974
cs_lnum_t cs_matrix_assembler_get_n_rows(const cs_matrix_assembler_t *ma)
Return the number of rows associated with a matrix assembler.
Definition: cs_matrix_assembler.c:3080
cs_matrix_assembler_values_t * cs_matrix_assembler_values_create(const cs_matrix_assembler_t *ma, bool sep_diag, const cs_lnum_t *db_size, const cs_lnum_t *eb_size, void *matrix, cs_matrix_assembler_values_init_t *init, cs_matrix_assembler_values_add_t *add, cs_matrix_assembler_values_add_g_t *add_g, cs_matrix_assembler_values_begin_t *begin, cs_matrix_assembler_values_end_t *end)
Create and initialize a matrix assembler values structure.
Definition: cs_matrix_assembler.c:3277
void cs_matrix_assembler_destroy(cs_matrix_assembler_t **ma)
Destroy a matrix assembler structure.
Definition: cs_matrix_assembler.c:2795
void cs_matrix_assembler_values_add_g(cs_matrix_assembler_values_t *mav, cs_lnum_t n, const cs_gnum_t g_row_id[], const cs_gnum_t g_col_id[], const cs_real_t val[])
Add values to a matrix assembler values structure using global row and column ids.
Definition: cs_matrix_assembler.c:3507
void cs_matrix_assembler_add_g_ids(cs_matrix_assembler_t *ma, cs_lnum_t n, const cs_gnum_t g_row_id[], const cs_gnum_t g_col_id[])
Add entries to a matrix assembler structure.
Definition: cs_matrix_assembler.c:2913
cs_log_t
Definition: cs_log.h:48
const cs_lnum_t * cs_matrix_assembler_get_row_index(const cs_matrix_assembler_t *ma)
Return a row index associated with a matrix assembler.
Definition: cs_matrix_assembler.c:3124
const cs_gnum_t * cs_matrix_assembler_get_l_range(const cs_matrix_assembler_t *ma)
Return a pointer to local global row range associated with a matrix assembler.
Definition: cs_matrix_assembler.c:3030
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
#define END_C_DECLS
Definition: cs_defs.h:462
struct _cs_matrix_assembler_t cs_matrix_assembler_t
Definition: cs_matrix_assembler.h:62
void() cs_matrix_assembler_values_init_t(void *matrix, const cs_lnum_t *db_size, const cs_lnum_t *eb_size)
Function pointer for initialization of matrix coefficients using local row ids and column indexes...
Definition: cs_matrix_assembler.h:85
const cs_halo_t * cs_matrix_assembler_get_halo(const cs_matrix_assembler_t *ma)
Return a pointer to the halo structure associated with a matrix assembler.
Definition: cs_matrix_assembler.c:3047
void cs_matrix_assembler_values_finalize(cs_matrix_assembler_values_t **mav)
Finalize matrix assembler values structure.
Definition: cs_matrix_assembler.c:3352
bool cs_matrix_assembler_get_separate_diag(const cs_matrix_assembler_t *ma)
Indicate if the matrix assembler is based on a separate diagonal.
Definition: cs_matrix_assembler.c:3064
void cs_matrix_assembler_log_rank_counts(const cs_matrix_assembler_t *ma, cs_log_t log_id, const char *name)
Log rank counts for a given matrix assembler.
Definition: cs_matrix_assembler.c:3200
int cs_matrix_assembler_get_options(const cs_matrix_assembler_t *ma)
Return the option flags for a given matrix assembler structure.
Definition: cs_matrix_assembler.c:2894
void() cs_matrix_assembler_values_add_t(void *matrix, cs_lnum_t n, cs_lnum_t stride, const cs_lnum_t row_id[], const cs_lnum_t col_idx[], const cs_real_t vals[])
Function pointer for addition to matrix coefficients using local row ids and column indexes...
Definition: cs_matrix_assembler.h:117
void() cs_matrix_assembler_values_begin_t(void *matrix)
Function pointer to start the final assembly of matrix coefficients.
Definition: cs_matrix_assembler.h:170