cs_zone.h

Go to the documentation of this file.

#ifndef __CS_ZONE_H__
#define __CS_ZONE_H__

/*============================================================================
 * Base zones handling.
 *============================================================================*/

/*
  This file is part of code_saturne, a general-purpose CFD tool.

  Copyright (C) 1998-2022 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 "cs_base.h"
#include "cs_mesh_location.h"

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

BEGIN_C_DECLS

/*============================================================================
 * Macro definitions
 *============================================================================*/

/*============================================================================
 * Type definitions
 *============================================================================*/

typedef struct {

  const char       *name;                
  int               id;                  
  int               type;                
  int               location_id;         
  cs_lnum_t         n_elts;              
  const cs_lnum_t  *elt_ids;             
  bool              time_varying;        
  bool              allow_overlay;       
  cs_gnum_t         n_g_elts;            
  cs_real_t         measure;             
  cs_real_t         f_measure;           
  cs_real_t         boundary_measure;    
  cs_real_t         f_boundary_measure;  
  cs_real_t         cog[3];              
} cs_zone_t;

typedef struct {

  const char       *name;           
  int               id;             
  int               type;           
  int               location_id;    
  cs_lnum_t         n_faces;        
  const cs_lnum_t  *face_ids;       
  bool              time_varying;   
  bool              allow_overlay;  
} cs_boundary_zone_t;

typedef struct {

  const char       *name;           
  int               id;             
  int               type;           
  int               location_id;    
  cs_lnum_t         n_cells;        
  const cs_lnum_t  *cell_ids;       
  bool              time_varying;   
  bool              allow_overlay;  
} cs_volume_zone_t;

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

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

END_C_DECLS

#endif /* __CS_ZONE_H__ */