8.3
general documentation
cs_cdo_main.h
Go to the documentation of this file.
1#ifndef __CS_CDO_MAIN_H__
2#define __CS_CDO_MAIN_H__
3
4/*============================================================================
5 * Functions for solving equations with CDO discretizations
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_domain.h"
36#include "cs_mesh.h"
37#include "cs_mesh_quantities.h"
38
39/*----------------------------------------------------------------------------*/
40
41BEGIN_C_DECLS
42
43/*============================================================================
44 * Macro definitions
45 *============================================================================*/
46
47/*============================================================================
48 * Type definitions
49 *============================================================================*/
50
51/*============================================================================
52 * Public function prototypes
53 *============================================================================*/
54
55/*----------------------------------------------------------------------------*/
59/*----------------------------------------------------------------------------*/
60
61void
62cs_cdo_solve_steady_state_domain(void);
63
64/*----------------------------------------------------------------------------*/
68/*----------------------------------------------------------------------------*/
69
70void
71cs_cdo_solve_unsteady_state_domain(void);
72
73/*----------------------------------------------------------------------------*/
83/*----------------------------------------------------------------------------*/
84
85void
86cs_cdo_initialize_setup(cs_domain_t *domain);
87
88/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
102cs_cdo_initialize_structures(cs_domain_t *domain,
103 cs_mesh_t *m,
104 cs_mesh_quantities_t *mq);
105
106/*----------------------------------------------------------------------------*/
113/*----------------------------------------------------------------------------*/
114
115void
116cs_cdo_finalize(cs_domain_t *domain);
117
118/*----------------------------------------------------------------------------*/
127/*----------------------------------------------------------------------------*/
128
129void
130cs_cdo_is_initialized(bool *setup,
131 bool *structures);
132
133/*----------------------------------------------------------------------------*/
139/*----------------------------------------------------------------------------*/
140
141void
142cs_cdo_main(cs_domain_t *domain);
143
144/*----------------------------------------------------------------------------*/
145
146END_C_DECLS
147
148#endif /* __CS_CDO_MAIN_H__ */
cs_base.h
cs_cdo_solve_unsteady_state_domain
void cs_cdo_solve_unsteady_state_domain(void)
Solve all the equations of a computational domain for one time step.
Definition: cs_cdo_main.cpp:710
cs_cdo_is_initialized
void cs_cdo_is_initialized(bool *setup, bool *structures)
Check if CDO has been initialized.
Definition: cs_cdo_main.cpp:1071
cs_cdo_solve_steady_state_domain
void cs_cdo_solve_steady_state_domain(void)
Solve only steady-state equations.
Definition: cs_cdo_main.cpp:698
cs_cdo_main
void cs_cdo_main(cs_domain_t *domain)
Main program for running a simulation with the CDO kernel.
Definition: cs_cdo_main.cpp:1090
cs_cdo_initialize_setup
void cs_cdo_initialize_setup(cs_domain_t *domain)
Initialize the computational domain when CDO/HHO schemes are activated and cs_user_model() has been c...
Definition: cs_cdo_main.cpp:728
cs_cdo_finalize
void cs_cdo_finalize(cs_domain_t *domain)
Free all structures allocated during the resolution of CDO/HHO schemes.
Definition: cs_cdo_main.cpp:953
cs_cdo_initialize_structures
void cs_cdo_initialize_structures(cs_domain_t *domain, cs_mesh_t *m, cs_mesh_quantities_t *mq)
Build additional connectivities and quantities when CDO/HHO schemes are activated....
Definition: cs_cdo_main.cpp:795
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_domain.h
cs_mesh.h
cs_mesh_quantities.h
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:129
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:92
cs_mesh_t
Definition: cs_mesh.h:85