8.3
general documentation
cs_wall_distance.h
Go to the documentation of this file.
1#ifndef __CS_WALL_DISTANCE_H__
2#define __CS_WALL_DISTANCE_H__
3
4/*============================================================================
5 * Compute distance to wall.
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 * Standard C library headers
32 *----------------------------------------------------------------------------*/
33
34/*----------------------------------------------------------------------------
35 * Local headers
36 *----------------------------------------------------------------------------*/
37
38#include "cs_defs.h"
39
40/*----------------------------------------------------------------------------*/
41
43
44/*=============================================================================
45 * Type definitions
46 *============================================================================*/
47
48typedef struct {
49
67 int method;
68
70
71/*=============================================================================
72 * Static global variables
73 *============================================================================*/
74
75/* Pointer to main time step structure */
76
78
79/*=============================================================================
80 * Public function prototypes
81 *============================================================================*/
82
83/*----------------------------------------------------------------------------*/
84/*
85 * \brief Compute distance to wall by solving a 3d diffusion equation.
86 *
87 * \param[in] iterns iteration number on Navier-Stokes equations
88 */
89/*----------------------------------------------------------------------------*/
90
91void
92cs_wall_distance(int iterns);
93
94/*----------------------------------------------------------------------------*/
95/*
96 * \param[in] visvdr dynamic viscosity in edge cells after
97 * driest velocity amortization
98 */
99/*----------------------------------------------------------------------------*/
100
101void
103
104/*----------------------------------------------------------------------------*/
109/*----------------------------------------------------------------------------*/
110
111void
113
114/*----------------------------------------------------------------------------*/
120/*----------------------------------------------------------------------------*/
121
124
125/*----------------------------------------------------------------------------*/
126
128
129#endif /* __CS_WALL_DISTANCE_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
#define END_C_DECLS
Definition: cs_defs.h:543
void cs_wall_distance(int iterns)
Compute distance to wall by solving a 3d diffusion equation. Solve.
Definition: cs_wall_distance.cpp:137
const cs_wall_distance_options_t * cs_glob_wall_distance_options
Definition: cs_wall_distance.cpp:104
void cs_wall_distance_geometric(void)
Compute distance to wall by a brute force geometric approach (serial only)
Definition: cs_wall_distance.cpp:1068
void cs_wall_distance_yplus(cs_real_t visvdr[])
Compute the dimensionless distance to the wall solving a steady transport equation.
Definition: cs_wall_distance.cpp:625
cs_wall_distance_options_t * cs_get_glob_wall_distance_options(void)
Provide read/write access to cs_glob_wall_distance.
Definition: cs_wall_distance.cpp:1142
Definition: cs_wall_distance.h:48
int need_compute
Definition: cs_wall_distance.h:50
int is_up_to_date
Definition: cs_wall_distance.h:52
int method
Definition: cs_wall_distance.h:67