8.3
general documentation
cs_porosity_from_scan.h
Go to the documentation of this file.
1#ifndef __CS_POROSITY_FROM_SCAN_H__
2#define __CS_POROSITY_FROM_SCAN_H__
3
4/*============================================================================
5 * Main for cooling towers related functions
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 * PLE library headers
32 *----------------------------------------------------------------------------*/
33
34#include <ple_locator.h>
35
36/*----------------------------------------------------------------------------
37 * Local headers
38 *----------------------------------------------------------------------------*/
39
40#include "fvm_nodal.h"
41
42#include "cs_base.h"
43#include "cs_halo.h"
44#include "cs_mesh.h"
45#include "cs_mesh_quantities.h"
46
47/*----------------------------------------------------------------------------*/
48
50
51/*============================================================================
52 * Local Macro definitions
53 *============================================================================*/
54
55/*============================================================================
56 * Type definitions
57 *============================================================================*/
58
59/*============================================================================
60 * Type definitions
61 *============================================================================*/
62
67/*----------------------------------------------------------------------------
68 * Porosity from scan model options descriptor
69 *----------------------------------------------------------------------------*/
70
71typedef enum {
72
76
78
79typedef struct {
84 char **headers;
102
104
105/*============================================================================
106 * Static global variables
107 *============================================================================*/
108
109/* Pointer to options structure */
111
112/*============================================================================
113 * Static global variables
114 *============================================================================*/
115
116/*============================================================================
117 * Public function definitions
118 *============================================================================*/
119
120/*----------------------------------------------------------------------------*/
127/*----------------------------------------------------------------------------*/
128
129void
130cs_porosity_from_scan_set_file_name(const char *file_name);
131
132/*----------------------------------------------------------------------------*/
138/*----------------------------------------------------------------------------*/
139
140void
141cs_porosity_from_scan_set_output_name(const char *output_name);
142
143/*----------------------------------------------------------------------------*/
150/*----------------------------------------------------------------------------*/
151
152void
154 bool transform);
155
156/*----------------------------------------------------------------------------*/
162/*----------------------------------------------------------------------------*/
163
164void
165cs_ibm_add_sources_by_file_name(const char *file_name);
166
167/*----------------------------------------------------------------------------*/
190/*----------------------------------------------------------------------------*/
191
192void
194
195/*----------------------------------------------------------------------------*/
196
197/*--------------------------------------------------------------------*/
198/*
199 * \brief Write the restart file of the ibm module
200 */
201/*--------------------------------------------------------------------*/
202
203void
205
206/*--------------------------------------------------------------------*/
207/*
208 * \brief Read the restart file of the ibm module
209 */
210/*--------------------------------------------------------------------*/
211
212void
214
215/*----------------------------------------------------------------------------*/
216
218
219#endif /* __CS_POROSITY_FROM_SCAN_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
cs_real_t cs_real_34_t[3][4]
Definition: cs_defs.h:374
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:359
#define END_C_DECLS
Definition: cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
cs_porosity_from_scan_opt_t * cs_glob_porosity_from_scan_opt
void cs_porosity_from_scan_set_output_name(const char *output_name)
Set the output name for the FVM writer of scan points.
Definition: cs_porosity_from_scan.cpp:952
cs_ibm_cog_location_t
Definition: cs_porosity_from_scan.h:71
@ CS_COG_FROM_PYRAMID
Definition: cs_porosity_from_scan.h:74
@ CS_COG_WITHOUT_RECONSTRUCTION_FOR_IBM_PLANE
Definition: cs_porosity_from_scan.h:75
@ CS_COG_FROM_FLUID_FACES
Definition: cs_porosity_from_scan.h:73
void cs_porous_model_write(void)
Write the restart file of the ibm module.
Definition: cs_porosity_from_scan.cpp:1355
void cs_ibm_add_sources_by_file_name(const char *file_name)
Add the scanner sources from csv file to fill fluid space.
Definition: cs_porosity_from_scan.cpp:1019
void cs_porosity_from_scan_set_file_name(const char *file_name)
Set the file name of points for the computation of the porosity from scan.
Definition: cs_porosity_from_scan.cpp:910
void cs_porosity_from_scan_add_source(const cs_real_t source[3], bool transform)
Add a scanner source point.
Definition: cs_porosity_from_scan.cpp:978
void cs_compute_porosity_from_scan(void)
Compute the porosity which is equal to one from a source, radiating sphericaly, and is 0 when touchin...
Definition: cs_porosity_from_scan.cpp:1085
void cs_porous_model_read(void)
Read the restart file of the ibm module.
Definition: cs_porosity_from_scan.cpp:1391
Definition: cs_porosity_from_scan.h:79
char ** headers
Definition: cs_porosity_from_scan.h:84
bool compute_porosity_from_scan
Definition: cs_porosity_from_scan.h:80
cs_real_34_t transformation_matrix
Definition: cs_porosity_from_scan.h:91
bool postprocess_points
Definition: cs_porosity_from_scan.h:86
int n_headers
Definition: cs_porosity_from_scan.h:82
int * header_type
Definition: cs_porosity_from_scan.h:83
char * output_name
Definition: cs_porosity_from_scan.h:85
bool use_staircase
Definition: cs_porosity_from_scan.h:98
cs_ibm_cog_location_t cog_location
Definition: cs_porosity_from_scan.h:101
int nb_sources
Definition: cs_porosity_from_scan.h:92
cs_real_t convection_porosity_threshold
Definition: cs_porosity_from_scan.h:97
cs_real_t eigenvalue_criteria
Definition: cs_porosity_from_scan.h:99
cs_lnum_t threshold
Definition: cs_porosity_from_scan.h:95
char * file_names
Definition: cs_porosity_from_scan.h:81
int use_restart
Definition: cs_porosity_from_scan.h:100
cs_real_t porosity_threshold
Definition: cs_porosity_from_scan.h:96
cs_lnum_t * source_c_ids
Definition: cs_porosity_from_scan.h:94
cs_real_3_t * sources
Definition: cs_porosity_from_scan.h:93