cs_cdovb_scalsys.h

Go to the documentation of this file.

#ifndef __CS_CDOVB_SCALSYS_H__
#define __CS_CDOVB_SCALSYS_H__
 
/*============================================================================
 * Build an algebraic CDO vertex-based system of equations. These equations
 * corresponds to scalar-valued unsteady convection diffusion reaction
 * equations
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2025 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_base.h"
#include "cdo/cs_cdo_connect.h"
#include "cdo/cs_cdo_quantities.h"
#include "cdo/cs_equation.h"
#include "cdo/cs_equation_param.h"
#include "cdo/cs_equation_system_param.h"
#include "mesh/cs_mesh.h"
#include "base/cs_time_step.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef struct _cs_cdovb_scalsys_t  cs_cdovb_scalsys_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdovb_scalsys_init_sharing(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_cdovb_scalsys_define(int                                 n_eqs,
                        const cs_equation_system_param_t   *sysp,
                        cs_equation_core_t                **block_factories,
                        cs_cdo_system_helper_t            **p_sh);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void *
cs_cdovb_scalsys_free(int                     n_eqs,
                      cs_equation_core_t    **blocks,
                      void                   *sys_context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdovb_scalsys_solve_implicit(bool                         cur2prev,
                                const cs_time_step_t        *time_step,
                                int                          n_equations,
                                cs_equation_system_param_t  *sysp,
                                cs_equation_core_t         **blocks,
                                void                        *sys_context,
                                cs_cdo_system_helper_t      *sh);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdovb_scalsys_solve_implicit_incr(bool                         cur2prev,
                                     const cs_time_step_t        *time_step,
                                     int                          n_equations,
                                     cs_equation_system_param_t  *sysp,
                                     cs_equation_core_t         **blocks,
                                     void                        *sys_context,
                                     cs_cdo_system_helper_t      *sh);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_CDOVB_SCALSYS_H__ */