cs_lagr_event.h

Go to the documentation of this file.

#ifndef __CS_LAGR_EVENT_H__
#define __CS_LAGR_EVENT_H__
 
/*============================================================================
 * Lagrangian particle event model
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2024 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 "cs_defs.h"
 
#include "cs_lagr_particle.h"
 
#include "assert.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/
 
#define CS_EVENT_INFLOW                (1 << 0)
 
#define CS_EVENT_OUTFLOW               (1 << 1)
 
#define CS_EVENT_REBOUND               (1 << 2)
 
#define CS_EVENT_DEPOSITION            (1 << 3)
 
#define CS_EVENT_RESUSPENSION          (1 << 4)
 
#define CS_EVENT_ROLL_OFF              (1 << 5)
 
#define CS_EVENT_ROLL_ON               (1 << 6)
 
#define CS_EVENT_FOULING               (1 << 7)
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/* ----------------------------- */
 
/* Numbering of predefined attributes starts after particle attributes,
   so that particle attribute can be added to mapped variables traced
   a particle events */
 
typedef enum {
 
  CS_LAGR_E_FLAG    = CS_LAGR_N_ATTRIBUTES,   
  CS_LAGR_E_CELL_ID,                          
  CS_LAGR_E_FACE_ID,                          
  CS_LAGR_E_VELOCITY,                         
  /* End of event attributes */
 
  CS_LAGR_N_E_ATTRIBUTES
 
} cs_lagr_event_attribute_t;
 
/* ------------------------------------- */
 
typedef struct {
 
  size_t         extents;                         /* size (in bytes) of event
                                                     structure */
  size_t         lb;                              /* size (in bytes) of lower
                                                     bounds of event data
                                                     (work area before) */
 
  size_t         size[CS_LAGR_N_E_ATTRIBUTES];    /* size (in bytes) of
                                                     attributes in event
                                                     structure for a given
                                                     time value */
  cs_datatype_t  datatype[CS_LAGR_N_E_ATTRIBUTES]; /* datatype of associated
                                                      attributes */
  int            count[CS_LAGR_N_E_ATTRIBUTES];    /* number of values for each
                                                      attribute */
  ptrdiff_t      displ[CS_LAGR_N_E_ATTRIBUTES];    /* displacement (in bytes)
                                                      of attributes in event
                                                      data */
 
} cs_lagr_event_attribute_map_t;
 
/* Event set */
/* ------------ */
 
typedef struct {
 
  cs_lnum_t  n_events;                              /* number of events */
  cs_lnum_t  n_events_max;
 
  const cs_lagr_event_attribute_map_t  *e_am;       
  unsigned char                        *e_buffer;   
} cs_lagr_event_set_t;
 
