8.1
general documentation
cs_lagr_log.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_LOG_H__
2 #define __CS_LAGR_LOG_H__
3 
4 /*============================================================================
5  * Lagrangian module logging
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  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_defs.h"
39 
40 /*----------------------------------------------------------------------------*/
41 
42 BEGIN_C_DECLS
43 
44 /*=============================================================================
45  * Public function prototypes
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------*/
52 /*----------------------------------------------------------------------------*/
53 
54 void
55 cs_lagr_log_setup(void);
56 
57 /*----------------------------------------------------------------------------*/
61 /*----------------------------------------------------------------------------*/
62 
63 void
64 cs_lagr_log_iteration(void);
65 
66 /*----------------------------------------------------------------------------*/
67 
68 END_C_DECLS
69 
70 #endif /* __CS_LAGR_LOG_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_lagr_log_iteration
void cs_lagr_log_iteration(void)
Log Lagrangian module output in the main log file.
Definition: cs_lagr_log.c:544
cs_lagr_log_setup
void cs_lagr_log_setup(void)
Log Lagrangian module output in the setup file.
Definition: cs_lagr_log.c:309