cs_param_mumps.h

Go to the documentation of this file.

#ifndef __CS_PARAM_MUMPS_H__
#define __CS_PARAM_MUMPS_H__
 
/*============================================================================
 * Routines and structure to handle the MUMPS settings
 *============================================================================*/
 
/*
  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
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef enum {
 
  CS_PARAM_MUMPS_FACTO_LU,
  CS_PARAM_MUMPS_FACTO_LDLT_SYM,
  CS_PARAM_MUMPS_FACTO_LDLT_SPD,
 
  CS_PARAM_MUMPS_N_FACTO_TYPES
 
} cs_param_mumps_facto_type_t;
 
 
typedef enum {
 
  CS_PARAM_MUMPS_ANALYSIS_AMD,
  CS_PARAM_MUMPS_ANALYSIS_QAMD,
  CS_PARAM_MUMPS_ANALYSIS_PORD,
  CS_PARAM_MUMPS_ANALYSIS_SCOTCH,
  CS_PARAM_MUMPS_ANALYSIS_PTSCOTCH,
  CS_PARAM_MUMPS_ANALYSIS_METIS,
  CS_PARAM_MUMPS_ANALYSIS_PARMETIS,
 
  CS_PARAM_MUMPS_ANALYSIS_AUTO,
 
  CS_PARAM_MUMPS_N_ANALYSIS_ALGOS
 
} cs_param_mumps_analysis_algo_t;
 
 
typedef enum {
 
  CS_PARAM_MUMPS_MEMORY_CONSTRAINED,
  CS_PARAM_MUMPS_MEMORY_AUTO,
  CS_PARAM_MUMPS_MEMORY_CPU_DRIVEN,
 
  CS_PARAM_MUMPS_N_MEMORY_USAGES
 
} cs_param_mumps_memory_usage_t;
 
 
typedef struct {
 
  /* \var analysis_algo
   * Choice of the algorithm used to perform the analysis step
   *
   * \var facto_type
   * Type of factorization to consider. This choice depends on the type of
   * matrix to handle
   *
   * \var mem_usage
   * Type of strategy to consider for the memory usage.
   */
 
  cs_param_mumps_analysis_algo_t   analysis_algo;
  cs_param_mumps_facto_type_t      facto_type;
  cs_param_mumps_memory_usage_t    mem_usage;
 
  bool    is_single;        
  bool    advanced_optim;   
  double  blr_threshold;    
  double  mem_coef;         
  bool    keep_ordering;    
  int     block_analysis;   
  int     ir_steps;         
} cs_param_mumps_t;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_param_mumps_t *
cs_param_mumps_create(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_param_mumps_t *
cs_param_mumps_copy(const cs_param_mumps_t  *mumpsp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_param_mumps_log(const char              *name,
                   const cs_param_mumps_t  *mumpsp);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_PARAM_MUMPS_H__ */