7.1
general documentation
cs_array.h
Go to the documentation of this file.
1 #ifndef __CS_ARRAY_H__
2 #define __CS_ARRAY_H__
3 
4 /*============================================================================
5  * Array handling utilities.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2021 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 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Global variables
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Public function prototypes
54  *============================================================================*/
55 
56 /*----------------------------------------------------------------------------*/
65 /*----------------------------------------------------------------------------*/
66 
67 void
68 cs_array_copy_real(cs_lnum_t n_elts,
69  cs_lnum_t dim,
70  const cs_real_t src[],
71  cs_real_t dest[restrict]);
72 
73 /*----------------------------------------------------------------------------
74  * Assign a constant value to an array.
75  *
76  * parameters:
77  * n_elts <-- number of associated elements
78  * dim <-- associated dimension
79  * v <-- value to assign
80  * a --> array values (size: n_elts*dim]
81  *----------------------------------------------------------------------------*/
82 
83 void
84 cs_array_set_value_real(cs_lnum_t n_elts,
85  cs_lnum_t dim,
86  cs_real_t v,
87  cs_real_t a[]);
88 
89 /*----------------------------------------------------------------------------*/
90 
91 END_C_DECLS
92 
93 #endif /* __CS_ARRAY_H__ */
restrict
#define restrict
Definition: cs_defs.h:142
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
atimbr::v
double precision, dimension(:,:,:), allocatable v
Definition: atimbr.f90:114
cs_array_set_value_real
void cs_array_set_value_real(cs_lnum_t n_elts, cs_lnum_t dim, cs_real_t v, cs_real_t a[])
Assign a constant value to an array.
Definition: cs_array.c:130
cs_fuel_incl::a
double precision, save a
Definition: cs_fuel_incl.f90:146
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:316
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_array_copy_real
void cs_array_copy_real(cs_lnum_t n_elts, cs_lnum_t dim, const cs_real_t src[], cs_real_t dest[restrict])
Copy real values from an array to another of the same dimensions.
Definition: cs_array.c:106