cs_iter_algo.h

Go to the documentation of this file.

#ifndef __CS_ITER_ALGO_H__
#define __CS_ITER_ALGO_H__
 
/*============================================================================
 * Set of functions to manage high-level iterative algorithms
 *============================================================================*/
 
/*
  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_cdo_blas.h"
#include "cs_math.h"
#include "cs_param_sles.h"
#include "cs_param_types.h"
#include "cs_sles.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef struct {
 
  int                              verbosity;
  cs_param_sles_cvg_t              cvg_param;
 
  void                            *context;
 
  cs_sles_convergence_state_t      cvg_status;
  double                           normalization;
  double                           tol;
 
  double                           prev_res;
  double                           res;
  double                           res0;
 
  int                              n_algo_iter;
  int                              n_inner_iter;
  int                              last_inner_iter;
 
} cs_iter_algo_t;
 
typedef struct {
 
  int                        n_max_dir;
  int                        starting_iter;
  double                     max_cond;
  double                     beta;
  cs_param_dotprod_type_t    dp_type;
 
} cs_iter_algo_param_aa_t;
 
typedef struct _cs_iter_algo_aa_t  cs_iter_algo_aa_t;
 
/*============================================================================
 * Inline static public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline void
cs_iter_algo_reset(cs_iter_algo_t    *algo)
{
  if (algo == NULL)
    return;
 
  algo->cvg_status = CS_SLES_ITERATING;
  algo->res0 = cs_math_big_r;
  algo->prev_res = cs_math_big_r;
  algo->res = cs_math_big_r;
  algo->n_algo_iter = 0;
  algo->n_inner_iter = 0;
  algo->last_inner_iter = 0;
}
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_iter_algo_t *
cs_iter_algo_create(int                    verbosity,
                    cs_param_sles_cvg_t    cvg_param);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_post_check(const char            *func_name,
                        const char            *eq_name,
                        const char            *algo_name,
                        cs_iter_algo_t        *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_update_cvg(cs_iter_algo_t         *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_update_cvg_default(cs_iter_algo_t         *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_reset_nl(cs_param_nl_algo_t   nl_algo_type,
                      cs_iter_algo_t      *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_iter_algo_aa_t *
cs_iter_algo_aa_create(cs_iter_algo_param_aa_t    aap,
                       cs_lnum_t                  n_elts);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_iter_algo_param_aa_t
cs_iter_algo_get_anderson_param(cs_iter_algo_t         *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_aa_allocate_arrays(cs_iter_algo_aa_t     *aa);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_aa_free_arrays(cs_iter_algo_aa_t     *aa);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_aa_free(cs_iter_algo_t  *algo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_iter_algo_aa_update(cs_iter_algo_t               *algo,
                       cs_real_t                    *cur_iterate,
                       const cs_real_t              *pre_iterate,
                       cs_cdo_blas_dotprod_t        *dotprod,
                       cs_cdo_blas_square_norm_t    *sqnorm);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_ITER_ALGO_H__ */