cs_equation_param.h

Go to the documentation of this file.

#ifndef __CS_EQUATION_PARAM_H__
#define __CS_EQUATION_PARAM_H__
 
/*============================================================================
 * Functions related to the structure cs_equation_param_t storing the settings
 * related to an equation.
 *============================================================================*/
 
/*
  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 "alge/cs_param_saddle.h"
#include "alge/cs_param_sles.h"
#include "cdo/cs_advection_field.h"
#include "cdo/cs_enforcement.h"
#include "cdo/cs_hodge.h"
#include "cdo/cs_iter_algo.h"
#include "cdo/cs_param_cdo.h"
#include "cdo/cs_property.h"
#include "cdo/cs_xdef.h"
#include "base/cs_time_control.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
#define CS_EQUATION_LOCKED         (1 <<  0)  /*    1 */
#define CS_EQUATION_UNSTEADY       (1 <<  1)  /*    2 */
#define CS_EQUATION_CONVECTION     (1 <<  2)  /*    4 */
#define CS_EQUATION_DIFFUSION      (1 <<  3)  /*    8 */
#define CS_EQUATION_CURLCURL       (1 <<  4)  /*   16 */
#define CS_EQUATION_GRADDIV        (1 <<  5)  /*   32 */
#define CS_EQUATION_REACTION       (1 <<  6)  /*   64 */
#define CS_EQUATION_FORCE_VALUES   (1 <<  7)  /*  128 */
#define CS_EQUATION_INSIDE_SYSTEM  (1 <<  8)  /*  256 */
#define CS_EQUATION_BUILD_HOOK     (1 <<  9)  /*  512 */
#define CS_EQUATION_USER_TRIGGERED (1 << 10)  /* 1024 */
 
#define CS_EQUATION_POST_BALANCE     (1 << 0) /* 1 */
#define CS_EQUATION_POST_PECLET      (1 << 1) /* 2 */
#define CS_EQUATION_POST_UPWIND_COEF (1 << 2) /* 4 */
#define CS_EQUATION_POST_NORMAL_FLUX (1 << 3) /* 8 */
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef enum {
 
  CS_EQUATION_TYPE_GROUNDWATER,
  CS_EQUATION_TYPE_MAXWELL,
  CS_EQUATION_TYPE_NAVSTO,
  CS_EQUATION_TYPE_PREDEFINED,
  CS_EQUATION_TYPE_THERMAL,
  CS_EQUATION_TYPE_SOLIDIFICATION,
  CS_EQUATION_TYPE_USER,
 
  CS_EQUATION_N_TYPES
 
} cs_equation_type_t;
 
/*----------------------------------------------------------------------------*/
 
typedef struct {
 
  char *restrict              name;    
  cs_equation_type_t          type;    
  int                         dim;     
  union {
    int                       verbosity;
    int                       iwarni;
  };
 
  cs_flag_t                   flag;
 
  cs_flag_t                   post_flag;
 
  /* Numerical settings */
 
  cs_param_space_scheme_t     space_scheme;  
  cs_param_dof_reduction_t    dof_reduction; 
  int                         space_poly_degree;
 
  int iconv;
  int istat;
  int idircl;
  int ndircl;
  int idiff;
  int idifft;
  int idften;
  int iswdyn;
  int ischcv;
  int ibdtso;
  int isstpc;
  int nswrgr;
  int nswrsm;
  int imvisf;
  int imrgra;
  int imligr;
  int ircflu;
  int iwgrec;
  int icoupl;
  union {
    double theta;
    double thetav;   /* deprecated */
  };
  double blencv;
  double blend_st;
  double epsilo;
  double epsrsm;
  double epsrgr;
  double climgr;
  cs_real_t b_climgr;
  double relaxv;
 
  int  b_gradient_r;
  int  b_diff_flux_rc;
 
  cs_param_bc_type_t          default_bc;
  int                         n_bc_defs;
  cs_xdef_t                 **bc_defs;
 
  cs_param_bc_enforce_t       default_enforcement;
  cs_real_t                   strong_pena_bc_coeff;
  cs_real_t                   weak_pena_bc_coeff;
 
  int                         n_ic_defs;
  cs_xdef_t                 **ic_defs;
 
  bool                        do_lumping;
 
  cs_hodge_param_t            time_hodgep;
  cs_property_t              *time_property;
  cs_param_time_scheme_t      time_scheme;
 
  cs_hodge_param_t            diffusion_hodgep;
  cs_property_t              *diffusion_property;
 
  cs_hodge_param_t            curlcurl_hodgep;
  cs_property_t              *curlcurl_property;
 
  cs_hodge_param_t            graddiv_hodgep;
  cs_property_t              *graddiv_property;
 
  cs_param_advection_form_t             adv_formulation;
  cs_param_advection_scheme_t           adv_scheme;
  cs_param_advection_strategy_t         adv_strategy;
  cs_param_advection_extrapol_t         adv_extrapol;
  cs_real_t                             upwind_portion;
  double                                cip_scaling_coef;
 
  cs_adv_field_t                       *adv_field;
  cs_property_t                        *adv_scaling_property;
 
  cs_hodge_param_t            reaction_hodgep;
  int                         n_reaction_terms;
  cs_property_t             **reaction_properties;
 
  int                         n_source_terms;
  cs_xdef_t                 **source_terms;
 
  int                         n_volume_mass_injections;
  cs_xdef_t                 **volume_mass_injections;
 
  int                         n_enforcements;
  cs_enforcement_param_t    **enforcement_params;
 
  cs_param_sles_t            *sles_param;
  cs_param_saddle_t          *saddle_param;
 
  cs_param_nl_algo_t          incremental_algo_type;
  cs_param_convergence_t      incremental_algo_cvg;
  cs_real_t                   incremental_relax_factor;
  cs_iter_algo_param_aac_t    incremental_anderson_param;
 
  bool                        time_control_owner; /* Is this instance owner
                                                     of the pointer. */
  cs_time_control_t          *time_control; /* Time control for equations*/
 
} cs_equation_param_t;
 
