cs_ext_neighborhood.h

Go to the documentation of this file.

#ifndef CS_EXT_NEIGHBOR_H
#define CS_EXT_NEIGHBOR_H
 
/*============================================================================
 * Extendend neighborhood hnalding and filtering.
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_base.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_quantities.h"
 
/*=============================================================================
 * Local Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definition
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Extended neighborhood type
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_EXT_NEIGHBORHOOD_NONE,                  /* No extended neighborhood */
  CS_EXT_NEIGHBORHOOD_COMPLETE,              /* Full extended neighborhood */
  CS_EXT_NEIGHBORHOOD_OPTIMIZED,             /* Extended neighborhood
                                                optimized through heuristics */
  CS_EXT_NEIGHBORHOOD_CELL_CENTER_OPPOSITE,  /* Cell centers best aligned
                                                opposite to adjacent
                                                cell centers */
  CS_EXT_NEIGHBORHOOD_NON_ORTHO_MAX          /* Cells adjacent to faces
                                                whose non-orthogonality exceeds
                                                a given threshold */
 
} cs_ext_neighborhood_type_t;
 
/*============================================================================
 *  Global variables
 *============================================================================*/
 
/* Short names for extended neighborhood types */
 
extern const char *cs_ext_neighborhood_type_name[];
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_ext_neighborhood_type_t
cs_ext_neighborhood_get_type(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ext_neighborhood_set_type(cs_ext_neighborhood_type_t  enh_type);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_ext_neighborhood_get_boundary_complete(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ext_neighborhood_set_boundary_complete(bool  keep);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_ext_neighborhood_get_non_ortho_max(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ext_neighborhood_set_non_ortho_max(cs_real_t  non_ortho_max);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ext_neighborhood_reduce(cs_mesh_t             *mesh,
                           cs_mesh_quantities_t  *mesh_quantities);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ext_neighborhood_define(cs_mesh_t  *mesh);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_EXT_NEIGHBOR_H */