programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structures | Typedefs | Enumerations | Functions | Variables
cs_lagr.h File Reference
#include "cs_defs.h"
#include "assert.h"
#include "cs_base.h"
#include "cs_field.h"
#include "cs_lagr_injection.h"
Include dependency graph for cs_lagr.h:

Go to the source code of this file.

Data Structures

struct  cs_lagr_const_dim_t
 
struct  cs_lagr_dim_t
 
struct  cs_lagr_time_scheme_t
 
struct  cs_lagr_model_t
 
struct  cs_lagr_particle_counter_t
 
struct  cs_lagr_specific_physics_t
 
struct  cs_lagr_reentrained_model_t
 
struct  cs_lagr_precipitation_model_t
 
struct  cs_lagr_clogging_model_t
 
struct  cs_lagr_consolidation_model_t
 
struct  cs_lagr_time_step_t
 
struct  cs_lagr_injection_set_t
 
struct  cs_lagr_source_terms_t
 
struct  cs_lagr_zone_data_t
 
struct  cs_lagr_internal_condition_t
 
struct  cs_lagr_encrustation_t
 
struct  cs_lagr_physico_chemical_t
 
struct  cs_lagr_brownian_t
 
struct  cs_lagr_boundary_interactions_t
 
struct  cs_lagr_extra_module_t
 
struct  cs_lagr_coal_comb_t
 

Typedefs

typedef void( cs_lagr_injection_profile_compute_t )(int zone_id, int location_id, const void *input, cs_lnum_t n_elts, const cs_lnum_t elt_ids[], cs_real_t profile[])
 Function pointer for computation of particle injection profile. More...
 

Enumerations

enum  cs_lagr_bc_type_t {
  CS_LAGR_BC_UNDEFINED, CS_LAGR_INLET, CS_LAGR_OUTLET, CS_LAGR_REBOUND,
  CS_LAGR_DEPO1, CS_LAGR_DEPO2, CS_LAGR_FOULING, CS_LAGR_JBORD1,
  CS_LAGR_JBORD2, CS_LAGR_JBORD3, CS_LAGR_JBORD4, CS_LAGR_JBORD5,
  CS_LAGR_DEPO_DLVO, CS_LAGR_SYM
}
 
enum  cs_lagr_deposition_state_t {
  CS_LAGR_PART_IN_FLOW = 0, CS_LAGR_PART_DEPOSITED = 1, CS_LAGR_PART_ROLLING = 2, CS_LAGR_PART_TO_DELETE = 3,
  CS_LAGR_PART_NO_MOTION = 10, CS_LAGR_PART_IMPOSED_MOTION = 11
}
 

Functions

cs_lagr_injection_set_tcs_lagr_get_injection_set (cs_lagr_zone_data_t *zone_data, int zone_id, int set_id)
 Provide access to injection set structure. More...
 
void cs_lagr_injection_set_default (cs_lagr_injection_set_t *zis)
 Initialize injection set data structure fields to defaults. More...
 
cs_lagr_particle_counter_tcs_lagr_get_particle_counter (void)
 Get read/write pointer to global particle counter. More...
 
cs_lagr_particle_counter_tcs_lagr_update_particle_counter (void)
 Update global particle counter. More...
 
cs_lagr_specific_physics_tcs_get_lagr_specific_physics (void)
 Provide access to cs_lagr_specific_physics_t. More...
 
cs_lagr_reentrained_model_tcs_get_lagr_reentrained_model (void)
 Provide access to cs_lagr_reentrained_model_t. More...
 
cs_lagr_precipitation_model_tcs_get_lagr_precipitation_model (void)
 Provide access to cs_lagr_precipitation_model_t. More...
 
cs_lagr_clogging_model_tcs_get_lagr_clogging_model (void)
 
cs_lagr_consolidation_model_tcs_get_lagr_consolidation_model (void)
 
cs_lagr_time_step_tcs_get_lagr_time_step (void)
 
cs_lagr_source_terms_tcs_get_lagr_source_terms (void)
 
cs_lagr_encrustation_tcs_get_lagr_encrustation (void)
 
cs_lagr_physico_chemical_tcs_get_lagr_physico_chemical (void)
 
cs_lagr_brownian_tcs_get_lagr_brownian (void)
 
cs_lagr_zone_data_tcs_lagr_get_boundary_conditions (void)
 Return pointer to the main boundary conditions structure. More...
 
cs_lagr_zone_data_tcs_lagr_get_volume_conditions (void)
 Return pointer to the main volume conditions structure. More...
 
cs_lagr_internal_condition_tcs_lagr_get_internal_conditions (void)
 Return pointer to the main internal conditions structure. More...
 
void cs_lagr_finalize_zone_conditions (void)
 Finalize the global boundary and volume condition structures. More...
 
void cs_lagr_finalize_internal_cond (void)
 