/*----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_EQKEY_ADV_CIP_COEF,
  CS_EQKEY_ADV_EXTRAPOL,
  CS_EQKEY_ADV_FORMULATION,
  CS_EQKEY_ADV_SCHEME,
  CS_EQKEY_ADV_STRATEGY,
  CS_EQKEY_ADV_UPWIND_PORTION,
  CS_EQKEY_AMG_TYPE,
  CS_EQKEY_BC_ENFORCEMENT,
  CS_EQKEY_BC_STRONG_PENA_COEFF,
  CS_EQKEY_BC_WEAK_PENA_COEFF,
  CS_EQKEY_DO_LUMPING,
  CS_EQKEY_DOF_REDUCTION,
  CS_EQKEY_EXTRA_OP,
  CS_EQKEY_HODGE_DIFF_ALGO,
  CS_EQKEY_HODGE_DIFF_COEF,
  CS_EQKEY_HODGE_TIME_ALGO,
  CS_EQKEY_HODGE_REAC_ALGO,
  CS_EQKEY_ITSOL,               /* deprecated */
  CS_EQKEY_ITSOL_ATOL,          /* deprecated */
  CS_EQKEY_ITSOL_DTOL,          /* deprecated */
  CS_EQKEY_ITSOL_EPS,           /* deprecated */
  CS_EQKEY_ITSOL_MAX_ITER,      /* deprecated */
  CS_EQKEY_ITSOL_RESNORM_TYPE,  /* deprecated */
  CS_EQKEY_ITSOL_RESTART,       /* deprecated */
  CS_EQKEY_ITSOL_RTOL,          /* deprecated */
  CS_EQKEY_SOLVER,
  CS_EQKEY_SOLVER_ATOL,
  CS_EQKEY_SOLVER_DTOL,
  CS_EQKEY_SOLVER_MAX_ITER,
  CS_EQKEY_SOLVER_NO_OP,
  CS_EQKEY_SOLVER_RESNORM_TYPE,
  CS_EQKEY_SOLVER_RESTART,
  CS_EQKEY_SOLVER_RTOL,
  CS_EQKEY_OMP_ASSEMBLY_STRATEGY,
  CS_EQKEY_PRECOND,
  CS_EQKEY_PRECOND_BLOCK_TYPE,
  CS_EQKEY_SADDLE_ATOL,
  CS_EQKEY_SADDLE_AUGMENT_SCALING,
  CS_EQKEY_SADDLE_DTOL,
  CS_EQKEY_SADDLE_MAX_ITER,
  CS_EQKEY_SADDLE_PRECOND,
  CS_EQKEY_SADDLE_RTOL,
  CS_EQKEY_SADDLE_SCHUR_APPROX,
  CS_EQKEY_SADDLE_SOLVER,
  CS_EQKEY_SADDLE_SOLVER_CLASS,
  CS_EQKEY_SADDLE_SOLVER_RESTART,
  CS_EQKEY_SADDLE_VERBOSITY,
  CS_EQKEY_SLES_VERBOSITY,
  CS_EQKEY_SOLVER_FAMILY,
  CS_EQKEY_SPACE_SCHEME,
  CS_EQKEY_TIME_SCHEME,
  CS_EQKEY_TIME_THETA,
  CS_EQKEY_VERBOSITY,
 
  CS_EQKEY_N_KEYS
 
} cs_equation_key_t;
 
