8.0
general documentation
Loading...
Searching...
No Matches
cs_field_default.h
Go to the documentation of this file.
1#ifndef __CS_FIELD_DEFAULT_H__
2#define __CS_FIELD_DEFAULT_H__
3
4/*============================================================================
5 * Field utility 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_defs.h"
35#include "cs_equation_param.h"
36
37/*----------------------------------------------------------------------------*/
38
40
41/*=============================================================================
42 * Macro definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Type definitions
47 *============================================================================*/
48
49/*============================================================================
50 * Global variables
51 *============================================================================*/
52
53/*=============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
70/*----------------------------------------------------------------------------*/
71
72int
73cs_variable_cdo_field_create(const char *name,
74 const char *label,
75 int location_id,
76 int dim,
77 int has_previous);
78
79/*----------------------------------------------------------------------------*/
90/*----------------------------------------------------------------------------*/
91
92int
93cs_variable_field_create(const char *name,
94 const char *label,
95 int location_id,
96 int dim);
97
98/*----------------------------------------------------------------------------*/
113/*----------------------------------------------------------------------------*/
114
117
118/*----------------------------------------------------------------------------*/
133/*----------------------------------------------------------------------------*/
134
137
138/*----------------------------------------------------------------------------*/
146/*----------------------------------------------------------------------------*/
147
150
151/*----------------------------------------------------------------------------*/
156/*----------------------------------------------------------------------------*/
157
158void
160
161/*----------------------------------------------------------------------------*/
166/*----------------------------------------------------------------------------*/
167
168void
170
171/*----------------------------------------------------------------------------*/
172
174
175#endif /* __CS_FIELD_DEFAULT_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:509
#define END_C_DECLS
Definition cs_defs.h:510
void cs_field_free_bc_codes_all(void)
Deallocate and unmap boundary condition coefficients for all variable fields.
Definition cs_field_default.c:471
void cs_field_build_bc_codes_all(void)
Allocate and map boundary condition coefficients for all variable fields.
Definition cs_field_default.c:368
const cs_equation_param_t * cs_field_get_equation_param_const(const cs_field_t *f)
Access a field's equation parameters for read only.
Definition cs_field_default.c:312
int cs_variable_field_create(const char *name, const char *label, int location_id, int dim)
Add field defining a general solved variable, with default options.
Definition cs_field_default.c:226
int cs_variable_cdo_field_create(const char *name, const char *label, int location_id, int dim, int has_previous)
Add a field shared between CDO and legacy schemes. This field is related to a general solved variable...
Definition cs_field_default.c:172
cs_field_t * cs_field_get_variance(const cs_field_t *f)
For a given field, returns field defined as its variance, if present.
Definition cs_field_default.c:337
cs_equation_param_t * cs_field_get_equation_param(cs_field_t *f)
Access a field's equation parameters.
Definition cs_field_default.c:280
char * label
Definition keywords.h:71
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition cs_equation_param.h:192
Field descriptor.
Definition cs_field.h:130