8.0
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  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * MEG function prototypes
49  *============================================================================*/
50 
51 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 cs_real_t *
71 cs_meg_boundary_function(const char *zone_name,
72  const cs_lnum_t n_elts,
73  const cs_lnum_t *elt_ids,
74  const cs_real_t xyz[][3],
75  const char *field_name,
76  const char *condition);
77 
78 /*----------------------------------------------------------------------------*/
92 /*----------------------------------------------------------------------------*/
93 
94 void
95 cs_meg_volume_function(const char *zone_name,
96  const cs_lnum_t n_elts,
97  const cs_lnum_t *elt_ids,
98  const cs_real_t xyz[][3],
99  cs_field_t *f[]);
100 
101 /*----------------------------------------------------------------------------*/
118 /*----------------------------------------------------------------------------*/
119 
120 cs_real_t *
121 cs_meg_initialization(const char *zone_name,
122  const cs_lnum_t n_elts,
123  const cs_lnum_t *elt_ids,
124  const cs_real_t xyz[][3],
125  const char *field_name);
126 
127 /*----------------------------------------------------------------------------*/
145 /*----------------------------------------------------------------------------*/
146 
147 cs_real_t *
148 cs_meg_source_terms(const char *zone_name,
149  const cs_lnum_t n_elts,
150  const cs_lnum_t *elt_ids,
151  const cs_real_t xyz[][3],
152  const char *name,
153  const char *source_type);
154 
155 /*----------------------------------------------------------------------------*/
167 /*----------------------------------------------------------------------------*/
168 
169 void
171  const char *object_name,
172  cs_real_t xyz[3],
173  cs_real_t t);
174 
175 /*----------------------------------------------------------------------------*/
185 /*----------------------------------------------------------------------------*/
186 
187 void
188 cs_meg_fsi_struct(const char *object_type,
189  const char *name,
190  const cs_real_t fluid_f[],
191  cs_real_t val[]);
192 
193 /*----------------------------------------------------------------------------*/
197 /*----------------------------------------------------------------------------*/
198 
199 void
201 
202 /*----------------------------------------------------------------------------*/
210 /*----------------------------------------------------------------------------*/
211 
212 void
213 cs_meg_post_profiles(const char *name,
214  int n_coords,
215  cs_real_t coords[][3]);
216 
217 /*----------------------------------------------------------------------------*/
218 
220 
221 #endif /* __CS_MEG_PROTOTYPES_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:510
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
@ t
Definition: cs_field_pointer.h:92
cs_real_t * 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)
Definition: cs_meg_boundary_function.c:75
cs_real_t * 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)
Definition: cs_meg_source_terms.c:76
void cs_meg_post_activate(void)
This function is used to activate postprocessing writers.
Definition: cs_meg_post_output.c:64
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
cs_real_t * 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)
Definition: cs_meg_initialization.c:75
void cs_meg_immersed_boundaries_inout(int *ipenal, const char *object_name, cs_real_t xyz[3], cs_real_t t)
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], cs_field_t *f[])
Definition: cs_meg_volume_function.c:72
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
Field descriptor.
Definition: cs_field.h:130