cs_equation_system.h

Go to the documentation of this file.

#ifndef __CS_EQUATION_SYSTEM_H__
#define __CS_EQUATION_SYSTEM_H__
 
/*============================================================================
 * Functions to handle a set of coupled equations hinging on the cs_equation_t
 * structure
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2024 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 "cs_equation.h"
#include "cs_equation_priv.h"
#include "cs_equation_system_param.h"
#include "cs_param_types.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void *
(cs_equation_system_define_t)(int                                 n_eqs,
                              const cs_equation_system_param_t   *sysp,
                              cs_equation_core_t                **core_array,
                              cs_cdo_system_helper_t            **p_sh);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void *
(cs_equation_system_free_t)(int                      n_eqs,
                            cs_equation_core_t     **core_array,
                            void                    *sys_context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_equation_system_solve_t)(bool                         c2p,
                             const cs_time_step_t        *time_step,
                             int                          n_eqs,
                             cs_equation_system_param_t  *sysp,
                             cs_equation_core_t         **blocks,
                             void                        *sys_context,
                             cs_cdo_system_helper_t      *sh);
 
 
typedef struct {
 
  cs_equation_system_param_t   *param;
 
  cs_timer_counter_t            timer;     
  int                           timer_id;  
  cs_cdo_system_helper_t       *system_helper;
 
  void                         *context;
 
  int                           n_equations;
  cs_equation_t               **equations;
 
  cs_equation_core_t          **block_factories;
 
  cs_equation_system_define_t     *define;
  cs_equation_system_free_t       *free;
 
  cs_equation_system_solve_t      *solve_system;
  cs_equation_system_solve_t      *solve_steady_state_system;
 
} cs_equation_system_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_equation_system_get_n_systems(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_system_t *
cs_equation_system_by_id(int         sys_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_system_param_t *
cs_equation_system_param_by_id(int         sys_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_system_t *
cs_equation_system_add(const char             *sysname,
                       int                     n_eqs,
                       int                     block_var_dim);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_destroy_all(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_log_monitoring(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_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_equation_system_set_functions(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_set_sles(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_define(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_solve(const cs_time_step_t *time_step,
                         bool                  cur2prev,
                         cs_equation_system_t *eqsys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_assign_equation(int                       row_id,
                                   cs_equation_t            *eq,
                                   cs_equation_system_t     *eqsys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_assign_param(int                       row_id,
                                int                       col_id,
                                cs_equation_param_t      *eqp,
                                cs_equation_system_t     *eqsys);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_EQUATION_SYSTEM_H__ */