cs_boundary_conditions_priv.h

Go to the documentation of this file.

#ifndef CS_BOUNDARY_CONDITIONS_PRIV_H
#define CS_BOUNDARY_CONDITIONS_PRIV_H
 
/*============================================================================
 * Private types for boundary condition 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.
*/
 
/*----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_function.h"
#include "base/cs_math.h"
#include "mesh/cs_mesh_location.h"
#include "base/cs_time_control.h"
#include "base/cs_zone.h"
 
/*----------------------------------------------------------------------------*/
 
/*============================================================================
 * Local Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Local type definitions
 *============================================================================*/
 
typedef enum {
 
  CS_BC_VEL_RESCALE_NONE,             
  CS_BC_VEL_RESCALE_MASS_FLOW_RATE,   
  CS_BC_VEL_RESCALE_VOLUME_FLOW_RATE  
} cs_bc_velocity_rescale_t;
 
/* Enum for boundary conditions of multiple turbulence values */
 
typedef enum {
 
  CS_BC_TURB_NONE = 0,                
  CS_BC_TURB_BY_HYDRAULIC_DIAMETER,   
  CS_BC_TURB_BY_TURBULENT_INTENSITY   
} cs_bc_turbulence_compute_t;
 
#define CS_BC_OPEN_CONSTANT           (1 << 1)
 
#define CS_BC_OPEN_UNIFORM_QUANTITY   (1 << 2)
 
#define CS_BC_OPEN_UNIFORM_DIRECTION  (1 << 3)
 
#define CS_BC_OPEN_NORMAL_DIRECTION   (1 << 4)
 
/*----------------------------------------------------*/
 
typedef struct {
 
  const  cs_zone_t       *zone;               
  cs_time_control_t       tc;                 
  int                     vel_flags;          
  cs_bc_velocity_rescale_t    vel_rescale;    
  cs_bc_turbulence_compute_t  turb_compute;   
  int                     bc_pm_zone_num;     
  cs_real_t               vel_values[4];      
  cs_real_t              *vel_buffer;         
  cs_real_t               hyd_diameter;       
  cs_real_t               turb_intensity;     
  cs_real_t               c_pr;               
  cs_real_t               c_tk;               
  cs_eval_at_location_t  *vel_func;           
  void                   *vel_func_input;     
  cs_eval_at_location_t  *flow_func;          
  void                   *flow_func_input;    
  cs_eval_at_location_t  *scale_func;         
  void                   *scale_func_input;   
  cs_dof_func_t          *dof_func;           
  void                   *model_inlet;        
  cs_destructor_t        *model_inlet_del;    
} cs_boundary_conditions_open_t;
 
/*=============================================================================
 * Semi-private function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_boundary_conditions_open_t *
cs_boundary_conditions_open_find_or_add(const  cs_zone_t   *zone);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_boundary_conditions_open_t *
cs_boundary_conditions_open_find(const  cs_zone_t   *zone);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_BOUNDARY_CONDITIONS_PRIV_H */