7.1
general 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-2021 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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------*/
33 
34 #if defined(HAVE_MPI)
35 #include <mpi.h>
36 #endif
37 
38 /*----------------------------------------------------------------------------
39  * Local headers
40  *----------------------------------------------------------------------------*/
41 
42 #include "cs_at_opt_interp.h"
43 
44 /*----------------------------------------------------------------------------*/
45 
46 BEGIN_C_DECLS
47 
48 /*=============================================================================
49  * Macro definitions
50  *============================================================================*/
51 
52 /*============================================================================
53  * Type definitions
54  *============================================================================*/
55 
56 /*============================================================================
57  * Global variables
58  *============================================================================*/
59 
60 /*=============================================================================
61  * Public function prototypes
62  *============================================================================*/
63 
64 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 void
71 cs_at_data_assim_initialize(void);
72 
73 /*----------------------------------------------------------------------------*/
77 /*----------------------------------------------------------------------------*/
78 
79 void
80 cs_at_data_assim_build_ops(void);
81 
82 /*----------------------------------------------------------------------------*/
86 /*----------------------------------------------------------------------------*/
87 
88 void
89 cs_at_data_assim_finalize(void);
90 
91 /*----------------------------------------------------------------------------*/
99 /*----------------------------------------------------------------------------*/
100 
101 void
102 cs_at_data_assim_log(cs_measures_set_t *ms,
103  cs_at_opt_interp_t *oi,
104  cs_field_t *f);
105 
106 /*----------------------------------------------------------------------------*/
115 /*----------------------------------------------------------------------------*/
116 
117 void
118 cs_at_data_assim_source_term(int f_id,
119  cs_real_t *exp_st,
120  cs_real_t *imp_st);
121 
122 /*----------------------------------------------------------------------------*/
123 
124 END_C_DECLS
125 
126 #endif /* __CS_AT_DATA_ASSIM_H__ */
cs_field_t
Field descriptor.
Definition: cs_field.h:125
cs_measures_set_t
Definition: cs_measures_util.h:47
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_at_data_assim_source_term
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:505
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_at_data_assim_log
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
cs_at_opt_interp_t
Definition: cs_at_opt_interp.h:62
cs_at_data_assim_initialize
void cs_at_data_assim_initialize(void)
Initialize data assimilation structures.
Definition: cs_at_data_assim.c:129
cs_at_opt_interp.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_at_data_assim_build_ops
void cs_at_data_assim_build_ops(void)
Build operators.
Definition: cs_at_data_assim.c:227
cs_at_data_assim_finalize
void cs_at_data_assim_finalize(void)
Destroy all structures linked to data assimilation.
Definition: cs_at_data_assim.c:337