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-2019 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 "cs_defs.h"

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

BEGIN_C_DECLS

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

#define CS_FLAG_BOUNDARY_CELL_BY_FACE   (1 << 0)  
#define CS_FLAG_BOUNDARY_CELL_BY_VERTEX (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_STATE_OWNER       (1 << 8) 
#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_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) 
/* According to the flag which are set, different quantities or connectivities
   are built on-the-fly and stored in a local cache structure (cell/base) */

#define CS_FLAG_COMP_PV   (1 <<  0) /*     1: local info. for vertices */
#define CS_FLAG_COMP_PVQ  (1 <<  1) /*     2: local quant. on vertices */
#define CS_FLAG_COMP_PE   (1 <<  2) /*     4: local info. for edges */
#define CS_FLAG_COMP_PEQ  (1 <<  3) /*     8: local quant. on edges */
#define CS_FLAG_COMP_DFQ  (1 <<  4) /*    16: local quant. on dual faces */
#define CS_FLAG_COMP_PF   (1 <<  5) /*    32: local info. for faces */
#define CS_FLAG_COMP_PFQ  (1 <<  6) /*    64: local quant. on faces */
#define CS_FLAG_COMP_DEQ  (1 <<  7) /*   128: local quant. on dual edges */
#define CS_FLAG_COMP_EV   (1 <<  8) /*   256: local e2v connectivity */
#define CS_FLAG_COMP_FE   (1 <<  9) /*   512: local f2e connectivity */
#define CS_FLAG_COMP_FEQ  (1 << 10) /*  1024: local f2e quantities */
#define CS_FLAG_COMP_FV   (1 << 11) /*  2048: local f2v connectivity */
#define CS_FLAG_COMP_EF   (1 << 12) /*  4096: local e2f connectivity */
#define CS_FLAG_COMP_EFQ  (1 << 13) /*  8192: local e2f quantities */
#define CS_FLAG_COMP_HFQ  (1 << 14) /* 16384: local quant. on face pyramids */
#define CS_FLAG_COMP_DIAM (1 << 15) /* 32768: local diameters on faces/cell */

/*============================================================================
 * 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_face;
extern const cs_flag_t  cs_flag_primal_cell;
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_dual_face_byc;

/* Part of dual cell closure belonging to a boundary primal face */
extern const cs_flag_t  cs_flag_dual_closure_byf;

/*============================================================================
 * 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;
}

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

const char *
cs_flag_str_location(cs_flag_t  loc);

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

END_C_DECLS

#endif /* __CS_FLAG_H__ */