My Project
programmer's documentation
cs_mesh_from_builder.h
Go to the documentation of this file.
1 #ifndef __CS_MESH_FROM_BUILDER_H__
2 #define __CS_MESH_FROM_BUILDER_H__
3 
4 /*============================================================================
5  * Define cs_mesh_t fields from cs_mesh_builder_t fields.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2019 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  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 
36 #include "fvm_group.h"
37 #include "fvm_selector.h"
38 #include "fvm_periodicity.h"
39 
40 #include "cs_base.h"
41 
42 #include "cs_mesh.h"
43 #include "cs_mesh_builder.h"
44 
45 /*----------------------------------------------------------------------------*/
46 
48 
49 /*=============================================================================
50  * Macro definitions
51  *============================================================================*/
52 
53 /*============================================================================
54  * Type definitions
55  *============================================================================*/
56 
57 /*============================================================================
58  * Static global variables
59  *============================================================================*/
60 
61 /*============================================================================
62  * Public function prototypes for Fortran API
63  *============================================================================*/
64 
65 /*----------------------------------------------------------------------------
66  * Query or modification of the option for domain partitioning when no
67  * partitioning file is present.
68  *
69  * This function returns 1 or 2 according to the selected algorithm.
70  *
71  * Fortran interface :
72  *
73  * subroutine algdom (iopt)
74  * *****************
75  *
76  * integer iopt : <-> : choice of the partitioning base
77  * 0: query
78  * 1: initial numbering
79  * 2: Morton curve (bounding box)
80  * 3: Morton curve (bounding cube)
81  * 4: Hilbert curve (bounding box)
82  * 5: Hilbert curve (bounding cube)
83  *----------------------------------------------------------------------------*/
84 
85 void
86 CS_PROCF (algdom, ALGDOM)(cs_int_t *iopt);
87 
88 /*=============================================================================
89  * Public function prototypes
90  *============================================================================*/
91 
92 /*----------------------------------------------------------------------------
93  * Transfer mesh builder to mesh structure.
94  *
95  * parameters:
96  * mesh <-- pointer to mesh structure
97  * mesh_builder <-- pointer to mesh builder structure
98  *----------------------------------------------------------------------------*/
99 
100 void
102  cs_mesh_builder_t *mesh_builder);
103 
104 /*----------------------------------------------------------------------------*/
105 
107 
108 #endif /* __CS_MESH_FROM_BUILDER_H__ */
cs_defs.h
cs_mesh_builder_t
Definition: cs_mesh_builder.h:57
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
fvm_group.h
cs_mesh_from_builder
void cs_mesh_from_builder(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder)
Transfer mesh builder to mesh structure.
Definition: cs_mesh_from_builder.c:1439
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
mesh
Definition: mesh.f90:26
cs_mesh.h
fvm_selector.h
cs_mesh_builder.h
fvm_periodicity.h
cs_int_t
int cs_int_t
Fortran-compatible integer.
Definition: cs_defs.h:301
CS_PROCF
void CS_PROCF(algdom, ALGDOM)(cs_int_t *iopt)
cs_mesh_t
Definition: cs_mesh.h:63
cs_base.h