9.2
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-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 * Standard C library headers
32 *----------------------------------------------------------------------------*/
33
34/*----------------------------------------------------------------------------
35 * Local headers
36 *----------------------------------------------------------------------------*/
37
38#include "base/cs_base.h"
39#include "mesh/cs_mesh_location.h"
40#include "base/cs_zone.h"
41
42/*============================================================================
43 * Macro definitions
44 *============================================================================*/
45
46/*============================================================================
47 * Type definitions
48 *============================================================================*/
49
50/*=============================================================================
51 * Global variables
52 *============================================================================*/
53
54/*============================================================================
55 * Public function prototypes
56 *============================================================================*/
57
58/*----------------------------------------------------------------------------*/
59/*
60 * \brief build solid flag for mesh cells.
61 *
62 * If no solid cells are present, returned pointer is null.
63
64 * If non-empty, the caller is responsible for freeing the flag
65 *
66 * \param[in] m pointer to mesh
67 *
68 * \return solid cell flag array (0 is fluid, 1 if solid), or null
69 */
70/*----------------------------------------------------------------------------*/
71
72int *
73cs_solid_zone_flag(const cs_mesh_t *m);
74
75/*----------------------------------------------------------------------------*/
76/*
77 * \brief Zero an array on cells of a solid zone
78 *
79 * \param[in] stride array stride
80 * \param[out] a array of cell values
81 */
82/*----------------------------------------------------------------------------*/
83
84void
85cs_solid_zone_set_zero_on_cells(int stride,
86 cs_real_t *a);
87
88/*----------------------------------------------------------------------------*/
95/*----------------------------------------------------------------------------*/
96
97void
98cs_solid_zone_set_scalar_on_cells(cs_real_t ref_val,
99 cs_real_t a[]);
100
101/*----------------------------------------------------------------------------*/
102
103#endif /* CS_SOLID_ZONE_H */
cs_base.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
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:132
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:214
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:159
cs_zone.h
cs_mesh_t
Definition: cs_mesh.h:85