8.3
general documentation
cs_mesh_to_builder.h
Go to the documentation of this file.
1#ifndef __CS_MESH_TO_BUILDER_H__
2#define __CS_MESH_TO_BUILDER_H__
3
4/*============================================================================
5 * Define cs_mesh_builder_t fields from cs_mesh_t fields.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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_io.h"
43#include "cs_mesh.h"
44#include "cs_mesh_builder.h"
45#include "cs_part_to_block.h"
46
47/*----------------------------------------------------------------------------*/
48
50
51/*=============================================================================
52 * Macro definitions
53 *============================================================================*/
54
55/*============================================================================
56 * Type definitions
57 *============================================================================*/
58
59/*============================================================================
60 * Static global variables
61 *============================================================================*/
62
63/*=============================================================================
64 * Public function prototypes
65 *============================================================================*/
66
67/*----------------------------------------------------------------------------
68 * Transfer mesh to mesh builder structure.
69 *
70 * As the dataflow is very similar, but may be done array-by array to minimize
71 * memory overhead, this function also handles a part of the output
72 * to file needed to save a mesh file.
73 *
74 * parameters:
75 * mesh <-> pointer to mesh structure
76 * mb <-> pointer to mesh builder structure
77 * transfer <-- if true, data is transferred from mesh to builder;
78 * if false, builder fields are only used as a temporary
79 * arrays.
80 * pp_out <-> optional output file, or NULL
81 *----------------------------------------------------------------------------*/
82
83void
86 bool transfer,
87 cs_io_t *pp_out);
88
89/*----------------------------------------------------------------------------
90 * Transfer mesh partitioning info to mesh builder structure.
91 *
92 * parameters:
93 * mesh <-- pointer to mesh structure
94 * mb <-> pointer to mesh builder structure
95 *----------------------------------------------------------------------------*/
96
97void
100
101/*----------------------------------------------------------------------------
102 * Reconstruct periodic faces info from mesh to builder.
103 *
104 * parameters:
105 * mesh <-- pointer to mesh structure
106 * mb <-> pointer to mesh builder structure
107 *----------------------------------------------------------------------------*/
108
109void
112
113/*----------------------------------------------------------------------------*/
114
116
117#endif /* __CS_MESH_TO_BUILDER_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
#define END_C_DECLS
Definition: cs_defs.h:543
struct _cs_io_t cs_io_t
Definition: cs_io.h:68
void cs_mesh_to_builder(cs_mesh_t *mesh, cs_mesh_builder_t *mb, bool transfer, cs_io_t *pp_out)
Transfer mesh to mesh builder structure.
Definition: cs_mesh_to_builder.cpp:1516
void cs_mesh_to_builder_perio_faces(const cs_mesh_t *mesh, cs_mesh_builder_t *mb)
Reconstruct periodic faces info from mesh to builder.
Definition: cs_mesh_to_builder.cpp:1701
void cs_mesh_to_builder_partition(const cs_mesh_t *mesh, cs_mesh_builder_t *mb)
Transfer mesh partitioning info to mesh builder structure.
Definition: cs_mesh_to_builder.cpp:1641
Definition: mesh.f90:26
Definition: cs_mesh_builder.h:57
Definition: cs_mesh.h:85