8.1
general documentation
cs_meg_prototypes.h
Go to the documentation of this file.
1 #ifndef __CS_MEG_PROTOTYPES_H__
2 #define __CS_MEG_PROTOTYPES_H__
3 
4 /*============================================================================
5  * Prototypes for MEG (Mathematical Expression Generator) 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  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 #include "cs_field.h"
36 #include "cs_volume_zone.h"
37 #include "cs_boundary_zone.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
42 
43 /*============================================================================
44  * MEG function prototypes
45  *============================================================================*/
46 
47 /*----------------------------------------------------------------------------*/
63 /*----------------------------------------------------------------------------*/
64 
65 void
66 cs_meg_boundary_function(const char *zone_name,
67  const cs_lnum_t n_elts,
68  const cs_lnum_t *elt_ids,
69  const cs_real_t xyz[][3],
70  const char *field_name,
71  const char *condition,
72  cs_real_t *retvals);
73 
74 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 void
91 cs_meg_volume_function(const char *zone_name,
92  const cs_lnum_t n_elts,
93  const cs_lnum_t *elt_ids,
94  const cs_real_t xyz[][3],
95  const char *fields_names,
96  cs_real_t *fvals[]);
97 
98 /*----------------------------------------------------------------------------*/
115 /*----------------------------------------------------------------------------*/
116 
117 void
118 cs_meg_initialization(const char *zone_name,
119  const cs_lnum_t n_elts,
120  const cs_lnum_t *elt_ids,
121  const cs_real_t xyz[][3],
122  const char *field_name,
123  cs_real_t *retvals);
124 
125 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 
145 void
146 cs_meg_source_terms(const char *zone_name,
147  const cs_lnum_t n_elts,
148  const cs_lnum_t *elt_ids,
149  const cs_real_t xyz[][3],
150  const char *name,
151  const char *source_type,
152  cs_real_t *retvals);
153 
154 /*----------------------------------------------------------------------------*/
166 /*----------------------------------------------------------------------------*/
167 
168 void
170  const char *object_name,
171  cs_real_t xyz[3],
172  cs_real_t t);
173 
174 /*----------------------------------------------------------------------------*/
184 /*----------------------------------------------------------------------------*/
185 
186 void
187 cs_meg_fsi_struct(const char *object_type,
188  const char *name,
189  const cs_real_t fluid_f[],
190  cs_real_t val[]);
191 
192 /*----------------------------------------------------------------------------*/
196 /*----------------------------------------------------------------------------*/
197 
198 void
200 
201 /*----------------------------------------------------------------------------*/
209 /*----------------------------------------------------------------------------*/
210 
211 void
212 cs_meg_post_profiles(const char *name,
213  int n_coords,
214  cs_real_t coords[][3]);
215 
216 /*----------------------------------------------------------------------------*/
217 
219 
220 #endif /* __CS_MEG_PROTOTYPES_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:515
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
@ t
Definition: cs_field_pointer.h:92
void cs_meg_source_terms(const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *name, const char *source_type, cs_real_t *retvals)
Definition: cs_meg_source_terms.c:76
void cs_meg_initialization(const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *field_name, cs_real_t *retvals)
Definition: cs_meg_initialization.c:74
void cs_meg_post_activate(void)
This function is used to activate postprocessing writers.
Definition: cs_meg_post_output.c:64
void cs_meg_volume_function(const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *fields_names, cs_real_t *fvals[])
Definition: cs_meg_volume_function.c:72
void cs_meg_post_profiles(const char *name, int n_coords, cs_real_t coords[][3])
This function is used to define profile coordinates.
Definition: cs_meg_post_profile.c:68
void cs_meg_immersed_boundaries_inout(int *ipenal, const char *object_name, cs_real_t xyz[3], cs_real_t t)
void cs_meg_fsi_struct(const char *object_type, const char *name, const cs_real_t fluid_f[], cs_real_t val[])
This function is used to query FSI internal coupling structure values for a given boundary and struct...
Definition: cs_meg_fsi_struct.c:70
void cs_meg_boundary_function(const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *field_name, const char *condition, cs_real_t *retvals)
Definition: cs_meg_boundary_function.c:74