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-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.
*/
 
/*----------------------------------------------------------------------------*/
 
#include "cs_defs.h"
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "cs_cdo_assembly.h"
#include "cs_cdo_bc.h"
#include "cs_cdo_system.h"
#include "cs_cdofb_priv.h"
#include "cs_cdofb_scaleq.h"
#include "cs_cdofb_vecteq.h"
#include "cs_cdofb_monolithic_sles.h"
#include "cs_cdofb_navsto.h"
#include "cs_equation_bc.h"
#include "cs_equation_priv.h"
#include "cs_iter_algo.h"
#include "cs_navsto_coupling.h"
#include "cs_navsto_param.h"
#include "cs_sles.h"
#include "cs_static_condensation.h"
#include "cs_timer.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*=============================================================================
 * Additional doxygen documentation
 *============================================================================*/
 
/* Context related to the resolution of a saddle point problem */
 
typedef struct {
 
  cs_real_t     *div_op;    /* Block related to the -divergence (block
                               A_{10}) */
 
  /* Arrays split according to the block shape. U is interlaced or not
   * according to the SLES strategy */
 
  cs_lnum_t      n_faces;       /* local number of DoFs for each component
                                 * of the velocity */
  cs_lnum_t      n_cells;       /* local number of DoFs for the pressure */
 
  cs_real_t     *u_f;           /* velocity values at faces */
  cs_real_t     *p_c;           /* pressure values at cells */
 
  cs_sles_t     *sles;          /* main SLES structure */
  cs_sles_t     *schur_sles;    /* auxiliary SLES for the Schur complement
                                 * May be NULL */
 
  cs_real_t      graddiv_coef;  /* value of the grad-div coefficient in case
                                 * of augmented system */
 
} cs_cdofb_monolithic_sles_t;
 
 
typedef struct _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,
                              const cs_equation_param_t      *eqp,
                              const cs_cdo_system_helper_t   *sh,
                              cs_param_sles_t                *slesp,
                              cs_cdofb_monolithic_sles_t     *msles);
 
/*=============================================================================
 * Structure definitions
 *============================================================================*/
 
struct _cdofb_monolithic_t {
 
  cs_navsto_monolithic_t   *coupling_context;
 
  cs_field_t               *velocity;
 
  cs_field_t               *pressure;
 
  cs_field_t               *divergence;
 
  cs_adv_field_t           *adv_field;
 
  cs_real_t                *mass_flux_array;
 
  cs_real_t                *mass_flux_array_pre;
 
  const cs_boundary_type_t       *bf_type;
 
  cs_cdo_bc_face_t               *pressure_bc;
  int                             pressure_rescaling;
 
  cs_cdo_apply_boundary_t        *apply_fixed_wall;
  cs_cdo_apply_boundary_t        *apply_sliding_wall;
  cs_cdo_apply_boundary_t        *apply_velocity_inlet;
  cs_cdo_apply_boundary_t        *apply_symmetry;
 
  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 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 msles
   * 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
   * Some members of this structure are allocated only if a specific algorithm
   * is requested.
   */
 
  cs_cdofb_monolithic_sles_t         *msles;
 
  cs_iter_algo_t                    *nl_algo;
 
  cs_timer_counter_t  timer;
 
};
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_CDOFB_MONOLITHIC_PRIV_H__ */