9.2
general documentation
cs_mesh_deform.h
Go to the documentation of this file.
1#ifndef CS_MESH_DEFORM_H
2#define CS_MESH_DEFORM_H
3
4/*============================================================================
5 * Mesh deformation.
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#include "base/cs_defs.h"
31
32/*----------------------------------------------------------------------------
33 * Standard C library headers
34 *----------------------------------------------------------------------------*/
35
36/*----------------------------------------------------------------------------
37 * Local headers
38 *----------------------------------------------------------------------------*/
39
40#include "cdo/cs_domain.h"
41#include "mesh/cs_mesh.h"
42
43/*=============================================================================
44 * Macro definitions
45 *============================================================================*/
46
47/*============================================================================
48 * Type definitions
49 *============================================================================*/
50
51/*============================================================================
52 * Public function prototypes
53 *============================================================================*/
54
55/*----------------------------------------------------------------------------*/
61/*----------------------------------------------------------------------------*/
62
63bool
64cs_mesh_deform_is_activated(void);
65
66/*----------------------------------------------------------------------------*/
70/*----------------------------------------------------------------------------*/
71
72void
73cs_mesh_deform_activate(void);
74
75/*----------------------------------------------------------------------------*/
87/*----------------------------------------------------------------------------*/
88
89void
90cs_mesh_deform_define_dirichlet_bc_zones(cs_lnum_t n_boundary_zones,
91 const int boundary_zone_ids[]);
92
93/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
102cs_mesh_deform_setup(cs_domain_t *domain);
103
104/*----------------------------------------------------------------------------*/
123/*----------------------------------------------------------------------------*/
124
125void
126cs_mesh_deform_prescribe_displacement(cs_lnum_t n_vertices,
127 const cs_lnum_t vertex_ids[],
128 const cs_real_3_t displacement[]);
129
130/*----------------------------------------------------------------------------*/
149/*----------------------------------------------------------------------------*/
150
151void
152cs_mesh_deform_force_displacements(cs_lnum_t n_vertices,
153 const cs_lnum_t vertex_ids[],
154 const cs_real_3_t displacement[]);
155
156/*----------------------------------------------------------------------------*/
162/*----------------------------------------------------------------------------*/
163
164void
165cs_mesh_deform_solve_displacement(cs_domain_t *domain);
166
167/*----------------------------------------------------------------------------*/
173/*----------------------------------------------------------------------------*/
174
175const cs_real_3_t *
176cs_mesh_deform_get_displacement(void);
177
178/*----------------------------------------------------------------------------*/
182/*----------------------------------------------------------------------------*/
183
184void
185cs_mesh_deform_finalize(void);
186
187#endif /* CS_MESH_DEFORM_H */
cs_defs.h
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:349
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_domain.h
cs_mesh.h
cs_mesh_deform_force_displacements
void cs_mesh_deform_force_displacements(cs_lnum_t n_vertices, const cs_lnum_t vertex_ids[], const cs_real_3_t displacement[])
Define a fixed displacement vector for given vertices.
Definition: cs_mesh_deform.cpp:384
cs_mesh_deform_finalize
void cs_mesh_deform_finalize(void)
Free structures used fo mesh deformation.
Definition: cs_mesh_deform.cpp:483
cs_mesh_deform_is_activated
bool cs_mesh_deform_is_activated(void)
Test if mesh deformation is activated.
Definition: cs_mesh_deform.cpp:169
cs_mesh_deform_activate
void cs_mesh_deform_activate(void)
Activate the future mesh deformation.
Definition: cs_mesh_deform.cpp:184
cs_mesh_deform_solve_displacement
void cs_mesh_deform_solve_displacement(cs_domain_t *domain)
Compute displacement for mesh deformation.
Definition: cs_mesh_deform.cpp:430
cs_mesh_deform_get_displacement
const cs_real_3_t * cs_mesh_deform_get_displacement(void)
Return pointer to current mesh displacement vector.
Definition: cs_mesh_deform.cpp:471
cs_mesh_deform_setup
void cs_mesh_deform_setup(cs_domain_t *domain)
Setup the equations related to mesh deformation.
Definition: cs_mesh_deform.cpp:247
cs_mesh_deform_define_dirichlet_bc_zones
void cs_mesh_deform_define_dirichlet_bc_zones(cs_lnum_t n_boundary_zones, const int boundary_zone_ids[])
Define the boundary zones on which mesh deformation is prescribed.
Definition: cs_mesh_deform.cpp:228
cs_mesh_deform_prescribe_displacement
void cs_mesh_deform_prescribe_displacement(cs_lnum_t n_vertices, const cs_lnum_t vertex_ids[], const cs_real_3_t displacement[])
Prescribe the displacement vector for a set of vertices.
Definition: cs_mesh_deform.cpp:328
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:120