cs_function.h

Go to the documentation of this file.

#ifndef __CS_FUNCTION_H__
#define __CS_FUNCTION_H__

/*============================================================================
 * Function objects management.
 *============================================================================*/

/*
  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.
*/

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

/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/

#include "cs_defs.h"
#include "cs_mesh_location.h"
#include "cs_param_types.h"
#include "cs_restart_default.h"

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

BEGIN_C_DECLS

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

/*
 * Function property type
 */

#define CS_FUNCTION_INTENSIVE           (1 << 0)

#define CS_FUNCTION_EXTENSIVE           (1 << 1)

#define CS_FUNCTION_TIME_INDEPENDENT    (1 << 2)

#define CS_FUNCTION_USER                (1 << 3)

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

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

typedef void
(cs_eval_at_location_t) (int               location_id,
                         cs_lnum_t         n_elts,
                         const cs_lnum_t  *elt_ids,
                         void             *input,
                         void             *vals);

/* Function descriptor */
/*---------------------*/

typedef struct {

  const char             *name;         
  char                   *label;        
  const int               id;           
  int                     type;         
  const int               dim;          
  const int               location_id;  
  const cs_datatype_t     datatype;     
  int                     post_vis;     
  int                     log;          
  int                     time_stamp;   
  cs_restart_file_t       restart_file;   
  cs_eval_at_location_t  *eval_func;      
  cs_analytic_func_t     *analytic_func;  
  cs_dof_func_t          *dof_func;       
  void                   *func_input;   /* Pointer to optional (untyped)
                                           value or structure, for use by
                                           evaluation function */

} cs_function_t;

/*=============================================================================
 * Global variables
 *============================================================================*/

/*============================================================================
 * Public function prototypes
 *============================================================================*/

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

cs_function_t *
cs_function_define_by_func(const char             *name,
                           int                     location_id,
                           int                     dim,
                           bool                    is_intensive,
                           cs_datatype_t           datatype,
                           cs_eval_at_location_t  *data_func,
                           void                   *data_input);

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

cs_function_t *
cs_function_define_by_analytic_func(const char          *name,
                                    int                  location_id,
                                    int                  dim,
                                    bool                 is_intensive,
                                    cs_analytic_func_t  *data_func,
                                    void                *data_input);

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

cs_function_t *
cs_function_define_by_dof_func(const char      *name,
                               int              location_id,
                               int              dim,
                               bool             is_intensive,
                               cs_dof_func_t   *data_func,
                               void            *data_input);

/*----------------------------------------------------------------------------
 * Destroy all function management metadata.
 *----------------------------------------------------------------------------*/

void
cs_function_destroy_all(void);

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

int
cs_function_n_functions(void);

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

cs_function_t  *
cs_function_by_id(int  id);

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

cs_function_t  *
cs_function_by_name(const char  *name);

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

cs_function_t  *
cs_function_by_name_try(const char  *name);

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

void
cs_function_set_label(cs_function_t   *f,
                      const char      *label);

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

void
cs_function_log_defs(void);

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

void
cs_function_log_all_settings(void);

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

void
cs_function_evaluate(const cs_function_t   *f,
                     const cs_time_step_t  *ts,
                     int                    location_id,
                     cs_lnum_t              n_elts,
                     const cs_lnum_t       *elt_ids,
                     void                  *vals);

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

END_C_DECLS

#endif /* __CS_FUNCTION_H__ */