9.2
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-2026 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 "base/cs_defs.h"
39
40/*=============================================================================
41 * Type definitions
42 *============================================================================*/
43
44typedef struct {
45
63 int method;
64
66
67/*=============================================================================
68 * Static global variables
69 *============================================================================*/
70
71/* Pointer to main time step structure */
72
74
75/*=============================================================================
76 * Public function prototypes
77 *============================================================================*/
78
79/*----------------------------------------------------------------------------*/
80/*
81 * \brief Compute distance to wall by solving a 3d diffusion equation.
82 *
83 * \param[in] iterns iteration number on Navier-Stokes equations
84 */
85/*----------------------------------------------------------------------------*/
86
87void
88cs_wall_distance(int iterns);
89
90/*----------------------------------------------------------------------------*/
91/*
92 * \param[in] visvdr dynamic viscosity in edge cells after
93 * driest velocity amortization
94 */
95/*----------------------------------------------------------------------------*/
96
97void
99
100/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107void
109
110/*----------------------------------------------------------------------------*/
116/*----------------------------------------------------------------------------*/
117
120
121/*----------------------------------------------------------------------------*/
122
123#endif /* CS_WALL_DISTANCE_H */
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
void cs_wall_distance(int iterns)
Compute distance to wall by solving a 3d diffusion equation. Solve.
Definition: cs_wall_distance.cpp:136
const cs_wall_distance_options_t * cs_glob_wall_distance_options
Definition: cs_wall_distance.cpp:103
void cs_wall_distance_geometric(void)
Compute distance to wall by a brute force geometric approach (serial only)
Definition: cs_wall_distance.cpp:1072
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:645
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:1146
Definition: cs_wall_distance.h:44
int need_compute
Definition: cs_wall_distance.h:46
int is_up_to_date
Definition: cs_wall_distance.h:48
int method
Definition: cs_wall_distance.h:63