8.3
general documentation
cs_mesh_warping.h
Go to the documentation of this file.
1#ifndef __CS_MESH_WARPING_H__
2#define __CS_MESH_WARPING_H__
3
4/*============================================================================
5 * Cut warped faces in serial or parallel with/without periodicity.
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_mesh.h"
36
37/*----------------------------------------------------------------------------*/
38
40
41/*============================================================================
42 * Macro definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Type definitions
47 *============================================================================*/
48
49/*=============================================================================
50 * Public function prototypes
51 *============================================================================*/
52
53/*----------------------------------------------------------------------------
54 * Cut warped faces.
55 *
56 * Updates border face connectivity and associated mesh quantities.
57 *
58 * parameters:
59 * mesh <-> pointer to mesh structure.
60 * max_warp_angle <-- criterion to know which face to cut
61 * post_flag <-- 1 if we have to post-process cut faces, 0 otherwise
62 *----------------------------------------------------------------------------*/
63
64void
66 double max_warp_angle,
67 bool post_flag);
68
69/*----------------------------------------------------------------------------
70 * Set defaults for cutting of warped faces.
71 *
72 * parameters:
73 * max_warp_angle <-- maximum warp angle (in degrees) over which faces will
74 * be cut; negative (-1) if faces should not be cut
75 * postprocess <-- 1 if postprocessing should be activated when cutting
76 * warped faces, 0 otherwise
77 *----------------------------------------------------------------------------*/
78
79void
80cs_mesh_warping_set_defaults(double max_warp_angle,
81 int postprocess);
82
83/*----------------------------------------------------------------------------
84 * Get defaults for cutting of warped faces.
85 *
86 * parameters:
87 * max_warp_angle --> if non-null, returns maximum warp angle (in degrees)
88 * over which faces will be cut, or -1 if faces should
89 * not be cut
90 * postprocess --> if non-null, returns 1 if postprocessing should be
91 * activated when cutting warped faces, 0 otherwise
92 *----------------------------------------------------------------------------*/
93
94void
95cs_mesh_warping_get_defaults(double *max_warp_angle,
96 int *postprocess);
97
98/*----------------------------------------------------------------------------*/
99
101
102#endif /* __CS_MESH_WARPING_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
#define END_C_DECLS
Definition: cs_defs.h:543
void cs_mesh_warping_cut_faces(cs_mesh_t *mesh, double max_warp_angle, bool post_flag)
Cut warped boundary faces.
Definition: cs_mesh_warping.cpp:542
void cs_mesh_warping_get_defaults(double *max_warp_angle, int *postprocess)
Definition: cs_mesh_warping.cpp:702
void cs_mesh_warping_set_defaults(double max_warp_angle, int postprocess)
Definition: cs_mesh_warping.cpp:678
Definition: mesh.f90:26
Definition: cs_mesh.h:85