programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_boundary_conditions.h
Go to the documentation of this file.
1 #ifndef __CS_BOUNDARY_CONDITIONS_H__
2 #define __CS_BOUNDARY_CONDITIONS_H__
3 
4 /*============================================================================
5  * Post-processing management
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2013 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 "fvm_nodal.h"
39 #include "fvm_writer.h"
40 
41 #include "cs_base.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
46 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Local type definitions
53  *============================================================================*/
54 
55 /*=============================================================================
56  * Global variables
57  *============================================================================*/
58 
59 /*============================================================================
60  * Public Fortran function prototypes
61  *============================================================================*/
62 
63 /*----------------------------------------------------------------------------
64  * Handling of boundary condition definition errors and associated output.
65  *
66  * For each boundary face, itypfb defines the boundary condition type.
67  * As a convention here, zero values correspond to undefined types,
68  * positive values to defined types (with no error), and negative values
69  * to defined types with inconsistent or incompatible values, the
70  * aboslute value indicationg the original boundary condition type.
71  *
72  * Fortran Interface:
73  *
74  * SUBROUTINE BCDERR (ITYPFB)
75  * *****************
76  *
77  * INTEGER ITYPFB : <-> : Array of BC type ids
78  *----------------------------------------------------------------------------*/
79 
80 void CS_PROCF (bcderr, BCDERR)
81 (
82  cs_int_t *itypfb
83 );
84 
85 /*============================================================================
86  * Public function prototypes
87  *============================================================================*/
88 
89 /*----------------------------------------------------------------------------
90  * Handling of boundary condition definition errors and associated output.
91  *
92  * For each boundary face, bc_type defines the boundary condition type.
93  * As a convention here, zero values correspond to undefined types,
94  * positive values to defined types (with no error), and negative values
95  * to defined types with inconsistent or incompatible values, the
96  * absolute value indicating the original boundary condition type.
97  *
98  * parameters:
99  * bc_type <-- array of BC type ids
100  *----------------------------------------------------------------------------*/
101 
102 void
103 cs_boundary_conditions_error(const cs_int_t bc_type[]);
104 
105 /*----------------------------------------------------------------------------*/
106 
108 
109 #endif /* __CS_BOUNDARY_CONDITIONS_H__ */