cs_macfb_vecteq.h

Go to the documentation of this file.

#ifndef CS_MACFB_VECTEQ_H
#define CS_MACFB_VECTEQ_H
 
/*============================================================================
 * Build an algebraic MAC face-based system for unsteady convection/diffusion
 * reaction of vector-valued equations with source terms
 *============================================================================*/
 
/*
  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 "alge/cs_sles.h"
#include "base/cs_base.h"
#include "base/cs_field.h"
#include "base/cs_restart.h"
#include "base/cs_time_step.h"
#include "cdo/cs_cdo_assembly.h"
#include "cdo/cs_cdo_connect.h"
#include "cdo/cs_cdo_quantities.h"
#include "cdo/cs_equation_builder.h"
#include "cdo/cs_equation_param.h"
#include "cdo/cs_macfb_priv.h"
#include "cdo/cs_source_term.h"
#include "mesh/cs_mesh.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/* Algebraic system for MAC face-based discretization */
 
typedef struct _cs_macfb_t cs_macfb_vecteq_t;
 
/*============================================================================
 * Static inline public function prototypes
 *============================================================================*/
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool cs_macfb_vecteq_is_initialized(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_init_sharing(const cs_cdo_quantities_t *quant,
                                  const cs_cdo_connect_t    *connect,
                                  const cs_time_step_t      *time_step);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_finalize_sharing(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void *cs_macfb_vecteq_init_context(cs_equation_param_t   *eqp,
                                   int                    var_id,
                                   int                    bflux_id,
                                   cs_equation_builder_t *eqb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void *cs_macfb_vecteq_free_context(void *data);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_init_values(cs_real_t                  t_eval,
                                 const int                  field_id,
                                 const cs_mesh_t           *mesh,
                                 const cs_equation_param_t *eqp,
                                 cs_equation_builder_t     *eqb,
                                 void                      *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_init_cell_system(const cs_cell_mesh_t        *cm,
                                      const cs_equation_param_t   *eqp,
                                      const cs_equation_builder_t *eqb,
                                      const cs_real_t              val_f_n[],
                                      const cs_real_t              val_f_nm1[],
                                      cs_macfb_builder_t          *macb,
                                      cs_cell_sys_t               *csys,
                                      cs_cell_builder_t           *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_setup(cs_real_t                  t_eval,
                           const cs_mesh_t           *mesh,
                           const cs_equation_param_t *eqp,
                           cs_equation_builder_t     *eqb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_init_build(const cs_cdo_connect_t      *connect,
                                const cs_cdo_quantities_t   *quant,
                                const cs_equation_param_t   *eqp,
                                const cs_equation_builder_t *eqb,
                                const cs_lnum_t              c_id,
                                const cs_real_t              vel_f_n[],
                                cs_cell_mesh_t              *cm,
                                cs_macfb_builder_t          *macb,
                                cs_cell_sys_t               *csys,
                                cs_cell_builder_t           *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_sourceterm(const cs_cell_mesh_t      *cm,
                                const cs_equation_param_t *eqp,
                                cs_macfb_builder_t        *macb,
                                const cs_real_t            t_eval,
                                const cs_real_t            coef,
                                cs_equation_builder_t     *eqb,
                                cs_cell_builder_t         *cb,
                                cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_euler_implicit_term(const cs_equation_param_t *eqp,
                                         const cs_cell_mesh_t      *cm,
                                         const cs_macfb_builder_t  *macb,
                                         const cs_cell_builder_t   *cb,
                                         const cs_real_t            dt,
                                         cs_cell_sys_t             *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_diffusion(const cs_equation_param_t *eqp,
                               const cs_cell_mesh_t      *cm,
                               const cs_macfb_builder_t  *macb,
                               const cs_property_t       *diff_pty,
                               cs_cell_sys_t             *csys,
                               cs_cell_builder_t         *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_advection(const cs_equation_param_t *eqp,
                               const cs_macfb_vecteq_t   *eqc,
                               const cs_cell_mesh_t      *cm,
                               const cs_macfb_builder_t  *macb,
                               cs_cell_sys_t             *csys,
                               cs_cell_builder_t         *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_conv_diff_reac(const cs_equation_param_t   *eqp,
                                    const cs_equation_builder_t *eqb,
                                    const cs_macfb_vecteq_t     *eqc,
                                    const cs_cell_mesh_t        *cm,
                                    const cs_macfb_builder_t    *macb,
                                    const cs_property_data_t    *diff_pty,
                                    cs_cell_sys_t               *csys,
                                    cs_cell_builder_t           *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_assembly(const cs_cell_sys_t   *csys,
                              cs_cdo_system_block_t *block,
                              cs_real_t             *rhs,
                              cs_cdo_assembly_t     *asb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_update_fields(cs_timer_counter_t *tce,
                                   cs_field_t         *fld,
                                   bool                cur2prev);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_solve_steady_implicit(bool                       cur2prev,
                                           const cs_mesh_t           *mesh,
                                           const int                  field_id,
                                           const cs_equation_param_t *eqp,
                                           cs_equation_builder_t     *eqb,
                                           void                      *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_solve_theta(bool                       cur2prev,
                                 const cs_mesh_t           *mesh,
                                 const int                  field_id,
                                 const cs_equation_param_t *eqp,
                                 cs_equation_builder_t     *eqb,
                                 void                      *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_current_to_previous(const cs_equation_param_t *eqp,
                                         cs_equation_builder_t     *eqb,
                                         void                      *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_extra_post(const cs_equation_param_t *eqp,
                                cs_equation_builder_t     *eqb,
                                void                      *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t *cs_macfb_vecteq_get_cell_values(void *context, bool previous);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t *cs_macfb_vecteq_get_face_values(void *context, bool previous);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_read_restart(cs_restart_t *restart,
                                  const char   *eqname,
                                  void         *scheme_context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void cs_macfb_vecteq_write_restart(cs_restart_t *restart,
                                   const char   *eqname,
                                   void         *scheme_context);
 
#endif /* CS_MACFB_VECTEQ_H */