cs_sles_amgx.h

Go to the documentation of this file.

#ifndef __CS_SLES_AMGX_H__
#define __CS_SLES_AMGX_H__
 
/*============================================================================
 * Sparse Linear Equation Solvers using AmgX
 *============================================================================*/
 
/*
  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
 *----------------------------------------------------------------------------*/
 
#include "cs_base.h"
#include "cs_matrix.h"
#include "cs_sles.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
#define CS_SLES_AMGX_PREFER_COMM_FROM_MAPS     (1 << 0)
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/* AmgX linear solver context (opaque) */
 
typedef struct _cs_sles_amgx_t  cs_sles_amgx_t;
 
/*============================================================================
 *  Global variables
 *============================================================================*/
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Define and associate an AmgX linear system solver
 * for a given field or equation name.
 *
 * If this system did not previously exist, it is added to the list of
 * "known" systems. Otherwise, its definition is replaced by the one
 * defined here.
 *
 * This is a utility function: if finer control is needed, see
 * cs_sles_define() and cs_sles_amgx_create().
 *
 * Note that this function returns a pointer directly to the AmgX solver
 * management structure. This may be used to set further options.
 * If needed, cs_sles_find() may be used to obtain a pointer to the matching
 * cs_sles_t container.
 *
 * parameters:
 *   f_id         <-- associated field id, or < 0
 *   name         <-- associated name if f_id < 0, or NULL
 *
 * returns:
 *   pointer to newly created AmgX solver info object.
 *----------------------------------------------------------------------------*/
 
cs_sles_amgx_t *
cs_sles_amgx_define(int          f_id,
                    const char  *name);
 
/*----------------------------------------------------------------------------
 * Create AmgX linear system solver info and context.
 *
 * In case of rotational periodicity for a block (non-scalar) matrix,
 * the matrix type will be forced to MATSHELL ("shell") regardless
 * of the option used.
 *
 * returns:
 *   pointer to newly created solver info object.
 *----------------------------------------------------------------------------*/
 
cs_sles_amgx_t *
cs_sles_amgx_create(void);
 
/*----------------------------------------------------------------------------
 * Create AmgX linear system solver info and context
 * based on existing info and context.
 *
 * parameters:
 *   context <-- pointer to reference info and context
 *               (actual type: cs_sles_amgx_t  *)
 *
 * returns:
 *   pointer to newly created solver info object
 *   (actual type: cs_sles_amgx_t  *)
 *----------------------------------------------------------------------------*/
 
void *
cs_sles_amgx_copy(const void  *context);
 
/*----------------------------------------------------------------------------
 * Destroy AmgX linear system solver info and context.
 *
 * parameters:
 *   context  <-> pointer to AmgX linear solver info
 *                (actual type: cs_sles_amgx_t  **)
 *----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_destroy(void  **context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const char *
cs_sles_amgx_get_config(void  *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_set_config(void        *context,
                        const char  *config);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const char *
cs_sles_amgx_get_config_file(void  *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_set_config_file(void        *context,
                             const char  *path);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_sles_amgx_get_use_device(void  *context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_set_use_device(void  *context,
                            bool   use_device);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_set_flags(void  *context,
                       int    flags);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_sles_amgx_get_flags(void  *context);
 
/*----------------------------------------------------------------------------
 * Setup AmgX linear equation solver.
 *
 * parameters:
 *   context   <-> pointer to AmgX linear solver info
 *                 (actual type: cs_sles_amgx_t  *)
 *   name      <-- pointer to system name
 *   a         <-- associated matrix
 *   verbosity <-- verbosity level
 *----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_setup(void               *context,
                   const char         *name,
                   const cs_matrix_t  *a,
                   int                 verbosity);
 
/*----------------------------------------------------------------------------
 * Call AmgX linear equation solver.
 *
 * \warn The precision, r_norm, and n_iter parameters are ignored here.
 *       the matching configuration options should be set earlier, using
 *       the \ref cs_sles_amgx_set_config function
 *
 *
 * parameters:
 *   context       <-> pointer to AmgX linear solver info
 *                     (actual type: cs_sles_amgx_t  *)
 *   name          <-- pointer to system name
 *   a             <-- matrix
 *   verbosity     <-- verbosity level
 *   precision     <-- solver precision
 *   r_norm        <-- residual normalization
 *   n_iter        --> number of iterations
 *   residual      --> residual
 *   rhs           <-- right hand side
 *   vx_ini        <-- initial system solution
 *                     (vx if nonzero, nullptr if zero)
 *   vx            <-> system solution
 *   aux_size      <-- number of elements in aux_vectors (in bytes)
 *   aux_vectors   --- optional working area (internal allocation if NULL)
 *
 * returns:
 *   convergence state
 *----------------------------------------------------------------------------*/
 
cs_sles_convergence_state_t
cs_sles_amgx_solve(void                *context,
                   const char          *name,
                   const cs_matrix_t   *a,
                   int                  verbosity,
                   double               precision,
                   double               r_norm,
                   int                 *n_iter,
                   double              *residual,
                   const cs_real_t     *rhs,
                   cs_real_t           *vx_ini,
                   cs_real_t           *vx,
                   size_t               aux_size,
                   void                *aux_vectors);
 
/*----------------------------------------------------------------------------
 * Free AmgX linear equation solver setup context.
 *
 * This function frees resolution-related data, such as
 * buffers and preconditioning but does not free the whole context,
 * as info used for logging (especially performance data) is maintained.
 
 * parameters:
 *   context <-> pointer to AmgX linear solver info
 *               (actual type: cs_sles_amgx_t  *)
 *----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_free(void  *context);
 
/*----------------------------------------------------------------------------
 * Log sparse linear equation solver info.
 *
 * parameters:
 *   context  <-> pointer to AmgX linear solver info
 *                (actual type: cs_sles_amgx_t  *)
 *   log_type <-- log type
 *----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_log(const void  *context,
                 cs_log_t     log_type);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_sles_amgx_library_info(cs_log_t  log_type);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_SLES_AMGX_H__ */