9.2
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-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 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "base/cs_base.h"
35#include "cdo/cs_domain.h"
36#include "mesh/cs_mesh.h"
37#include "mesh/cs_mesh_quantities.h"
38
39/*============================================================================
40 * Macro definitions
41 *============================================================================*/
42
43/*============================================================================
44 * Type definitions
45 *============================================================================*/
46
47/*============================================================================
48 * Public function prototypes
49 *============================================================================*/
50
51/*----------------------------------------------------------------------------*/
55/*----------------------------------------------------------------------------*/
56
57void
58cs_cdo_solve_steady_state_domain(void);
59
60/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66void
67cs_cdo_solve_unsteady_state_domain(void);
68
69/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_cdo_initialize_setup(cs_domain_t *domain);
83
84/*----------------------------------------------------------------------------*/
95/*----------------------------------------------------------------------------*/
96
97void
98cs_cdo_initialize_structures(cs_domain_t *domain,
99 cs_mesh_t *m,
100 cs_mesh_quantities_t *mq);
101
102/*----------------------------------------------------------------------------*/
109/*----------------------------------------------------------------------------*/
110
111void
112cs_cdo_finalize(cs_domain_t *domain);
113
114/*----------------------------------------------------------------------------*/
123/*----------------------------------------------------------------------------*/
124
125void
126cs_cdo_is_initialized(bool *setup,
127 bool *structures);
128
129/*----------------------------------------------------------------------------*/
135/*----------------------------------------------------------------------------*/
136
137void
138cs_cdo_main(cs_domain_t *domain);
139
140#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:731
cs_cdo_is_initialized
void cs_cdo_is_initialized(bool *setup, bool *structures)
Check if CDO has been initialized.
Definition: cs_cdo_main.cpp:1132
cs_cdo_solve_steady_state_domain
void cs_cdo_solve_steady_state_domain(void)
Solve only steady-state equations.
Definition: cs_cdo_main.cpp:719
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:1151
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:783
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:1014
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:850
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:120
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:88
cs_mesh_t
Definition: cs_mesh.h:85