cs_param_hpddm.h

Go to the documentation of this file.

#ifndef CS_PARAM_HPDDM_H
#define CS_PARAM_HPDDM_H
 
/*============================================================================
 * Routines and structure to handle the HPDDM settings
 *============================================================================*/
 
/*
  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
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef struct {
 
  /* There are three important parameters:
   *   Left bound values  --> easy problem and low cost
   *   Right bound values --> hard problem and high cost
   *   - 1 <= harmonic_overlap <= 10
   *   - 40 <= nb_eigenvector =< 500
   *   - 0.5 >= relative_threshold >= 1.e-6
   *   - 1 <= p < nb_mpi/2
   */
 
  bool use_neumann;      
  int  harmonic_overlap; 
  int  nb_eigenvector;    
  int    p;                  
  double relative_threshold; 
  /* Advanced options */
 
  bool adaptative; /* Compute parameters using adaptative algorithm */
  int  min_harmonic_overlap; 
  int  max_harmonic_overlap; 
  int min_nb_eigenvector; 
  int max_nb_eigenvector; 
  int min_iter;
  int max_iter;            
  int nb_iter_prev;        /* Number of iterations of previous solve */
 
} cs_param_hpddm_t;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_param_hpddm_t *
cs_param_hpddm_create(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_param_hpddm_t *
cs_param_hpddm_copy(const cs_param_hpddm_t *hpddmp);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_param_hpddm_log(const char *name, const cs_param_hpddm_t *hpddmp);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* CS_PARAM_HPDDM_H */