cs_meg_prototypes.h

Go to the documentation of this file.

#ifndef CS_MEG_PROTOTYPES_H
#define CS_MEG_PROTOTYPES_H
 
/*============================================================================
 * Prototypes for MEG (Mathematical Expression Generator) functions
 *============================================================================*/
 
/*
  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_base.h"
#include "base/cs_field.h"
#include "base/cs_volume_zone.h"
#include "base/cs_boundary_zone.h"
#include "base/cs_ibm.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
typedef void
(cs_ibm_volume_func_t)(const cs_lnum_t    c_id,
                       const cs_real_3_t  xyz,
                       const cs_real_t    t,
                       cs_real_t         *retval);
 
typedef void
(cs_ibm_fsi_func_t)(cs_real_t  *retval);
 
/*============================================================================
 * MEG function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_boundary_function
(
  const char       *zone_name,  
  const cs_lnum_t   n_elts,     
  const cs_lnum_t  *elt_ids,    
  const cs_real_t   xyz[][3],   
  const char       *field_name, 
  const char       *condition,  
  cs_real_t        *retvals     
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_volume_function
(
  const char      *zone_name,    
  const cs_lnum_t  n_elts,       
  const cs_lnum_t *elt_ids,      
  const cs_real_t  xyz[][3],     
  const char      *fields_names, 
  cs_real_t       *fvals[]       
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_initialization
(
  const char      *zone_name,  
  const cs_lnum_t  n_elts,     
  const cs_lnum_t *elt_ids,    
  const cs_real_t  xyz[][3],   
  const char      *field_name, 
  cs_real_t       *retvals     
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_source_terms
(
  const char      *zone_name,   
  const cs_lnum_t  n_elts,      
  const cs_lnum_t *elt_ids,     
  const cs_real_t  xyz[][3],    
  const char      *name,        
  const char      *source_type, 
  cs_real_t       *retvals      
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_fsi_struct
(
  const char       *object_type, 
  const char       *name,        
  const cs_real_t   fluid_f[],   
  cs_real_t         val[]        
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_post_activate(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_post_profiles
(
  const char   *name,       
  int           n_coords,   
  cs_real_t     coords[][3] 
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_meg_post_calculator
(
  const char      *name,     
  const cs_lnum_t  n_elts,   
  const cs_lnum_t *elt_ids,  
  const cs_real_t  xyz[][3], 
  cs_real_t       *retvals   
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_cutcell_func_t *
cs_meg_ibm_func_by_name
(
  const char *object_name 
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_ibm_volume_func_t *
cs_meg_ibm_volume_func_by_name
(
  const char *object_name, 
  const char *gui_var_name 
);
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_ibm_fsi_func_t *
cs_meg_ibm_fsi_func_by_name
(
  const char *object_name, 
  const char *gui_var_name 
);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* CS_MEG_PROTOTYPES_H */