cs_flag.h

Go to the documentation of this file.

#ifndef CS_FLAG_H
#define CS_FLAG_H
 
/*============================================================================
 * Manage the definition/setting of a computation
 *============================================================================*/
 
/*
  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_defs.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
#define CS_FLAG_BOUNDARY_CELL_BY_FACE     (1 << 0)
#define CS_FLAG_BOUNDARY_CELL_BY_VERTEX   (1 << 1)
#define CS_FLAG_BOUNDARY_CELL_BY_EDGE     (1 << 2)
#define CS_FLAG_SOLID_CELL                (1 << 3)
 
#define CS_FLAG_CURRENT_TO_PREVIOUS       (1 << 0)
#define CS_FLAG_INITIALIZATION            (1 << 1)
 
#define CS_FLAG_SYS_MASS_MATRIX  (1 << 0) 
#define CS_FLAG_SYS_SYM          (1 << 1) 
#define CS_FLAG_SYS_TIME_DIAG    (1 << 2) 
#define CS_FLAG_SYS_REAC_DIAG    (1 << 3) 
#define CS_FLAG_SYS_SOURCES_HLOC (1 << 4) 
#define CS_FLAG_SYS_VECTOR       (1 << 5) 
#define CS_FLAG_STATE_UNIFORM      (1 << 0) 
#define CS_FLAG_STATE_CELLWISE     (1 << 1) 
#define CS_FLAG_STATE_FACEWISE     (1 << 2) 
#define CS_FLAG_STATE_STEADY       (1 << 3) 
#define CS_FLAG_STATE_POTENTIAL    (1 << 4) 
#define CS_FLAG_STATE_CIRCULATION  (1 << 5) 
#define CS_FLAG_STATE_FLUX         (1 << 6) 
#define CS_FLAG_STATE_DENSITY      (1 << 7) 
#define CS_FLAG_FULL_LOC  (1 <<  0) 
#define CS_FLAG_SCALAR    (1 <<  1) 
#define CS_FLAG_VECTOR    (1 <<  2) 
#define CS_FLAG_TENSOR    (1 <<  3) 
#define CS_FLAG_VERTEX    (1 <<  4) 
#define CS_FLAG_EDGE      (1 <<  5) 
#define CS_FLAG_FACE      (1 <<  6) 
#define CS_FLAG_CELL      (1 <<  7) 
#define CS_FLAG_PRIMAL    (1 <<  8) 
#define CS_FLAG_DUAL      (1 <<  9) 
#define CS_FLAG_BORDER    (1 << 10) 
#define CS_FLAG_BY_CELL   (1 << 11) 
#define CS_FLAG_BY_FACE   (1 << 12) 
#define CS_FLAG_MAC_LOC   (1 << 13) 
#define CS_FLAG_SCHEME_SCALAR  (1 << 0) 
#define CS_FLAG_SCHEME_VECTOR  (1 << 1) 
#define CS_FLAG_SCHEME_NAVSTO  (1 << 2) 
#define CS_FLAG_SCHEME_POLY0   (1 << 3) 
#define CS_FLAG_SCHEME_POLY1   (1 << 4) 
#define CS_FLAG_SCHEME_POLY2   (1 << 5) 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef unsigned char       cs_mask_t;   /* Elementary flag */
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/* Default locations */
 
extern const cs_flag_t  cs_flag_primal_vtx;
extern const cs_flag_t  cs_flag_primal_edge;
extern const cs_flag_t  cs_flag_primal_face;
extern const cs_flag_t  cs_flag_primal_cell;
extern const cs_flag_t  cs_flag_vertex;      /* equal to cs_flag_primal_vtx */
extern const cs_flag_t  cs_flag_cell;        /* equal to cs_flag_primal_cell */
extern const cs_flag_t  cs_flag_boundary_face;
extern const cs_flag_t  cs_flag_mac_primal_face;
 
extern const cs_flag_t  cs_flag_dual_vtx;
extern const cs_flag_t  cs_flag_dual_face;
extern const cs_flag_t  cs_flag_dual_cell;
 
extern const cs_flag_t  cs_flag_primal_edge_byc;
extern const cs_flag_t  cs_flag_dual_cell_byc;
extern const cs_flag_t  cs_flag_dual_face_byc;
 
/* Part of dual cell closure belonging to a boundary primal face */
 
extern const cs_flag_t  cs_flag_dual_closure_byf;
 
/* According to the extended flag defined below one can identify which set of
 * quantities or connectivities have to be built on-the-fly and stored in a
 * local structure possibly owned by each thread and with a cellwise scope */
 
typedef unsigned int  cs_eflag_t;
 
/* Store predefined flags */
 
extern const cs_eflag_t  cs_flag_need_v;
extern const cs_eflag_t  cs_flag_need_e;
extern const cs_eflag_t  cs_flag_need_f;
extern const cs_eflag_t  cs_flag_need_fe;
extern const cs_eflag_t  cs_flag_need_ef;
extern const cs_eflag_t  cs_flag_need_peq;
extern const cs_eflag_t  cs_flag_need_dfq;
extern const cs_eflag_t  cs_flag_need_pfq;
extern const cs_eflag_t  cs_flag_need_deq;
extern const cs_eflag_t  cs_flag_need_pfc;
 