/*=============================================================================
 * Global variables
 *============================================================================*/
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_lagr_event_initialize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_lagr_event_finalize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const cs_lagr_event_attribute_map_t *
cs_lagr_event_get_attr_map(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const char *
cs_lagr_event_get_attr_name(cs_lagr_event_attribute_t   attr);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_lagr_event_set_t  *
cs_lagr_event_set_create(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_lagr_event_set_destroy(cs_lagr_event_set_t  **events);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_lagr_event_get_attr_info(const cs_lagr_event_set_t  *events,
                            cs_lagr_event_attribute_t   attr,
                            size_t                     *extents,
                            size_t                     *size,
                            ptrdiff_t                  *displ,
                            cs_datatype_t              *datatype,
                            int                        *count);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_lagr_event_attr_in_range(int  attr);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static void *
cs_lagr_events_attr(cs_lagr_event_set_t  *event_set,
                    cs_lnum_t             event_id,
                    int                   attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return   (unsigned char *)event_set->e_buffer
         + event_set->e_am->extents*event_id
         + event_set->e_am->displ[attr];
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static const void *
cs_lagr_events_attr_const(const cs_lagr_event_set_t  *event_set,
                          cs_lnum_t                   event_id,
                          int                         attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return   event_set->e_buffer
         + event_set->e_am->extents*event_id
         + event_set->e_am->displ[attr];
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#if defined(__cplusplus)
template <typename T>
T *
cs_lagr_events_attr_get_ptr(cs_lagr_event_set_t  *event_set,
                            cs_lnum_t             event_id,
                            int                   attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return (T *)( event_set->e_buffer
              + event_set->e_am->extents*event_id
              + event_set->e_am->displ[attr]);
}
 
template <typename T>
const T *
cs_lagr_events_attr_get_const_ptr(const cs_lagr_event_set_t  *event_set,
                                  cs_lnum_t                   event_id,
                                  int                         attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return (const T *)( event_set->e_buffer
                    + event_set->e_am->extents*event_id
                    + event_set->e_am->displ[attr]);
}
 
template <typename T>
T
cs_lagr_events_attr_get_val(const cs_lagr_event_set_t  *event_set,
                            cs_lnum_t                   event_id,
                            int                         attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return *((const T *)( event_set->e_buffer
                     + event_set->e_am->extents*event_id
                     + event_set->e_am->displ[attr]));
}
 
template <typename T>
void
cs_lagr_events_attr_set_val(cs_lagr_event_set_t *event_set,
                            cs_lnum_t            event_id,
                            int                  attr,
                            T                    value)
{
  assert(event_set->e_am->count[attr] > 0);
 
  *((T *)(  event_set->e_buffer
                  + event_set->e_am->extents*event_id
                  + event_set->e_am->displ[attr])) = value;
}
#endif
 
BEGIN_C_DECLS
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static cs_lnum_t
cs_lagr_events_get_lnum(const cs_lagr_event_set_t  *event_set,
                        cs_lnum_t                   event_id,
                        int                         attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return *((const cs_lnum_t *)(  event_set->e_buffer
                               + event_set->e_am->extents*event_id
                               + event_set->e_am->displ[attr]));
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static void
cs_lagr_events_set_lnum(cs_lagr_event_set_t        *event_set,
                        cs_lnum_t                   event_id,
                        int                         attr,
                        cs_lnum_t                   value)
{
  assert(event_set->e_am->count[attr] > 0);
 
  *((cs_lnum_t *)(  event_set->e_buffer
                  + event_set->e_am->extents*event_id
                  + event_set->e_am->displ[attr])) = value;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static cs_real_t
cs_lagr_events_get_real(const cs_lagr_event_set_t  *event_set,
                        cs_lnum_t                   event_id,
                        int                         attr)
{
  assert(event_set->e_am->count[attr] > 0);
 
  return *((const cs_real_t *)(  event_set->e_buffer
                               + event_set->e_am->extents*event_id
                               + event_set->e_am->displ[attr]));
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline static void
cs_lagr_events_set_real(cs_lagr_event_set_t  *event_set,
                        cs_lnum_t             event_id,
                        int                   attr,
                        cs_real_t             value)
{
  assert(event_set->e_am->count[attr] > 0);
 
  *((cs_real_t *)(  event_set->e_buffer
                  + event_set->e_am->extents*event_id
                  + event_set->e_am->displ[attr])) = value;
}
 
/*----------------------------------------------------------------------------
 * Resize event set buffers if needed.
 *
 * \param[in, out]  event_set  pointer to event set
 * \param[in]       mini mum required
 *----------------------------------------------------------------------------*/
 
void
cs_lagr_event_set_resize(cs_lagr_event_set_t  *event_set,
                         cs_lnum_t             min_size);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_lagr_event_set_dump(const cs_lagr_event_set_t  *events);
 
/*----------------------------------------------------------------------------
 * Resize event set buffers if needed.
 *
 * \param[in, out]  events       pointer to event set
 * \param[in, out]  particles    pointer to particle set
 * \param[in]       event_id     event id
 * \param[in]       particle_id  particle id
 *----------------------------------------------------------------------------*/
 
void
cs_lagr_event_init_from_particle(cs_lagr_event_set_t     *events,
                                 cs_lagr_particle_set_t  *particles,
                                 cs_lnum_t                event_id,
                                 cs_lnum_t                particle_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_lagr_event_set_t  *
cs_lagr_event_set_boundary_interaction(void);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_LAGR_EVENT_H__ */