8.3
general documentation
cs_walldistance.h
Go to the documentation of this file.
1#ifndef __CS_WALLDISTANCE_H__
2#define __CS_WALLDISTANCE_H__
3
4/*============================================================================
5 * Compute the wall distance using the CDO framework
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/*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "cs_base.h"
35#include "cs_equation.h"
36
37/*----------------------------------------------------------------------------*/
38
39BEGIN_C_DECLS
40
41/*============================================================================
42 * Macro definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Type definitions
47 *============================================================================*/
48
49/*============================================================================
50 * Public function prototypes
51 *============================================================================*/
52
53/*----------------------------------------------------------------------------*/
57/*----------------------------------------------------------------------------*/
58
59bool
60cs_walldistance_is_activated(void);
61
62/*----------------------------------------------------------------------------*/
66/*----------------------------------------------------------------------------*/
67
68void
69cs_walldistance_activate(void);
70
71/*----------------------------------------------------------------------------*/
75/*----------------------------------------------------------------------------*/
76
77void
78cs_walldistance_setup(void);
79
80/*----------------------------------------------------------------------------*/
89/*----------------------------------------------------------------------------*/
90
91void
92cs_walldistance_compute(const cs_mesh_t *mesh,
93 const cs_time_step_t *time_step,
94 const cs_cdo_connect_t *connect,
95 const cs_cdo_quantities_t *cdoq);
96
97/*----------------------------------------------------------------------------*/
98
99END_C_DECLS
100
101#endif /* __CS_WALLDISTANCE_H__ */
cs_base.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_equation.h
cs_walldistance_is_activated
bool cs_walldistance_is_activated(void)
Test if the computation of the wall distance is activated.
Definition: cs_walldistance.cpp:410
cs_walldistance_compute
void cs_walldistance_compute(const cs_mesh_t *mesh, const cs_time_step_t *time_step, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq)
Compute the wall distance.
Definition: cs_walldistance.cpp:514
cs_walldistance_activate
void cs_walldistance_activate(void)
Activate the future computation of the wall distance.
Definition: cs_walldistance.cpp:425
cs_walldistance_setup
void cs_walldistance_setup(void)
Setup the equation related to the wall distance.
Definition: cs_walldistance.cpp:461
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:139
cs_mesh_t
Definition: cs_mesh.h:85
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64