cs_navsto_system.h

Go to the documentation of this file.

#ifndef CS_NAVSTO_SYSTEM_H
#define CS_NAVSTO_SYSTEM_H
 
/*============================================================================
 * Functions to handle cs_navsto_system_t structure
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_field.h"
#include "base/cs_param_types.h"
#include "base/cs_time_plot.h"
#include "base/cs_time_step.h"
#include "cdo/cs_advection_field.h"
#include "cdo/cs_cdo_turbulence.h"
#include "cdo/cs_equation.h"
#include "cdo/cs_maxwell.h"
#include "cdo/cs_navsto_context.h"
#include "cdo/cs_navsto_param.h"
#include "cdo/cs_property.h"
#include "cdo/cs_thermal_system.h"
#include "cdo/cs_xdef.h"
#include "mesh/cs_mesh.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Function pointer definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef cs::cdo_navsto_ctx_t *(
  cs_navsto_init_scheme_context_t)(const cs_navsto_param_t *nsp,
                                   cs_adv_field_t          *adv_field,
                                   cs_real_t               *mflux,
                                   cs_real_t               *mflux_pre,
                                   cs_boundary_type_t      *fb_type,
                                   void                    *nscc);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void *(cs_navsto_free_scheme_context_t)(cs::cdo_navsto_ctx_t *
                                                scheme_context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_navsto_init_values_t)(const cs_navsto_param_t     *nsp,
                          const cs_cdo_quantities_t   *quant,
                          const cs_time_step_t        *ts,
                          cs_field_t                  *field);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void(cs_navsto_compute_t)(const cs_mesh_t         *mesh,
                                  const cs_navsto_param_t *nsp,
                                  cs::cdo_navsto_ctx_t    *sc);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void(cs_navsto_check_init_t)(const cs_navsto_param_t   *nsp,
                                     const cs_cdo_connect_t    *connect,
                                     const cs_cdo_quantities_t *quant,
                                     const cs_time_step_t      *ts,
                                     const cs_field_t          *velocity,
                                     const cs_real_t           *face_vel,
                                     const cs_field_t          *pressure);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void(cs_navsto_check_convergence_t)(
  const cs_navsto_param_t     *nsp,
  const cs_cdo_quantities_t   *quant,
  const cs_time_step_t        *ts,
  const cs::cdo_navsto_ctx_t  *sc,
  const cs_turbulence_t       *tbs,
  cs_cdo_navsto_psteady_cvg_t &ps_cvg);
 
/*=============================================================================
 * Structure definitions
 *============================================================================*/
 
typedef struct {
 
  cs_navsto_param_t          *param;
 
  cs_adv_field_t             *adv_field;
 
  cs_real_t                  *mass_flux_array;
 
  cs_real_t                  *mass_flux_array_pre;
 
  cs_boundary_type_t         *bf_type;
 
  cs_field_t                 *velocity;
 
  cs_field_t                 *pressure;
 
  cs_turbulence_t            *turbulence;
 
  cs_time_plot_t             *plot_writer;
 
  cs_field_t                 *velocity_divergence;
 
  cs_field_t                 *pressure_gradient;
 
  cs_field_t                 *kinetic_energy;
 
  cs_field_t                 *mass_density;
 
  cs_field_t                 *mass_flux_balance;
 
  cs_field_t                 *vorticity;
 
  cs_field_t                 *helicity;
 
  cs_field_t                 *enstrophy;
 
  cs_field_t                 *velocity_gradient;
 
  cs_field_t *boundary_stress;
 
  cs_equation_t              *stream_function_eq;
 
  void                       *coupling_context;
 
  cs::cdo_navsto_ctx_t *scheme_context;
 
  cs_cdo_navsto_psteady_cvg_t psteady_cvg;
 
  cs_navsto_init_scheme_context_t   *init_scheme_context;
 
  cs_navsto_free_scheme_context_t   *free_scheme_context;
 
  cs_navsto_init_values_t           *init_velocity;
 
  cs_navsto_init_values_t           *init_pressure;
 
  cs_navsto_check_init_t *check_init;
 
  cs_navsto_compute_t               *compute_steady;
 
  cs_navsto_compute_t               *compute;
 
  cs_navsto_check_convergence_t *check_convergence;
 
} cs_navsto_system_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_navsto_system_is_activated(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_update_model(bool   with_thermal);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_navsto_system_t *
cs_navsto_system_activate(const cs_boundary_t          *boundaries,
                          cs_navsto_param_model_t       model,
                          cs_navsto_param_model_flag_t  model_flag,
                          cs_navsto_param_coupling_t    algo_coupling,
                          cs_navsto_param_post_flag_t   post_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_navsto_system_t *
cs_navsto_system_activate(const cs_boundary_t       *boundaries,
                          cs_navsto_param_model_t    model,
                          cs_navsto_param_coupling_t algo_coupling);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_destroy(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_navsto_param_t *
cs_navsto_system_get_param(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_t *
cs_navsto_system_get_momentum_eq(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_adv_field_t *
cs_navsto_get_adv_field(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t *
cs_navsto_get_mass_flux(bool   previous);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_init_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_finalize_setup(const cs_mesh_t            *mesh,
                                const cs_cdo_connect_t     *connect,
                                const cs_cdo_quantities_t  *quant,
                                const cs_time_step_t       *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_define_context(const cs_mesh_t             *mesh);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_init_values(const cs_mesh_t             *mesh,
                             const cs_cdo_connect_t      *connect,
                             const cs_cdo_quantities_t   *quant,
                             const cs_time_step_t        *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_set_solid_cells(cs_lnum_t          n_solid_cells,
                                 cs_lnum_t          solid_cell_ids[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_update(const cs_mesh_t             *mesh,
                        const cs_cdo_connect_t      *connect,
                        const cs_cdo_quantities_t   *quant,
                        const cs_time_step_t        *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_compute_steady_state(const cs_mesh_t             *mesh,
                                      const cs_cdo_connect_t      *connect,
                                      const cs_cdo_quantities_t   *quant,
                                      const cs_time_step_t        *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_compute(const cs_mesh_t           *mesh,
                         const cs_cdo_connect_t    *connect,
                         const cs_cdo_quantities_t *quant,
                         const cs_time_step_t      *time_step,
                         bool                      &is_last_iter);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_extra_op(const cs_mesh_t             *mesh,
                          const cs_cdo_connect_t      *connect,
                          const cs_cdo_quantities_t   *quant,
                          const cs_time_step_t        *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_extra_post(void                      *input,
                            int                        mesh_id,
                            int                        cat_id,
                            int                        ent_flag[5],
                            cs_lnum_t                  n_cells,
                            cs_lnum_t                  n_i_faces,
                            cs_lnum_t                  n_b_faces,
                            const cs_lnum_t            cell_ids[],
                            const cs_lnum_t            i_face_ids[],
                            const cs_lnum_t            b_face_ids[],
                            const cs_time_step_t      *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_set_post_flag(cs_navsto_param_post_flag_t post_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_set_model_flag(cs_navsto_param_model_flag_t model_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_set_num_flag(cs_navsto_param_num_flag_t num_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_navsto_system_log_setup(void);
 
#endif /* CS_NAVSTO_SYSTEM_H */