9.2
general 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-2026 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 "base/cs_base.h"
35
36/*=============================================================================
37 * Local Macro definitions
38 *============================================================================*/
39
40/*============================================================================
41 * Type definition
42 *============================================================================*/
43
44/*=============================================================================
45 * Public function prototypes
46 *============================================================================*/
47
48/*----------------------------------------------------------------------------
49 * Compute filters for dynamic models for a scalar.
50 *
51 * This function deals with the standard or extended neighborhood.
52 *
53 * parameters:
54 * val <-> array of values to filter
55 * f_val --> array of filtered values
56 *----------------------------------------------------------------------------*/
57
58extern "C" void
59cs_les_filter_scalar(const cs_real_t val[],
60 cs_real_t f_val[]);
61
62/*----------------------------------------------------------------------------
63 * Compute filters for dynamic models for vectors.
64 *
65 * This function deals with the standard or extended neighborhood.
66 *
67 * template parameters:
68 * stride 3 for vectors, 6 for symmetric tensors
69 *
70 * parameters:
71 * val <-> array of values to filter
72 * f_val --> array of filtered values
73 *----------------------------------------------------------------------------*/
74
75template <cs_lnum_t stride>
76void
77cs_les_filter_strided(const cs_real_t val[][stride],
78 cs_real_t f_val[][stride]);
79
80/*----------------------------------------------------------------------------*/
81
82#endif /* CS_LES_FILTER_H */
cs_base.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_les_filter_strided
void cs_les_filter_strided(const cs_real_t val[][stride], cs_real_t f_val[][stride])
Compute filters for dynamic models.
Definition: cs_les_filter.cpp:371
cs_les_filter_scalar
void cs_les_filter_scalar(const cs_real_t val[], cs_real_t f_val[])
Compute filters for dynamic models.
Definition: cs_les_filter.cpp:286