programmer's documentation
cs_domain_post.h
Go to the documentation of this file.
1 #ifndef __CS_DOMAIN_POST_H__
2 #define __CS_DOMAIN_POST_H__
3 
4 /*============================================================================
5  * Manage specific post-processing related to a computational domain
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  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_advection_field.h"
33 #include "cs_cdo_quantities.h"
34 #include "cs_equation.h"
35 #include "cs_property.h"
36 #include "cs_time_step.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /*============================================================================
47  * Type definitions
48  *============================================================================*/
49 
50 /*============================================================================
51  * Static global variables
52  *============================================================================*/
53 
54 /*============================================================================
55  * Public function prototypes
56  *============================================================================*/
57 
58 /*----------------------------------------------------------------------------*/
70 /*----------------------------------------------------------------------------*/
71 
72 void
73 cs_domain_post_init(double dt,
74  cs_cdo_quantities_t *quant,
75  int n_adv_fields,
76  cs_adv_field_t **adv_fields,
77  int n_properties,
78  cs_property_t **properties,
79  int n_equations,
80  cs_equation_t **equations);
81 
82 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 void
92 
93 /*----------------------------------------------------------------------------*/
99 /*----------------------------------------------------------------------------*/
100 
101 void
103 
104 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 void
113 cs_domain_post(cs_time_step_t *time_step);
114 
115 /*----------------------------------------------------------------------------*/
119 /*----------------------------------------------------------------------------*/
120 
121 void
123 
124 /*----------------------------------------------------------------------------*/
125 
127 
128 #endif /* __CS_DOMAIN_POST_H__ */
time step descriptor
Definition: cs_time_step.h:51
Definition: cs_advection_field.h:59
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
void cs_domain_post_update(double dt)
Update the hidden view of the domain dedicated for post-processing.
Definition: cs_domain_post.c:346
void cs_domain_post_init(double dt, cs_cdo_quantities_t *quant, int n_adv_fields, cs_adv_field_t **adv_fields, int n_properties, cs_property_t **properties, int n_equations, cs_equation_t **equations)
Initialize the generic post-processing related to a domain.
Definition: cs_domain_post.c:311
Definition: cs_cdo_quantities.h:102
Definition: cs_field_pointer.h:65
void cs_domain_post_activate(cs_time_step_t *time_step)
Activate writers and output meshes if needed.
Definition: cs_domain_post.c:361
void cs_domain_post(cs_time_step_t *time_step)
Update the hidden view of the domain dedicated for post-processing.
Definition: cs_domain_post.c:375
void cs_domain_post_finalize(void)
Finalize post-processing related to the computational domain.
Definition: cs_domain_post.c:398
#define END_C_DECLS
Definition: cs_defs.h:452
Definition: cs_property.h:66