8.2
general documentation
cs_symmetry_faces_filter.h
Go to the documentation of this file.
1 #ifndef __CS_SYMMETRY_FACES_FILTER_H__
2 #define __CS_SYMMETRY_FACES_FILTER_H__
3 
4 /*============================================================================
5  * Filter symmetry faces whose effects cancel out
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2024 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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------
33  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "cs_base.h"
37 #include "cs_mesh.h"
38 #include "cs_mesh_quantities.h"
39 
40 /*----------------------------------------------------------------------------
41  * Header for the current file
42  *----------------------------------------------------------------------------*/
43 
45 
46 /*----------------------------------------------------------------------------*/
47 
49 
50 /*=============================================================================
51  * Additional Doxygen documentation
52  *============================================================================*/
53 
61 /*=============================================================================
62  * Local macros
63  *============================================================================*/
64 
65 /*=============================================================================
66  * Local type definitions
67  *============================================================================*/
68 
69 /*============================================================================
70  * Global variables
71  *============================================================================*/
72 
73 /*============================================================================
74  * Private function definitions
75  *============================================================================*/
76 
79 /*============================================================================
80  * Public function definitions
81  *============================================================================*/
82 
83 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
99  const cs_mesh_quantities_t *mq,
100  cs_lnum_t *n_faces,
101  cs_lnum_t face_ids[]);
102 
103 /*----------------------------------------------------------------------------*/
104 
106 
107 #endif /* __CS_SYMMETRY_FACES_FILTER__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:528
#define END_C_DECLS
Definition: cs_defs.h:529
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
void cs_symmetry_faces_filter_cancel(const cs_mesh_t *m, const cs_mesh_quantities_t *mq, cs_lnum_t *n_faces, cs_lnum_t face_ids[])
Filter selected faces whose effects should cancel out.
Definition: cs_symmetry_faces_filter.c:115
Definition: cs_mesh_quantities.h:92
Definition: cs_mesh.h:85