8.3
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-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/*----------------------------------------------------------------------------
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
48typedef 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
65 *============================================================================*/
66
67/*----------------------------------------------------------------------------
68 * Boundary conditions treatment
69 *
70 * \param[in, out] itypfb <-- type of boundary for each face
71 *----------------------------------------------------------------------------*/
72
73void
75
76/*----------------------------------------------------------------------------
77 * Boundary conditions input verification
78 *----------------------------------------------------------------------------*/
79
80void
82
83/*----------------------------------------------------------------------------*/
90/*----------------------------------------------------------------------------*/
91
92void
94
95/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
103
104/*----------------------------------------------------------------------------*/
115/*----------------------------------------------------------------------------*/
116
119 const char *name,
120 const char *condition,
121 int dim);
122
123/*----------------------------------------------------------------------------*/
139/*----------------------------------------------------------------------------*/
140
141void
143 const cs_lnum_t *elt_ids,
144 bool dense_output,
145 void *input,
146 cs_real_t *retval);
147
148/*----------------------------------------------------------------------------*/
149
151
152#endif /* __CS_GUI_BOUNDARY_CONDITION_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
#define END_C_DECLS
Definition: cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
void cs_gui_boundary_conditions_define(cs_boundary_t *bdy)
Define boundary conditions based on setup file.
Definition: cs_gui_boundary_conditions.cpp:3361
void cs_gui_boundary_conditions_free_memory(void)
Free GUI boundary condition structures.
Definition: cs_gui_boundary_conditions.cpp:3562
void cs_gui_boundary_conditions_verify(void)
Definition: cs_gui_boundary_conditions.cpp:3302
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.cpp:3670
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.cpp:3626
void cs_gui_boundary_conditions_processing(int *itypfb)
Definition: cs_gui_boundary_conditions.cpp:2720
integer, dimension(:), pointer, save itypfb
boundary condition type at the boundary face ifac (see cs_user_boundary_conditions)
Definition: pointe.f90:69
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