cs_field_pointer.h

Go to the documentation of this file.

#ifndef __CS_FIELD_POINTER_H__
#define __CS_FIELD_POINTER_H__
 
/*============================================================================
 * Field pointers and ids for standard and model fields
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2025 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"
#include "base/cs_field.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/
 
/* Macro used for scoping of field pointer enums */
 
#define CS_ENUMF_(e) CS_FIELD_POINTER_ ## e
 
/* Macro used to return a field pointer by its enumerated value */
 
#define CS_F_(e) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].f
 
#define CS_FI_(e, i) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].p[i]
 
/*============================================================================
 * Type definitions
 *============================================================================*/

 
typedef enum {
 
  /* Base variables and properties */
 
  CS_ENUMF_(dt),           
 
  CS_ENUMF_(p),            
  CS_ENUMF_(pgr),          
  CS_ENUMF_(pfr),          
  CS_ENUMF_(vel),          
 
  CS_ENUMF_(k),            
  CS_ENUMF_(eps),          
 
  CS_ENUMF_(rij),          
 
  CS_ENUMF_(phi),          
  CS_ENUMF_(f_bar),        
  CS_ENUMF_(alp_bl),        
 
  CS_ENUMF_(omg),          
  CS_ENUMF_(nusa),         
 
  CS_ENUMF_(hybrid_blend), 
 
  CS_ENUMF_(mesh_u),       
 
  CS_ENUMF_(void_f),       
  CS_ENUMF_(vol_f),        
 
  CS_ENUMF_(h),            
  CS_ENUMF_(t),            
  CS_ENUMF_(t_b),          
  CS_ENUMF_(e_tot),        
  CS_ENUMF_(h_tot),        
 
  CS_ENUMF_(rho),          
  CS_ENUMF_(rho_b),        
 
  CS_ENUMF_(cp),           
  CS_ENUMF_(cv),           
 
  CS_ENUMF_(mu),           
  CS_ENUMF_(mu_t),         
 
  CS_ENUMF_(lambda),       
  CS_ENUMF_(th_diff),      
 
  CS_ENUMF_(poro),         
  CS_ENUMF_(if_poro),      
  CS_ENUMF_(t_poro),       
 
  /* Specific physics variables and properties */
 
  CS_ENUMF_(t_kelvin),     
 
  CS_ENUMF_(vism),         
 
  CS_ENUMF_(volume_f),     
  CS_ENUMF_(mass_f),       
  CS_ENUMF_(energy_f),     
 
  CS_ENUMF_(pot_t),        
  CS_ENUMF_(ntdrp),        
  CS_ENUMF_(chemistry),    
 
  CS_ENUMF_(fm),           
  CS_ENUMF_(fp2m),         
 
  CS_ENUMF_(fsm),          
  CS_ENUMF_(npm),          
  CS_ENUMF_(ygfm),         
 
  CS_ENUMF_(potr),         
  CS_ENUMF_(poti),         
  CS_ENUMF_(potva),        
  CS_ENUMF_(ycoel),        
  CS_ENUMF_(joulp),        
  CS_ENUMF_(radsc),        
  CS_ENUMF_(elech),        
  CS_ENUMF_(curre),        
  CS_ENUMF_(curim),        
  CS_ENUMF_(laplf),        
  CS_ENUMF_(magfl),        
  CS_ENUMF_(elefl),        
 
  CS_ENUMF_(rad_energy),   
  CS_ENUMF_(rad_q),        
  CS_ENUMF_(radiance),     
 
  CS_ENUMF_(rad_est),      
  CS_ENUMF_(rad_ist),      
  CS_ENUMF_(rad_abs),      
  CS_ENUMF_(rad_emi),      
  CS_ENUMF_(rad_cak),      
 
  CS_ENUMF_(qinci),        
  CS_ENUMF_(qinsp),        
  CS_ENUMF_(xlam),         
  CS_ENUMF_(epa),          
  CS_ENUMF_(emissivity),   
  CS_ENUMF_(fnet),         
  CS_ENUMF_(fconv),        
  CS_ENUMF_(hconv),        
  CS_ENUMF_(fup),          
  CS_ENUMF_(fdown),        
  CS_ENUMF_(rad_ck_up),    
  CS_ENUMF_(rad_ck_down),  
 
  CS_ENUMF_(mol_mass),     
 
  CS_ENUMF_(head),         
 
  /* Cooling tower fields */
  CS_ENUMF_(humid),          
  CS_ENUMF_(ym_w),           
  CS_ENUMF_(t_l_pack),       
  CS_ENUMF_(yh_l_pack),      
  CS_ENUMF_(y_l_pack),       
  CS_ENUMF_(thermal_diff_h), 
  CS_ENUMF_(thermal_diff_l), 
  CS_ENUMF_(pack_zone_id),   
 
  /* NCFD fields */
  CS_ENUMF_(yf_ncond),       
  CS_ENUMF_(qp),             
  CS_ENUMF_(qfp),            
  CS_ENUMF_(qfpxx),          
  CS_ENUMF_(qfpxy),          
  CS_ENUMF_(qfpxz),          
  CS_ENUMF_(qfpyx),          
  CS_ENUMF_(qfpyy),          
  CS_ENUMF_(qfpyz),          
  CS_ENUMF_(qfpzx),          
  CS_ENUMF_(qfpzy),          
  CS_ENUMF_(qfpzz),          
  CS_ENUMF_(gamma),          
  CS_ENUMF_(ia),             
  CS_ENUMF_(x2),             
  CS_ENUMF_(d32),            
  CS_ENUMF_(drag),           
  CS_ENUMF_(ad_mass),        
  CS_ENUMF_(wlubr),          
  CS_ENUMF_(th_diff_t),      
  CS_ENUMF_(drho_dp),        
  CS_ENUMF_(drho_dh),        
  CS_ENUMF_(tau12_t),        
  CS_ENUMF_(lift),           
  CS_ENUMF_(disp_t),         
  CS_ENUMF_(surf_tens),      
  CS_ENUMF_(sl_corr),        
  CS_ENUMF_(fi),             
  CS_ENUMF_(fj),             
  CS_ENUMF_(drift_vel),      
  CS_ENUMF_(yplus),          
  CS_ENUMF_(vel_mean),       
  CS_ENUMF_(vel_rel),        
  CS_ENUMF_(dt_dp),          
  CS_ENUMF_(kindiff),        
  CS_ENUMF_(coldiff),        
  CS_ENUMF_(elast),          
  CS_ENUMF_(c_alpha),        
 
  /* Added variables (scalars) */
  CS_ENUMF_(add_var),        
 
  /* User-defined arrays */
  CS_ENUMF_(user),
 
  /* End of attributes */
 
  CS_FIELD_N_POINTERS
 
} cs_field_pointer_id_t;

 
struct cs_field_pointer_array_t {
  cs_field_t   *f;   
  cs_field_t  **p;   
};
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/* Pointers */
 
