cs_porosity_from_scan.h

Go to the documentation of this file.

#ifndef __CS_POROSITY_FROM_SCAN_H__
#define __CS_POROSITY_FROM_SCAN_H__
 
/*============================================================================
 * Main for cooling towers 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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * PLE library headers
 *----------------------------------------------------------------------------*/
 
#include <ple_locator.h>
 
/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/
 
#include "fvm/fvm_nodal.h"
 
#include "base/cs_base.h"
#include "base/cs_halo.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_quantities.h"
#include "base/cs_restart.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Local Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Porosity from scan model options descriptor
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_COG_FROM_FLUID_FACES = 0,
  CS_COG_FROM_PYRAMID = 1,
  CS_COG_WITHOUT_RECONSTRUCTION_FOR_IBM_PLANE = 2
 
} cs_ibm_cog_location_t;
 
typedef enum {
 
  CS_FILL_RADIAL = 0,
  CS_FILL_DIRECTION = 1,
 
} cs_fill_type_t;
 
typedef struct {
  bool  compute_porosity_from_scan;
  char *file_names;
  int n_headers;
  int *header_type;
  char **headers;
  char *output_name;
  bool  postprocess_points;
  cs_real_34_t transformation_matrix;
  cs_real_3_t direction_vector;
  cs_fill_type_t type_fill;
  int   nb_sources;
  cs_real_3_t *sources;
  cs_lnum_t *source_c_ids;
  cs_lnum_t threshold;
  cs_lnum_t n_agglomeration;
  cs_real_t porosity_threshold;
  cs_real_t convection_porosity_threshold;
  bool      use_staircase;
  cs_real_t eigenvalue_criteria;
  int       use_restart;
  cs_ibm_cog_location_t cog_location;
  cs_real_33_t *mom_mat;
  bool  has_classification;
  float *classification_values;
  bool  *class_used;
  int   n_classifications;
  cs_restart_t *restart;
  bool remove_cells_on_restart;
} cs_porosity_from_scan_opt_t;
 
/*============================================================================
 * Static global variables
 *============================================================================*/
 
/* Pointer to options structure */
extern cs_porosity_from_scan_opt_t *cs_glob_porosity_from_scan_opt;
 
/*============================================================================
 * Static global variables
 *============================================================================*/
 
/*============================================================================
 * Public function definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_porosity_from_scan_set_file_name(const char  *file_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_porosity_from_scan_set_output_name(const char  *output_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_porosity_from_scan_add_source(const cs_real_t  source[3],
                                 bool             transform);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ibm_add_sources_by_file_name(const char *file_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_compute_porosity_from_scan(void);
 
/*----------------------------------------------------------------------------*/
 
/*--------------------------------------------------------------------*/
/*
 * \brief Write the restart file of the ibm module
 */
/*--------------------------------------------------------------------*/
 
void
cs_porous_model_restart_write_stage_1(void);
 
/*--------------------------------------------------------------------*/
/*
 * \brief Write the restart file of the ibm module
 */
/*--------------------------------------------------------------------*/
 
void
cs_porous_model_restart_write_stage_2(void);
 
/*--------------------------------------------------------------------*/
/*
 * \brief Read the restart file of the ibm module
 */
/*--------------------------------------------------------------------*/
 
void
cs_porous_model_restart_read_stage_1(void);
 
/*--------------------------------------------------------------------*/
/*
 * \brief Read the restart file of the ibm module
 */
/*--------------------------------------------------------------------*/
 
void
cs_porous_model_restart_read_stage_2(void);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_POROSITY_FROM_SCAN_H__ */