9.2
general documentation
cs_flag_check.h
Go to the documentation of this file.
1#ifndef CS_FLAG_CHECK_H
2#define CS_FLAG_CHECK_H
3
4/*============================================================================
5 * Mesh element flag checking and error 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
41/*============================================================================
42 * Macro definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Type definitions
47 *============================================================================*/
48
49/*=============================================================================
50 * Global variables
51 *============================================================================*/
52
53/*============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
90/*----------------------------------------------------------------------------*/
91
92int
93cs_flag_check(const char *err_elt_descr,
94 const char *flag_descr,
95 const char *flag_label,
96 const char *error_mesh_name,
97 const char *valid_mesh_name,
98 int location_id,
99 int min_flag,
100 const int elt_flag[]);
101
102/*----------------------------------------------------------------------------*/
133/*----------------------------------------------------------------------------*/
134
135void
136cs_flag_check_error_info(const char *err_elt_descr,
137 const char *flag_descr,
138 const char *flag_label,
139 const char *error_mesh_name,
140 const char *valid_mesh_name,
141 int location_id,
142 int min_flag,
143 const int elt_flag[]);
144
145/*----------------------------------------------------------------------------*/
146
147#endif /* CS_FLAG_CHECK_H */
cs_base.h
cs_flag_check
int cs_flag_check(const char *err_elt_descr, const char *flag_descr, const char *flag_label, const char *error_mesh_name, const char *valid_mesh_name, int location_id, int min_flag, const int elt_flag[])
Check for and handle errors with an associated element flag.
Definition: cs_flag_check.cpp:464
cs_flag_check_error_info
void cs_flag_check_error_info(const char *err_elt_descr, const char *flag_descr, const char *flag_label, const char *error_mesh_name, const char *valid_mesh_name, int location_id, int min_flag, const int elt_flag[])
Handle an error with an associated element flag.
Definition: cs_flag_check.cpp:537
cs_mesh_location.h