cs_equation_builder.h

Go to the documentation of this file.

#ifndef CS_EQUATION_BUILDER_H
#define CS_EQUATION_BUILDER_H
 
/*============================================================================
 * Functions to handle the equation builder 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 "alge/cs_matrix.h"
#include "cdo/cs_cdo_bc.h"
#include "cdo/cs_cdo_connect.h"
#include "cdo/cs_cdo_local.h"
#include "cdo/cs_cdo_quantities.h"
#include "cdo/cs_cdo_system.h"
#include "cdo/cs_enforcement.h"
#include "cdo/cs_equation_param.h"
#include "cdo/cs_flag.h"
#include "cdo/cs_source_term.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef struct _equation_builder_t  cs_equation_builder_t;
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_equation_build_hook_t)(const cs_equation_param_t     *eqp,
                           const cs_equation_builder_t   *eqb,
                           const void                    *eqc,
                           const cs_cell_mesh_t          *cm,
                           void                          *context,
                           cs_hodge_t                    *mass_hodge,
                           cs_hodge_t                    *diff_hodge,
                           cs_cell_sys_t                 *csys,
                           cs_cell_builder_t             *cb);
 
struct _equation_builder_t {
 
  bool         init_step;  
  cs_eflag_t   msh_flag;   
  cs_eflag_t   bdy_flag;   
  cs_eflag_t   src_flag;   
  cs_flag_t    sys_flag;   
  bool   diff_pty_uniform;      
  bool   curlcurl_pty_uniform;  
  bool   graddiv_pty_uniform;   
  bool   time_pty_uniform;      
  bool   reac_pty_uniform[CS_CDO_N_MAX_REACTIONS]; 
  cs_mask_t   *source_mask;  
  cs_source_term_cellwise_t  **compute_source;
 
  cs_cdo_system_helper_t     *system_helper;
 
  cs_real_t                  *enforced_values;
 
  cs_real_t              *increment;
  cs_iter_algo_t         *incremental_algo;
 
  cs_cdo_bc_face_t   *face_bc;  
  cs_real_t          *dir_values; 
  void                        *hook_context;
  cs_equation_build_hook_t    *hook_function;
 
  cs_timer_counter_t     tcb; 
  cs_timer_counter_t     tcs; 
  cs_timer_counter_t     tce; 
};
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/*============================================================================
 * Inline public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline cs_eflag_t
cs_equation_builder_cell_mesh_flag(cs_flag_t                      cell_flag,
                                   const cs_equation_builder_t   *eqb)
{
  if (cell_flag & CS_FLAG_BOUNDARY_CELL_BY_FACE)
    return eqb->msh_flag | eqb->src_flag | eqb->bdy_flag;
  else
    return eqb->msh_flag | eqb->src_flag;
}
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_update_default_flags(cs_eflag_t    msh_flag,
                                         cs_eflag_t    bdy_flag,
                                         cs_eflag_t    src_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_builder_t *
cs_equation_builder_create(const cs_equation_param_t   *eqp,
                           const cs_mesh_t             *mesh);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const cs_matrix_t *
cs_equation_builder_get_matrix(const cs_equation_builder_t  *builder,
                               int                           block_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const cs_range_set_t *
cs_equation_builder_get_range_set(const cs_equation_builder_t  *builder,
                                  int                           block_id);
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_free(cs_equation_builder_t  **p_builder);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_reset(cs_equation_builder_t  *eqb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_apply_default_flags(cs_equation_builder_t  *eqb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_log_performance(int                          n_time_steps,
                                    cs_gnum_t                    n_g_dofs,
                                    const cs_equation_param_t   *eqp,
                                    const cs_equation_builder_t *eqb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_equation_builder_set_reaction_pty_cw(const cs_equation_param_t     *eqp,
                                        const cs_equation_builder_t   *eqb,
                                        const cs_cell_mesh_t          *cm,
                                        cs_cell_builder_t             *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_init_properties(const cs_equation_param_t     *eqp,
                                    const cs_equation_builder_t   *eqb,
                                    cs_hodge_t                    *diff_hodge,
                                    cs_cell_builder_t             *cb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_enforce_dofs(const cs_equation_builder_t     *eqb,
                                 cs_cell_builder_t               *cb,
                                 cs_cell_sys_t                   *csys);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_builder_enforce_block_dofs(const cs_equation_builder_t   *eqb,
                                       cs_cell_builder_t             *cb,
                                       cs_cell_sys_t                 *csys);
 
#endif /* CS_EQUATION_BUILDER_H */