cs_lagr_boundary_interactions_tcs_get_lagr_boundary_interactions (void)
 
cs_lagr_extra_module_tcs_get_lagr_extra_module (void)
 
void cs_lagr_solve_initialize (const cs_real_t *dt)
 
void cs_lagr_solve_time_step (const int itypfb[], const cs_real_t *dt)
 
void cs_lagr_init_c_arrays (int dim_cs_glob_lagr_source_terms[2], cs_real_t **p_cs_glob_lagr_source_terms)
 
void cs_lagr_finalize (void)
 

Variables

const cs_lagr_const_dim_tcs_glob_lagr_const_dim
 
cs_lagr_dim_tcs_glob_lagr_dim
 
cs_lagr_time_scheme_tcs_glob_lagr_time_scheme
 
cs_lagr_model_tcs_glob_lagr_model
 
const cs_lagr_particle_counter_tcs_glob_lagr_particle_counter
 
int cs_glob_lagr_log_frequency_n
 
cs_real_tbound_stat
 
cs_lagr_specific_physics_tcs_glob_lagr_specific_physics
 
cs_lagr_reentrained_model_tcs_glob_lagr_reentrained_model
 
cs_lagr_precipitation_model_tcs_glob_lagr_precipitation_model
 
cs_lagr_clogging_model_tcs_glob_lagr_clogging_model
 
cs_lagr_consolidation_model_tcs_glob_lagr_consolidation_model
 
cs_lagr_time_step_tcs_glob_lagr_time_step
 
cs_lagr_source_terms_tcs_glob_lagr_source_terms
 
cs_lagr_encrustation_tcs_glob_lagr_encrustation
 
cs_lagr_physico_chemical_tcs_glob_lagr_physico_chemical
 
cs_lagr_brownian_tcs_glob_lagr_brownian
 
cs_lagr_boundary_interactions_tcs_glob_lagr_boundary_interactions
 
cs_lagr_extra_module_tcs_glob_lagr_extra_module
 
cs_lagr_coal_comb_tcs_glob_lagr_coal_comb
 
const cs_lagr_zone_data_tcs_glob_lagr_boundary_conditions
 
const cs_lagr_zone_data_tcs_glob_lagr_volume_conditions
 
cs_lagr_internal_condition_tcs_glob_lagr_internal_conditions
 
cs_real_4_tcs_glob_lagr_b_u_normal
 
cs_real_33_tcs_glob_lagr_b_face_proj
 

Typedef Documentation

typedef void( cs_lagr_injection_profile_compute_t)(int zone_id, int location_id, const void *input, cs_lnum_t n_elts, const cs_lnum_t elt_ids[], cs_real_t profile[])

Function pointer for computation of particle injection profile.

Note: if the input pointer is non-NULL, it must point to valid data when the selection function is called, so that value or structure should not be temporary (i.e. local);

Parameters
[in]zone_idid of associated mesh zone
[in]location_idid of associated mesh location
[in]inputpointer to optional (untyped) value or structure.
[in]n_eltsnumber of zone elements
[in]elt_idsids of zone elements
[out]profileweight of a given zone element (size: n_elts)

Enumeration Type Documentation

Lagrangian boundary condition types

Enumerator
CS_LAGR_BC_UNDEFINED 
CS_LAGR_INLET 
CS_LAGR_OUTLET 
CS_LAGR_REBOUND 
CS_LAGR_DEPO1 
CS_LAGR_DEPO2 
CS_LAGR_FOULING 
CS_LAGR_JBORD1 
CS_LAGR_JBORD2 
CS_LAGR_JBORD3 
CS_LAGR_JBORD4 
CS_LAGR_JBORD5 
CS_LAGR_DEPO_DLVO 
CS_LAGR_SYM 

Lagrangian deposition state

Enumerator
CS_LAGR_PART_IN_FLOW 
CS_LAGR_PART_DEPOSITED 
CS_LAGR_PART_ROLLING 
CS_LAGR_PART_TO_DELETE 
CS_LAGR_PART_NO_MOTION 
CS_LAGR_PART_IMPOSED_MOTION 

Function Documentation

cs_lagr_boundary_interactions_t* cs_get_lagr_boundary_interactions ( void  )
cs_lagr_brownian_t* cs_get_lagr_brownian ( void  )
cs_lagr_clogging_model_t* cs_get_lagr_clogging_model ( void  )
cs_lagr_consolidation_model_t* cs_get_lagr_consolidation_model ( void  )
cs_lagr_encrustation_t* cs_get_lagr_encrustation ( void  )
cs_lagr_extra_module_t* cs_get_lagr_extra_module ( void  )
cs_lagr_physico_chemical_t* cs_get_lagr_physico_chemical ( void  )
cs_lagr_precipitation_model_t* cs_get_lagr_precipitation_model ( void  )

