9.2
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-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#include "base/cs_boundary.h"
36#include "base/cs_zone.h"
37
38/*============================================================================
39 * Type definitions
40 *============================================================================*/
41
44typedef struct {
45
46 const cs_zone_t *zone; /*<! Pointer to zone */
47
48 const char *name; /*<! Pointer to field or array name */
49 const char *condition; /*<! Pointer to condition name type */
50
51 int dim; /*<! Values dimension */
52
54
55/*============================================================================
56 * Static global variables
57 *============================================================================*/
58
59/*=============================================================================
60 * Public function prototypes
61 *============================================================================*/
62
63/*----------------------------------------------------------------------------
64 * Boundary conditions treatment
65 *
66 * \param[in, out] itypfb <-- type of boundary for each face
67 *----------------------------------------------------------------------------*/
68
69void
71
72/*----------------------------------------------------------------------------
73 * Boundary conditions input verification
74 *----------------------------------------------------------------------------*/
75
76void
78
79/*----------------------------------------------------------------------------*/
86/*----------------------------------------------------------------------------*/
87
88void
90
91/*----------------------------------------------------------------------------*/
95/*----------------------------------------------------------------------------*/
96
97void
99
100/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
115 const char *name,
116 const char *condition,
117 int dim);
118
119/*----------------------------------------------------------------------------*/
135/*----------------------------------------------------------------------------*/
136
137void
139 const cs_lnum_t *elt_ids,
140 bool dense_output,
141 void *input,
142 cs_real_t *retval);
143
144/*----------------------------------------------------------------------------*/
145
146#endif /* CS_GUI_BOUNDARY_CONDITION_H */
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
void cs_gui_boundary_conditions_define(cs_boundary_t *bdy)
Define boundary conditions based on setup file.
Definition: cs_gui_boundary_conditions.cpp:3287
void cs_gui_boundary_conditions_free_memory(void)
Free GUI boundary condition structures.
Definition: cs_gui_boundary_conditions.cpp:3494
void cs_gui_boundary_conditions_verify(void)
Definition: cs_gui_boundary_conditions.cpp:3236
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:3592
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:3550
void cs_gui_boundary_conditions_processing(int *itypfb)
Definition: cs_gui_boundary_conditions.cpp:2685
Structure storing information related to the "physical" boundaries associated with the computational ...
Definition: cs_boundary.h:154
Definition: cs_gui_boundary_conditions.h:44
const char * condition
Definition: cs_gui_boundary_conditions.h:49
int dim
Definition: cs_gui_boundary_conditions.h:51
const char * name
Definition: cs_gui_boundary_conditions.h:48
const cs_zone_t * zone
Definition: cs_gui_boundary_conditions.h:46
Definition: cs_zone.h:51