programmer's documentation
cs_at_data_assim.h
Go to the documentation of this file.
1 #ifndef __CS_AT_DATA_ASSIM_H__
2 #define __CS_AT_DATA_ASSIM_H__
3 
4 /*============================================================================
5  * Data assimilation
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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 #if defined(HAVE_MPI)
31 #include <mpi.h>
32 #endif
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_defs.h"
39 
40 /*----------------------------------------------------------------------------*/
41 
43 
44 /*=============================================================================
45  * Macro definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Type definitions
50  *============================================================================*/
51 
52 /*============================================================================
53  * Global variables
54  *============================================================================*/
55 
56 /*=============================================================================
57  * Public function prototypes
58  *============================================================================*/
59 
60 /*----------------------------------------------------------------------------*/
64 /*----------------------------------------------------------------------------*/
65 
66 void
68 
69 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 
75 void
77 
78 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 void
86 
87 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
100  cs_field_t *f);
101 
102 /*----------------------------------------------------------------------------*/
111 /*----------------------------------------------------------------------------*/
112 
113 void
115  cs_real_t *exp_st,
116  cs_real_t *imp_st);
117 
118 /*----------------------------------------------------------------------------*/
119 
121 
122 #endif /* __CS_AT_DATA_ASSIM_H__ */
Field descriptor.
Definition: cs_field.h:124
Definition: cs_measures_util.h:47
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
void cs_at_data_assim_source_term(int f_id, cs_real_t *exp_st, cs_real_t *imp_st)
Compute source terms for a given variable and add them up to source term arrays.
Definition: cs_at_data_assim.c:502
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_at_data_assim_log(cs_measures_set_t *ms, cs_at_opt_interp_t *oi, cs_field_t *f)
Log data assimilation.
Definition: cs_at_data_assim.c:357
Definition: cs_at_opt_interp.h:62
void cs_at_data_assim_initialize(void)
Initialize data assimilation structures.
Definition: cs_at_data_assim.c:129
#define END_C_DECLS
Definition: cs_defs.h:452
void cs_at_data_assim_build_ops(void)
Build operators.
Definition: cs_at_data_assim.c:227
void cs_at_data_assim_finalize(void)
Destroy all structures linked to data assimilation.
Definition: cs_at_data_assim.c:337