8.3
general documentation
cs_lagr_post.h
Go to the documentation of this file.
1#ifndef __CS_LAGR_POST_H__
2#define __CS_LAGR_POST_H__
3
4/*============================================================================
5 * Lagrangian module postprocessing
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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#include "assert.h"
33#include "cs_base.h"
34#include "cs_field.h"
35
36#include "cs_lagr.h"
37#include "cs_lagr_particle.h"
38
39/*----------------------------------------------------------------------------*/
40
41BEGIN_C_DECLS
42
43/*=============================================================================
44 * Macro definitions
45 *============================================================================*/
46
47/*============================================================================
48 * Type definitions
49 *============================================================================*/
50
51/*============================================================================
52 Global variables
53 ============================================================================*/
54
55/*============================================================================
56 * Public function prototypes
57 *============================================================================*/
58
59/*----------------------------------------------------------------------------*/
63/*----------------------------------------------------------------------------*/
64
65void
66cs_lagr_post_init(void);
67
68/*----------------------------------------------------------------------------*/
76/*----------------------------------------------------------------------------*/
77
78bool
79cs_lagr_post_get_attr(cs_lagr_attribute_t attr_id);
80
81/*----------------------------------------------------------------------------*/
88/*----------------------------------------------------------------------------*/
89
90void
91cs_lagr_post_set_attr(cs_lagr_attribute_t attr_id,
92 bool active);
93
94/*----------------------------------------------------------------------------*/
95
96END_C_DECLS
97
98#endif /* __CS_LAGR_POST_H__ */
cs_base.h
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_field.h
cs_lagr.h
cs_lagr_particle.h
cs_lagr_attribute_t
cs_lagr_attribute_t
Definition: cs_lagr_particle.h:80
cs_lagr_post_set_attr
void cs_lagr_post_set_attr(cs_lagr_attribute_t attr_id, bool active)
Activate or deactive postprocessing for a given particle attribute.
Definition: cs_lagr_post.cpp:394
cs_lagr_post_init
void cs_lagr_post_init(void)
Initialize Lagrangian postprocessing.
Definition: cs_lagr_post.cpp:347
cs_lagr_post_get_attr
bool cs_lagr_post_get_attr(cs_lagr_attribute_t attr_id)
Activate or deactive postprocessing for a given particle attribute.
Definition: cs_lagr_post.cpp:366