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-2022 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_nodal.h"

#include "cs_base.h"
#include "cs_halo.h"
#include "cs_mesh.h"
#include "cs_mesh_quantities.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*============================================================================
 * Local Macro definitions
 *============================================================================*/

/*============================================================================
 * Type definitions
 *============================================================================*/

/*============================================================================
 * Type definitions
 *============================================================================*/

/*----------------------------------------------------------------------------
 * Porosity from scan model options descriptor
 *----------------------------------------------------------------------------*/

typedef struct {
  bool  compute_porosity_from_scan;
  char *file_name;
  char *output_name;
  bool  postprocess_points;
  cs_real_34_t transformation_matrix;
  int   nb_sources;
  cs_real_3_t *sources;
  cs_lnum_t *source_c_ids;
  cs_lnum_t threshold;
} 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_compute_porosity_from_scan(void);

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_POROSITY_FROM_SCAN_H__ */