8.1
general documentation
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-2023 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 
41 
42 /*=============================================================================
43  * Public function prototypes
44  *============================================================================*/
45 
46 /*----------------------------------------------------------------------------
47  * Project an extruded mesh to its base plane.
48  *
49  * This is currently only possible for 2D element topologies.
50  *
51  * parameters:
52  * this_nodal <-> pointer to structure that should be cut in edges
53  * chosen_axis <-- indicate which axis is selected to extract edges
54  * error_count --> number of triangulation errors counter (optional)
55  *----------------------------------------------------------------------------*/
56 
57 void
58 fvm_nodal_project(fvm_nodal_t *this_nodal,
59  int chosen_axis,
60  cs_lnum_t *error_count);
61 
62 /*----------------------------------------------------------------------------
63  * Reduce the spatial dimension of a mesh, discarding the last coordinate
64  * component.
65  *
66  * The mesh's spatial dimension is reduced by 1.
67  *
68  * parameters:
69  * this_nodal <-> pointer to structure that projected
70  * matrix <-- projection matrix
71  * 3D -> 2D: (a11, a12, a13, a21, a22, a23)
72  * 2D -> 1D: (a11, a12)
73  *----------------------------------------------------------------------------*/
74 
75 void
76 fvm_nodal_project_coords(fvm_nodal_t *this_nodal,
77  double matrix[]);
78 
79 /*----------------------------------------------------------------------------*/
80 
82 
83 #endif /* __FVM_NODAL_PROJECT_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
#define END_C_DECLS
Definition: cs_defs.h:515
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
void matrix(const int *iconvp, const int *idiffp, const int *ndircp, const int *isym, const cs_real_t *thetap, const int *imucpp, const cs_real_t coefbp[], const cs_real_t cofbfp[], const cs_real_t rovsdt[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t xcpp[], cs_real_t da[], cs_real_t xa[])
void fvm_nodal_project(fvm_nodal_t *this_nodal, int chosen_axis, cs_lnum_t *error_count)
Definition: fvm_nodal_project.c:412
void fvm_nodal_project_coords(fvm_nodal_t *this_nodal, double matrix[])
Definition: fvm_nodal_project.c:505