7.0
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-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 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 #include "cs_equation.h"
36 
37 /*----------------------------------------------------------------------------*/
38 
39 BEGIN_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 
59 bool
60 cs_walldistance_is_activated(void);
61 
62 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 void
69 cs_walldistance_activate(void);
70 
71 /*----------------------------------------------------------------------------*/
75 /*----------------------------------------------------------------------------*/
76 
77 void
78 cs_walldistance_setup(void);
79 
80 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 void
91 cs_walldistance_finalize_setup(const cs_cdo_connect_t *connect,
92  const cs_cdo_quantities_t *cdoq);
93 
94 /*----------------------------------------------------------------------------*/
103 /*----------------------------------------------------------------------------*/
104 
105 void
106 cs_walldistance_compute(const cs_mesh_t *mesh,
107  const cs_time_step_t *time_step,
108  const cs_cdo_connect_t *connect,
109  const cs_cdo_quantities_t *cdoq);
110 
111 /*----------------------------------------------------------------------------*/
112 
113 END_C_DECLS
114 
115 #endif /* __CS_WALLDISTANCE_H__ */
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
cs_cdo_connect_t
Definition: cs_cdo_connect.h:76
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:124
cs_mesh_t
Definition: cs_mesh.h:84
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.c:401
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.c:515
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:496
cs_walldistance_setup
void cs_walldistance_setup(void)
Setup the equation related to the wall distance.
Definition: cs_walldistance.c:449
cs_walldistance_activate
void cs_walldistance_activate(void)
Activate the future computation of the wall distance.
Definition: cs_walldistance.c:416
cs_walldistance_finalize_setup
void cs_walldistance_finalize_setup(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq)
Finalize the setup stage for the equation related to the wall distance. Only useful for Hamilton-Jaco...
Definition: cs_walldistance.c:494
mesh
Definition: mesh.f90:26