cs_mobile_structures.h

Go to the documentation of this file.

#ifndef __CS_MOBILE_STRUCTURES_H__
#define __CS_MOBILE_STRUCTURES_H__
 
/*============================================================================
 * Mobile structures management.
 *============================================================================*/
 
/*
  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_restart.h"
#include "base/cs_time_control.h"
#include "base/cs_time_plot.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/* Bit values for mobile boundary
   ----------------------------- */
 
typedef enum {
  CS_STRUCTURE_NONE                = 1 << 0, /* No structure*/
  CS_STRUCTURE_INTERNAL_0D         = 1 << 1, 
  CS_STRUCTURE_EXTERNAL_CODE_ASTER = 1 << 2, 
  CS_STRUCTURE_EXTERNAL_USER       = 1 << 3  
} cs_mobile_structure_type_t;
 
/*-------------------------*/
 
typedef struct {
 
  /* Base structure definitions and input */
 
  int n_int_structs; 
  int n_ext_structs; 
  int n_ast_structs; 
  cs_real_t      aexxst;     
  cs_real_t      bexxst;     
  cs_real_t      cfopre;     
  cs_real_t      alpnmk;     
  cs_real_t      betnmk;     
  cs_real_t      gamnmk;     
  cs_real_33_t  *xmstru;     
  cs_real_33_t  *xcstru;     
  cs_real_33_t  *xkstru;     
  /* Output (plotting) control */
 
  int                plot;               
  cs_time_control_t  plot_time_control;  
  char              *plot_dir_name;      
  /* Computed structure values */
 
  cs_real_3_t   *xstr;       
  cs_real_3_t  *xsta;        
  cs_real_3_t  *xstp;        
  cs_real_3_t  *xstreq;      
  cs_real_3_t  *xpstr;       
  cs_real_3_t  *xpsta;       
  cs_real_3_t  *xppstr;      
  cs_real_3_t  *xppsta;      
  cs_real_3_t  *forstr;      
  cs_real_3_t  *forsta;      
  cs_real_3_t  *forstp;      
  cs_real_t  *dtstr;         
  cs_real_t *dtsta; 
  /* Association with mesh */
 
  int *idfstr;                         
  cs_mobile_structure_type_t *idftype; /* structure type associated to each
                                        *   boundary face */
 
  /* Plotting */
 
  int n_plots; 
  cs_time_plot_t  **plot_files[2];  
} cs_mobile_structures_t;
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
extern int cs_glob_mobile_structures_n_iter_max;
 
extern double cs_glob_mobile_structures_i_eps;
 
extern cs_mobile_structures_t  *_mobile_structures;
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_initialize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_finalize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_mobile_structures_get_n_int_structures(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_mobile_structures_get_n_ext_structures(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_mobile_structures_get_n_ast_structures(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_add_n_int_structures(const int n_structures);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_add_n_ext_structures(const int n_structures);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_add_n_ast_structures(const int n_structures);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_set_newmark_coefficients(cs_real_t  alpha,
                                              cs_real_t  beta,
                                              cs_real_t  gamma);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Predict displacement of mobile structures with ALE.
 *
 * \param[in]  itrfin   indicator for last iteration of implicit coupling
 */
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_restore_previous_values(int  itrfin);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_prediction(cs_field_bc_coeffs_t *bc_coeffs_vel,
                                int                   itrale,
                                int                   italim,
                                int                   ineefl,
                                int                   impale[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_displacement(int   itrale,
                                  int   italim,
                                  int  *itrfin);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_restart_read(cs_restart_t  *r);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mobile_structures_restart_write(cs_restart_t  *r);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_MOBILE_STRUCTURES_H__ */