8.3
general documentation
cs_solid_zone.h
Go to the documentation of this file.
1#ifndef __CS_SOLID_ZONE_H__
2#define __CS_SOLID_ZONE_H__
3
4/*============================================================================
5 * Solid zones handling.
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 * Standard C library headers
32 *----------------------------------------------------------------------------*/
33
34/*----------------------------------------------------------------------------
35 * Local headers
36 *----------------------------------------------------------------------------*/
37
38#include "cs_base.h"
39#include "cs_mesh_location.h"
40#include "cs_zone.h"
41
42/*----------------------------------------------------------------------------*/
43
44BEGIN_C_DECLS
45
46/*============================================================================
47 * Macro definitions
48 *============================================================================*/
49
50/*============================================================================
51 * Type definitions
52 *============================================================================*/
53
54/*=============================================================================
55 * Global variables
56 *============================================================================*/
57
58/*============================================================================
59 * Public function prototypes
60 *============================================================================*/
61
62/*----------------------------------------------------------------------------*/
74/*----------------------------------------------------------------------------*/
75
76int *
77cs_solid_zone_flag(const cs_mesh_t *m);
78
79/*----------------------------------------------------------------------------*/
80/*
81 * \brief Zero an array on cells of a solid zone
82 *
83 * \param[in] stride array stride
84 * \param[out] a array of cell values
85 */
86/*----------------------------------------------------------------------------*/
87
88void
89cs_solid_zone_set_zero_on_cells(int stride,
90 cs_real_t *a);
91
92/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
102cs_solid_zone_set_scalar_on_cells(cs_real_t ref_val,
103 cs_real_t a[]);
104
105/*----------------------------------------------------------------------------*/
106
107END_C_DECLS
108
109#endif /* __CS_SOLID_ZONE_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_mesh_location.h
cs_solid_zone_flag
int * cs_solid_zone_flag(const cs_mesh_t *m)
build solid flag for mesh cells.
Definition: cs_solid_zone.cpp:143
cs_solid_zone_set_scalar_on_cells
void cs_solid_zone_set_scalar_on_cells(cs_real_t ref_val, cs_real_t a[])
Assign a constant scalar value to cells of a solid zone.
Definition: cs_solid_zone.cpp:225
cs_solid_zone_set_zero_on_cells
void cs_solid_zone_set_zero_on_cells(int stride, cs_real_t *a)
Zero an array on cells of a solid zone.
Definition: cs_solid_zone.cpp:170
cs_zone.h
cs_mesh_t
Definition: cs_mesh.h:85