extern struct cs_field_pointer_array_t  *cs_glob_field_pointers;
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Ensure field pointer array is initialized.
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_ensure_init(void);
 
/*----------------------------------------------------------------------------
 * Free all field pointer data.
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_destroy_all(void);
 
/*----------------------------------------------------------------------------
 * Map a simple field to an enumerated pointer.
 *
 * The associated field pointer may then be retreived using \ref CS_F_(e).
 *
 * parameters:
 *   e <--  field enumerator value
 *   f <--  pointer to field structure
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_map(cs_field_pointer_id_t   e,
                     cs_field_t             *f);
 
/*----------------------------------------------------------------------------
 * Map a field to an (enumerated pointer, index) couple.
 *
 * This sort of mapping may be used for sets of fields whose size
 * is not known in advance.
 *
 * The associated field pointer may then be retreived using \ref CS_F_(e, i).
 *
 * parameters:
 *   e     <-- field enumerator value
 *   index <-- field enumerator index
 *   f     <-- pointer to field structure
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_map_indexed(cs_field_pointer_id_t   e,
                             int                     index,
                             cs_field_t             *f);
 
/*----------------------------------------------------------------------------
 * Map base fields to enumerated pointers.
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_map_base(void);
 
/*----------------------------------------------------------------------------
 * Map some boundary fields to enumerated pointers.
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_map_boundary(void);
 
/*----------------------------------------------------------------------------
 * Map base fields to enumerated pointers for atmospheric models
 *
 * parameters:
 *   n_chem_species <-- number of chemical species
 *   species_f_if   <-- field id for each chemical species
 *----------------------------------------------------------------------------*/
 
void
cs_field_pointer_map_atmospheric(int        n_chem_species,
                                 const int  species_f_id[]);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_FIELD_POINTER_H__ */