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-2015 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 
39 
40 /*=============================================================================
41  * Local Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definition
46  *============================================================================*/
47 
48 /*============================================================================
49  * Public function prototypes for Fortran API
50  *============================================================================*/
51 
52 /*----------------------------------------------------------------------------
53  * Compute filters for dynamic models. This function deals with the standard
54  * or extended neighborhood.
55  *
56  * Fortran Interface :
57  *
58  * subroutine cfiltr (var, f_var, wbuf1, wbuf2)
59  * *****************
60  *
61  * double precision(*) var[] <-- array of variables to filter
62  * double precision(*) f_var[] --> filtered variable array
63  * double precision(*) wbuf1[] --- working buffer
64  * double precision(*) wbuf2[] --- working buffer
65  *----------------------------------------------------------------------------*/
66 
67 void
68 CS_PROCF (cfiltr, CFILTR)(cs_real_t var[],
69  cs_real_t f_var[],
70  cs_real_t wbuf1[],
71  cs_real_t wbuf2[]);
72 
73 /*=============================================================================
74  * Public function prototypes
75  *============================================================================*/
76 
77 /*----------------------------------------------------------------------------
78  * Compute filters for dynamic models.
79  *
80  * This function deals with the standard or extended neighborhood.
81  *
82  * parameters:
83  * stride <-- stride of array to filter
84  * val <-> array of values to filter
85  * f_val --> array of filtered values
86  *----------------------------------------------------------------------------*/
87 
88 void
89 cs_les_filter(int stride,
90  cs_real_t val[],
91  cs_real_t f_val[]);
92 
93 /*----------------------------------------------------------------------------*/
94 
96 
97 #endif /* __CS_LES_FILTER_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:429
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:133
#define END_C_DECLS
Definition: cs_defs.h:430
double cs_real_t
Definition: cs_defs.h:296
#define CS_PROCF(x, y)
Definition: cs_defs.h:453
void cfiltr(cs_real_t var[], cs_real_t f_var[], cs_real_t wbuf1[], cs_real_t wbuf2[])
Definition: cs_les_filter.c:108