8.3
general documentation
cs_cf_energy.h
Go to the documentation of this file.
1#ifndef __CS_CF_ENERGY_H__
2#define __CS_CF_ENERGY_H__
3
4/*============================================================================
5 * Solve the convection/diffusion equation (with eventual source terms)
6 * for total energy over a time step.
7 *============================================================================*/
8
9/*
10 This file is part of code_saturne, a general-purpose CFD tool.
11
12 Copyright (C) 1998-2024 EDF S.A.
13
14 This program is free software; you can redistribute it and/or modify it under
15 the terms of the GNU General Public License as published by the Free Software
16 Foundation; either version 2 of the License, or (at your option) any later
17 version.
18
19 This program is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22 details.
23
24 You should have received a copy of the GNU General Public License along with
25 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26 Street, Fifth Floor, Boston, MA 02110-1301, USA.
27*/
28
29/*----------------------------------------------------------------------------*/
30
31/*----------------------------------------------------------------------------
32 * Standard C library headers
33 *----------------------------------------------------------------------------*/
34
35/*----------------------------------------------------------------------------
36 * Local headers
37 *----------------------------------------------------------------------------*/
38
39#include "cs_defs.h"
40
41/*----------------------------------------------------------------------------*/
42
43BEGIN_C_DECLS
44
45/*=============================================================================
46 * Public function prototypes
47 *============================================================================*/
48
49/*----------------------------------------------------------------------------*/
50/*
51 * \param[in] f_sc_id scalar field id
52 */
53/*----------------------------------------------------------------------------*/
54
55void
56cs_cf_energy(int f_sc_id);
57
58/*----------------------------------------------------------------------------*/
59
60END_C_DECLS
61
62#endif /* __CS_CF_ENERGY_H__ */
cs_cf_energy
void cs_cf_energy(int f_sc_id)
Perform the solving of the convection/diffusion equation (with eventual source terms) for total energ...
Definition: cs_cf_energy.cpp:307
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543