cs_cdofb_monolithic_priv.h

Go to the documentation of this file.

#ifndef CS_CDOFB_MONOLITHIC_PRIV_H
#define CS_CDOFB_MONOLITHIC_PRIV_H
 
/*============================================================================
 * Build an algebraic CDO face-based system for the Navier-Stokes equations
 * and solved it as one block (monolithic approach of the velocity-pressure
 * coupling)
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "alge/cs_saddle_solver.h"
#include "alge/cs_sles.h"
#include "base/cs_timer.h"
#include "cdo/cs_cdo_assembly.h"
#include "cdo/cs_cdo_bc.h"
#include "cdo/cs_cdo_system.h"
#include "cdo/cs_cdofb_monolithic_sles.h"
#include "cdo/cs_cdofb_navsto.h"
#include "cdo/cs_cdofb_priv.h"
#include "cdo/cs_cdofb_scaleq.h"
#include "cdo/cs_cdofb_vecteq.h"
#include "cdo/cs_equation_bc.h"
#include "cdo/cs_equation_priv.h"
#include "cdo/cs_iter_algo.h"
#include "cdo/cs_navsto_context.h"
#include "cdo/cs_navsto_coupling.h"
#include "cdo/cs_navsto_param.h"
#include "cdo/cs_static_condensation.h"
 
/*=============================================================================
 * Additional doxygen documentation
 *============================================================================*/
 
typedef struct _cs_cdofb_monolithic_t cs_cdofb_monolithic_t;
 
/*=============================================================================
 * Definitions of function pointers
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_cdofb_monolithic_assemble_t)(const cs_cell_sys_t              *csys,
                                 const cs_cell_mesh_t             *cm,
                                 const cs_cdofb_navsto_builder_t  *nsb,
                                 cs_cdofb_monolithic_t            *sc,
                                 cs_cdofb_vecteq_t                *eqc,
                                 cs_cdo_assembly_t                *asb);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_cdofb_monolithic_build_t)(const cs_navsto_param_t      *nsp,
                              const cs_real_t               vel_f_n[],
                              const cs_real_t               vel_c_n[],
                              const cs_real_t               vel_f_nm1[],
                              const cs_real_t               vel_c_nm1[],
                              cs_cdofb_monolithic_t        *sc);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef int
(cs_cdofb_monolithic_solve_t)(const cs_navsto_param_t  *nsp,
                              cs_saddle_solver_t       *saddle,
                              cs_real_t                *u_f,
                              cs_real_t                *p_c);
 
/*=============================================================================
 * Structure definitions
 *============================================================================*/
 
struct _cs_cdofb_monolithic_t : public cs::cdo_navsto_monolithic_ctx_t {
  cs_cdofb_monolithic_build_t *steady_build;
  cs_cdofb_monolithic_build_t *build;
 
  cs_cdofb_navsto_source_t *add_gravity_term;
 
  /* \var assemble
   * Function pointer to manage the assembly process for the Navier-Stokes
   * system of equation
   */
 
  cs_cdofb_monolithic_assemble_t *assemble;
 
  /* \var block21_op
   * Unassembled (2,1)-block (related to the divergence). Not always
   * allocated. It depends on the solver for the saddle-point system.
   */
 
  cs_real_t *block21_op;
 
  /* \var system_helper
   * Set of structure to handle the saddle-point matrix and its rhs
   */
 
  cs_cdo_system_helper_t *system_helper;
 
  cs_cdofb_monolithic_solve_t *solve;
 
  /* \var saddle_solver
   * Set of pointers to enable the resolution of saddle-point system
   * with various algorithms. This structure allows us to unify the prototype
   * of "solve" functions
   *
   * \var gamma
   * Scaling coefficient in case of augmentation of the system
   */
 
  cs_saddle_solver_t *saddle_solver;
 
  double gamma;
 
  cs_iter_algo_t *nl_algo;
 
};
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
#endif /* CS_CDOFB_MONOLITHIC_PRIV_H */