8.1
general documentation
cs_gui_boundary_conditions.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_BOUNDARY_CONDITION_H__
2 #define __CS_GUI_BOUNDARY_CONDITION_H__
3 
4 /*============================================================================
5  * Management of the GUI parameters file: boundary conditions
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  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 #include "cs_boundary.h"
36 #include "cs_zone.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*============================================================================
43  * Type definitions
44  *============================================================================*/
45 
48 typedef struct {
49 
50  const cs_zone_t *zone; /*<! Pointer to zone */
51 
52  const char *name; /*<! Pointer to field or array name */
53  const char *condition; /*<! Pointer to condition name type */
54 
55  int dim; /*<! Values dimension */
56 
58 
59 /*============================================================================
60  * Static global variables
61  *============================================================================*/
62 
63 /*============================================================================
64  * Public function prototypes for Fortran API
65  *============================================================================*/
66 
67 /*----------------------------------------------------------------------------
68  * Boundary conditions treatment
69  *
70  * Fortran Interface:
71  *
72  * subroutine uiclim
73  * *****************
74  *----------------------------------------------------------------------------*/
75 
77 
78 /*----------------------------------------------------------------------------
79  * Boundary conditions input verification
80  *
81  * Fortran Interface:
82  *
83  * SUBROUTINE UICLVE
84  * *****************
85  *
86  * integer nozppm <-- max number of boundary conditions zone
87  *----------------------------------------------------------------------------*/
88 
90 
91 /*=============================================================================
92  * Public function prototypes
93  *============================================================================*/
94 
95 /*----------------------------------------------------------------------------*/
102 /*----------------------------------------------------------------------------*/
103 
104 void
106 
107 /*----------------------------------------------------------------------------*/
111 /*----------------------------------------------------------------------------*/
112 
113 void
115 
116 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
131  const char *name,
132  const char *condition,
133  int dim);
134 
135 /*----------------------------------------------------------------------------*/
151 /*----------------------------------------------------------------------------*/
152 
153 void
155  const cs_lnum_t *elt_ids,
156  bool dense_output,
157  void *input,
158  cs_real_t *retval);
159 
160 /*----------------------------------------------------------------------------*/
161 
163 
164 #endif /* __CS_GUI_BOUNDARY_CONDITION_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:515
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
void cs_gui_boundary_conditions_define(cs_boundary_t *bdy)
Define boundary conditions based on setup file.
Definition: cs_gui_boundary_conditions.c:3202
void cs_gui_boundary_conditions_free_memory(void)
Free GUI boundary condition structures.
Definition: cs_gui_boundary_conditions.c:3391
cs_gui_boundary_meg_context_t * cs_gui_boundary_add_meg_context(const cs_zone_t *zone, const char *name, const char *condition, int dim)
Add new MEG-based cs_dof_func_t context info.
Definition: cs_gui_boundary_conditions.c:3455
void cs_gui_boundary_conditions_verify(void)
Definition: cs_gui_boundary_conditions.c:3139
void cs_gui_boundary_conditions_dof_func_meg(cs_lnum_t n_elts, const cs_lnum_t *elt_ids, bool dense_output, void *input, cs_real_t *retval)
cs_dof_func_t function to compute a boundary profiles using a MEG generated function.
Definition: cs_gui_boundary_conditions.c:3499
void cs_gui_boundary_conditions_processing(int *itypfb)
Definition: cs_gui_boundary_conditions.c:2549
integer, dimension(:), pointer, save itypfb
boundary condition type at the boundary face ifac (see cs_user_boundary_conditions)
Definition: pointe.f90:89
Structure storing information related to the "physical" boundaries associated with the computational ...
Definition: cs_boundary.h:155
Definition: cs_gui_boundary_conditions.h:48
const char * condition
Definition: cs_gui_boundary_conditions.h:53
int dim
Definition: cs_gui_boundary_conditions.h:55
const char * name
Definition: cs_gui_boundary_conditions.h:52
const cs_zone_t * zone
Definition: cs_gui_boundary_conditions.h:50
Definition: cs_zone.h:55