My Project
programmer's documentation
cs_les_filter.h
Go to the documentation of this file.
1 #ifndef __CS_LES_FILTER_H__
2 #define __CS_LES_FILTER_H__
3 
4 /*============================================================================
5  * Filters for dynamic models.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2019 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_base.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Local Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definition
46  *============================================================================*/
47 
48 /*=============================================================================
49  * Public function prototypes
50  *============================================================================*/
51 
52 /*----------------------------------------------------------------------------
53  * Compute filters for dynamic models.
54  *
55  * This function deals with the standard or extended neighborhood.
56  *
57  * parameters:
58  * stride <-- stride of array to filter
59  * val <-> array of values to filter
60  * f_val --> array of filtered values
61  *----------------------------------------------------------------------------*/
62 
63 void
64 cs_les_filter(int stride,
65  cs_real_t val[],
66  cs_real_t f_val[]);
67 
68 /*----------------------------------------------------------------------------*/
69 
70 END_C_DECLS
71 
72 #endif /* __CS_LES_FILTER_H__ */
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
stride
void const cs_int_t const cs_int_t const cs_int_t const cs_int_t * stride
Definition: cs_sat_coupling.h:325
cs_les_filter
void cs_les_filter(int stride, cs_real_t val[], cs_real_t f_val[])
Compute filters for dynamic models.
Definition: cs_les_filter.c:105
cs_base.h
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16