8.1
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-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 /*----------------------------------------------------------------------------
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 
71 typedef struct {
73  char *file_names;
74  char *output_name;
86 
87 /*============================================================================
88  * Static global variables
89  *============================================================================*/
90 
91 /* Pointer to options structure */
93 
94 /*============================================================================
95  * Static global variables
96  *============================================================================*/
97 
98 /*============================================================================
99  * Public function definitions
100  *============================================================================*/
101 
102 /*----------------------------------------------------------------------------*/
109 /*----------------------------------------------------------------------------*/
110 
111 void
112 cs_porosity_from_scan_set_file_name(const char *file_name);
113 
114 /*----------------------------------------------------------------------------*/
120 /*----------------------------------------------------------------------------*/
121 
122 void
123 cs_porosity_from_scan_set_output_name(const char *output_name);
124 
125 /*----------------------------------------------------------------------------*/
132 /*----------------------------------------------------------------------------*/
133 
134 void
136  bool transform);
137 
138 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 void
147 cs_ibm_add_sources_by_file_name(const char *file_name);
148 
149 /*----------------------------------------------------------------------------*/
172 /*----------------------------------------------------------------------------*/
173 
174 void
176 
177 /*----------------------------------------------------------------------------*/
178 
180 
181 #endif /* __CS_POROSITY_FROM_SCAN_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
cs_real_t cs_real_34_t[3][4]
Definition: cs_defs.h:349
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:334
#define END_C_DECLS
Definition: cs_defs.h:515
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
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.c:935
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.c:1002
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.c:894
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.c:961
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.c:1068
Definition: cs_porosity_from_scan.h:71
bool compute_porosity_from_scan
Definition: cs_porosity_from_scan.h:72
cs_real_34_t transformation_matrix
Definition: cs_porosity_from_scan.h:80
bool postprocess_points
Definition: cs_porosity_from_scan.h:75
char * output_name
Definition: cs_porosity_from_scan.h:74
int nb_sources
Definition: cs_porosity_from_scan.h:81
cs_lnum_t threshold
Definition: cs_porosity_from_scan.h:84
char * file_names
Definition: cs_porosity_from_scan.h:73
cs_lnum_t * source_c_ids
Definition: cs_porosity_from_scan.h:83
cs_real_3_t * sources
Definition: cs_porosity_from_scan.h:82