9.0
general documentation
Loading...
Searching...
No Matches
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-2025 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 "base/cs_base.h"
35#include "base/cs_field.h"
36#include "base/cs_volume_zone.h"
38#include "base/cs_ibm.h"
39
40/*----------------------------------------------------------------------------*/
41
43
44typedef void
46 const cs_real_3_t xyz,
47 const cs_real_t t,
48 cs_real_t *retval);
49
50typedef void
52
53/*============================================================================
54 * MEG function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
71/*----------------------------------------------------------------------------*/
72
73void
74cs_meg_boundary_function(const char *zone_name,
75 const cs_lnum_t n_elts,
76 const cs_lnum_t *elt_ids,
77 const cs_real_t xyz[][3],
78 const char *field_name,
79 const char *condition,
80 cs_real_t *retvals);
81
82/*----------------------------------------------------------------------------*/
94/*----------------------------------------------------------------------------*/
95
96void
97cs_meg_volume_function(const char *zone_name,
98 const cs_lnum_t n_elts,
99 const cs_lnum_t *elt_ids,
100 const cs_real_t xyz[][3],
101 const char *fields_names,
102 cs_real_t *fvals[]);
103
104/*----------------------------------------------------------------------------*/
119/*----------------------------------------------------------------------------*/
120
121void
122cs_meg_initialization(const char *zone_name,
123 const cs_lnum_t n_elts,
124 const cs_lnum_t *elt_ids,
125 const cs_real_t xyz[][3],
126 const char *field_name,
127 cs_real_t *retvals);
128
129/*----------------------------------------------------------------------------*/
145/*----------------------------------------------------------------------------*/
146
147void
148cs_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 cs_real_t *retvals);
155
156/*----------------------------------------------------------------------------*/
166/*----------------------------------------------------------------------------*/
167
168void
169cs_meg_fsi_struct(const char *object_type,
170 const char *name,
171 const cs_real_t fluid_f[],
172 cs_real_t val[]);
173
174/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180void
182
183/*----------------------------------------------------------------------------*/
191/*----------------------------------------------------------------------------*/
192
193void
194cs_meg_post_profiles(const char *name,
195 int n_coords,
196 cs_real_t coords[][3]);
197
198/*----------------------------------------------------------------------------*/
209/*----------------------------------------------------------------------------*/
210
211void
212cs_meg_post_calculator(const char *name,
213 const cs_lnum_t n_elts,
214 const cs_lnum_t *elt_ids,
215 const cs_real_t xyz[][3],
216 cs_real_t *retvals);
217
218/*----------------------------------------------------------------------------*/
225/*----------------------------------------------------------------------------*/
226
229(
230 const char *object_name
231);
232
233/*----------------------------------------------------------------------------*/
241/*----------------------------------------------------------------------------*/
242
244cs_meg_ibm_volume_func_by_name(const char *object_name,
245 const char *gui_var_name);
246
247/*----------------------------------------------------------------------------*/
248
249/*----------------------------------------------------------------------------*/
257/*----------------------------------------------------------------------------*/
258
260cs_meg_ibm_fsi_func_by_name(const char *object_name,
261 const char *gui_var_name);
262
263/*----------------------------------------------------------------------------*/
264
266
267#endif /* __CS_MEG_PROTOTYPES_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:542
double cs_real_t
Floating-point value.
Definition cs_defs.h:342
#define END_C_DECLS
Definition cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition cs_defs.h:335
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition cs_defs.h:359
@ t
Definition cs_field_pointer.h:94
int cs_cutcell_func_t(const cs_lnum_t c_id, const cs_real_3_t xyz, const cs_real_t t, const int num_object)
Definition cs_ibm.h:150
void cs_ibm_volume_func_t(const cs_lnum_t c_id, const cs_real_3_t xyz, const cs_real_t t, cs_real_t *retval)
Definition cs_meg_prototypes.h:45
void cs_ibm_fsi_func_t(cs_real_t *retval)
Definition cs_meg_prototypes.h:51
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)
This function is used to compute source terms over a volume zone. The mathematical expression is defi...
Definition cs_meg_source_terms.cxx: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)
This function is used for the initalization of fields over a given volume zone. The mathematical expr...
Definition cs_meg_initialization.cxx:72
cs_ibm_fsi_func_t * cs_meg_ibm_fsi_func_by_name(const char *object_name, const char *gui_var_name)
This function is used to get the cs_ibm_fsi_func_t pointer for a given object.
Definition cs_meg_immersed_boundaries_fsi.cxx:67
cs_cutcell_func_t * cs_meg_ibm_func_by_name(const char *object_name)
This function is used to get the cs_cutcell_func_t pointer for a given object.
Definition cs_meg_immersed_boundaries.cxx:64
void cs_meg_post_activate(void)
This function is used to activate postprocessing writers.
Definition cs_meg_post_output.cxx: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[])
This function is used to compute user defined values for fields over a given volume zone....
Definition cs_meg_volume_function.cxx:70
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.cxx:68
void cs_meg_post_calculator(const char *name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], cs_real_t *retvals)
This function is used to compute user defined calculator formulae. The mathematical expression is def...
Definition cs_meg_post_calculator.cxx:72
cs_ibm_volume_func_t * cs_meg_ibm_volume_func_by_name(const char *object_name, const char *gui_var_name)
This function is used to get the cs_ibm_volume_func_t pointer for a given object.
Definition cs_meg_immersed_boundaries_volume.cxx:67
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.cxx: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)
This function is used to compute user defined values for fields over a given boundary zone....
Definition cs_meg_boundary_function.cxx:72