src/fvm/fvm_nodal_project.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_project.h
Go to the documentation of this file.
1 #ifndef __FVM_NODAL_PROJECT_H__
2 #define __FVM_NODAL_PROJECT_H__
3
4 /*============================================================================
5 * Projection 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 * Project an extruded mesh to its base plane.
48 *
49 * parameters:
50 * this_nodal <-> pointer to structure that should be cut in edges
51 * chosen_axis <-- indicate which axis is selected to extract edges
52 * error_count --> number of triangulation errors counter (optional)
53 *----------------------------------------------------------------------------*/
54
55 void
56 fvm_nodal_project(fvm_nodal_t *this_nodal,
57 int chosen_axis,
58 cs_lnum_t *error_count);
59
60 /*----------------------------------------------------------------------------
61 * Reduce the spatial dimension of a mesh, discarding the last coordinate
62 * component.
63 *
64 * The mesh's spatial dimension is reduced by 1.
65 *
66 * parameters:
67 * this_nodal <-> pointer to structure that projected
68 * matrix <-- projection matrix
69 * 3D -> 2D: (a11, a12, a13, a21, a22, a23)
70 * 2D -> 1D: (a11, a12)
71 *----------------------------------------------------------------------------*/
72
73 void
74 fvm_nodal_project_coords(fvm_nodal_t *this_nodal,
75 double matrix[]);
76
77 /*----------------------------------------------------------------------------*/
78
79 END_C_DECLS
80
81 #endif /* __FVM_NODAL_PROJECT_H__ */