/usr/include/code_saturne/fvm_triangulate.h is in code-saturne-include 3.3.2-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | #ifndef __FVM_TRIANGULATE_H__
#define __FVM_TRIANGULATE_H__
/*============================================================================
* Triangulation of a polygon
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2014 EDF S.A.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "fvm_defs.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*=============================================================================
* Macro definitions
*============================================================================*/
/*============================================================================
* Type definitions
*============================================================================*/
/*
* Pointer to structure maintaining the state of the current triangulation;
* the structure itself is private.
*/
typedef struct _fvm_triangulate_state_t fvm_triangulate_state_t;
/*
* Describe how the resulting triangle connectivity is defined.
*/
typedef enum {
FVM_TRIANGULATE_MESH_DEF, /* Definition by mesh vertex numbers */
FVM_TRIANGULATE_ELT_DEF /* Definition by local (element) vertex
position (1 to n) */
} fvm_triangulate_def_t;
/*=============================================================================
* Static global variables
*============================================================================*/
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Create a structure necessary to the polygon triangulation algorithm.
*
* parameters:
* n_vertices_max <-- maximum expected number of vertices per polygon.
*
* returns:
* pointer to polygon triangulation state structure.
*----------------------------------------------------------------------------*/
fvm_triangulate_state_t *
fvm_triangulate_state_create(const int n_vertices_max);
/*----------------------------------------------------------------------------
* Destroy a structure necessary to the polygon triangulation algorithm.
*
* parameters:
* this_state <-> pointer to structure that should be destroyed.
*
* returns:
* NULL pointer.
*----------------------------------------------------------------------------*/
fvm_triangulate_state_t *
fvm_triangulate_state_destroy(fvm_triangulate_state_t *this_state);
/*----------------------------------------------------------------------------
* Triangulate a polygonal face.
*
* For a polygon with n vertices, we should obtain a triangluation with
* (n-2) triangles and (2n-3) edges. If the polygon_vertices argument
* is NULL, 1, 2, ...,n local numbering is implied.
*
* parameters:
* dim <-- spatial dimension (2 or 3).
* n_vertices <-- number of vertices defining the polygon.
* coords <-- coordinates of the triangulation's vertices.
* parent_vertex_num <-- optional indirection to vertex coordinates (1 to n).
* polygon_vertices <-- polygon connectivity; size: n_vertices or empty.
* mode <-- triangles connectivity by vertex number or
* polygon vertex index (1 to n).
* triangle_vertices --> triangles connectivity;
* size: (n_vertices - 2) * 3.
* state <-> associated triangulation state structure.
*
* returns:
* number of resulting triangles.
*----------------------------------------------------------------------------*/
int
fvm_triangulate_polygon(int dim,
int n_vertices,
const cs_coord_t coords[],
const cs_lnum_t parent_vertex_num[],
const cs_lnum_t polygon_vertices[],
fvm_triangulate_def_t mode,
cs_lnum_t triangle_vertices[],
fvm_triangulate_state_t *const state);
/*----------------------------------------------------------------------------
* Triangulate a quadrangle.
*
* A convex quadrangle is divided into two triangles along its shortest
* diagonal. A non-convex quadrangle may only be divided along the diagonal
* which lies inside the quadrangle.
*
* If the quadrangle_vertices argument is NULL, 1, 2, ...,n local numbering
* is implied.
*
* parameters:
* dim <-- spatial dimension (2 or 3).
* coords <-- coordinates of the triangulation's vertices.
* parent_vertex_num <-- optional indirection to vertex coordinates
* quadrangle_vertices <-- polygon connectivity; size: n_vertices or empty.
* triangle_vertices --> triangles connectivity; size: 2 * 3.
*
* returns:
* number of resulting triangles.
*----------------------------------------------------------------------------*/
int
fvm_triangulate_quadrangle(int dim,
const cs_coord_t coords[],
const cs_lnum_t parent_vertex_num[],
const cs_lnum_t quadrangle_vertices[],
cs_lnum_t triangle_vertices[]);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __FVM_TRIANGULATE_H__ */
|