8.1
general documentation
cs_scalar_clipping.h
Go to the documentation of this file.
1 #ifndef __CS_SCALAR_CLIPPING_H__
2 #define __CS_SCALAR_CLIPPING_H__
3 
4 /*============================================================================
5  * Clip scalar (i.e. convected/diffused) fields.
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 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  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_base.h"
39 
40 /*----------------------------------------------------------------------------*/
41 
42 BEGIN_C_DECLS
43 
44 /*============================================================================
45  * Macro definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Local type definitions
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Global variables
54  *============================================================================*/
55 
56 /*============================================================================
57  * Public function prototypes
58  *============================================================================*/
59 
60 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 void
69 cs_scalar_clipping(cs_field_t *f);
70 
71 /*----------------------------------------------------------------------------*/
72 
73 END_C_DECLS
74 
75 #endif /* __CS_SCALAR_CLIPPING_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_scalar_clipping
void cs_scalar_clipping(cs_field_t *f)
Clip a scalar variable field.
Definition: cs_scalar_clipping.c:138
cs_field_t
Field descriptor.
Definition: cs_field.h:131