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-2021 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_bc.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_common.h"
#include "cs_equation_priv.h"
#include "cs_iter_algo.h"
#include "cs_navsto_coupling.h"
#include "cs_static_condensation.h"
#include "cs_timer.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*=============================================================================
 * Additional doxygen documentation
 *============================================================================*/

typedef struct _cdofb_monolithic_t  cs_cdofb_monolithic_t;

/*=============================================================================
 * Definitions of function pointers
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_cdofb_monolithic_source_t)(const cs_navsto_param_t           *nsp,
                               const cs_cell_mesh_t              *cm,
                               const cs_cdofb_navsto_builder_t   *nsb,
                               cs_cell_sys_t                     *csys);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_cdofb_monolithic_init_matrix_t)(cs_cdofb_monolithic_t     *sc);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_cdofb_monolithic_assemble_t)(const cs_cell_sys_t            *csys,
                                 const cs_cell_mesh_t           *cm,
                                 const cs_real_t                *div_op,
                                 const bool                      has_sourceterm,
                                 cs_cdofb_monolithic_t          *sc,
                                 cs_cdofb_vecteq_t              *eqc,
                                 cs_equation_assemble_t         *eqa);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

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[],
                              const cs_real_t              *dir_values,
                              const cs_lnum_t               forced_ids[],
                              cs_cdofb_monolithic_t        *sc);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef int
(cs_cdofb_monolithic_solve_t)(const cs_navsto_param_t       *nsp,
                              const cs_equation_param_t     *eqp,
                              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_cdofb_monolithic_source_t   *add_gravity_source_term;

  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_init_matrix_t   *init_system;
  cs_cdofb_monolithic_build_t         *steady_build;
  cs_cdofb_monolithic_build_t         *build;

  /* \var assemble
   * Function pointer to manage the assembly process for the Navier-Stokes
   * system of equation
   */

  cs_cdofb_monolithic_assemble_t      *assemble;

  /* \var elemental_assembly
   * Function pointer to manage the assembly process at low-level
   */

  cs_equation_assembly_t              *elemental_assembly;

  /* \var mav_structures
   * Set of pointers to the matrix assembler structures for matrix values
   * Size = 1 or 9
   */

  cs_matrix_assembler_values_t       **mav_structures;

  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_info_t              *algo_info;

  cs_timer_counter_t  timer;

};

/*============================================================================
 * Public function prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_CDOFB_MONOLITHIC_PRIV_H__ */