typedef enum {
 
  /* Compute simple and cellwise information for vertices */
 
  CS_FLAG_COMP_PV      = 1 << 0,   /* = 1 */
 
  /* Compute cellwise quantities for vertices */
 
  CS_FLAG_COMP_PVQ     = 1 << 1,   /* = 2 */
 
  /* Compute simple and cellwise information for edges */
 
  CS_FLAG_COMP_PE      = 1 << 2,   /* = 4 */
 
  /* Compute cellwise quantities for edges */
 
  CS_FLAG_COMP_PEQ     = 1 << 3,   /* = 8 */
 
  /* Compute cellwise quantities for dual faces (associated to edges) */
 
  CS_FLAG_COMP_DFQ     = 1 << 4,   /* = 16 */
 
  /* Compute simple and cellwise information for faces */
 
  CS_FLAG_COMP_PF      = 1 << 5,   /* = 32 */
 
  /* Compute cellwise quantities for faces */
 
  CS_FLAG_COMP_PFQ     = 1 << 6,   /* = 64 */
 
  /* Compute cellwise quantities for dual edges (associated to faces) */
 
  CS_FLAG_COMP_DEQ     = 1 << 7,   /* = 128 */
 
  /* Compute the cellwise connectivity edge to vertices */
 
  CS_FLAG_COMP_EV      = 1 << 8,   /* = 256 */
 
  /* Compute cellwise connectivity face to edges */
 
  CS_FLAG_COMP_FE      = 1 << 9,   /* = 512 */
 
  /* Compute cellwise quantities associated to the couple (face, edge) */
 
  CS_FLAG_COMP_FEQ     = 1 << 10,  /* = 1024 */
 
  /* Compute cellwise connectivity face to vertices */
 
  CS_FLAG_COMP_FV      = 1 << 11,  /* = 2048 */
 
  /* Compute cellwise connectivity edge to faces */
 
  CS_FLAG_COMP_EF      = 1 << 12,  /* = 4096 */
 
  /* Compute elemental portion of dual faces associated to the couple
     (edge, face) */
 
  CS_FLAG_COMP_SEF     = 1 << 13,  /* = 8192 */
 
  /* Compute cellwise quantities related to the height of the pyramid with
     basis spanned by a face and with apex the cell center */
 
  CS_FLAG_COMP_HFQ     = 1 << 14,  /* = 16384 */
 
  /* Compute cellwise orientation of oriented edges belonging to a face */
 
  CS_FLAG_COMP_FES     = 1 << 15,  /* = 32768 */
 
  /* Compute cellwise quantities related to the volume of the pyramid with
     basis spanned by a face and with apex the cell center */
 
  CS_FLAG_COMP_PFC     = 1 << 16,  /* = 65536 */
 
  /* Compute cellwise quantities related to the volume surrounding an edge */
 
  CS_FLAG_COMP_PEC     = 1 << 17,  /* = 131072 */
 
  /* Compute cellwise diameters */
 
  CS_FLAG_COMP_DIAM    = 1 << 18,  /* = 262144 */
 
} cs_flag_comp_bits_t;
 
typedef enum {
 
  CS_FLAG_LOCATION_PRIMAL_VTX  = CS_FLAG_PRIMAL | CS_FLAG_VERTEX,
  CS_FLAG_LOCATION_PRIMAL_EDGE = CS_FLAG_PRIMAL | CS_FLAG_EDGE,
  CS_FLAG_LOCATION_PRIMAL_FACE = CS_FLAG_PRIMAL | CS_FLAG_FACE,
  CS_FLAG_LOCATION_PRIMAL_CELL = CS_FLAG_PRIMAL | CS_FLAG_CELL,
  CS_FLAG_LOCATION_DUAL_VTX    = CS_FLAG_DUAL | CS_FLAG_VERTEX,
  CS_FLAG_LOCATION_DUAL_EDGE   = CS_FLAG_DUAL | CS_FLAG_EDGE,
  CS_FLAG_LOCATION_DUAL_FACE   = CS_FLAG_DUAL | CS_FLAG_FACE,
  CS_FLAG_LOCATION_DUAL_CELL   = CS_FLAG_DUAL | CS_FLAG_CELL,
  CS_FLAG_LOCATION_MAC_PRIMAL_FACE
  = CS_FLAG_PRIMAL | CS_FLAG_FACE | CS_FLAG_MAC_LOC,
 
  CS_FLAG_N_LOCATIONS
 
} cs_flag_location_t;
 
typedef enum {
 
  CS_FLAG_X_AXIS = 0,
  CS_FLAG_Y_AXIS = 1,
  CS_FLAG_Z_AXIS = 2,
 
  CS_FLAG_N_AXIS /* undefined Cartesian axis */
 
} cs_flag_cartesian_axis_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_flag_test(cs_flag_t flag_to_check,
             cs_flag_t reference)
{
  if ((flag_to_check & reference) == reference)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_flag_at_least(cs_flag_t flag_to_check,
                 int       n_masks,
                 cs_flag_t masks[])
{
  for (int i = 0; i < n_masks; i++)
    if ((flag_to_check & masks[i]) == masks[i])
      return true;
  return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline bool
cs_eflag_test(cs_eflag_t flag_to_check,
              cs_eflag_t reference)
{
  if ((flag_to_check & reference) == reference)
    return true;
  else
    return false;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const char *
cs_flag_str_location(cs_flag_t  loc);
 
#endif /* CS_FLAG_H */