cs_macfb_navsto.h

Go to the documentation of this file.

#ifndef CS_MACFB_NAVSTO_H
#define CS_MACFB_NAVSTO_H
 
/*============================================================================
 * Functions shared for MAC face-based schemes for the discretization of the
 * Navier--Stokes system
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 EDF S.A.
 
  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
 
  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  details.
 
  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/*----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "alge/cs_matrix.h"
#include "base/cs_base.h"
#include "base/cs_field.h"
#include "base/cs_math.h"
#include "base/cs_time_plot.h"
#include "base/cs_time_step.h"
#include "cdo/cs_cdo_connect.h"
#include "cdo/cs_cdo_quantities.h"
#include "cdo/cs_cdofb_navsto.h"
#include "cdo/cs_iter_algo.h"
#include "cdo/cs_navsto_param.h"
#include "cdo/cs_sdm.h"
#include "mesh/cs_mesh.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef cs_cdofb_navsto_boussinesq_type_t cs_macfb_navsto_boussinesq_type_t;
 
typedef cs_cdofb_navsto_builder_t cs_macfb_navsto_builder_t;
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void(cs_macfb_navsto_source_t)(const cs_navsto_param_t         *nsp,
                                       const cs_cell_mesh_t            *cm,
                                       const cs_macfb_navsto_builder_t *nsb,
                                       cs_cell_sys_t                   *csys);
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_macfb_navsto_set_boussinesq_algo(cs_macfb_navsto_boussinesq_type_t type);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_macfb_navsto_builder_t
cs_macfb_navsto_create_builder(const cs_navsto_param_t *nsp,
                               const cs_cdo_connect_t  *connect);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_free_builder(cs_macfb_navsto_builder_t *nsb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_define_builder(cs_real_t                  t_eval,
                                    const cs_navsto_param_t   *nsp,
                                    const cs_cell_mesh_t      *cm,
                                    const cs_macfb_builder_t  *macb,
                                    const cs_cell_sys_t       *csys,
                                    const cs_cdo_bc_face_t    *pr_bc,
                                    const cs_boundary_type_t  *bf_type,
                                    cs_macfb_navsto_builder_t *nsb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_mass_flux(const cs_navsto_param_t   *nsp,
                               const cs_cdo_quantities_t *quant,
                               const cs_real_t           *face_vel,
                               cs_real_t                 *mass_flux);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
double cs_macfb_navsto_cell_divergence(const cs_lnum_t            c_id,
                                       const cs_cdo_quantities_t *quant,
                                       const cs_adjacency_t      *c2f,
                                       const cs_real_t           *f_vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_compute_face_pressure(const cs_mesh_t           *mesh,
                                           const cs_cdo_connect_t    *connect,
                                           const cs_cdo_quantities_t *quant,
                                           const cs_time_step_t      *ts,
                                           const cs_navsto_param_t   *nsp,
                                           const cs_real_t           *p_cell,
                                           cs_real_t                 *p_face);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_compute_cell_velocity(const cs_cdo_connect_t    *connect,
                                           const cs_cdo_quantities_t *quant,
                                           const cs_real_t           *mass_flux,
                                           cs_real_t                 *u_cell);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_add_grad_div(short int       n_fc,
                                  const cs_real_t zeta,
                                  const cs_real_t div[],
                                  cs_sdm_t       *mat);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_init_pressure(const cs_navsto_param_t   *nsp,
                                   const cs_cdo_quantities_t *quant,
                                   const cs_time_step_t      *ts,
                                   cs_field_t                *pr);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_init_face_pressure(const cs_navsto_param_t *nsp,
                                        const cs_cdo_connect_t  *connect,
                                        const cs_time_step_t    *ts,
                                        cs_real_t               *pr_f);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_rescale_pressure_to_ref(const cs_navsto_param_t   *nsp,
                                             const cs_cdo_quantities_t *quant,
                                             cs_real_t values[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_set_zero_mean_pressure(const cs_cdo_quantities_t *quant,
                                            cs_real_t values[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_extra_op(const cs_navsto_param_t   *nsp,
                              const cs_mesh_t           *mesh,
                              const cs_cdo_quantities_t *quant,
                              const cs_cdo_connect_t    *connect,
                              const cs_time_step_t      *ts,
                              cs_time_plot_t            *time_plotter,
                              const cs_adv_field_t      *adv_field,
                              const cs_real_t           *mass_flux,
                              const cs_real_t           *p_cell,
                              const cs_real_t           *u_face);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_block_dirichlet_alge(short int                  f,
                                   const cs_equation_param_t *eqp,
                                   const cs_cell_mesh_t      *cm,
                                   const cs_property_data_t  *pty,
                                   cs_cell_builder_t         *cb,
                                   cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_block_dirichlet_pena(short int                  f,
                                   const cs_equation_param_t *eqp,
                                   const cs_cell_mesh_t      *cm,
                                   const cs_property_data_t  *pty,
                                   cs_cell_builder_t         *cb,
                                   cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_block_dirichlet_weak(short int                  fb,
                                   const cs_equation_param_t *eqp,
                                   const cs_cell_mesh_t      *cm,
                                   const cs_property_data_t  *pty,
                                   cs_cell_builder_t         *cb,
                                   cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_block_dirichlet_wsym(short int                  fb,
                                   const cs_equation_param_t *eqp,
                                   const cs_cell_mesh_t      *cm,
                                   const cs_property_data_t  *pty,
                                   cs_cell_builder_t         *cb,
                                   cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_symmetry(short int                  fb,
                       const cs_equation_param_t *eqp,
                       const cs_cell_mesh_t      *cm,
                       const cs_property_data_t  *pty,
                       cs_cell_builder_t         *cb,
                       cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_fixed_wall(short int                  fb,
                         const cs_equation_param_t *eqp,
                         const cs_cell_mesh_t      *cm,
                         const cs_property_data_t  *pty,
                         cs_cell_builder_t         *cb,
                         cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_sles_convergence_state_t
cs_macfb_navsto_nl_algo_cvg(const cs_navsto_param_t *nsp,
                            const cs_real_t         *pre_iterate,
                            cs_real_t               *cur_iterate,
                            cs_iter_algo_t          *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_set_gravity_func(const cs_navsto_param_t   *nsp,
                                      cs_macfb_navsto_source_t **p_func);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_gravity_term(const cs_navsto_param_t         *nsp,
                                  const cs_cell_mesh_t            *cm,
                                  const cs_macfb_navsto_builder_t *nsb,
                                  cs_cell_sys_t                   *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_boussinesq_at_cell(const cs_navsto_param_t         *nsp,
                                        const cs_cell_mesh_t            *cm,
                                        const cs_macfb_navsto_builder_t *nsb,
                                        cs_cell_sys_t                   *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_boussinesq_at_face(const cs_navsto_param_t         *nsp,
                                        const cs_cell_mesh_t            *cm,
                                        const cs_macfb_navsto_builder_t *nsb,
                                        cs_cell_sys_t                   *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_boussinesq_by_part(const cs_navsto_param_t         *nsp,
                                        const cs_cell_mesh_t            *cm,
                                        const cs_macfb_navsto_builder_t *nsb,
                                        cs_cell_sys_t                   *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_navsto_stream_source_term(cs_lnum_t        n_elts,
                                        const cs_lnum_t *elt_ids,
                                        bool             dense_output,
                                        void            *input,
                                        cs_real_t       *retval);
 
#endif /* CS_MACFB_NAVSTO_H */