src/fvm/fvm_nodal_triangulate.h Source File

| programmer's documentation

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fvm_nodal_triangulate.h
Go to the documentation of this file.
1 #ifndef __FVM_NODAL_TRIANGULATE_H__
2 #define __FVM_NODAL_TRIANGULATE_H__
3
4 /*============================================================================
5 * Triangulation of nodal sections associated with a mesh
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 #include "cs_defs.h"
31
32 /*----------------------------------------------------------------------------
33 * Local headers
34 *----------------------------------------------------------------------------*/
35
36 #include "fvm_defs.h"
37
38 /*----------------------------------------------------------------------------*/
39
40 BEGIN_C_DECLS
41
42 /*=============================================================================
43 * Public function prototypes
44 *============================================================================*/
45
46 /*----------------------------------------------------------------------------
47 * Triangulate all sections of a nodal mesh.
48 *
49 * parameters:
50 * this_nodal <-> pointer to structure that should be triangulated
51 * error_count --> number of triangulation errors counter (optional)
52 *----------------------------------------------------------------------------*/
53
54 void
55 fvm_nodal_triangulate(fvm_nodal_t *this_nodal,
56 cs_lnum_t *error_count);
57
58 /*----------------------------------------------------------------------------
59 * Triangulate polygonal sections of a nodal mesh.
60 *
61 * parameters:
62 * this_nodal <-> pointer to structure that should be triangulated
63 * error_count --> number of triangulation errors counter (optional)
64 *----------------------------------------------------------------------------*/
65
66 void
67 fvm_nodal_triangulate_polygons(fvm_nodal_t *this_nodal,
68 cs_lnum_t *error_count);
69
70 /*----------------------------------------------------------------------------*/
71
72 END_C_DECLS
73
74 #endif /* __FVM_NODAL_TRIANGULATE_H__ */