programmer's documentation
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-2019 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 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Global variables
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Public function prototypes
54  *============================================================================*/
55 
56 /*----------------------------------------------------------------------------*/
69 /*----------------------------------------------------------------------------*/
70 
71 int
72 cs_variable_cdo_field_create(const char *name,
73  const char *label,
74  int location_id,
75  int dim,
76  int has_previous);
77 
78 /*----------------------------------------------------------------------------*/
89 /*----------------------------------------------------------------------------*/
90 
91 int
92 cs_variable_field_create(const char *name,
93  const char *label,
94  int location_id,
95  int dim);
96 
97 /*----------------------------------------------------------------------------*/
98 
99 END_C_DECLS
100 
101 #endif /* __CS_FIELD_DEFAULT_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_variable_field_create
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:178
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_variable_cdo_field_create
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:126
Generated on Tue Sep 24 2019 16:18:04 by   doxygen 1.8.13