/*============================================================================
 * Static inline public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline void
cs_equation_param_set_flag(cs_equation_param_t *eqp,
                           cs_flag_t            flag)
{
  assert(eqp != NULL);
  eqp->flag |= flag;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_diffusion(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_DIFFUSION)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_curlcurl(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_CURLCURL)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_graddiv(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_GRADDIV)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_convection(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_CONVECTION)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_reaction(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_REACTION)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_time(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_UNSTEADY)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_sourceterm(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->n_source_terms > 0)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_internal_enforcement(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_FORCE_VALUES)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_implicit_advection(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_CONVECTION) {
    if (eqp->adv_strategy == CS_PARAM_ADVECTION_IMPLICIT_FULL ||
        eqp->adv_strategy == CS_PARAM_ADVECTION_IMPLICIT_LINEARIZED)
      return true;
    else
      return false;
  }
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_user_hook(const cs_equation_param_t *eqp)
{
  assert(eqp != NULL);
  if (eqp->flag & CS_EQUATION_BUILD_HOOK)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_equation_param_has_name(cs_equation_param_t *eqp,
                           const char          *name)
{
  if (eqp == NULL)
    return false;
  if (eqp->name == NULL)
    return false;
  if (strcmp(eqp->name, name) == 0)
    return true;
  else
    return false;
}
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_param_t *
cs_equation_param_create(const char         *name,
                         cs_equation_type_t  type,
                         int                 dim,
                         cs_param_bc_type_t  default_bc);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static cs_equation_param_t *
cs_equation_create_param(const char         *name,
                         cs_equation_type_t  type,
                         int                 dim,
                         cs_param_bc_type_t  default_bc)
{
  return cs_equation_param_create(name, type, dim, default_bc);
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_copy_from(const cs_equation_param_t *ref,
                            cs_equation_param_t       *dst,
                            bool                       copy_fld_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_copy_bc(const cs_equation_param_t *ref,
                          cs_equation_param_t       *dst);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static void
cs_equation_copy_param_from(const cs_equation_param_t *ref,
                            cs_equation_param_t       *dst,
                            bool                       copy_fid)
{
  cs_equation_param_copy_from(ref, dst, copy_fid);
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_clear(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_param_t *
cs_equation_param_free(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_set(cs_equation_param_t *eqp,
                      cs_equation_key_t    key,
                      const char          *keyval);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static void
cs_equation_set_param(cs_equation_param_t *eqp,
                      cs_equation_key_t    key,
                      const char           *keyval)
{
  cs_equation_param_set(eqp, key, keyval);
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_param_sles_t *
cs_equation_param_get_sles_param(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_param_saddle_t *
cs_equation_param_get_saddle_param(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_set_sles(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_set_quadrature_to_all(cs_equation_param_t  *eqp,
                                        cs_quadrature_type_t  qtype);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_lock_settings(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_unlock_settings(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_ensure_consistent_settings(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_param_log(const cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_equation_param_has_robin_bc(const cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_ic_by_value(cs_equation_param_t *eqp,
                            const char          *z_name,
                            cs_real_t           *val);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_ic_by_qov(cs_equation_param_t *eqp,
                          const char          *z_name,
                          double               quantity);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_ic_by_analytic(cs_equation_param_t *eqp,
                               const char          *z_name,
                               cs_analytic_func_t  *analytic,
                               void                *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_ic_by_dof_func(cs_equation_param_t *eqp,
                               const char          *z_name,
                               cs_flag_t            loc_flag,
                               cs_dof_func_t       *func,
                               void                *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_xdef_bc(cs_equation_param_t *eqp,
                        cs_xdef_t           *xdef);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_bc_by_value(cs_equation_param_t      *eqp,
                            const cs_param_bc_type_t  bc_type,
                            const char               *z_name,
                            cs_real_t                *values);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_bc_by_array(cs_equation_param_t      *eqp,
                            const cs_param_bc_type_t  bc_type,
                            const char               *z_name,
                            cs_flag_t                 loc,
                            cs_real_t                *array,
                            bool                      is_owner,
                            bool                      full_length);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_bc_by_field(cs_equation_param_t      *eqp,
                            const cs_param_bc_type_t  bc_type,
                            const char               *z_name,
                            cs_field_t               *field);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_bc_by_analytic(cs_equation_param_t      *eqp,
                               const cs_param_bc_type_t  bc_type,
                               const char               *z_name,
                               cs_analytic_func_t       *analytic,
                               void                     *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_bc_by_time_func(cs_equation_param_t      *eqp,
                                const cs_param_bc_type_t  bc_type,
                                const char               *z_name,
                                cs_time_func_t           *t_func,
                                void                     *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_bc_by_dof_func(cs_equation_param_t      *eqp,
                               const cs_param_bc_type_t  bc_type,
                               const char               *z_name,
                               cs_flag_t                 loc_flag,
                               cs_dof_func_t            *func,
                               void                     *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_volume_mass_injection_by_array(cs_equation_param_t *eqp,
                                               const char          *z_name,
                                               cs_flag_t            loc_flag,
                                               cs_real_t           *array,
                                               bool                 is_owner,
                                               bool                 full_length);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_find_bc(cs_equation_param_t *eqp,
                    const char          *z_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_remove_bc(cs_equation_param_t *eqp,
                      const char          *z_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_remove_ic(cs_equation_param_t *eqp,
                      const char          *z_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_sliding_condition(cs_equation_param_t *eqp,
                                  const char          *z_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_diffusion(cs_equation_param_t *eqp,
                          cs_property_t       *property);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_curlcurl(cs_equation_param_t *eqp,
                         cs_property_t       *property,
                         int                  inversion);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_graddiv(cs_equation_param_t *eqp,
                        cs_property_t       *property);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_time(cs_equation_param_t *eqp,
                     cs_property_t       *property);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_advection(cs_equation_param_t *eqp,
                          cs_adv_field_t      *adv_field);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_add_advection_scaling_property(cs_equation_param_t *eqp,
                                           cs_property_t       *property);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_equation_add_reaction(cs_equation_param_t *eqp,
                         cs_property_t       *property);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_source_term_by_val(cs_equation_param_t *eqp,
                                   const char          *z_name,
                                   cs_real_t           *val);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_source_term_by_analytic(cs_equation_param_t *eqp,
                                        const char          *z_name,
                                        cs_analytic_func_t  *func,
                                        void                *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_source_term_by_dof_func(cs_equation_param_t *eqp,
                                        const char          *z_name,
                                        cs_flag_t            loc_flag,
                                        cs_dof_func_t       *func,
                                        void                *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_source_term_by_array(cs_equation_param_t *eqp,
                                     const char          *z_name,
                                     cs_flag_t            loc,
                                     cs_real_t           *array,
                                     bool                 is_owner,
                                     bool                 full_length);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_volume_mass_injection_by_value(cs_equation_param_t *eqp,
                                               const char          *z_name,
                                               double              *val);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_volume_mass_injection_by_qov(cs_equation_param_t *eqp,
                                             const char          *z_name,
                                             double              *quantity);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_volume_mass_injection_by_analytic(cs_equation_param_t *eqp,
                                                  const char          *z_name,
                                                  cs_analytic_func_t  *func,
                                                  void                *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_xdef_t *
cs_equation_add_volume_mass_injection_by_dof_func(cs_equation_param_t *eqp,
                                                  const char          *z_name,
                                                  cs_flag_t            loc_flag,
                                                  cs_dof_func_t       *func,
                                                  void                *input);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_enforcement_param_t *
cs_equation_add_vertex_dof_enforcement(cs_equation_param_t *eqp,
                                       cs_lnum_t            n_vertices,
                                       const cs_lnum_t      vertex_ids[],
                                       const cs_real_t      ref_value[],
                                       const cs_real_t      vtx_values[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_enforcement_param_t *
cs_equation_add_edge_dof_enforcement(cs_equation_param_t *eqp,
                                     cs_lnum_t            n_edges,
                                     const cs_lnum_t      edge_ids[],
                                     const cs_real_t      ref_value[],
                                     const cs_real_t      edge_values[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_enforcement_param_t *
cs_equation_add_face_dof_enforcement(cs_equation_param_t *eqp,
                                     cs_lnum_t            n_faces,
                                     const cs_lnum_t      face_ids[],
                                     const cs_real_t      ref_value[],
                                     const cs_real_t      face_values[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_enforcement_param_t *
cs_equation_add_cell_enforcement(cs_equation_param_t *eqp,
                                 cs_lnum_t            n_cells,
                                 const cs_lnum_t      elt_ids[],
                                 const cs_real_t      ref_value[],
                                 const cs_real_t      cell_values[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_enforcement_param_t *
cs_equation_add_or_replace_cell_enforcement(cs_equation_param_t *eqp,
                                            int                  enforcement_id,
                                            cs_lnum_t            n_cells,
                                            const cs_lnum_t      cell_ids[],
                                            const cs_real_t      ref_value[],
                                            const cs_real_t      cell_values[]);
 
/*----------------------------------------------------------------------------*/
/* Clear time control data from equation_param instance. */
/*----------------------------------------------------------------------------*/
 
void
cs_equation_time_control_clear(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
/* Add a time control to an equation_parap structure */
/*----------------------------------------------------------------------------*/
 
void
cs_equation_time_control_add(cs_equation_param_t *eqp,
                             cs_time_control_t   *time_control,
                             bool                 shallow_copy);
 
/*----------------------------------------------------------------------------*/
/* Add a time control to an equation_parap structure based on default values */
/*----------------------------------------------------------------------------*/
 
void
cs_equation_time_control_add_default(cs_equation_param_t *eqp);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_EQUATION_PARAM_H__ */