Provide access to cs_lagr_precipitation_model_t.

Returns

pointer to lagrangian precipitation model options

cs_lagr_reentrained_model_t* cs_get_lagr_reentrained_model ( void  )

Provide access to cs_lagr_reentrained_model_t.

Returns

pointer to lagrangian reentrained model options

cs_lagr_source_terms_t* cs_get_lagr_source_terms ( void  )
cs_lagr_specific_physics_t* cs_get_lagr_specific_physics ( void  )

Provide access to cs_lagr_specific_physics_t.

Returns

pointer to lagrangian specific physics options

cs_lagr_time_step_t* cs_get_lagr_time_step ( void  )
void cs_lagr_finalize ( void  )
void cs_lagr_finalize_internal_cond ( void  )
void cs_lagr_finalize_zone_conditions ( void  )

Finalize the global boundary and volume condition structures.

Finalize the global boundary and volume condition structures.

Returns
pointer to current internal conditions structure
cs_lagr_zone_data_t* cs_lagr_get_boundary_conditions ( void  )

Return pointer to the main boundary conditions structure.

Returns
pointer to current boundary zone data structure
cs_lagr_injection_set_t* cs_lagr_get_injection_set ( cs_lagr_zone_data_t zone_data,
int  zone_id,
int  set_id 
)

Provide access to injection set structure.

This access method ensures the strucure is initialized for the given zone and injection set.

Parameters
[in]zone_datapointer to boundary or volume conditions structure
[in]zone_idzone id
[in]setid injection set id
Returns
pointer to injection set data structure
cs_lagr_internal_condition_t* cs_lagr_get_internal_conditions ( void  )

Return pointer to the main internal conditions structure.

Returns
pointer to current internal conditions structure
pointer to current internal_contditions or NULL
cs_lagr_particle_counter_t* cs_lagr_get_particle_counter ( void  )

Get read/write pointer to global particle counter.

Returns
pointer to lagrangian particle counter structure
cs_lagr_zone_data_t* cs_lagr_get_volume_conditions ( void  )

Return pointer to the main volume conditions structure.

Returns
pointer to current volume zone data structure
void cs_lagr_init_c_arrays ( int  dim_cs_glob_lagr_source_terms[2],
cs_real_t **  p_cs_glob_lagr_source_terms 
)
void cs_lagr_injection_set_default ( cs_lagr_injection_set_t zis)

Initialize injection set data structure fields to defaults.

Parameters
[in,out]zispointer to structure to initialize
void cs_lagr_solve_initialize ( const cs_real_t dt)
void cs_lagr_solve_time_step ( const int  itypfb[],
const cs_real_t dt 
)
cs_lagr_particle_counter_t* cs_lagr_update_particle_counter ( void  )

Update global particle counter.

All fields handled in the local particle set are updated relative to that data (using global sums).

Returns
pointer to lagrangian particle counter structure

Variable Documentation

cs_real_t* bound_stat
cs_real_33_t* cs_glob_lagr_b_face_proj
cs_real_4_t* cs_glob_lagr_b_u_normal
const cs_lagr_zone_data_t* cs_glob_lagr_boundary_conditions
cs_lagr_boundary_interactions_t* cs_glob_lagr_boundary_interactions
cs_lagr_brownian_t* cs_glob_lagr_brownian
cs_lagr_clogging_model_t* cs_glob_lagr_clogging_model
cs_lagr_coal_comb_t* cs_glob_lagr_coal_comb
cs_lagr_consolidation_model_t* cs_glob_lagr_consolidation_model
const cs_lagr_const_dim_t* cs_glob_lagr_const_dim

Fixed constants

cs_lagr_dim_t* cs_glob_lagr_dim

General dimensions

cs_lagr_encrustation_t* cs_glob_lagr_encrustation
cs_lagr_extra_module_t* cs_glob_lagr_extra_module
cs_lagr_internal_condition_t* cs_glob_lagr_internal_conditions
int cs_glob_lagr_log_frequency_n
cs_lagr_model_t* cs_glob_lagr_model

Main Lagragian physical model parameters

const cs_lagr_particle_counter_t* cs_glob_lagr_particle_counter

Read-only pointer to global particle counter

cs_lagr_physico_chemical_t* cs_glob_lagr_physico_chemical
cs_lagr_precipitation_model_t* cs_glob_lagr_precipitation_model
cs_lagr_reentrained_model_t* cs_glob_lagr_reentrained_model
cs_lagr_source_terms_t* cs_glob_lagr_source_terms
cs_lagr_specific_physics_t* cs_glob_lagr_specific_physics
cs_lagr_time_scheme_t* cs_glob_lagr_time_scheme

Time and Lagrangian-Eulerian coupling scheme

cs_lagr_time_step_t* cs_glob_lagr_time_step
const cs_lagr_zone_data_t* cs_glob_lagr_volume_conditions