cs_balance_by_zone.h

Go to the documentation of this file.

#ifndef __CS_BALANCE_BY_ZONE_H__
#define __CS_BALANCE_BY_ZONE_H__

/*============================================================================
 * Scalar balance on zones.
 *============================================================================*/

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

  Copyright (C) 1998-2021 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.
*/

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

#include "cs_defs.h"

/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/

#include "cs_base.h"

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

BEGIN_C_DECLS

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

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

typedef enum {

  CS_BALANCE_VOLUME,              
  CS_BALANCE_DIV,                 
  CS_BALANCE_UNSTEADY,            
  CS_BALANCE_MASS,                
  CS_BALANCE_MASS_IN,             
  CS_BALANCE_MASS_OUT,            
  CS_BALANCE_INTERIOR_IN,         
  CS_BALANCE_INTERIOR_OUT,        
  CS_BALANCE_BOUNDARY_IN,         
  CS_BALANCE_BOUNDARY_OUT,        
  CS_BALANCE_BOUNDARY_SYM,        
  CS_BALANCE_BOUNDARY_WALL,       
  CS_BALANCE_BOUNDARY_WALL_S,     
  CS_BALANCE_BOUNDARY_WALL_R,     
  CS_BALANCE_BOUNDARY_COUPLED,    
  CS_BALANCE_BOUNDARY_COUPLED_E,  
  CS_BALANCE_BOUNDARY_COUPLED_I,  
  CS_BALANCE_BOUNDARY_OTHER,      
  CS_BALANCE_TOTAL,               
  CS_BALANCE_TOTAL_NORMALIZED,    
  /* End of balance terms */

  CS_BALANCE_N_TERMS

} cs_balance_term_t;

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

typedef enum {

  CS_BALANCE_P_IN,                
  CS_BALANCE_P_OUT,               
  CS_BALANCE_P_U2_IN,             
  CS_BALANCE_P_U2_OUT,            
  CS_BALANCE_P_RHOGX_IN,          
  CS_BALANCE_P_RHOGX_OUT,         
  CS_BALANCE_P_U_IN,              
  CS_BALANCE_P_U_OUT,             
  CS_BALANCE_P_RHOU_IN,           
  CS_BALANCE_P_RHOU_OUT,          
  /* End of balance terms */

  CS_BALANCE_P_N_TERMS

} cs_balance_p_term_t;

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

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

void
cs_balance_by_zone_compute(const char      *scalar_name,
                           cs_lnum_t        n_cells_sel,
                           const cs_lnum_t  cell_sel_ids[],
                           cs_real_t        balance[CS_BALANCE_N_TERMS]);

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

void
cs_balance_by_zone(const char  *selection_crit,
                   const char  *scalar_name);

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

void
cs_pressure_drop_by_zone_compute(cs_lnum_t        n_cells_sel,
                                 const cs_lnum_t  cell_sel_ids[],
                                 cs_real_t        balance[CS_BALANCE_P_N_TERMS]);

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

void
cs_pressure_drop_by_zone(const char  *selection_crit);

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

void
cs_surface_balance(const char       *selection_crit,
                   const char       *scalar_name,
                   const cs_real_t   normal[3]);

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

void
cs_flux_through_surface(const char         *scalar_name,
                        const cs_real_t     normal[3],
                        cs_lnum_t           n_b_faces_sel,
                        cs_lnum_t           n_i_faces_sel,
                        const cs_lnum_t     b_face_sel_ids[],
                        const cs_lnum_t     i_face_sel_ids[],
                        cs_real_t          *balance,
                        cs_real_t          *flux_b_faces,
                        cs_real_t          *flux_i_faces);

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

END_C_DECLS

#endif /* __CS_BALANCE_BY_ZONE_H__ */