cs_param.h

Go to the documentation of this file.

#ifndef __CS_PARAM_H__
#define __CS_PARAM_H__

/*============================================================================
 * Manage the definition/setting of a computation
 *============================================================================*/

/*
  This file is part of Code_Saturne, a general-purpose CFD tool.

  Copyright (C) 1998-2019 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_defs.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*============================================================================
 * Macro definitions
 *============================================================================*/

/*============================================================================
 * Type definitions
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_analytic_func_t) (cs_real_t            time,
                      cs_lnum_t            n_elts,
                      const cs_lnum_t     *elt_ids,
                      const cs_real_t     *coords,
                      bool                 compact,
                      void                *input,
                      cs_real_t           *retval);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_time_func_t) (int           time_iter,
                  double        time,
                  void         *input,
                  cs_real_t    *retval);

/* ================
 * ENUM definitions
 * ================ */

typedef enum {

  CS_SPACE_SCHEME_LEGACY,
  CS_SPACE_SCHEME_CDOVB,
  CS_SPACE_SCHEME_CDOVCB,
  CS_SPACE_SCHEME_CDOFB,
  CS_SPACE_SCHEME_HHO_P0,
  CS_SPACE_SCHEME_HHO_P1,
  CS_SPACE_SCHEME_HHO_P2,

  CS_SPACE_N_SCHEMES

} cs_param_space_scheme_t;

typedef enum {

  CS_PARAM_REDUCTION_DERHAM,
  CS_PARAM_REDUCTION_AVERAGE,

  CS_PARAM_N_REDUCTIONS

} cs_param_dof_reduction_t;

typedef enum {

  CS_TIME_SCHEME_STEADY,
  CS_TIME_SCHEME_EULER_IMPLICIT,
  CS_TIME_SCHEME_EULER_EXPLICIT,
  CS_TIME_SCHEME_CRANKNICO,
  CS_TIME_SCHEME_THETA,

  CS_TIME_N_SCHEMES

} cs_param_time_scheme_t;

typedef enum {

  CS_PARAM_ADVECTION_FORM_CONSERV,
  CS_PARAM_ADVECTION_FORM_NONCONS,

  CS_PARAM_N_ADVECTION_FORMULATIONS

} cs_param_advection_form_t;

typedef enum {

  CS_PARAM_ADVECTION_SCHEME_CENTERED,
  CS_PARAM_ADVECTION_SCHEME_CIP,
  CS_PARAM_ADVECTION_SCHEME_CIP_CW,
  CS_PARAM_ADVECTION_SCHEME_MIX_CENTERED_UPWIND,
  CS_PARAM_ADVECTION_SCHEME_SAMARSKII,
  CS_PARAM_ADVECTION_SCHEME_SG,
  CS_PARAM_ADVECTION_SCHEME_UPWIND,

  CS_PARAM_N_ADVECTION_SCHEMES

} cs_param_advection_scheme_t;

typedef enum {

  CS_PARAM_BC_HMG_DIRICHLET,
  CS_PARAM_BC_DIRICHLET,
  CS_PARAM_BC_HMG_NEUMANN,
  CS_PARAM_BC_NEUMANN,
  CS_PARAM_BC_ROBIN,
  CS_PARAM_BC_SLIDING,
  CS_PARAM_N_BC_TYPES

} cs_param_bc_type_t;

typedef enum {

  CS_PARAM_BC_ENFORCE_ALGEBRAIC,
  CS_PARAM_BC_ENFORCE_PENALIZED,
  CS_PARAM_BC_ENFORCE_WEAK_NITSCHE,
  CS_PARAM_BC_ENFORCE_WEAK_SYM,

  CS_PARAM_N_BC_ENFORCEMENTS

} cs_param_bc_enforce_t;

typedef enum {

  CS_PARAM_SLES_CLASS_CS,
  CS_PARAM_SLES_CLASS_PETSC,
  CS_PARAM_SLES_N_CLASSES

} cs_param_sles_class_t;

typedef enum {

  CS_PARAM_AMG_NONE,            
  CS_PARAM_AMG_HYPRE_BOOMER,    
  CS_PARAM_AMG_PETSC_GAMG  ,    
  CS_PARAM_AMG_PETSC_PCMG  ,    
  CS_PARAM_AMG_HOUSE_V,         
  CS_PARAM_AMG_HOUSE_K,         
  CS_PARAM_N_AMG_TYPES

} cs_param_amg_type_t;

typedef enum {

  CS_PARAM_PRECOND_NONE,    
  CS_PARAM_PRECOND_DIAG,    
  CS_PARAM_PRECOND_BJACOB,  
  CS_PARAM_PRECOND_POLY1,   
  CS_PARAM_PRECOND_POLY2,   
  CS_PARAM_PRECOND_SSOR,    
  CS_PARAM_PRECOND_ILU0,    
  CS_PARAM_PRECOND_ICC0,    
  CS_PARAM_PRECOND_AMG,     
  CS_PARAM_PRECOND_AMG_BLOCK,  
  CS_PARAM_PRECOND_AS,         
  CS_PARAM_N_PRECOND_TYPES

} cs_param_precond_type_t;

typedef enum {

  CS_PARAM_ITSOL_AMG,              
  CS_PARAM_ITSOL_BICG,             
  CS_PARAM_ITSOL_BICGSTAB2,        
  CS_PARAM_ITSOL_CG,               
  CS_PARAM_ITSOL_CR3,              
  CS_PARAM_ITSOL_FCG,              
  CS_PARAM_ITSOL_GAUSS_SEIDEL,     
  CS_PARAM_ITSOL_GMRES,            
  CS_PARAM_ITSOL_JACOBI,           
  CS_PARAM_ITSOL_MINRES,           
  CS_PARAM_ITSOL_SYM_GAUSS_SEIDEL, 
  CS_PARAM_N_ITSOL_TYPES

} cs_param_itsol_type_t;

typedef enum {

  CS_PARAM_RESNORM_NONE,           
  CS_PARAM_RESNORM_VOLTOT,         
  CS_PARAM_RESNORM_WEIGHTED_RHS,   
  CS_PARAM_RESNORM_MAT_DIAG,
  CS_PARAM_N_RESNORM_TYPES

} cs_param_resnorm_type_t;

typedef struct {

  bool                     setup_done;   
  int                      verbosity;    
  cs_param_sles_class_t    solver_class; 
  cs_param_precond_type_t  precond;      
  cs_param_itsol_type_t    solver;       
  cs_param_amg_type_t      amg_type;     
  cs_param_resnorm_type_t  resnorm_type;
  int                      n_max_iter;   
  double                   eps;          
} cs_param_sles_t;

/*============================================================================
 * Global variables
 *============================================================================*/

/*============================================================================
 * Public function prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_space_scheme_name(cs_param_space_scheme_t    scheme);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_time_scheme_name(cs_param_time_scheme_t    scheme);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_bc_name(cs_param_bc_type_t  bc);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_bc_enforcement_name(cs_param_bc_enforce_t  type);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_solver_name(cs_param_itsol_type_t  solver);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_precond_name(cs_param_precond_type_t  precond);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

const char *
cs_param_get_amg_type_name(cs_param_amg_type_t   type);

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_PARAM_H__ */