cs_equation_system_param.h

Go to the documentation of this file.

#ifndef __CS_EQUATION_SYSTEM_PARAM_H__
#define __CS_EQUATION_SYSTEM_PARAM_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-2023 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_param.h"
#include "cs_iter_algo.h"
#include "cs_param_sles.h"
#include "cs_param_types.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef enum {
 
  CS_EQUATION_SYSTEM_SLES_MUMPS,
 
  CS_EQUATION_SYSTEM_N_SLES_TYPES
 
} cs_equation_system_sles_strategy_t;
 
typedef struct {
 
  char *restrict            name;
 
  int                       verbosity;
 
  cs_param_space_scheme_t   space_scheme;
 
  int                       block_var_dim;
 
  bool                                   sles_setup_done;
 
  cs_equation_system_sles_strategy_t     sles_strategy;
 
  cs_param_sles_cvg_t                    linear_solver_cvg;
 
} cs_equation_system_param_t;
 
 
typedef enum {
 
  CS_SYSKEY_LINEAR_SOLVER_ATOL,
  CS_SYSKEY_LINEAR_SOLVER_DTOL,
  CS_SYSKEY_LINEAR_SOLVER_RTOL,
  CS_SYSKEY_LINEAR_SOLVER_MAX_ITER,
  CS_SYSKEY_SLES_STRATEGY,
  CS_SYSKEY_VERBOSITY,
 
  CS_SYSKEY_N_KEYS
 
} cs_equation_system_key_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_system_param_t *
cs_equation_system_param_create(const char       *name,
                                int               block_var_dim);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_system_param_t *
cs_equation_system_param_free(cs_equation_system_param_t    *sysp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_param_log(const cs_equation_system_param_t    *sysp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_equation_system_param_set(cs_equation_system_param_t    *sysp,
                             cs_equation_system_key_t       key,
                             const char                    *keyval);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_EQUATION_SYSTEM_PARAM_H__ */