cs_function_default.h

Go to the documentation of this file.

#ifndef CS_FUNCTION_DEFAULT_H
#define CS_FUNCTION_DEFAULT_H
 
/*============================================================================
 * Base predefined function objects.
 *============================================================================*/
 
/*
  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_defs.h"
#include "base/cs_function.h"
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef enum {
 
  CS_FUNCTION_CELL_RANK_ID,      
  CS_FUNCTION_B_FACE_RANK_ID     
} cs_function_predefined_t;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_default_define(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_mpi_rank_id(cs_mesh_location_type_t  location_id);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Create or access a function for evaluation of mesh element's
 *        refinement generation.
 *
 * The refinement generation indicates at which refinement level a given
 * vertex or interior face was inserted into the mesh. Cells and boundary
 * faces always have a generation of 0.
 *
 * \param[in]   location_id  base associated mesh location id
 *
 * \return  pointer to the associated function object in case of success,
 *          or null in case of error
 */
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_refinement_generation(cs_mesh_location_type_t  location_id);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Create or access a function for evaluation of mesh element's
 *        refinement level.
 *
 * For vertices, the refinement level equivalent to the refinement generation.
 *
 * \param[in]   location_id  base associated mesh location id
 *
 * \return  pointer to the associated function object in case of success,
 *          or null in case of error
 */
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_refinement_level(cs_mesh_location_type_t  location_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_boundary_stress_normal(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_boundary_stress_tangential(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_boundary_thermal_flux(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_q_criterion(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_class_or_zone_id(int               location_id,
                             cs_lnum_t         n_elts,
                             const cs_lnum_t  *elt_ids,
                             void             *input,
                             void             *vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_field_boundary_nr(int               location_id,
                              cs_lnum_t         n_elts,
                              const cs_lnum_t  *elt_ids,
                              void             *input,
                              void             *vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_boundary_stress_normal(int               location_id,
                                   cs_lnum_t         n_elts,
                                   const cs_lnum_t  *elt_ids,
                                   void             *input,
                                   void             *vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_boundary_stress_tangential(int               location_id,
                                       cs_lnum_t         n_elts,
                                       const cs_lnum_t  *elt_ids,
                                       void             *input,
                                       void             *vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_boundary_nusselt(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_boundary_thermal_flux(int               location_id,
                                  cs_lnum_t         n_elts,
                                  const cs_lnum_t  *elt_ids,
                                  void             *input,
                                  void             *vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_boundary_nusselt(int               location_id,
                             cs_lnum_t         n_elts,
                             const cs_lnum_t  *elt_ids,
                             void             *input,
                             void             *vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_function_q_criterion(int               location_id,
                        cs_lnum_t         n_elts,
                        const cs_lnum_t  *elt_ids,
                        void             *input,
                        void             *vals);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define output function of a property (which is not a field).
 */
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_property_cells
(
  char *property_name 
);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define output function for the vorticity.
 */
/*----------------------------------------------------------------------------*/
 
cs_function_t *
cs_function_define_vorticity
(
  cs_field_t *velocity_field 
);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_FUNCTION_DEFAULT_H */