cs_volume_zone.h

Go to the documentation of this file.

#ifndef CS_VOLUME_ZONE_H
#define CS_VOLUME_ZONE_H
 
/*============================================================================
 * Volume zones handling.
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_base.h"
#include "mesh/cs_mesh_location.h"
#include "base/cs_zone.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*
 * Zone type
 */
 
#define CS_VOLUME_ZONE_INITIALIZATION       (1 << 0)
 
#define CS_VOLUME_ZONE_POROSITY             (1 << 1)
 
#define CS_VOLUME_ZONE_HEAD_LOSS            (1 << 2)
 
#define CS_VOLUME_ZONE_SOURCE_TERM          (1 << 3)
 
#define CS_VOLUME_ZONE_MASS_SOURCE_TERM     (1 << 4)
 
#define CS_VOLUME_ZONE_GWF_SOIL             (1 << 5)
 
#define CS_VOLUME_ZONE_SOLID                (1 << 6)
 
#define CS_VOLUME_ZONE_PHYSICAL_PROPERTIES  (1 << 7)
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*=============================================================================
 * Global variables
 *============================================================================*/
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Initialize volume zone structures.
 *
 * This defines a default volume zone. This is the first function of
 * the volume zone handling functions which should be called, and it should
 * only be called after \ref cs_mesh_location_initialize.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_initialize(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Free all volume zone structures.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_finalize(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return number of volume zones defined.
 */
/*----------------------------------------------------------------------------*/
 
int
cs_volume_zone_n_zones(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return number of volume zones which may vary in time.
 *
 * \return  number of zones which may vary in time
 */
/*----------------------------------------------------------------------------*/
 
int
cs_volume_zone_n_zones_time_varying(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Update association of volume zones with a mesh.
 *
 * For time-varying zones, the associated mesh location is updated.
 *
 * \param[in]  mesh_modified  indicate if mesh has been modified
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_build_all(bool  mesh_modified);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define a new volume zone using a selection criteria string.
 *
 * \param[in]  name       name of location to define
 * \param[in]  criteria   selection criteria for associated elements
 * \param[in]  type_flag  mask of zone category values
 *
 * \return  id of newly defined volume zone
 */
/*----------------------------------------------------------------------------*/
 
int
cs_volume_zone_define(const char  *name,
                      const char  *criteria,
                      int          type_flag);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define a new mesh location with an associated selection function.
 *
 * So as to define a subset of mesh entities of a given type, a pointer
 * to a selection function may be given.
 *
 * This requires more programming but allows finer control than selection
 * criteria, as the function has access to the complete mesh structure.
 *
 * \param[in]  name        name of location to define
 * \param[in]  func        pointer to selection function for associated elements
 * \param[in, out]  input  pointer to optional (untyped) value
 *                         or structure.
 * \param[in]  type_flag   mask of zone category values
 *
 * \return  id of newly defined created mesh location
 */
/*----------------------------------------------------------------------------*/
 
int
cs_volume_zone_define_by_func(const char                 *name,
                              cs_mesh_location_select_t  *func,
                              void                       *input,
                              int                         type_flag);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return a pointer to a volume zone based on its id.
 *
 * This function requires that a volume zone of the given id is defined.
 *
 * \param[in]  id   zone id
 *
 * \return  pointer to the volume zone structure
 */
/*----------------------------------------------------------------------------*/
 
const cs_zone_t  *
cs_volume_zone_by_id(int  id);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return a pointer to a volume zone based on its name if present.
 *
 * This function requires that a volume zone of the given name is defined.
 *
 * \param[in]  name  volume zone name
 *
 * \return  pointer to (read-only) zone structure
 */
/*----------------------------------------------------------------------------*/
 
const cs_zone_t  *
cs_volume_zone_by_name(const char  *name);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return a pointer to a volume zone based on its name if present.
 *
 * If no volume zone of the given name is defined, returned pointer is null.
 *
 * \param[in]  name  volume zone name
 *
 * \return  pointer to (read only) zone structure, or NULL
 */
/*----------------------------------------------------------------------------*/
 
const cs_zone_t  *
cs_volume_zone_by_name_try(const char  *name);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Retrieve the volume zone id from its zone name.
 *         If the zone name is equal to NULL or has an empty length, then
 *         the default zone id (=0) corresponding to all entities is returned
 *
 * \param[in] z_name        name of the zone or NULL or ""
 *
 * \return the id of the volume zone
 */
/*----------------------------------------------------------------------------*/
 
int
cs_volume_zone_id_by_name(const char   *z_name);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Set type flag for a given volume zone.
 *
 * \param[in]  id         volume zone id
 * \param[in]  type_flag  volume zone type flag
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_set_type(int   id,
                        int   type_flag);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Set time varying behavior for a given volume zone.
 *
 * \param[in]  id            volume zone id
 * \param[in]  time_varying  true if the zone's definition varies in time
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_set_time_varying(int   id,
                                bool  time_varying);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Set overlay behavior for a given volume zone.
 *
 * \param[in]  id             volume zone id
 * \param[in]  allow_overlay  true if the zone may be overlayed by another
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_set_overlay(int   id,
                           bool  allow_overlay)
;
/*----------------------------------------------------------------------------*/
/*
 * \brief Return pointer to zone id associated with each cell.
 *
 * In case of overlayed zones, the highest zone id associated with
 * a given cell is given.
 */
/*----------------------------------------------------------------------------*/
 
const int *
cs_volume_zone_cell_zone_id(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Print info relative to a given volume zone to log file.
 *
 * \param[in]  z   pointer to volume zone structure
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_log_info(const cs_zone_t  *z);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Log setup information relative to defined volume zones.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return number of volume zones associated with a
 *        given zone flag.
 *
 * \param[in]  type_flag  flag to compare to zone type
 *
 * \return  number of zones matching the given type flag
 */
/*----------------------------------------------------------------------------*/
 
int
cs_volume_zone_n_type_zones(int  type_flag);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return number of volume zone cells associated with a
 *        given zone flag.
 *
 * Note that in the case of overlapping zones, a cell may be accounted
 * for multiple times.
 *
 * \param[in]  type_flag  flag to compare to zone type
 *
 * \return  number of cells in zones matching the given type flag
 */
/*----------------------------------------------------------------------------*/
 
cs_lnum_t
cs_volume_zone_n_type_cells(int  type_flag);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Select cells associated with volume zones of a given type.
 *
 * Note that in the case of overlapping zones, a cell may be accounted
 * for multiple times.
 *
 * \param[in]   type_flag  flag to compare to zone type
 * \param[out]  cell_ids   ids of selected cells (size: given by
 *                         \ref cs_volume_zone_n_type_cells)
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_select_type_cells(int        type_flag,
                                 cs_lnum_t  cell_ids[]);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Tag cells of a given zone type
 *
 * The tag array should be initialized. The given tag_value is associted
 * to cells of the given zone type using a logical "or", so multiple flag
 * bits can be handled using the same array if necessary.
 *
 * \param[in]       zone_type_flag  zone types to tag
 * \param[in]       tag_value  tag value to add to cells of matching zones
 * \param[in, out]  tag        tag value for each cell
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_tag_cell_type(int  zone_type_flag,
                             int  tag_value,
                             int  tag[]);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Print volume zones information to listing file
 */
/*----------------------------------------------------------------------------*/
 
void
cs_volume_zone_print_info(void);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_VOLUME_ZONE_H */