cs_atmo_imbrication.h

Go to the documentation of this file.

#ifndef __CS_ATMO_IMBRICATION_H__
#define __CS_ATMO_IMBRICATION_H__
 
/*============================================================================
 * Atmospheric imbrication related functions
 *============================================================================*/
 
/*
  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"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Local Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Atmospheric imbrication option
 *----------------------------------------------------------------------------*/
 
typedef struct {
 
  bool imbrication_flag;
  bool imbrication_verbose;
 
  bool cressman_u;
  bool cressman_v;
  bool cressman_qw;
  bool cressman_nc;
  bool cressman_tke;
  bool cressman_eps;
  bool cressman_theta;
 
  cs_real_t vertical_influence_radius;
  cs_real_t horizontal_influence_radius;
 
  int id_u;
  int id_v;
  int id_qw;
  int id_nc;
  int id_tke;
  int id_eps;
  int id_theta;
 
} cs_atmo_imbrication_t;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/* Pointer to atmo imbrication structure */
extern cs_atmo_imbrication_t *cs_glob_atmo_imbrication;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
void
cs_finalize_imbrication(void);
 
void
cs_activate_imbrication(void);
 
void
cs_summon_cressman(cs_real_t the_time);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_ATMO_IMBRICATION_H__ */