8.3
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-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
41/*----------------------------------------------------------------------------*/
42
43BEGIN_C_DECLS
44
45/*============================================================================
46 * Macro definitions
47 *============================================================================*/
48
49/*============================================================================
50 * Type definitions
51 *============================================================================*/
52
53/*=============================================================================
54 * Global variables
55 *============================================================================*/
56
57/*============================================================================
58 * Public function prototypes
59 *============================================================================*/
60
61/*----------------------------------------------------------------------------*/
94/*----------------------------------------------------------------------------*/
95
96int
97cs_flag_check(const char *err_elt_descr,
98 const char *flag_descr,
99 const char *flag_label,
100 const char *error_mesh_name,
101 const char *valid_mesh_name,
102 int location_id,
103 int min_flag,
104 const int elt_flag[]);
105
106/*----------------------------------------------------------------------------*/
137/*----------------------------------------------------------------------------*/
138
139void
140cs_flag_check_error_info(const char *err_elt_descr,
141 const char *flag_descr,
142 const char *flag_label,
143 const char *error_mesh_name,
144 const char *valid_mesh_name,
145 int location_id,
146 int min_flag,
147 const int elt_flag[]);
148
149/*----------------------------------------------------------------------------*/
150
151END_C_DECLS
152
153#endif /* __CS_FLAG_CHECK_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
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:473
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:546
cs_mesh_location.h