programmer's documentation
cs_cdovb_priv.h
Go to the documentation of this file.
1 #ifndef __CS_CDOVB_PRIV_H__
2 #define __CS_CDOVB_PRIV_H__
3 
4 /*============================================================================
5  * Definition of cs_cdovb_scaleq_t and cs_cdovb_vecteq structures
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_defs.h"
33 #include "cs_hodge.h"
34 #include "cs_cdo_diffusion.h"
35 #include "cs_cdo_advection.h"
36 #include "cs_cdo_time.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
49 /*============================================================================
50  * Macro definitions
51  *============================================================================*/
52 
53 /*============================================================================
54  * Type definitions
55  *============================================================================*/
56 
57 /*=============================================================================
58  * Structure definitions
59  *============================================================================*/
60 
61 /* Algebraic system for CDO vertex-based discretization */
62 
63 struct _cs_cdovb_t {
64 
65  /* Ids related to the variable field and to the boundary flux field */
68 
69  /* System size */
71 
72  /* Array storing the value arising from the contribution of all source
73  terms */
75 
76  /* Array for extra-operations */
77  cs_real_t *cell_values; /* NULL if not requested */
78 
79  /* Pointer of function to build the diffusion term */
83 
84  /* Pointer of function to build the advection term */
87 
88  /* Pointer of function to apply the time scheme */
90 
91  /* If one needs to build a local hodge op. for time and reaction */
94 
95 };
96 
97 /*============================================================================
98  * Public function prototypes
99  *============================================================================*/
100 
101 /*----------------------------------------------------------------------------*/
102 
104 
105 #endif /* __CS_CDOVB_PRIV_H__ */
cs_cdo_time_scheme_t * apply_time_scheme
Definition: cs_cdovb_priv.h:89
void() cs_cdo_advection_bc_t(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Compute the BC contribution for the advection operator.
Definition: cs_cdo_advection.h:121
cs_cdo_advection_t * get_advection_matrix
Definition: cs_cdovb_priv.h:85
Definition: cs_cdovb_priv.h:63
cs_cdo_diffusion_enforce_dir_t * enforce_dirichlet
Definition: cs_cdovb_priv.h:81
cs_hodge_t * get_mass_matrix
Definition: cs_cdovb_priv.h:93
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
int var_field_id
Definition: cs_cdovb_priv.h:66
cs_param_hodge_t hdg_mass
Definition: cs_cdovb_priv.h:92
cs_cdo_advection_bc_t * add_advection_bc
Definition: cs_cdovb_priv.h:86
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_flag_t * vtx_bc_flag
Definition: cs_cdovb_priv.h:82
cs_lnum_t n_dofs
Definition: cs_cdovb_priv.h:70
int bflux_field_id
Definition: cs_cdovb_priv.h:67
cs_real_t * source_terms
Definition: cs_cdovb_priv.h:74
void() cs_cdo_diffusion_enforce_dir_t(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Enforce the Dirichlet BCs when a diffusion term is present. This routine define an operator which rec...
Definition: cs_cdo_diffusion.h:85
cs_hodge_t * get_stiffness_matrix
Definition: cs_cdovb_priv.h:80
cs_real_t * cell_values
Definition: cs_cdovb_priv.h:77
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
void() cs_hodge_t(const cs_param_hodge_t h_info, const cs_cell_mesh_t *cm, cs_cell_builder_t *cb)
Build a local operator for a given cell (stored in cb->hdg for a discrete Hodge operator or in cb->lo...
Definition: cs_hodge.h:63
void() cs_cdo_advection_t(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme. The local matrix related to this operator is stored in cb->loc.
Definition: cs_cdo_advection.h:101
#define END_C_DECLS
Definition: cs_defs.h:463
unsigned short int cs_flag_t
Definition: cs_defs.h:299
Definition: cs_param_cdo.h:105
void() cs_cdo_time_scheme_t(const cs_equation_param_t *eqp, const double tpty_val, const cs_sdm_t *mass_mat, const cs_flag_t system_flag, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Apply the time discretization to a local system.
Definition: cs_cdo_time.h:65